8-0_Deployer_Users_Guide

8-0_Deployer_Users_Guide - Title Page webMethods Deployer...

Info iconThis preview shows page 1. Sign up to view the full content.

View Full Document Right Arrow Icon
This is the end of the preview. Sign up to access the rest of the document.

Unformatted text preview: Title Page webMethods Deployer User's Guide Version 8.0 June 2009 Copyright & Docu ment ID This document applies to webMethods Deployer Version 8.0 and to all subsequent releases. Specifications contained herein are subject to change and these changes will be reported in subsequent release notes or new editions. Copyright 20042009 Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, United States of America, and/or their suppliers. All rights reserved. The name Software AG, webMethods, and all Software AG product names are either trademarks or registered trademarks of Software AG and/or Software AG USA, Inc. Other company and product names mentioned herein may be trademarks of their respective owners. This software includes portions of thirdparty products. For thirdparty copyright notices and license terms, please refer to ThirdParty Copyright and Trademark Notices and License Terms. This document is part of the product documentation, located at http://documentation.softwareag.com/thirdparty and/or in the root installation directory of the licensed product(s). Document ID: DEP-UG-80-20090629 Table of Contents About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . webMethods Central Documentation Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . webMethods Advantage Bookshelf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Software AG Developer Community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . webMethods Deployer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deployment Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Create the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Define the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Build the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Map the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deploy the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Checkpoint and Roll Back . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Access to Target Environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deployer Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Project Locking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2. Starting Deployer and Connecting to Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting Deployer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set Up Connections to Brokers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set Up Connections to ProcessModel Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set Up Connections to Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set Up Connections to My webMethods Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set Up Connections to Optimize Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Target Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3. Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling or Disabling Deployer GUI Audit Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Default Properties for All Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting the Dependency Checking Default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting the Project Locking Default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting General Deployment Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting the Defaults for Integration Server and Trading Networks Projects . . . . . . . . . . . . Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting and Importing a Project's Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 7 8 8 8 8 9 10 10 10 11 13 13 14 14 15 15 16 16 17 18 18 18 19 21 21 23 23 25 26 27 27 27 27 28 30 32 webMethods Deployer User's Guide Version 8.0 3 Table of Contents Authorizing Groups to Perform Tasks on a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Adding and Viewing Instructions or Notes About a Project . . . . . . . . . . . . . . . . . . . . . . . . . 33 4. Defining a Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Identifying Source Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Assets to a Broker, ProcessModel, MWS, or Optimize Deployment Set . . . . . . . . . Adding Assets to an IS & TN Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deploying ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Integration Server Administration Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Integration Server Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding an Entire Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Package Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Package Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Package Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding webMethods Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Trading Networks Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Excluding Common Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Resolving Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Manually Adding Dependencies on a Package Component in an IS & TN Deployment Set Removing Process Models from a Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5. Defining a Deletion Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a Deletion Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Identifying Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Assets to a Deletion Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting and Importing Deletion Set Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6. Building, Mapping, and Deploying a Project Using the Deployer GUI . . . . . . . . . . . . . Building a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Create a Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Rebuilding a Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting and Importing a Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mapping a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mapping a Project to Target Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting and Importing a Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Substituting Configuration Values for Integration Server Assets . . . . . . . . . . . . . . . . . Exporting and Importing Substitute Configuration Values . . . . . . . . . . . . . . . . . . . . . . Deploying a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Generating a Checkpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Simulating Deployment of a Project or Deploying a Project . . . . . . . . . . . . . . . . . . . . . Post-Deployment Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Rolling Back Target Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 36 37 37 38 39 39 40 40 40 41 43 46 46 47 47 49 50 51 52 53 53 55 57 58 58 59 59 60 60 62 63 64 64 64 65 67 67 4 webMethods Deployer User's Guide Version 8.0 Table of Contents 7. Deploying to Clustered Integration Servers and ProcessModel Servers . . . . . . . . . . . Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set Up Connections to Integration Servers in the Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . Define the Target Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deploying Scheduled Tasks to a Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8. Using Deployer Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating and Running Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying Log On Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a Configuration File for Log On Parameters . . . . . . . . . . . . . . . . . . . . . . . . . Error Handling and Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . General and Project Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Locking and Unlocking Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Listing Builds, Maps, or Deployment Candidates for a Project . . . . . . . . . . . . . . . . . . . Displaying Project Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting Project Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing Project Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting Deletion Sets from a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing Deletion Set Definitions into a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Build Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a Project Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Listing Builds for a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Displaying Contents of a Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Displaying Substitute Configuration Values for Integration Server Assets in a Build . . Displaying Contents of a Build File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Displaying Substitute Configuration Values for Integration Server Assets in a Build File Exporting a Build from a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing a Build into a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Listing Build Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Displaying a Build Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Map Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Listing All Deployment Maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting a Deployment Map from a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing a Deployment Map or Substitute Configuration Values . . . . . . . . . . . . . . . . . . Importing a Deployment Map Into a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting Substitute Configuration Values for Integration Server Assets from a Deployment Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing Substitute Configuration Variables for Integration Server Assets into a Deployment Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting a Deployment Map from a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 70 70 70 71 73 74 77 78 79 79 79 80 80 80 80 81 81 81 82 82 83 83 83 83 84 84 84 85 85 86 86 87 87 87 87 88 89 90 90 webMethods Deployer User's Guide Version 8.0 5 Table of Contents Deployment Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a Deployment Candidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Displaying Information About a Deployment Candidate . . . . . . . . . . . . . . . . . . . . . . . . Deleting a Deployment Candidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Generating a Checkpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Simulating a Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deploying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Rolling Back Target Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Listing Simulation, Rollback, and Deployment Reports . . . . . . . . . . . . . . . . . . . . . . . . Displaying a Simulation, Rollback, or Deployment Report . . . . . . . . . . . . . . . . . . . . . . 91 91 91 92 92 92 93 93 94 94 6 webMethods Deployer User's Guide Version 8.0 About This Guide This guide explains how to use webMethods Deployer 8.0. Deployer is a tool you use to deploy assets from source webMethods servers to target webMethods servers. You can deploy assets from the products listed below. Product Blaze Advisor webMethods Broker webMethods Designer webMethods Integration Server My webMethods Server webMethods Optimize webMethods Trading Networks Versions 6.6 8.0 8.0 8.0 8.0 8.0 8.0 Document Conventions Convention Bold Narrow font UPPERCASE Italic Description Identifies elements on a user interface. Identifies storage locations for services on webMethods Integration Server, using the convention folder.subfolder:service. Identifies keyboard keys. Keys you must press simultaneously are joined with a plus sign (+). Identifies variables for which you must supply values specific to your own situation or environment. Identifies new terms the first time they occur in the text. Identifies text you must type or messages displayed by the system. Indicates a set of choices from which you must choose one. Type only the information inside the curly braces. Do not type the { } symbols. Separates two mutually exclusive choices in a syntax line. Type one of these choices. Do not type the | symbol. Indicates one or more options. Type only the information inside the square brackets. Do not type the [ ] symbols. Indicates that you can type multiple options of the same type. Type only the information. Do not type the ellipsis (...). Monospace font { } | [ ] ... webMethods Deployer User's Guide Version 8.0 7 About This Guide Additional Information You can find additional information about webMethods products at the locations described below. webMethods Central Documentation Directory During product installation, you can download the webMethods product documentation to a single directory called "_documentation." This directory is located by default under the webMethods installation directory. webMethods Advantage Bookshelf The webMethods Advantage Web site at http://advantage.webmethods.com provides you with important sources of information about webMethods products: Troubleshooting Information. The webMethods Knowledge Base provides troubleshooting information for many webMethods products. Documentation Feedback. To provide feedback on webMethods documentation, go to the Documentation Feedback Form on the webMethods Bookshelf. Additional Documentation. You can find documentation for all webMethods products on the webMethods Bookshelf. Software AG Developer Community Additional articles, demos, and tutorials are available on the webMethods portion of the Software AG Developer Community. The various Developer Communities feature technical information, useful resources, and online discussion forums, moderated by Software AG professionals, to help you do more with webMethods technology. With the Software AG Developer Communities, you can: Use the online discussion forums to exchange best practices and chat with other experts. Expand your knowledge with product documentation, code samples, articles, online seminars and tutorials. Link to external sites on open standards and many Web technology topics. See how other customers are streamlining their operations with technology from Software AG. 8 webMethods Deployer User's Guide Version 8.0 1 Concepts 10 10 15 15 16 16 webMethods Deployer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deployment Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Access to Target Environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deployer Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Project Locking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . webMethods Deployer User's Guide Version 8.0 9 1 Concepts webMethods Deployer webMethods Deployer is a tool you use to deploy usercreated assets that reside on source webMethods servers to target webMethods servers. For example, you might want to deploy assets you have developed on servers in a development environment to servers in a test or production environment. Important! You can deploy usercreated assets using Deployer. You cannot deploy webMethods components that have been installed by the webMethods Installer as part of a product. For example, you can deploy Integration Server packages that have been created by users, but you cannot deploy Integration Server packages that were installed, such as WmPRT. If you want such components on target servers, you must install them using the webMethods Installer. Deployment Process The deployment process involves these steps: 1 2 3 4 5 Create a deployment project by assigning the project a name, setting the project's properties, and authorizing users to work on the project. Define the project by identifying its contents (that is, usercreated assets). Create a project build. Map the contents of the project build to target servers. Deploy the project to the target servers. Create the Project A deployment project identifies the usercreated assets on source servers that you want to deploy to target servers. To create a project, you assign the project a name and set its properties, and then you authorize users to perform the project tasks (that is, defining, building, mapping, and deploying the project). When you create a project, Deployer automatically creates an HTML home page for the project. You can modify this page to contain instructions or notes about the project that you want users to view. For example, you might want to list the target servers for the users who will perform the mapping task, or you might want to provide instructions for users who will test the deployed solution. 10 webMethods Deployer User's Guide Version 8.0 1 Concepts Define the Project You define a project by creating deployment sets in the project. Each deployment set identifies the usercreated assets you want to deploy from and to one type of webMethods server. Types of webMethods server you can deploy from and to are: Brokers. ProcessModel servers. A ProcessModel server is an Integration Server that hosts the webMethods Process Engine and executes business processes. Integration Servers. My webMethods Server. Optimize servers. An Optimize server is an Optimize Analytic Engine. You can define the types of deployment sets listed below. Deployment Set Broker ProcessModel Contents Document types and client groups from one or more source Brokers. Process models from one source ProcessModel server. Note: If you want to deploy process models from more than one ProcessModel server, you must define a deployment set for each ProcessModel server. IS & TN Integration Server administrative assets such as ports, users, groups, scheduled tasks, packages, and Web Service Descriptors from one or more source Integration Servers. Usercreated Integration Server packages from one or more source Integration Servers. Trading Networks assets such as processing rules, document types, trading partner agreements, partner profiles, and security data from one or more source Integration Servers. Blaze Advisor rules from one or more source Integration Servers. Files from webMethods installations on one or more machines that host an Integration Servers. These are called webMethods files. MWS Usercreated assets such as pages, portlets, CAF and task applications, rules, users, groups, roles, and directory services from one or more My webMethods Servers. Process configuration assets such as process and step timeouts and process extensions, and other analysis KPI metadata from one or more Optimize servers. Optimize webMethods Deployer User's Guide Version 8.0 11 1 Concepts A single project can include different types of deployment sets; for example, a single project could include all of the deployment sets listed above. The usercreated assets you include in a deployment set depend on the target servers to which you want to deploy the assets. For example, if you wanted to deploy Integration Server assets to one set of target Integration Servers, you could define a single deployment set that identifies those assets. project deployment set target Integration Servers If you wanted to deploy some Integration Server assets to one set of target Integration Servers and other Integration Server assets to a second set of target Integration Servers, you would have to define two different deployment sets. project deployment set 1 first set of target Integration Servers deployment set 2 second set of target Integration Servers As you define a deployment set, Deployer determines when assets that are in a deployment set require other assets that are not in the deployment set. Deployer identifies these missing assets as unresolved dependencies. For example, if you add a trigger to an IS & TN deployment set, but do not add the service that is invoked by the trigger, Deployer identifies the missing service as an unresolved dependency. Deployer gives you several options for resolving unresolved dependencies. You can also define deletion sets in a project. Deletion sets let you identify usercreated assets to delete from target servers before deploying the assets in the project's deployment sets. You can export deletion set definitions from one project and import them into another. 12 webMethods Deployer User's Guide Version 8.0 1 Concepts Build the Project You build a project to create a file that contains the actual assets referenced in the project. If you later change the project, or if the build contains assets that you know have changed on the source servers, you can recreate the build to bring it up to date. Map the Project In a deployment map, you identify target servers for each deployment set in a project. If you add or delete deployment sets from a project, and then recreate the build to reflect the changes, you would update the map as well. You can create multiple deployment maps for each project build (for example, if you are deploying to multiple environments). If you find that you repeatedly have to map deployment sets to the same set of target servers, you can reduce your effort by grouping the target servers into a target group. You can then map the deployment sets to the target group rather than to the individual target servers. As part of the deployment map for an IS & TN deployment set, you can specify configuration values for Integration Server assets that you want Deployer to substitute during deployment so the assets will run properly on target servers. Suppose an Integration Server in a development environment has a file polling port that is configured to monitor the C:\TEMP directory. You want to deploy this port to a production Integration Server on a Solaris system and have the port poll the /tmp directory instead. In the deployment map, you would specify a substitute configuration value of /tmp directory for the port. You can substitute different configuration values for scheduled tasks, ports, adapter connections, adapter notifications, and extended settings. You can substitute different configuration values for different target servers. You also identify the target servers for deletion sets in deployment maps. Deploy the Project To deploy a project, you first create a deployment candidate, which is the combination of a project build and a deployment map. You then generate a simulation report that scans the source and target servers and alerts you to some potential problems before you deploy. You can address problems and regenerate the simulation reports until all problems are resolved. When you are ready, you deploy the project. If the project includes deletion sets, Deployer deletes the identified assets from the target servers. Deployer then copies the contents of each deployment set in the deployment candidate's project build to the target servers identified in the deployment candidate's deployment map. Deployer creates a deployment report that lists all actions that occurred during deployment. For an IS & TN deployment set, if you specified substitute configuration values for certain deployed Integration Server assets on target servers, Deployer changes those values during deployment. webMethods Deployer User's Guide Version 8.0 13 1 Concepts Checkpoint and Roll Back If a deployment to a target server fails and the target environment is in an inconsistent state, or a deployment is successful but the deployed assets are not working as expected, you can use Deployer's roll back feature to undo the deployment. For deployment sets, you create a checkpoint to which you want to roll back the target server before you deploy. The checkpoint contains a copy of the assets on the target server that will be replaced by the assets in the deployment sets. The roll back feature rolls back the target server to the checkpoint. If the deployment sets added assets to the target servers, the roll back removes them. You can choose automatic or manual checkpoint, roll back, or both, as follows: If you choose... Automatic checkpoint Manual checkpoint Automatic roll back Manual roll back Description Deployer automatically generates a checkpoint as the first step when you deploy. You are responsible for generating the checkpoint before you deploy. Deployer automatically generates a checkpoint as the first step when you deploy. If deployment fails, Deployer automatically rolls back the target server to the checkpoint. You are responsible for rolling back the target server manually if necessary. For deletion sets, Deployer automatically creates the checkpoint for the target server. If deployment fails, Deployer automatically rolls back the target server. Access to Target Environments You might want to deploy from one environment to another, but the Deployer in your source environment might not be able to access the target environment. In such cases, you can export the build you want to deploy from the Deployer in the source environment and import the build into the Deployer in the target environment. The Deployer in the target environment automatically creates the deployment project and deployment sets from the imported build. You can then map the imported build, or you can export a deployment map for the build from the Deployer in the source environment and import it into the target project. Before you import a map, you can edit any of the attributes (for example, you could map a deployment set to a different target server). 14 webMethods Deployer User's Guide Version 8.0 1 Concepts Deployer Interfaces Deployer offers a graphical user interface and a command line interface. You can enter commands at a command prompt or you can create scripts that execute commands automatically. The table below shows which tasks you can perform from each type of Deployer interface. Task Configure communication between Deployer and the source and target servers Create or delete projects, set default properties for projects, authorize groups to work on projects, add and view instructions or notes about projects Export and import project properties and deletion set definitions Define deployment sets and deletion sets Map deployment sets and deletion sets to target servers List, display, export, import, and delete deployment maps Create project builds List, export, and import builds; display build contents; list and display build reports List, create, display, or delete deployment candidates; simulate deployments; deploy; list and display simulation and deployment reports Generate a checkpoint or roll back target servers, list and display rollback reports GUI Command Line Project Locking Deployer offers project locking. If locking is enabled for a project, a user who wants to modify the project or perform an action such as deployment must lock the project. Other users will be able to view the project and run display commands. If necessary, users with administrative privileges can unlock a locked project. webMethods Deployer User's Guide Version 8.0 15 1 Concepts Logging Deployer writes audit log entries to two logs: The Deployer GUI audit log. This log contains information about actions that users perform through the Deployer GUI, such as creating builds and deploying. The Deployer command line audit log. This log lists errors that occur during Deployer command line operations performed by users. Deployer writes journal entries to the Integration Server server log. The server log contains information about operations and errors that occur on Integration Server, such as the starting of Integration Server subsystems and the loading of Integration Server packages such as Deployer. For complete information about the Integration Server server log, see the webMethods Integration Server Administrator's Guide. 16 webMethods Deployer User's Guide Version 8.0 2 Starting Deployer and Connecting to Servers 18 18 18 19 21 21 23 23 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting Deployer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set Up Connections to Brokers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set Up Connections to ProcessModel Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set Up Connections to Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set Up Connections to My webMethods Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set Up Connections to Optimize Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Target Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . webMethods Deployer User's Guide Version 8.0 17 2 Starting Deployer and Connecting to Servers Overview This chapter explains how to start Deployer, set up the connections between Deployer and the source and target servers, and create target groups. Starting Deployer Deployer starts automatically when you start its host Integration Server. Open Deployer interface by entering this URL in an Internet browser, where Integration Server is the Integration Server that hosts Deployer: http://Integration Server_host:Integration Server_port/WmDeployer Deployer and Integration Server Administrator use the same log on user name and password. If you just installed Deployer with a new Integration Server, the defaults are user name Administrator and password manage. Set Up Connections to Brokers For each source and target Broker, Deployer must connect to the Broker Server that controls that Broker. To set up connections to source and target Brokers 1 2 In Deployer, go to the Servers > Broker page. For every source or target Broker, click Configure Broker Server and complete these fields: Box Name Host Port Client Group Entry Name to assign to the Broker Server. Host name or IP address of the Broker Server. Port for the Broker Server. Client group for Deployer to use to access the source or target Broker. For target Brokers, type admin. Note: To connect, Deployer must belong to the specified Broker client group and have access permission. Broker Name Name of the source or target Broker. 18 webMethods Deployer User's Guide Version 8.0 2 Starting Deployer and Connecting to Servers Box Use SSL Entry Whether Deployer should use SSL to connect to the Broker Server. If you use SSL, you must complete the fields below. Note: You can only use SSL if the Broker Server is configured to use SSL. Deployer Keystore Full path to Deployer's keystore file. The keystore contains the SSL credentials (private key and signed certificate) that the Broker Server uses to authenticate Deployers identity and establish an SSL connection. File type of Deployer's keystore file. Password that Deployer uses to access its keystore file. Full path to Deployer's truststore file. The truststore contains the trusted roots for Deployers SSL certificates. File type of Deployer's truststore file. Keystore Type Keystore Password Deployer Truststore Truststore Type 3 Click Configure. To test the connection, click . Set Up Connections to ProcessModel Servers A ProcessModel server is an Integration Server that hosts the webMethods Process Engine and executes business processes. To set up connections to ProcessModel servers 1 Make sure the Process Audit Log database component is installed and Integration Server is configured to write to it. For instructions, see the webMethods Installation Guide. In Deployer, go to the Servers > ProcessModel page. For every source or target ProcessModel server, click Configure ProcessModel Server and complete these fields: Box Name Host Port Entry Name to assign to the server. Host name or IP address of the server. Port for the server. 2 3 webMethods Deployer User's Guide Version 8.0 19 2 Starting Deployer and Connecting to Servers Box User Password Use SSL Entry User name for a user account with Administrator authority that Deployer can use to access the server. Password that is associated with the user name. Whether Deployer should use SSL to connect to the server. Note: You can only use SSL if the server is configured to use SSL. Configure the server's HTTPS port to not request client certificates. For instructions on defining the HTTPS port, see the webMethods Integration Server Administrator's Guide. Click Configure. To test the connection, click . 4 In Designer, a logicaltophysical server mapping is defined for each process model. For deployment purposes, you must duplicate the mapping for each process model to deploy on the model's source and target ProcessModel servers. In the Integration Server Administrator for each of the servers, do the following: a b c Define the physical servers in the mapping as remote servers. For instructions, see the webMethods Integration Server Administrator's Guide. Go to the Packages > Management page and click for the WmDesigner package. Click Add Logical Server and complete these fields: Box Name Type Physical Server d e f 5 Entry Name of a logical server in the mapping for the process model. Integration Server. Physical server to which the logical server is mapped. Click Add Logical Server. Repeat these steps to duplicate the rest of the mapping. Repeat these steps for every process model to deploy. Install the WmDeployerResource package on each ProcessModel server that will run process steps. In Deployer, go to the Servers > IS & TN page; the page lists all ProcessModel servers you defined as remote servers. In the Install column, select the check box next to each ProcessModel server, then click Install. If a process model to deploy includes a task, go to the Packages > Management page on the model's source and target ProcessModel servers, click for the WmTaskClient package, and identify the My webMethods Server that hosts the task. 6 20 webMethods Deployer User's Guide Version 8.0 2 Starting Deployer and Connecting to Servers Set Up Connections to Integration Servers To set up connections to source and target Integration Servers 1 Open the Integration Server Administrator for the Integration Server that hosts Deployer and define the following as remote servers: All source Integration Servers All target Integration Servers The Integration Server that hosts Deployer, if you will be using it as a source or target server (that is, define the Integration Server as a remote server to itself) For more information about remote servers, and instructions on defining them, see the webMethods Integration Server Administrator's Guide. 2 Install the WmDeployerResource package on each Integration Server. In Deployer, go to the Servers > IS & TN page; the page lists all Integration Servers you defined as remote servers. In the Install column, select the check box next to each Integration Server. Click Install. Set Up Connections to My webMethods Servers To set up connections to My webMethods Servers 1 2 In Deployer, go to the Servers > MWS page. For every source and target My webMethods Server, click Configure MWS Server and complete these fields: Box Name Host Port User Password Entry Name to assign to the server. Host name or IP address of the server. Port for the server. User name for a user account with Administrator authority that Deployer can use to access the server. Password that is associated with the user name. webMethods Deployer User's Guide Version 8.0 21 2 Starting Deployer and Connecting to Servers Box Exclude Core Task Engine Dependencies Entry Whether to exclude Task Engine portlets from the dependencies list for task application assets. Exclude the portlets from the list if the target My webMethods Servers host the Task Engine; the portlets are installed with the Task Engine. Include the portlets if the target My webMethods Servers do not host the Task Engine; you will have to include the portlets in the deployment set. For information about dependencies, see "Resolving Dependencies" on page 47. Length of time queries should remain in the cache unless the cache capacity is exceeded. Whether to include the following in the dependencies list for My webMethods Server assets when creating an MWS deployment set: Security realms that contain the assets. User/group/role references in the assets security ACLs. Include the dependencies in the list if they do not exist on the target My webMethods Servers; you will have to include them in the deployment set. Exclude the dependencies if they do exist on the target My webMethods Servers. For information about dependencies, see "Resolving Dependencies" on page 47. Cache Timeout Include security dependencies Root folder aliases Maximum folder object count Enable additional MWS logging Maximum folder depth Use SSL My webMethods Server aliases to use as root folders when selecting pages to deploy. Separate the folders using commas. Maximum number of assets to display within My webMethods Server folders when you are defining and choosing assets to include in an MWS deployment set. Whether to log debug information about selected assets to source My webMethods Server logs, and assets that Deployer deploys to target My webMethods Server logs. Maximum number of My webMethods Server folder levels to display when you are defining and choosing assets to include in an MWS deployment set. Whether Deployer should use SSL to connect to the My webMethods Server. Note: You can only use SSL if the My webMethods Server is configured to use SSL. Configure the My webMethods Server's HTTPS port to not request client certificates. For instructions on defining the HTTPS port, see the My webMethods Server Administrator's Guide. 3 Click Configure. To test the connection, click . 22 webMethods Deployer User's Guide Version 8.0 2 Starting Deployer and Connecting to Servers Set Up Connections to Optimize Servers To set up connections to Optimize servers 1 2 In Deployer, go to the Servers > Optimize page. For every source and target Optimize server, click Configure Optimize Server. In the Configure Optimize Server area, complete these fields: Box Name Host Port Use SSL Entry Name to assign to the server. Host name or IP address of the server. Port for the server. Whether Deployer should use SSL to connect to the server. Note: You can only use SSL if the server is configured to use SSL. Configure the server's HTTPS port to not request client certificates. For instructions on defining the HTTPS port, see the webMethods Optimize Administrator's Guide. 3 Click Configure. To test the connection, click . Creating Target Groups To create a target group 1 2 3 In Deployer, go to the Target Groups > server page. Click Create server Target Groups. In the Name box, type the name to use for the target group. The name can be up to 32 characters long and can include any characters that are valid for a file name in your operating system. In the Description box, type a description for the target group. The description length has no limit and can include any characters. Click Create. You can specify that deployment must either succeed on all servers in the target group or be automatically rolled back. In other words, if deployment fails on any server in the target group, you can specify that Deployer must automatically roll back the deployment on all servers in the group. To do so, set Roll Back All on Failure to Yes. When a target group is defined as a logical cluster, Deployer ignores the Roll back on Error project setting (see "Setting General Deployment Defaults" on page 27). 4 5 6 webMethods Deployer User's Guide Version 8.0 23 2 Starting Deployer and Connecting to Servers 7 The Available Servers list shows all servers of the specified type for which you have set up connections to Deployer. Select the servers to add to the target group, and then click Add. The servers move to the Selected Servers list. Click Save. To test the connection between Deployer and the target group, click in the left pane. 8 9 24 webMethods Deployer User's Guide Version 8.0 3 Creating a Project 26 27 28 32 30 32 33 Enabling or Disabling Deployer GUI Audit Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Default Properties for All Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting the Defaults for Integration Server and Trading Networks Projects . . . . . . . . . . . . . . . . . Exporting and Importing a Project's Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Authorizing Groups to Perform Tasks on a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding and Viewing Instructions or Notes About a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . webMethods Deployer User's Guide Version 8.0 25 3 Creating a Project Enabling or Disabling Deployer GUI Audit Logging Under the Audit Logging Settings area on the Settings page, indicate whether to enable or disable audit logging for user actions taken through the Deployer GUI. To view the audit log, go to the Logs > Audit page. The columns in the audit log are described below. Column Time Stamp Request Type Message Status User Id Server Type Type of server on which the action was performed; can include the Integration Server that hosts Deployer and source and target servers. Name assigned to the server in Deployer (see Chapter 2, "Starting Deployer and Connecting to Servers"). IP address and port for the server on which the action was performed. Unique identification for each Deployer action. If an action fails, the thread ID helps you identify the failed action. through the Audit Log page in Deployer. Using this, the user can identify the failed activity. You can change this display; use the Log display controls area at the top of the page and then click Refresh. The changes remain until you change them again, or until you shut down the Integration Server that hosts Deployer, whichever comes first. Description Date and time the entry was written to the log. Type of action Deployer performed (for example, Create Build or Deploy) Message that describes the action. Outcome of the action (for example, Success or Failed). User name under which Deployer performed the action. Alias Host IP:Port Thread ID 26 webMethods Deployer User's Guide Version 8.0 3 Creating a Project Setting Default Properties for All Projects Deployer uses default properties for all projects. To set the properties, go to the Deployer > Settings page. When you are done, click Save. You can override many of these properties for individual projects; see "Creating a Project" on page 30 for instructions. Setting the Dependency Checking Default Under the Dependency Checking Default area on the Settings page, indicate the default for dependency checking for all projects. Option Automatic Description Tells Deployer to automatically check dependencies regularly as you modify the project and progress through the different phases of deployment. Tells Deployer to automatically check dependencies when you create a project build and when you deploy. You can trigger additional dependency checking at different steps yourself. You will trigger dependency checking at different steps yourself. Reduced Manual Setting the Project Locking Default Under the Project Locking Default area on the Settings page, indicate whether locking should be enabled or disabled by default for all projects. Setting General Deployment Defaults Under the General Deployment Defaults area on the Settings page, indicate the defaults for the options below for all projects. Option Checkpoint Creation Roll back on Error Entry To have Deployer automatically create a checkpoint for target servers before deploying, click Automatic. If you want to generate checkpoints when you choose, click Manual. To have Deployer automatically create checkpoints before deploying and roll back deployments if they fail, click Automatic. If you want to roll back deployments when you choose, click Manual. webMethods Deployer User's Guide Version 8.0 27 3 Creating a Project Note: If deployment sets in a project include deletion sets, Deployer ignores these settings. Instead, Deployer automatically creates checkpoints for target servers, and if deployment fails, Deployer automatically rolls back the target servers. Setting the Defaults for Integration Server and Trading Networks Projects In addition to the default properties for all projects, Deployer uses default properties for all Integration Server and Trading Networks projects. To set these properties, go to the Deployer > Settings page. When you are done, click Save. You can override many of these properties for individual projects; see "Creating a Project" on page 30. These default properties apply to all assets except Integration Server packages. You specify package properties for Integration Server packages on a packagebypackage basis. For instructions, see "Setting Package Properties" on page 43. To set default properties for Integration Server and Trading Networks projects 1 In the Suspend During Deployment area on the Settings page, indicate whether Deployer should suspend activity for the Integration Server assets listed below while deployment is going on. Typically, if the targets are production Integration Servers, you would suspend all of these types of assets. After deployment, Deployer resumes the suspended triggers, adapter listeners, and polling notifications; enables the disabled ports; and stops preventing the scheduled tasks. Asset Triggers Description Allow all running trigger operations to complete, then suspend all trigger execution and document retrieval on the target Integration Servers. Click... All Important! If you choose All, Deployer suspends execution and document retrieval for ALL triggers on the target Integration Servers, not just for the triggers that you include in the project. Do not suspend triggers. Suspend individual triggers. You choose the triggers to suspend when you set package properties (see "Setting Package Properties" on page 43). Ports None Selected Whether to disable ports on the target Integration Servers that match ports you are trying to deploy. 28 webMethods Deployer User's Guide Version 8.0 3 Creating a Project Asset Scheduled Tasks Description Click... Whether to prevent scheduled tasks on the target Integration Servers that match scheduled tasks you are trying to deploy from running. Note: Tasks that are already running at deployment time are not affected by deployment. Adapters Do not suspend adapter listeners or polling notifications. Suspend individual adapter listeners and polling notifications. You choose the notifications to suspend when you set package properties (see "Setting Package Properties" on page 43). None Selected 2 In the Overwrite Existing area on the Settings page, indicate how Deployer should proceed when it finds that assets you are trying to deploy already exist on target Integration Servers. For this option... TN Rules Indicate whether Deployer should... Replace the entire rule list. Overwrite existing rules and deploy new rules into the rule set. 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. Overwrite existing assets. This option applies to all assets except the following: Trading Networks processing rules (see the previous step). Integration Server ACL maps (see ACL Maps, above). Integration Server packages. You specify the overwrite option for Integration Server packages on a packagebypackage basis, as described in "Setting Package Properties" on page 43. Note: Before you deploy a project, you can find out which assets Deployer will overwrite by generating the simulation report. Click Replace All Merge Other NonPackage Assets webMethods Deployer User's Guide Version 8.0 29 3 Creating a Project 3 In the Activate After Deployment area on the Settings page, indicate whether Deployer should activate newly deployed ports and scheduled tasks on the target Integration Servers. Activate After Deployment is used only if Suspend During Deployment is set to Yes. Note: If you choose to activate ports, and one of the ports you deploy uses the same port number as an existing port on a target Integration Server, Deployer will display a message to that effect and will not activate the port. 4 Click Save. Creating a Project You can create a project by creating a new, blank project or by copying an existing project and modifying it. To create a project 1 2 Go to the Deployer > Projects page. Create a project using one of these methods: Create... New Steps 1 2 Click Create Project. In the Name box, type the name to use for the new project. The name can be up to 32 characters long and can include any characters that are valid for a file name in your operating system. In the Description box, type a description for the project. The description length has no limit and can include any characters. Click Create. Click Copy Project. In the Project to Copy box, click the project to copy. In the New Project Name box, type the name to use for the new project. The name can be up to 32 characters long and can include any characters that are valid for a file name in your operating system. Click Copy Project. 3 4 From existing 1 2 3 4 5 Review the default properties for projects in the righthand pane and override any if necessary, then click Save. For explanations of these properties, see "Setting Default Properties for All Projects" on page 27. For explanations of the general and IS & TN properties, see "Setting the Defaults for Integration Server and Trading Networks Projects" on page 28. 30 webMethods Deployer User's Guide Version 8.0 3 Creating a Project If the project is for Optimize, you can set the Include Dimension Values property for the project under the Optimize Options area to indicate whether Deployer should include the values for dimensions you add to deployment sets (for example, Customer Names or Product Types). If the project is for process models, you can set the properties below for the project under the ProcessModel Deployment Options area. For more information about process models, see the webMethods Monitor User's Guide. For this property... Enable process for execution Indicate whether Deployer should... Enable webMethodsexecuted business process versions for execution after deployment. When a process version is enabled, the Process Engine uses the enabled version when starting new process instances. When a process is disabled, the Process Engine does not use the process version for new process instances. Only one version of a process can be enabled at a time. If there are no enabled process versions, the Process Engine will not start any process instances of the process. Enable process for analysis Enable webMethodsexecuted processes for analysis after deployment. When a process is enabled, the Process Engine forwards all process instance activity to the Optimize Analytic Engines. When a process is disabled, no activity is forwarded. If the project is for My webMethods Server, you can set these properties for the project under the MWS Deployment Options area: For this property... Export Subscriptions Export Access Control Lists Export Principal Attributes Export Content As Reference Alias Prefix Export Version History Indicate whether Deployer should... Deploy subscriptions for My webMethods Server assets you are deploying. Deploy ACLs for My webMethods Server assets you are deploying. Include attributes contained in attributes providers when exporting users, groups, and roles. Export a reference to the page content without deploying the content. Apply the specified prefix to every automatically generated My webMethods Server alias. Include all versions of an asset in Portal version control. This applies to the content within a page or folder. webMethods Deployer User's Guide Version 8.0 31 3 Creating a Project For this property... Auto Generate Aliases Indicate whether Deployer should... Automatically generate an alias on the target My webMethods Server for every My webMethods Server asset that is deployed. If an asset already has one or more aliases, then the aliases are retained when the autogenerated alias is added. Deploy content referenced by portal pages and folders you are deploying (for example, a PDF document that has been published on a portal page you are deploying). Export Content (Documents) 6 Click Save. Exporting and Importing a Project's Properties To export and import a project's properties 1 Export a project's properties as follows: a b c In Deployer, go to the Deployer > Projects page. In the Name column, click the project from which to export. In the righthand pane, click Export Project properties. Deployer creates a file that contains the project property settings. The file is named project_properties and is stored in the Integration Server_directory\packages\WmDeployer\replicate\ outbound directory. Deployer also gives you the option to save the file to your local file system. 2 Import a project's properties into another project as follows: a Copy the project_properties file to the Integration Server_directory\packages\ WmDeployer\replicate\inbound directory on the machine that hosts the project into which to import. In Deployer, go to the Deployer > Projects page. In the Name column, click the project into which to import. In the righthand pane, click Import Project properties, then select the project_properties file you just copied to the inbound directory. a b c 32 webMethods Deployer User's Guide Version 8.0 3 Creating a Project Authorizing Groups to Perform Tasks on a Project You authorize users to perform tasks by selecting a task and assigning Integration Server security groups or My webMethods Server central user management groups to it. When Deployer users display the Projects page, they will see only those Deployer projects to which they are authorized. Users must have Developer ACL authorization to perform tasks in Deployer. You can also create intuitively named Integration Server security groups for use with Deployer (for example, you could create groups named viewDeployerProjects, buildDeployerProjects, mapDeployerProjects, deployDeployerProjects, and defineDeployerProjects). To define, export, or import deployment or deletion sets, users must have Define ACL authorization. To deploy deployment or deletion sets (that is, to actually deploy assets to or delete assets from target servers), users must have Deploy ACL authorization. For instructions on creating security groups and assigning users to them, see the webMethods Integration Server Administrator's Guide. For information on My webMethods Server central user management groups, see the My webMethods Server Administrator's Guide. You must have Administrator ACL authorization to create projects and authorize other users to perform tasks in Deployer. To authorize groups to perform tasks 1 2 In Deployer, go to the Deployer > Projects page. Locate the project to which to authorize groups. If locking is enabled, in the Lock Status column for the project, click to lock the project. In the Authorize column for the project, click . In the Groups, click the type of group to authorize. In the Select Authorization list, click a task to which to authorize the groups. The Not Specified box lists all groups defined in the type of group you chose. Using the arrow buttons, move each group you want to assign to the specified task into the Allowed box. Move each group that you do not want to assign to the specified task into the Denied box. 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). In the Lock Status column for the project, click to unlock the project. 3 4 5 6 7 webMethods Deployer User's Guide Version 8.0 33 3 Creating a Project Adding and Viewing Instructions or Notes About a Project When you create a project, Deployer automatically creates an HTML home page for the project. The HTML home page for a project is located in the Integration Server_directory\ packages\WmDeployer\pub\projects\project directory. The file name for the home page is project.html. Modify the page as necessary, but do not move it from this directory or rename it. To view the home page for the project, go to the Deployer > Projects page and click the Home column for the project. in 34 webMethods Deployer User's Guide Version 8.0 4 Defining a Deployment Set 36 37 37 38 47 49 50 Creating a Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Identifying Source Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Assets to a Broker, ProcessModel, MWS, or Optimize Deployment Set . . . . . . . . . . . . . Adding Assets to an IS & TN Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Resolving Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Manually Adding Dependencies on a Package Component in an IS & TN Deployment Set . . . . Removing Process Models from a Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . webMethods Deployer User's Guide Version 8.0 35 4 Defining a Deployment Set Creating a Deployment Set To create a deployment set 1 2 3 4 5 6 In Deployer, go to the Deployer > Projects page. If locking is enabled, in the Lock Status column for the project, click project. In the Name column, click the project. In the righthand pane, click Click Create Set. Make a selection in the Type list, and then complete these fields: Box Name Entry Name to use for the deployment set. The name can be up to 32 characters long and can include any characters that are valid for a file name in your operating system. Description for the deployment set. The description length has no limit and can include any characters. After you choose the source servers, Deployer will display all packages on the servers. You can use this field to narrow the display. Type a regular expression that specifies the text that the package names must contain in order to be listed. After you choose the source servers, Deployer will display all assets on those servers. You can use this field to narrow the display. Specify a regular expression that specifies the text that the asset names must contain in order to be listed. Define. to lock the Description Packages (IS & TN, ProcessModel, or Optimize deployment set) All other Assets 7 8 In the Set field, click Deployment. Click Create. 36 webMethods Deployer User's Guide Version 8.0 4 Defining a Deployment Set Identifying Source Servers To identify source servers 1 2 On the Deployer > Projects > project > Define page, in the lefthand pane in the Name column, click the deployment set for which to identify source servers. In the Select column, select the check box next to each source server that contains assets to add to the deployment set. Note: If a server you want to use as a source does not appear in the list, you have not yet set it up to work with Deployer. For instructions, see Chapter 2, "Starting Deployer and Connecting to Servers". Then click Refresh this Page to update the list of servers on this page. 3 Click Save. Adding Assets to a Broker, ProcessModel, MWS, or Optimize Deployment Set If you are creating an MWS deployment set, the set you create should depend on the number of assets you want to deploy. The Root folder aliases field in the MWS Server configuration (see "Set Up Connections to My webMethods Servers" on page 21) controls the Page assets that are displayed for each My webMethods Server. By default, this field is set to folder.public. However, if your Public Folders and its subfolders contain hundreds of pages, displaying these assets can take a long time. In addition, Deployer cannot display more than 2500 assets at once. To avoid problems, Software AG recommends displaying smaller sets of assets and creating smaller deployment sets. To do so, change the Root folder aliases field to specify a folder that is deeper within the Public Folders hierarchy and then create the deployment set for those assets. Change the field again to specify another folder and create another deployment set, and so on. Important! You can only deploy usercreated assets using Deployer. You cannot deploy system components that were installed by the webMethods Installer as part of a product installation. For example, you can deploy My webMethods Server components that were created by users in Designer, but you cannot deploy My webMethods Server system components that were installed, such as the Task Engine. If you want such components on target servers, you must install them using the webMethods Installer. webMethods Deployer User's Guide Version 8.0 37 4 Defining a Deployment Set To add assets to a Broker, ProcessModel, MWS, or Optimize deployment set 1 In the Deployment Sets area, under the deployment set to which to add assets, click the Broker, ProcessModel, MWS, or Optimize folder. In the righthand pane, Deployer lists the source servers of the type you selected. In the righthand pane, open the tree to show the assets on the source servers, then select the check box next to each asset to add to the deployment set. Keep in mind the following: For... Broker Note Do not add any client groups with a queue type of persistent and a lifecycle set to explicit destroy. Deployer cannot deploy such client groups. The process models displayed are those that were Built for execution on the Integration Server. The My webMethods Server folder is listed twice within its directory, as a container preceded by and as an asset preceded by . If you want to add a folder with all the assets it contains to the deployment set, select the folder where it appears next to the square icon. If you want to add individual assets in the folder without adding the folder itself, open the folder where it appears as a container and click the assets to add. 2 ProcessModel MWS 3 Click Save. Deployer shows the selected assets in the lefthand pane under the Broker, ProcessModel, MWS, or Optimize folder for the deployment set. Adding Assets to an IS & TN Deployment Set The sections below explain how to add these types of usercreated assets to an IS & TN deployment set: Integration Server administrative assets such as ports, users, groups, and scheduled tasks, packages, and Web Service Descriptors. Integration Server packages. webMethods files. Trading Networks assets. 38 webMethods Deployer User's Guide Version 8.0 4 Defining a Deployment Set Important! You can only deploy usercreated assets using Deployer. You cannot deploy system components that were installed by the webMethods Installer as part of a product installation. For example, you can deploy Integration Server packages that were created by users, but you cannot deploy Integration Server system packages that were installed, such as the WmPRT package (Process Engine). If you want such components on target servers, you must install them using the webMethods Installer. Your source and target Integration Servers might have assets in common, and you therefore do not need to deploy them from one environment to another. You can improve Deployer performance by excluding these assets from deployment sets. For instructions, see "Excluding Common Assets" on page 47. Deploying ACLs If you want to deploy ACLs, you must perform extra steps in some cases, as follows: If you want to deploy ACLs that are associated with My webMethods Server groups, you must first use an MWS deployment set to deploy the My webMethods Server groups to the target Integration Servers. Then create an IS & TN deployment set containing the ACLs, mark the unresolved dependencies for the My webMethods Server groups as Exists, and deploy the ACLs. If you want to deploy ACLs that are associated with LDAP groups, you must first configure the LDAP groups on the target Integration Servers. Then create an IS & TN deployment set containing the ACLs, mark the unresolved dependencies for the LDAP groups as Exists, and deploy the ACLs. Adding Integration Server Administration Assets To add Integration Server administration assets 1 In the Deployment Sets area, under the deployment set to which to add Integration Server administration assets, click the Administration folder. In the righthand pane, Deployer lists the source Integration Servers you identified. In the righthand pane, open the tree to show the administration assets on the source Integration Servers, select the check box next to each asset to add to the deployment set, and then click Save. Deployer shows the selected assets in the lefthand pane under the Administration folder for the deployment set. If you are not going to add any more assets to the deployment set, go to "Resolving Dependencies" on page 47. If you added JMS triggers to the deployment set, create the same JMS connection aliases on the target Integration Servers that exist on the source Integration Servers. For instructions, see the webMethods Integration Server JMS Client Developer's Guide. 2 3 4 webMethods Deployer User's Guide Version 8.0 39 4 Defining a Deployment Set Important! If the JMS connection aliases on the target Integration Servers do not have the same names as on the source Integration Servers, the JMS triggers will not be enabled after deployment. Adding Integration Server Packages You can add an Integration Server package to a deployment set as follows: Add a package in its entirety. Add selected package components only (partial package). Add selected package files only (partial package). If you add a partial package of only selected files to a deployment set and the package already exists on target Integration Servers, you can have Deployer delete specified files from the existing package on the target Integration Servers after deployment. You might use this feature if the existing package contains a service that has been superseded; you would deploy the files that make up the new service and delete the files that make up the old service. Adding an Entire Package To add an entire package 1 In the Deployment Sets area, under the deployment set to which to add packages, click the Packages folder. In the righthand pane, Deployer lists all source Integration Servers. In the righthand pane, open the tree to show the packages on the source Integration Servers, select the check boxes next to the packages to add in their entirety, and then click Save. Deployer shows the entire package icon ( ) for the selected packages in the lefthand pane under the Packages folder and in the righthand pane, and a black check mark for the packages in the righthand pane. If you are done adding packages to the deployment set, go to "Setting Package Properties" on page 43. 2 3 Adding Package Components If you choose to add both package components and package files to a deployment set, you must be aware of the following: If you first select components, and then select files, Deployer only allows you to add files from the package file list. If you first select files, and then select components, Deployer might overwrite certain file selections to ensure consistency. 40 webMethods Deployer User's Guide Version 8.0 4 Defining a Deployment Set To add package components 1 In the Deployment Sets area, under the deployment set to which to add package components, click the Packages folder. In the righthand pane, Deployer lists all source Integration Servers. In the righthand pane, open the tree to show the packages on the source Integration Servers, and then click the name of a package that contains components to add to the deployment set. In the Select Components area, open the tree to show the components in the package, select the check box next to each component to add to the deployment set, and then click Save. Click Return to Packages. Deployer shows the partial package icon ( ) for the package in the lefthand pane under the Packages folder and in the righthand pane, and a gray check mark for the package in the righthand pane. Note: If you later decide to include the entire package (as opposed to selected components only), cancel the selection of the components by clicking the name of the partial package, clearing all checked boxes, and clicking Save. Then save the deployment set and select the entire package as explained in "Adding an Entire Package" on page 40. 5 If you are done adding packages to the deployment set, go to "Setting Package Properties" on page 43. 2 3 4 Adding Package Files Important! Use caution if you choose to add both package components and package files to a deployment set, for these reasons: If you first select files, and then select components, Deployer might overwrite certain file selections to ensure consistency. If you first select components, and then select files, Deployer only allows you to add files from the package file list. To add package files 1 In the Deployment Sets area, under the deployment set to which to add package files, click the Packages folder. In the righthand pane, Deployer lists all source Integration Servers. In the righthand pane, open the tree to show the packages on the source Integration Servers, then click the name of a package that contains files to add to the deployment set. 2 webMethods Deployer User's Guide Version 8.0 41 4 Defining a Deployment Set 3 Click Select Files. Deployer lists all files in the package. Do one of the following: To add... All the files in the list Only files you select in the list Do this... Click All files. Click Selected Files, then press the CTRL key and click each file to include in the deployment set. Note: The Select Files option is a link near the top of the righthand pane. Only files other than those you select in the list All files in the list whose name contains a specified string All files in the list whose name does not contain a specified string Click All except selected files, then press the CTRL key and click each file to exclude from the deployment set. Click Files specified by filter, then type the string on which to match the files to include in the deployment set. You can use an asterisk (*) as a wild card (for example, *.java or *.class). Click All except files specified by filter, then type the string on which to match the files to exclude from the deployment set. You can use an asterisk (*) as a wild card (for example, *.java or *.class). 4 If a package of the same name as this partial package already exists on one of the deployment set's target Integration Servers, and the existing package contains files to delete after deployment, type the fully qualified names of the files to delete in the Files to Delete from Target box. Type each file name on its own line, and end each line with a semicolon (;). For example: code/classes/wm/administratorResource/admin.class; code/classes/wm/administratorResource/user.class; ns/wm/administratorResource/ 5 6 Click Save. Click Return to Packages. Deployer shows the partial package icon ( ) for the package in the lefthand pane under the Packages folder and in the righthand pane, and a gray check mark for the package in the righthand pane. Note: If you later decide to include the entire package (as opposed to selected files only), cancel the selection of the files by navigating to the file selection page and clicking None, then save the deployment set, and then select the entire package as explained in "Adding an Entire Package" on page 40. 7 If you are done adding packages to the deployment set, go to "Setting Package Properties" on page 43. 42 webMethods Deployer User's Guide Version 8.0 4 Defining a Deployment Set Setting Package Properties You must set properties for each package you added to the deployment set. To set properties for a package 1 2 In the Deployment Sets area, under the deployment set to which you added entire or partial packages, open the tree under the Packages folder and click a package. In the package_name Properties area, specify the properties listed below. Property Package Type Entry Use this property when the source package already exists on the target Integration Servers. You can use the options below for entire packages and for partial packages. If you want Deployer to... Deploy the source package, replacing the existing package entirely. When you choose to deploy an entire package, this is the default. Deploy the components and files in the source package over the corresponding components and files in the existing package. When you choose to deploy package components, package files, or both, this is the default. Click... Full Patch Note: Before you deploy a project, you can find out which assets Deployer will overwrite by generating the simulation report. Version Supply the version number to use for the source package in comparisons with existing packages on target Integration Servers. Whether Deployer actually deploys the package depends on the version numbers of the source package and the existing package. If the source package's version number is the same or higher than the existing package's version number, Deployer deploys. If the source package's version number is lower than the existing package's version number, Deployer does not deploy. Note: The version number for the source package on the source Integration Server is not affected by your entry here. Build Supply the build number to assign to the deployed package on the target Integration Servers. Specify a build number only if you selected Full for Package Type. webMethods Deployer User's Guide Version 8.0 43 4 Defining a Deployment Set Property Patches Included Entry Supply the list of patches that have been applied to the deployed package on the target Integration Servers. Specify the patch numbers, separated by commas (for example, 44, 45, 55). Specify patches only if you selected Full for Package Type. Supply a description to use for the deployed package on the target Integration Servers (for example, "December 2003 release with patches to correct Order Process problem.") Specify a description only if you selected Full for Package Type. Brief Description 3 In the Recommendations for Target area, you can recommend the minimum version of Integration Server and Java Virtual Machine (JVM) to run the source package. If the JVM version on the target Integration Server is lower than you specify here, Deployer will deploy the source package but will not activate it, regardless of the setting of the Activate After Deployment option, and the target Integration Server will display a warning about the JVM version. The defaults shown in this area reflect the Integration Server and JVM that host the source package. In the Package Build Options area, indicate whether Deployer should use the package version and build numbers that exist in the source Integration Server each time the user creates a build instead of the package version and build numbers specified in the package_name Properties area. In the Package Deployment Options area, specify the following: Option Activate After Deployment Entry How Deployer should deploy the package. If you want Deployer to deploy the package to the Integration Server_directory\replicate\ inbound directory on the target Integration Servers, and then do the following: Action Enable the package. Install the package but do not enable it. Do not install or enable the package. Click Activate Install Only Inbound Only 4 5 44 webMethods Deployer User's Guide Version 8.0 4 Defining a Deployment Set Option Sync Document Types Entry Whether Deployer should synchronize the publishable IS document types in the source package with documents types on the Brokers that are connected to the target Integration Servers. Note: The connected Brokers must be available at deployment time for synchronization to occur. If a connected Broker is not available, IS document types are not synchronized for the Integration Server to which the Broker is connected. Deployer writes a message to that effect to the deployment report. Deployer can detect Broker unavailability when you generate the simulation report and will write a message advising you of the problem to the report. Action Synchronize all publishable IS document types in the package that are new to the target Integration Servers. Do not synchronize IS document types in the package that already exist on the target Integration Servers, even if they have been modified. Synchronize all publishable IS document types in the package. Do not synchronize any IS document types. Click New All None 6 If you indicated in the project properties that you want Deployer to suspend individual triggers during deployment, click Suspend Triggers, select the check box next to each trigger to suspend, click Suspend, and then return to the previous page. If you indicated in the project properties that you want Deployer to suspend individual adapter notifications during deployment, click Suspend Notifications, select the check box next to each notification to suspend, click Suspend, and then return to the previous page. Important! If you suspend a particular adapter notification but the notification does not exist on a target Integration Server, you will not be able to deploy. You can only suspend notifications that already exist on all target Integration Servers. 7 8 9 Click Save. Repeat these steps for each package in the deployment set. 10 If you are not going to add any more assets to the deployment set, go to "Resolving Dependencies" on page 47. webMethods Deployer User's Guide Version 8.0 45 4 Defining a Deployment Set Adding webMethods Files When Deployer deploys a webMethods file, the file retains the read/write permissions it had on the source server. To add webMethods files 1 In the Deployment Sets area, under the deployment set to which to add webMethods files, click the webMethods Files folder. In the righthand pane, Deployer lists the source Integration Servers you identified. In the righthand pane, open the tree to show the webMethods installation directory and its contents on the source Integration Servers. Select the check box next to each file to add to the deployment set. Click Save. Deployer shows the selected assets in the lefthand pane under the webMethods Files folder for the deployment set. If you are not going to add any more assets to the deployment set, go to "Resolving Dependencies" on page 47. 2 3 4 Adding Trading Networks Assets Note: Your source and target Integration Servers might have assets in common, and you therefore do not need to deploy them from one environment to another. You can improve Deployer performance by excluding these assets from deployment sets. For instructions, see "Excluding Common Assets" on page 47. To add Trading Networks assets 1 In the Deployment Sets area, under the deployment set to which to add Trading Networks assets, click the Trading Networks folder. In the righthand pane, Deployer lists the source Integration Servers you identified. In the righthand pane, open the tree to show the Trading Networks assets on the source Integration Servers, then select the check box next to each asset to add to the deployment set. Important! If you add a TN document type that is set up in Trading Networks for duplicate checking using custom services, Deployer does not detect the dependency on the service. If the service does not already exist on the target Integration Servers, you must add the service to the deployment set. If you do not, Deployer will log an error to the deployment report and will not deploy the TN document type. 2 46 webMethods Deployer User's Guide Version 8.0 4 Defining a Deployment Set 3 4 Click Save. Deployer shows the selected assets in the lefthand pane under the Trading Networks folder for the deployment set. If you are not going to add any more assets to the deployment set, go to "Resolving Dependencies" on page 47. Excluding Common Assets Your source and target Integration Servers might have assets in common, and therefore you do not need to deploy them from one environment to another. For example, you might have created certain packages that exist on all your source and target Integration Servers. Deployer lets you identify these common assets so they will not appear in the asset list when you define deployment sets or as referenced assets when you resolve dependencies (see "Resolving Dependencies", below). The assets you specify on this list will be excluded for all IS & TN deployment sets in all projects. Excluding these common assets improves Deployer performance by reducing the amount of processing needed to produce the asset and dependencies lists, and by preventing you from deploying unnecessary assets. You identify the common assets in a file named common.cnf in the Integration Server_directory\WmDeployer\conf directory. By default, the file is prepopulated with the names of Integration Server packages you should never deploy to other Integration Servers using Deployer, but rather should only install on other Integration Servers using the webMethods Installer. The file also includes instructions, lists the asset types you can exclude, and shows examples. List the assets you want to exclude next to the appropriate asset types. Resolving Dependencies Deployer can determine when assets that are in a deployment set require other assets that are not in the deployment set. The assets that require other assets are called dependent assets, while the assets that are required are called referenced assets. Deployer identifies missing referenced assets as unresolved dependencies. Deployment Set Broker Example of Unresolved Dependencies If you add a client group but not the documents to which the client group can publish or subscribe, the documents are unresolved dependencies. If you add a trigger but not the service that is invoked by the trigger, the service is an unresolved dependency. If you add a page but not the portlets that are referenced by the page, the portlets are unresolved dependencies. IS & TN MWS webMethods Deployer User's Guide Version 8.0 47 4 Defining a Deployment Set Deployment Set Optimize ProcessModel Example of Unresolved Dependencies If you add a rule but not the dimensions used by the rule, the dimen sions are unresolved dependencies. If you add a process model but not the flow services called by the process model, the flow services are unresolved dependencies. In the project properties ("Setting the Dependency Checking Default" on page 27), you indicated how you want to check dependencies in the deployment sets. When Deployer automatically checks dependencies and finds unresolved dependencies in a deployment set, it shows in the Unresolved Dependencies column for the deployment set; when there are no unresolved dependencies, Deployer shows in the column. When you can check dependencies manually, Deployer shows in the Unresolved Dependencies column for each deployment set; click Check next to the . If necessary, you can later "unresolve" or remove a dependency you have resolved and resolve it again a different way. To resolve dependencies: 1 In the Unresolved Dependencies column for the deployment set, click Check. Deployer shows all unresolved dependencies on the Unresolved Dependencies page. The Referenced Assets column lists the missing referenced assets. The next column offers the possible ways you can resolve the unresolved dependency. The Asset column shows the dependent assets. Tell Deployer how to resolve each unresolved dependency as described below. If you want to resolve all assets in a folder the same way, you can set the resolution at the folder level rather than at the level of the individual assets. Option Add Description If the referenced asset does not exist on the target servers and you want to deploy the referenced asset to them, use this option. Deployer adds the referenced asset to the deployment set. If you believe the referenced asset already exists on the target servers and you want to continue working, but you want Deployer to make sure the asset does in fact exist later, use this option. Deployer will check for the referenced asset when you map the project to target servers. If Deployer does not find the asset, an icon alerts you during the mapping task. If you do not address the problem during the mapping task, Deployer will write a message about the problem to the simulation report. If you deploy without addressing the problem, Deployer will not deploy the deployment set. 2 Exists 48 webMethods Deployer User's Guide Version 8.0 4 Defining a Deployment Set Option Ignore Description If you want to bypass dependency checking for the referenced asset at this time so you can continue working, use this option. You might use this option if the referenced asset is missing on the source server. Missing referenced assets are marked with a question mark (?) on the Unresolved Dependencies page. Before deploying, make sure either that the referenced asset exists on the target server or that the referenced asset is unnecessary. If the referenced asset does not exist on the target server, Deployer might not be able to deploy correctly; if it can deploy, the deployed assets will not run correctly. Deployer will list ignored assets in the simulation report and in the deployment report. Unset 3 4 If you have set the assets in a folder to various settings and want to start over, use this option. Click Save. Deployer moves dependencies you resolved using the Exists or Ignore option to the Resolved Dependencies page. To see the resolved dependencies, click Resolved Dependencies. You can unresolve a resolved dependency and reresolve it differently. To unresolve a dependency, go to the Resolved Dependencies page, select the check box in the Delete column for the resolved dependency, and click Delete. Deployer returns the dependency to the Unresolved Dependencies page. Go to that page and reresolve the dependency. Manually Adding Dependencies on a Package Component in an IS & TN Deployment Set Deployer cannot always detect all dependencies. If you are aware that an asset in an IS & TN deployment set has a dependency on a package component, and Deployer has not detected this dependency, you can manually add that dependency. For example, when you add Trading Networks Profile objects to the deployment set, Deployer does not generate dependencies for Profile Groups that are referenced by the Profile objects. You must manually add the Profile Groups to the deployment set. Deployer will check for the referenced asset when you map the project to target Integration Servers, as it does when you use the Exists option to resolve an unresolved dependency. If Deployer does not find the asset, an icon alerts you during the mapping task. If you do not resolve the dependency at that time, Deployer will write a message about it to the simulation report and, if you do not resolve it at that time, to the deployment report. webMethods Deployer User's Guide Version 8.0 49 4 Defining a Deployment Set To manually add a dependency on a package component 1 2 3 4 Go to the Resolved Dependencies page as explained in the previous section. Under the Manually Add Dependency area, in the Referenced Package box, type the name of the package that contains the referenced component. In the Referenced Component box, type the name of the referenced component. Click Add. You can remove a dependency you added manually. To do so, return to the Projects > project > Define page, open the folder that contains the asset, navigate to the asset in the tree in the righthand pane, cancel the selection of the asset by clearing the appropriate check box, and save the deployment set. Removing Process Models from a Deployment Set When you add a process model to a ProcessModel deployment set and then add referenced assets that reside on the logical servers, Deployer shows the referenced assets as children of the process model. If you want to remove a process model from a deployment set, clear the check box next to the process model under the tree. This removes the process model from the deployment set; however, the dependencies must be removed manually. 50 webMethods Deployer User's Guide Version 8.0 5 Defining a Deletion Set 52 53 53 55 Creating a Deletion Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Identifying Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Assets to a Deletion Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting and Importing Deletion Set Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . webMethods Deployer User's Guide Version 8.0 51 5 Defining a Deletion Set Creating a Deletion Set To create a deletion set 1 2 3 4 5 6 In Deployer, go to the Deployer > Projects page. If locking is enabled, in the Lock Status column for the project, click project. In the Name column, click the project. In the righthand pane, click Click Create Set. Make a selection in the Type list, and then complete these fields: Box Name Entry Name to use for the deletion set. The name can be up to 32 characters long and can include any characters that are valid for a file name in your operating system. Description for the deletion set. The description length has no limit and can include any characters. After you choose the servers from which to define deletion sets, Deployer will display all packages on the servers. You can use this field to narrow the display. Type a regular expression that specifies the text that the package names must contain in order to be listed. After you choose the servers from which to define deletion sets, Deployer will display all assets on those servers. You can use this field to narrow the display. Specify a regular expression that specifies the text that the asset names must contain in order to be listed. Define. to lock the Description Packages (IS & TN deletion set) All other Assets Important! Deployer can display up to 10,000 assets. If the source server hosts more than 10,000 assets, use the Packages and All other Assets fields to reduce the number of assets to be displayed. 7 8 In the Set field, click Deletion. Click Create. 52 webMethods Deployer User's Guide Version 8.0 5 Defining a Deletion Set Identifying Servers To identify servers 1 2 On the Deployer > Projects > project > Define page, in the lefthand pane in the Name column, click the deletion set for which to identify servers. In the Select column, select the check box next to each server that contains assets to add to the deletion set. Note: If a server you want to use does not appear in the list, you have not yet set it up to work with Deployer. For instructions, see Chapter 2, "Starting Deployer and Connecting to Servers". Then click Refresh this Page to update the list of servers on this page. 3 Click Save. Adding Assets to a Deletion Set You can choose assets to add to a deletion set from any server that is similar to the target server from which you want to actually delete the assets. Note: For Trading Networks, you cannot delete document attributes, field definitions, binary types, or profile security data. Important! When you map a deletion set to target servers, Deployer identifies assets that depend on the assets you want to delete and lets you resolve those dependencies (see "Mapping a Project to Target Servers" on page 60). However, Deployer can only detect dependencies among assets from the same type of product (for example, among Integration Servers); it cannot detect dependencies among assets from different products (for example, among Integration Servers and ProcessModel Servers). Make sure that assets you want to delete for one type of product are not required by assets of other types of product. To add assets to a deletion set 1 In the Deletion Sets area, under the deletion set to which to add assets, click a folder that contains assets you want to add to the deletion set. In the righthand pane, Deployer lists the servers you identified in "Identifying Servers", above. Note: For the Packages folder, use the instructions in step 3, below. webMethods Deployer User's Guide Version 8.0 53 5 Defining a Deletion Set 2 In the righthand pane, open the tree to show the assets on the servers, select the check box next to each asset to add to the deletion set, and then click Save. Deployer shows the selected assets in the lefthand pane under the folder you clicked in the previous step. If you are creating an IS & TN deletion set, you can add Integration Server packages in their entirety, or you can add selected package components only (partial packages). a In the Deletion Sets area, under the deletion set to which to add entire packages or package components, click the Packages folder. In the righthand pane, Deployer lists all the Integration Server you identified in "Identifying Servers", above. In the righthand pane, open the tree to show the packages on the Integration Servers, then do one of the following: To add... Entire packages Do this... Select the check boxes next to the packages to add in their entirety to the deletion set and click Save. Deployer shows the entire package icon ( ) for the selected packages in the left hand pane under the Packages folder and in the righthand pane, and a black check mark for the packages in the righthand pane. 1 2 Click the package name. In the Select Components area, open the tree to show the package components, then select the check box next to each component to add to the deletion set. Click Save. Click Return to Packages. Deployer shows the partial package icon ( ) for the package in the lefthand pane under the Packages folder and in the righthand pane, and a gray check mark for the package in the righthand pane. Note: If you add a partial package and later want to include the entire package instead, cancel the selection of the components by clicking the name of the partial package, clearing all checked boxes, and clicking Save. Then save the deletion set and add the entire package as explained above. 3 b Package components 3 4 54 webMethods Deployer User's Guide Version 8.0 5 Defining a Deletion Set Exporting and Importing Deletion Set Definitions To export and import deletion set definitions 1 Export deletion set definitions from a project as follows: a b c d In Deployer, go to the Deployer > Projects page. In the Name column, click the project from which to export. In the righthand pane, click Define. Click Export Deletion Set Definitions. Deployer creates a file that contains the definitions. The file is named project_deleteSets.xml and is stored in the Integration Server_directory\packages\WmDeployer\replicate\outbound directory. Deployer also gives you the option to save the file to your local file system. 2 Import deletion set definitions into a project as follows: a a b c d Copy the project_deleteSets.xml file to the Integration Server_directory\packages\ WmDeployer\replicate\inbound directory on the machine that hosts the project. In Deployer, go to the Deployer > Projects page. In the Name column, click the project into which to import. In the righthand pane, click Define. Click Import Deletion Set Definitions, then select the project_deleteSets.xml file you just copied to the inbound directory. webMethods Deployer User's Guide Version 8.0 55 5 Defining a Deletion Set 56 webMethods Deployer User's Guide Version 8.0 6 Building, Mapping, and Deploying a Project Using the Deployer GUI 58 60 64 Building a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mapping a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deploying a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . webMethods Deployer User's Guide Version 8.0 57 6 Building, Mapping, and Deploying a Project Using the Deployer GUI Building a Project This section explains how to do the following: Create a build Rebuild a build List the builds for a project Export a build from one project and into another. Create a Build To create a build 1 2 3 4 In Deployer, go to the Deployer > Projects page. If locking is enabled, in the Lock Status column for the project, click project. In the Name column, click the project. Click Build. Deployer displays the Projects > project > Build page and lists all builds that exist for the selected project. Note: The Status column on the Projects > project > Build page indicates whether each project build is in sync with the current project definition. If the build and the current project definition are in sync, the column shows . If the project definition has changed since the build was created, the column shows . You can rebuild such a project if you want. For instructions, see "Rebuilding a Build" on page 59. 5 6 In the lefthand pane, click Create Build. In the Name box accept the default build name or replace it with a name that you choose. The name can be up to 32 characters long and can include any characters that are valid for a file name in your operating system. In the Description box, you can type a description for the build. The description can be of any length and can include any characters. Click Create. Important! If the project for which you are trying to create the build contains unresolved dependencies, you will receive a message to that effect and the build process will fail. For instructions on displaying and resolving unresolved dependencies, see "Resolving Dependencies" on page 47. to lock the 7 8 58 webMethods Deployer User's Guide Version 8.0 6 Building, Mapping, and Deploying a Project Using the Deployer GUI 9 Under Build Properties in the righthand pane, click in the Build Report column to display the build report. The build report lists the assets that were successfully included in the build, describes any errors that occurred during the build process, and informs you if the project contains unresolved dependencies. Rebuilding a Build The Status column on the Projects > project > Build page indicates whether each project build is in sync with the current project definition. If the build and the current project definition are in sync, the column shows . If the project definition has changed since the build was created, the column shows . If a project build is out of sync with the current project definition or contains assets that you know have changed on the source servers, and you want to recreate the build to bring it up to date, click in the Rebuild column for the build. Important! If the project for which you are trying to create the build contains unresolved dependencies, you will receive a message to that effect and the build process will fail. For instructions on displaying and resolving unresolved dependencies, see "Resolving Dependencies" on page 47. Exporting and Importing a Build To export and import a build 1 Export a build as follows: a b In the source Deployer, go to the Deployer > Projects > project > Build page. Locate the build to export and click in the build's Export column. Deployer creates a file that contains the build. The file is named project_build and is stored in the Integration Server_directory\packages\WmDeployer\replicate\outbound directory. Deployer also gives you the option to save the file to your local file system. 2 Import the build as follows: a Copy the project_build file to the Integration Server_directory\packages\ WmDeployer\replicate\inbound directory on the machine that hosts the target Deployer. In the target Deployer, go to the Tools > Import Build page. In the Project Build list, click the project_build file you just copied to the inbound directory. Click Import. b c d webMethods Deployer User's Guide Version 8.0 59 6 Building, Mapping, and Deploying a Project Using the Deployer GUI Mapping a Project This section explains how to do the following: Map a project to target servers. Export a deployment map from one project and import it into another. Specify configuration values to substitute for Integration Server assets. Export substitute configuration values from one deployment map and import them into another. Mapping a Project to Target Servers You can map a project to target servers by mapping to individual target servers, target groups, or both. Important! If you encounter unresolved dependencies during this step, resolve them using the instructions in "Resolving Dependencies" on page 47. To map a project to target servers 1 2 3 4 5 6 In Deployer, go to the Deployer > Projects page. If locking is enabled, in the Lock Status column for the project, click project. In the Name column, click the project. In the righthand pane, click Map. Deployer displays the Projects > project > Map page and lists all maps that exist for the selected project. In the lefthand pane, click Create Deployment Map. In the Name box, accept the default deployment map name or replace it with a name that you choose. The name can be up to 32 characters long and can include any characters that are valid for a file name in your operating system. In the Description box, type a description for the map. The description length has no limit and can include any characters. Click Create. to lock the 7 8 60 webMethods Deployer User's Guide Version 8.0 6 Building, Mapping, and Deploying a Project Using the Deployer GUI 9 Under the Deployment Map Topology area, in the Set Mapping column for a deployment set, map to the target servers to which to deploy the assets, as follows: To add a... Target group Do this... Click Add Target Group. Select the check box next to each target group to which to deploy the assets in the deployment set and then click Add. Individual Click Add Target Server. Select the check box next to each server to target which to deploy the assets in the deployment set, and then click Add. server Note: If a server you want to map to does not appear in the list, you have not yet set it up to work with Deployer. For instructions, see Chapter 2, "Starting Deployer and Connecting to Servers". Then click Refresh this Page to update the list of servers on this page. Important! When you deploy Trading Networks assets, Deployer updates the Trading Networks database with the deployed assets. If Trading Networks is installed on multiple Integration Servers, map deployment sets that contain Trading Networks assets to only one of the Integration Servers. Do not map to multiple Integration Servers or you will experience unpredictable results when you deploy. 10 Under the Deployment Map Topology area, in the Set Mapping column for a deletion set, follow the instructions in the previous step, but map to the target servers from which to delete the assets. The Important! note is also true for deletion sets. 11 When Deployer returns to the map > Properties page, the Deployment Map Topology area might show . For deployment sets, this icon appears in the Referenced Assets column and indicates that you resolved an unresolved dependency using the Exists option, but Deployer has found that the referenced asset does not exist on target servers. Click to see the missing referenced asset. You can then place the referenced asset on the target servers, or you can return to the project definition stage and reresolve the dependency in a different way (see "Resolving Dependencies" on page 47). For deletion sets, dependencies work in the opposite direction from deployment sets. Deployer finds all assets on the target servers that depend on assets in the deletion set. If you were to delete the assets in the deletion set from the target servers, the dependent assets would no longer work properly. On the map > Properties page, in the Deployment Map Topology area, therefore, the icon appears in the Dependent Assets column, and indicates that dependent assets exist. Click to see the dependent assets, then choose whether to Add the dependent assets to the deletion set or to Remove the assets they depend on from the deletion set. Important! Deployer cannot detect dependencies across products. Make sure assets you want to delete are not required by assets of other products. webMethods Deployer User's Guide Version 8.0 61 6 Building, Mapping, and Deploying a Project Using the Deployer GUI Important! If you do not address problems at this time, Deployer will write messages about them to the simulation report. If you deploy without addressing problems, Deployer will not deploy the assets identified in the deployment set or delete the assets identified in the deletion set. 12 If you resolved dependencies in the previous step, the contents of the deletion set have changed, and you must therefore rebuild the project (see "Rebuilding a Build" on page 59). If you exported the deletion set definition or the project build, you must also reexport the definition (see "Exporting and Importing Deletion Set Definitions" on page 55) and the build (see "Exporting and Importing a Build" on page 59). Exporting and Importing a Map To export and import a map 1 Export a map as follows: a b In the source Deployer, go to the Deployer > Projects > project > Map page. Locate the map to export and click in the map's Export column. Deployer creates a file that contains the deployment map. The file is named project_map.map and is stored in the Integration Server_directory\packages\ WmDeployer\replicate\outbound directory. Deployer also gives you the option to save the file to your local file system. 2 After you export a map, you can edit any of the attributes before importing it into the target environment. For example, you might want to map a deployment set to a new target server. For instructions, see "Editing a Deployment Map or Substitute Configuration Values" on page 87. Import the map as follows: a Copy the project_map.map file to the Integration Server_directory\packages\ WmDeployer\replicate\inbound directory on the machine that hosts the target Deployer. In the target Deployer, go to the Deployer > Projects > project > Map page. Click Import Map, then select the project_map.map file you just copied to the inbound directory. 3 b c 62 webMethods Deployer User's Guide Version 8.0 6 Building, Mapping, and Deploying a Project Using the Deployer GUI Substituting Configuration Values for Integration Server Assets Integration Server assets might be configured differently on the source server than on the target server. For example, a port that is associated with one package on the source server might be associated with a different package on the target server. You can have Deployer substitute different configuration values for Integration Server assets during deployment so the assets will run properly on the target Integration Servers. You can substitute configuration values by asset or by target server. Important! As mentioned above, a port might be associated with package A on the source server and package B on the target server. If package B does not yet exist on the target server, do not add package A as a dependency (see "Resolving Dependencies" on page 47) and then substitute package B. Doing so would cause Deployer to deploy the full package B, including all associated ports, and two instances of the port would exist on the target server. Instead, deploy package B first. Mark package A as existing on the target server (see "Resolving Dependencies" on page 47), and then substitute package B. To substitute configuration values by asset 1 2 Under the Deployment Map Properties area, click Configure Builds by Assets. Deployer lists assets that have configuration values in the lefthand pane. Substitute different configuration values for an asset as follows: a b c d In the lefthand pane, click the asset. Deployer displays the asset's configuration values as they exist on the source server. In the righthand pane, type the configuration values to substitute. In the bottom righthand pane, select the target servers and target groups on which to make the substitutions. Click Save Substitutions. To substitute configuration values by target server 1 2 3 Under the Deployment Map Properties area, click Configure Builds by Server. Deployer lists the target servers that are mapped to the deployment set. Select a target server. Deployer lists assets that have configuration values in the right hand pane. Substitute different configuration values for an asset as follows: a b c In the righthand pane, click the asset. Deployer displays the asset's configuration values as they exist on the source server. In the bottom righthand pane, type the configuration values to substitute. Click Save Substitutions. webMethods Deployer User's Guide Version 8.0 63 6 Building, Mapping, and Deploying a Project Using the Deployer GUI Exporting and Importing Substitute Configuration Values To export and import substitute configuration values 1 Export the substitute configuration values from a deployment map as follows: a b c In the source Deployer, go to the Deployer > Projects > project > Map page. Click the deployment map that contains the substitute configuration values to export. Deployer displays the deployment map properties in the righthand pane. Click Export Variable Substitution. Deployer creates a file that contains the substitute configuration values for the assets in the project. The file is named project_map.vs and is stored in the Integration Server_directory\packages\WmDeployer\ replicate\outbound directory. Deployer also gives you the option to save the file to your local file system. 2 Import the substitute configuration values into a deployment map as follows: a Copy the project_map.vs file to the Integration Server_directory\packages\ WmDeployer\replicate\inbound directory on the machine that hosts the target Deployer. In the target Deployer, go to the Projects > project > Map page. Click the deployment map into which to import the substitute configuration values. Deployer displays the deployment map properties in the righthand pane. Click Import Variable Substitution. Select the project_map.vs file you just copied to the inbound directory. b c d e Deploying a Project This section explains how to do the following: Generate a checkpoint Simulate deployment of a project Deploy a project Roll back the target servers Generating a Checkpoint You set up the checkpoint feature in the project properties (see "Setting General Deployment Defaults" on page 27). If you chose automatic checkpoint, Deployer automatically generates a checkpoint as the first step when you actually deploy a project. If you chose manual checkpoint, generate a checkpoint before you deploy. If you take multiple checkpoints for a deployment candidate, only the latest is retained. 64 webMethods Deployer User's Guide Version 8.0 6 Building, Mapping, and Deploying a Project Using the Deployer GUI The target servers must be available for the checkpoint generation to be successful. Note: If deployment sets in a project include deletion sets, Deployer ignores the project properties. Instead, Deployer automatically creates a checkpoint for the target servers; if a deployment fails on a target server, Deployer automatically rolls back the target server. To generate a checkpoint In the Deployment Candidates list, click in the Checkpoint column. The checkpoint report appears in the righthand pane in the Deployment History area. Click next to Checkpoint in the Report Type column to display the report. In the checkpoint report, the term EXTRACT is used for assets that exist on the target system and have been extracted to a backup. The term MISSING is used for assets that do not exist on the target system and will be deleted during a roll back. Simulating Deployment of a Project or Deploying a Project You can simulate a deployment before you actually deploy. A simulation report contains information such as the following: Assets that will be suspended during deployment. Assets that will be enabled after deployment. Changes that will occur on the target servers, such as the assets that will be added or overwritten, and configuration values that will be substituted for Integration Server assets. Messages about problems, such as unresolved dependencies. To simulate deployment of a project or deploy a project 1 If you chose to suspend triggers, ports, and scheduled tasks, but a service is triggered by one of these assets before Deployer suspends them, and the service is a long running service, Deployer might overwrite the service during deployment. Make sure longrunning services have completed. In Deployer, go to the Deployer > Projects page. If locking is enabled, in the Lock Status column for the project, click project. In the Name column, click the project. In the righthand pane, click Deploy. Deployer displays the Projects > project > Deploy page and lists all deployment candidates that exist for the selected project. In the lefthand pane, click Create Deployment Candidate. to lock the 2 3 4 5 6 webMethods Deployer User's Guide Version 8.0 65 6 Building, Mapping, and Deploying a Project Using the Deployer GUI 7 In the Name box, accept the default deployment candidate name or replace it with a name that you choose. The name can be up to 32 characters long and can include any characters that are valid for a file name in your operating system. In the Description box, type a description for the deployment candidate. The description length has no limit and can include any characters. 8 9 In the Project Build list, click the project build to deploy. In the Deployment Map list, click the deployment map that identifies the target servers to which to deploy the assets in the selected project build. Important! If the words Missing referenced assets appears next to the map name in the list, it means that you resolved an unresolved dependency using the Exists option, but Deployer found during the mapping task that the referenced asset in fact does not exist on the target server. You can place the referenced asset on the target servers, or you can return to the project definition stage and reresolve the dependency in a different way (see "Resolving Dependencies" on page 47). If you do not address the problem during the mapping task, Deployer will write a message about the problem to the simulation report. If you deploy without addressing the problem, Deployer will not deploy the deployment set. 10 Click Create. In the candidate list in the lefthand pane, if the selected build and the current project definition are in sync, the Status column shows . If the project definition has changed since the build was created, the column shows . You can rebuild the project build before proceeding. For instructions, see "Building a Project" on page 58. 11 If you want to simulate the deployment, in the Deployment Candidates list, click in the Simulate column. The simulation report appears in the righthand pane in the Deployment History area. Click next to Simulation in the Report Type column to display the report. Read the report and address all problems. Important! If you do not address all problems at this time, you will probably experience errors during the deployment. For instructions on resolving unresolved dependencies, see "Resolving Dependencies" on page 47. 12 To deploy the project, click in the Deploy column for the deployment candidate. Deployer does the following: If you chose automatic checkpointing or automatic rollback in the project properties, Deployer automatically generates a checkpoint at this time. If you chose manual checkpointing and no checkpoint exists, Deployer asks whether you want to deploy anyway. Important! If you deploy without a checkpoint, you will not be able to roll back the target servers. 66 webMethods Deployer User's Guide Version 8.0 6 Building, Mapping, and Deploying a Project Using the Deployer GUI If the project build contains deletion set definitions, Deployer deletes the specified assets from the target servers you identified in the selected deployment map. Deployer deploys the assets in the project build to the target servers. Creates a deployment report and lists the report in the Deployment History area. Click next to Deployment Report in the Report Type column to display the report. The report contains similar information to the simulation report, except that the events have actually occurred at this point. Post-Deployment Tasks If you deployed JMS triggers, do the following: a If the JMS alias connection for the deployed trigger does not exist on the target server, create the same JMS alias connections on the target Integration Servers that exist on the source Integration Servers. Then reload the packages that contain the triggers. Enable the JMS triggers. Configure the queue or topic for each JMS trigger on the message provider for the target Integration Servers. b c For instructions, see the webMethods Integration Server JMS Client Developer's Guide. If you deployed My webMethods Server rules, the order in which the deployed rules are resolved with the existing rules on the target servers might need modification. Review the rule order and modify as necessary. Rolling Back Target Servers Deployer automatically rolls back target servers in these cases: You set the Roll back on Error project setting to Automatic (see "Setting General Deployment Defaults" on page 27). If the deployment fails on a target server, Deployer automatically rolls back that target server. Deployment to a target group for which you chose Yes for the Roll Back All on Failure option failed (see "Creating Target Groups" on page 23). If deployment to any server in such a target group fails, Deployer automatically rolls back all servers in the target group. Deployment sets in the project include deletion sets. In this case, Deployer ignores the project properties described in "Setting General Deployment Defaults" on page 27. Instead, Deployer automatically created a checkpoint for the target servers before deployment, and if a deployment fails on a target server, Deployer automatically rolls back the target server. webMethods Deployer User's Guide Version 8.0 67 6 Building, Mapping, and Deploying a Project Using the Deployer GUI If you set the Roll back on Error project setting to Manual, and you did not deploy to a target group defined as a logical cluster, you can roll back target servers manually at any time after a deployment. In the Deployment Candidates list, click in the Roll Back column. The roll back report appears in the righthand pane in the Deployment History area. Click next to Roll Back in the Report Type column to display the report. If you rolled back an IS & TN deployment set, the following apply: If the Activate After Deployment option for a package was set to Inbound Only, the report will warn that the package is not present on the target Integration Servers. You can ignore this warning. If the deployment set included webMethods files, the directory structure for those files remains in the webMethods installation directory on the target servers. You can delete the directories manually. If you deployed Trading Networks document attributes, field definitions, binary types, or profile security data, Deployer does not roll them back. 68 webMethods Deployer User's Guide Version 8.0 7 Deploying to Clustered Integration Servers and ProcessModel Servers 70 70 70 71 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set Up Connections to Integration Servers in the Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Define the Target Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deploying Scheduled Tasks to a Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . webMethods Deployer User's Guide Version 8.0 69 7 Deploying to Clustered Integration Servers and ProcessModel Servers Overview Deployer can deploy all Integration Server assets to clustered Integration Servers except existing scheduled tasks. For instructions on deploying existing scheduled tasks, see "Deploying Scheduled Tasks to a Cluster" on page 71. Deployer can deploy Trading Networks assets to clustered Trading Networks Servers. Before deploying, make sure the tn.cluster.sync.remoteAliases property is set for each Trading Networks Server in the cluster. For instructions, see the webMethods Trading Networks Administrator's Guide. Deployer can deploy process models to clustered ProcessModel servers. Set Up Connections to Integration Servers in the Cluster To set up connections to the Integration Server in the cluster 1 2 Make sure all Integration Servers in the cluster are up and running. In the Integration Server Administrator for the Integration Server that hosts Deployer, define every Integration Server in the Integration Server cluster following as a remote server. For more information about remote servers, and instructions on defining them, see the webMethods Integration Server Administrator's Guide. In Deployer, install the WmDeployerResource package on each Integration Server in the Integration Server cluster. Go to the Servers > IS & TN page; the page lists all Integration Servers you defined as remote servers. In the Install column, select the check box next to each Integration Server. Click Install. 3 Define the Target Group 1 2 3 In Deployer, go to the Target Groups > IS & TN page or ProcessModel page. Click Configure IS & TN Target Groups. In the Group Name box, type the name to use for the target group. The name can be up to 32 characters long and can include any characters that are valid for a file name in your operating system. In the Description box, type a description for the target group. The description length has no limit and can include any characters. Click Configure. On the View Target Group pane, set Roll Back All on Failure to Yes. 4 5 6 70 webMethods Deployer User's Guide Version 8.0 7 Deploying to Clustered Integration Servers and ProcessModel Servers Important! All nodes in an Integration Server cluster must be identical or tasks will not run equally well on all Integration Servers in the cluster, causing errors and failures. 7 The Available Servers list shows the Integration Server cluster name as a toplevel node in the tree, and then all the Integration Servers in that cluster as child nodes under the cluster name. Select the Integration Server cluster name node, and then click Add. The entire Integration Server cluster tree moves to the Selected Servers list. Click Save. Note: If you did not define an Integration Server in the cluster as a remote server, that node will appear disabled in the tree, and you will not be able to select it, or deploy to it. If an Integration Server in the cluster is not up and running, that Integration Server will not appear in the tree at all. Make sure every Integration Server in the cluster has a remote server alias and is up and running. Important! If you select individual nodes of the Integration Server cluster and not the entire Integration Server cluster, when you deploy, the nodes in the Integration Server cluster will no longer be identical. Tasks will not run equally well on all Integration Servers in the cluster, causing errors and failures. 8 9 You can add other Integration Server clusters or individual Integration Server servers to the target group. Map and deploy to the target group as you would any other target group. Deploying Scheduled Tasks to a Cluster Deployer can deploy new (that is, can add) scheduled tasks to clustered Integration Servers. It cannot deploy existing (that is, cannot update) scheduled tasks. You cannot use cluster synchronization for scheduled tasks; you must deploy to each Integration Server in the cluster. Deployer always activates scheduled tasks you deploy to clustered Integration Servers after deployment, regardless of the setting of the Activate After Deployment option in the project properties. To deploy scheduled services to a cluster 1 2 3 4 Create a separate project that contains the scheduled tasks to deploy. Define every Integration Server in the cluster as a remote server. For instructions, see the webMethods Integration Server Administrator's Guide. Map the project to every Integration Server in the cluster. Checkpoint, deploy, and, if necessary, roll back the project as you would normally do in an unclustered environment. webMethods Deployer User's Guide Version 8.0 71 7 Deploying to Clustered Integration Servers and ProcessModel Servers 72 webMethods Deployer User's Guide Version 8.0 8 Using Deployer Commands 74 77 79 79 83 87 91 Creating and Running Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying Log On Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Handling and Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . General and Project Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Build Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Map Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deployment Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . webMethods Deployer User's Guide Version 8.0 73 8 Using Deployer Commands Creating and Running Scripts You can enter Deployer commands at a command prompt or you can create scripts that execute commands automatically. If you create a script, Deployer runs the commands in the order in which they appear in the script. To invoke Deployer from the command line and execute a script, use the command indicated below. System Windows or UNIX Mac Command Deployer.{bat|sh} path_to_file deployerMac.sh path_to_file You can also call scripts from other automated procedures, such as other scripts. The sample script below automates these tasks on a Windows system: Imports a build that was exported from a test environment. Deployer automatically creates the deployment project and deployment sets. Displays the build contents on the console. Imports the deployment map. Imports substitute configuration values for Integration Server assets into the deployment map. Creates a deployment candidate. Generates a checkpoint, simulates the deployment, and deploys the build. 74 webMethods Deployer User's Guide Version 8.0 8 Using Deployer Commands :environment set host=%1 set port=%2 set user=%3 set pwd=%4 set project=testProject set build=DemoBuild set depCandidate=DemoDC set depMap=DemoMap rem ----clear the ERRORLEVEL system variable to avoid any sideeffects of previous executions cases set ERRORLEVEL= :importBuild set importB=%project%_ExportedBuild_%build% IF "%ERRORLEVEL%" == "8" GOTO FINISH ECHO --------------------------------------------------------------------------ECHO Importing Build %ImportB% ECHO --------------------------------------------------------------------------call Deployer.bat --import -buildFile %importB% -host %host% -port %port% -user %user% -pwd %pwd% @echo off echo. echo. echo. set importB= set nextAction=describeBuild GOTO verifyStatus :describeBuild IF "%ERRORLEVEL%" == "8" GOTO FINISH ECHO --------------------------------------------------------------------------ECHO Describing %build% ECHO --------------------------------------------------------------------------call Deployer.bat --describe -build %build% -project %project% -host %host% -port %port% -user %user% -pwd %pwd% @echo off echo. echo. echo. set nextAction=buildit GOTO verifyStatus :importMap set importM=%project%_%depMap%.map IF "%ERRORLEVEL%" == "8" GOTO FINISH ECHO --------------------------------------------------------------------------ECHO Importing Map %ImportM% ECHO --------------------------------------------------------------------------call Deployer.bat --import -mapFile %importM% -project %project% -host %host% -port %port% -user %user% -pwd %pwd% @echo off echo. echo. echo. set importM= set nextAction=importVarSub GOTO verifyStatus webMethods Deployer User's Guide Version 8.0 75 8 Using Deployer Commands :importVarSub set importV=%project%_%depMap%.vs IF "%ERRORLEVEL%" == "8" GOTO FINISH ECHO --------------------------------------------------------------------------ECHO Importing Varsub %ImportV% ECHO --------------------------------------------------------------------------call Deployer.bat --import -varsub -vsFile %importV% -map %depMap% -project %project% -host %host% -port %port% -user %user% -pwd %pwd% @echo off echo. echo. echo. set importV= set nextAction=createDC GOTO verifyStatus :createDC IF "%ERRORLEVEL%" == "8" GOTO FINISH ECHO --------------------------------------------------------------------------ECHO Creating Deployment Candidate %depCandidate% ECHO --------------------------------------------------------------------------call Deployer.bat --create -dc %depCandidate% -build %build% -map %depMap% -project %project% -host %host% -port %port% -user %user% -pwd %pwd% @echo off echo. echo. echo. set nextAction=simulate GOTO verifyStatus :simulate IF "%ERRORLEVEL%" == "8" GOTO FINISH ECHO --------------------------------------------------------------------------ECHO Performaing deployment simulation on deployment candidate %depCandidate% ECHO --------------------------------------------------------------------------call Deployer.bat -host %host% -port %port% -user %user% -pwd %pwd% --simulate project %project% -dc %depCandidate% @echo off echo. echo. echo. set nextAction=checkpoint GOTO verifyStatus :checkpoint IF "%ERRORLEVEL%" == "8" GOTO FINISH ECHO --------------------------------------------------------------------------ECHO Performing CHECKPOINT operation of %depCandidate% ECHO --------------------------------------------------------------------------echo %project% echo %depCandidate% call Deployer.bat --checkpoint -project %project% -dc %depCandidate% -host %host% port %port% -user %user% -pwd %pwd% @echo off echo . echo . echo . set nextAction=deploy GOTO verifyStatus 76 webMethods Deployer User's Guide Version 8.0 8 Using Deployer Commands :deploy IF "%ERRORLEVEL%" == "8" GOTO FINISH ECHO --------------------------------------------------------------------------ECHO DEPLOYING %depCandidate% :VerifyStatus IF "%ERRORLEVEL%" == "8" ECHO "<<<ERROR>>>" IF "%ERRORLEVEL%" == "4" ECHO "<<<WARNING>>>" IF "%ERRORLEVEL%" == "0" ECHO "<<<SUCCESS>>>" echo. echo. goto %nextAction% :FINISH echo. echo. echo Completed. set set set set set set set set host= port= user= pwd= project= build= depCandidate= ERRORLEVEL= @echo on Specifying Log On Parameters All Deployer commands require parameters for logging onto the Integration Server that hosts the Deployer. You can have Deployer commands connect to the Integration Server using HTTP or HTTPS. If you want the Deployer commands to log on using HTTP, you can use an existing HTTP port on the Integration Server or configure a new one. If you want the Deployer commands to log on using HTTPS, you must do the following: Use an existing HTTPS port on the Integration Server or configure a new one. Place the command line interface's client certificate, private key, and signing authority's certificate on the Integration Server host machine. Map the command line interface's client certificate to an Integration Server user that has Administrator or Developer privileges. For instructions on these tasks, see the webMethods Integration Server Administrator's Guide. When you run Deployer commands, the log on parameters you provide depend on whether you want to use HTTP or HTTPS, as follows: The log on parameters for logging onto an HTTP port are as follows: Deployer.{sh|bat} --command -host host -port port -user user -pwd password webMethods Deployer User's Guide Version 8.0 77 8 Using Deployer Commands The logon parameters for logging onto an HTTPS port are as follows: Deployer.{sh|bat} --command -host host -port port -user user -pwd password -useSSL -senderCert path_to_cert -privKey path_to_key -caCert path_to_cert Parameter -host host -port port -user user -pwd password Description Host machine and port for the Integration Server to log on to. User name and password to use to log on to the Integration Server. Note: If you do not provide a password, Deployer will prompt you for it. -useSSL -senderCert path_to_cert -privKey path_to_key -caCert path_to_cert Tells the Deployer command to log on to an HTTPS port. Command line interface's client certificate. Command line interface's private key. Command line interface's signing authority's certificate. Important! If the certificates and private key do not exactly match the ones in the Integration Server installation for the command line interface, the command will fail. Creating a Configuration File for Log On Parameters You can save time by creating a configuration file that specifies the values to use for the log on parameters and then pointing commands to the configuration file. Create the configuration file using a text editor and specify the appropriate parameter values, as specified above. For example: host=idcauto1 port=5555 user=Administrator pwd=1xcfdg55 host=idcauto1 port=5555 useSSL=true senderCert=C:\files\SenderCert.der privKey=C:\files\SenderPrivKey.der caCert=C:\files\SenderCACert.der Save the file with the extension .cnf and store it in the Integration Server_directory\ packages\WmDeployer\bin directory. 78 webMethods Deployer User's Guide Version 8.0 8 Using Deployer Commands To point a command to the configuration file, specify the following on the command instead of the log on parameters: Deployer.{sh|bat} --command -configFile file Parameter command -configFile file Description Command to run. Full path to the configuration file. Error Handling and Logging Deployer logs errors that occur during command line operations in the Deployer command line log file. The log file is named CLI.log and is located in the Integration Server_directory\packages\WmDeployer\logs directory. Typical command line errors include required options that were not specified and invalid parameter values. Execution errors can include connectivity and authentication errors. The maximum size for the CLI.log file is 100 KB. When it reaches the maximum size, it archives the log by renaming the file CLI.log.old and creating a new CLI.log file. General and Project Commands Help Displays usage information for Deployer commands. Deployer.{sh|bat} --help -command command_string Parameter -command command_string Description Command for which you want usage information. webMethods Deployer User's Guide Version 8.0 79 8 Using Deployer Commands About Deployer.{sh|bat} --about Locking and Unlocking Projects Deployer.{sh|bat} --lockProject -project project -host host -port port -user user_name -pwd password Deployer.{sh|bat} --unlockProject -project project -host host -port port -user user_name -pwd password Listing Builds, Maps, or Deployment Candidates for a Project Important! To list builds, you must have Build ACL authorization. To list maps, you must have Map ACL authorization. To list deployment candidates, you must have Deploy ACL authorization. Deployer.{sh|bat} --list -candidate {Build|Map|DC} -project project -host host -port port -user user_name -pwd password Parameter -candidate {Build|Map|DC} -project project Description Whether to list builds, maps, or deployment candidates. Project that contains the builds, maps, or deployment candidates to list. Displaying Project Properties Important! You must have Administrator ACL authorization to run this command. Deployer.{sh|bat} --getProjectProperties -project project -host host -port port -user user_name -pwd password 80 webMethods Deployer User's Guide Version 8.0 8 Using Deployer Commands Exporting Project Properties Important! You must have Administrator ACL authorization to run this command. Deployer.{sh|bat} -export -project project -host host -port port -user user_name -pwd password Parameter -project project Description Project from which to export properties. When you export, Deployer creates a file that contains the project property settings. The file is named project_properties and is stored in the Integration Server_directory\packages\ WmDeployer\replicate\outbound directory. Importing Project Properties Importing properties into a project overwrites the existing properties for that project. Before you can import project properties, you must copy the exported project_properties file to the Integration Server_directory\packages\WmDeployer\replicate\inbound directory on the machine that hosts the target Deployer. Important! You must have Administrator ACL authorization to run this command. Deployer.{sh|bat} --setProjectProperties -project project -projectFile properties_file -host host -port port -user user_name -pwd password Parameter -project project -projectFile properties_file Description Project into which to import the properties. Full path to the file that contains the properties to import. These files are named project_properties and are located in the Integration Server_directory\ packages\ WmDeployer\replicate\inbound directory. Deleting a Project Important! You must have Administrator ACL authorization to run this command. Deployer.{sh|bat} --delete -project project -host host -port port -user user_name -pwd password webMethods Deployer User's Guide Version 8.0 81 8 Using Deployer Commands Exporting Deletion Sets from a Project Important! You must have Define ACL authorization to run this command. Deployer.[sh|bat] --export -deleteSpec -project project -overwrite {true|false} -host host -port port -user user_name -pwd password Parameter -project project -overwrite {true|false} Description Project whose deletion set definitions to export. If the project already contains a file with the same name, whether the Deployer should overwrite it. If you specify false (do not overwrite), and a file with the same name exists, Deployer issues an error and ends the command. Deployer creates a file that contains the definitions. The file is named project_deleteSets.xml and is stored in the Integration Server_directory\packages\ WmDeployer\replicate\outbound directory. Importing Deletion Set Definitions into a Project Before you can import deletion set definitions, you must copy the exported project_deleteSets.xml file to the Integration Server_directory\packages\WmDeployer\ replicate\inbound directory. If the project already contains a deletion set with the same name as one you are importing, Deployer issues an error and ends the command. Important! You must have Define ACL authorization to run this command. Deployer.{sh|bat} --import -deleteSpec definitions_file -project project -host host -port port -user user_name -pwd password Parameter -deleteSpec definitions_file Description Full path to the file that contains the definitions to import. Definition files are named project_deleteSets.xml and are located in the Integration Server_directory\ packages\WmDeployer\repli cate\inbound directory. Project into which to import the definitions. -project project 82 webMethods Deployer User's Guide Version 8.0 8 Using Deployer Commands Build Commands Creating a Project Build If there are any unresolved dependencies, build creation will fail. For instructions on resolving unresolved dependencies, see "Resolving Dependencies" on page 47. Important! You must have Build ACL authorization to run this command. Deployer.{sh|bat} --create -build build -project project -host host -port port -user user_name -pwd password Parameter -build build Description Name of the build to create. The build name can be up to 32 characters long and can include any characters that are valid for a file name in your operating system. Project from which to create the build. -project project Listing Builds for a Project Important! You must have View ACL authorization to run this command. Deployer.{sh|bat} --list -candidate build -project project -host host -port port -user user_name -pwd password Displaying Contents of a Build Important! You must have Administrator ACL authorization to run this command. Deployer.{sh|bat} --describe -build build -project project -host host -port port -user user_name -pwd password Parameter -build build -project project Description Build whose contents to display. Project to which the build belongs. webMethods Deployer User's Guide Version 8.0 83 8 Using Deployer Commands Displaying Substitute Configuration Values for Integration Server Assets in a Build Important! You must have Administrator ACL authorization to run this command. Deployer.{sh|bat} --describe -build build -project project -varsub -host host -port port -user user_name -pwd password Parameter -build build -project project -varsub Description Build whose substitute configuration values to display. Project to which the build belongs. Displays the substitute configuration values. Displaying Contents of a Build File Important! You must have Administrator ACL authorization to run this command. Deployer.{sh|bat} --describe -buildFile build_file -project project -host host -port port -user user_name -pwd password . Parameter -buildFile build_file Description Full path to the build file whose contents to display. Build files are named project_build and are located in the Integration Server_directory\packages\ WmDeployer\ replicate\outbound directory. Project to which the build belongs. -project project Displaying Substitute Configuration Values for Integration Server Assets in a Build File Important! You must have Administrator ACL authorization to run this command. Deployer.{sh|bat} --describe -buildFile build_file -project project -varsub -host host -port port -user user_name -pwd password 84 webMethods Deployer User's Guide Version 8.0 8 Using Deployer Commands . Parameter -buildFile build_file Description Full path to the build file whose substitute configuration values to display. Build files are named project_build and are located in the Integration Server_directory\packages\WmDeployer\replicate\ outbound directory. Project to which the build belongs. Displays the substitute configuration values. -project project -varsub Exporting a Build from a Project Important! You must have Build ACL authorization to run this command. Deployer.[sh|bat] --export -build build -project project -overwrite {true|false} -host host -port port -user user_name -pwd password Parameter -build build -project project -overwrite {true|false} Description Build to export. Project to which the build belongs. If the project already contains a build with the same name, whether the Deployer should overwrite it. If you specify false (do not overwrite), and a build with the same name exists, Deployer issues an error and ends the command. Deployer creates a file that contains the build. The file is named project_build and is stored in the Integration Server_directory\packages\WmDeployer\replicate\outbound directory. Importing a Build into a Project Before you can import a build, you must copy the exported project_build file to the Integration Server_directory\packages\WmDeployer\replicate\inbound directory on the machine that hosts the target Deployer. Important! You must have Build ACL authorization to run this command. Deployer.{sh|bat} --import -buildFile build_file -project project -overwrite {true|false} -host host -port port -user user_name -pwd password webMethods Deployer User's Guide Version 8.0 85 8 Using Deployer Commands Parameter -buildFile build_file Description Full path to the build file that contains the deployment map to import. Build files are named project_build and are located in the Integration Server_directory\ pack ages\WmDeployer\replicate\inbound directory. Project into which to import the build. If the project already contains a build with the same name, whether Deployer should overwrite it. If you specify false (do not overwrite), and a build with the same name exists, the Deployer issues an error and ends the command. -project project -overwrite {true|false} Listing Build Reports Important! You must have Build ACL authorization to run this command. Deployer.{sh|bat} --list -candidate buildReport -build build -project project -host host -port port -user user_name -pwd password . Parameter -build build -project project Description Build for which to list build reports. Project to which the build belongs. Displaying a Build Report Important! You must have Build ACL authorization to run this command. Deployer.{sh|bat} --showReport -candidate buildReport -build build -id integerId -project project -host host -port port -user user_name -pwd password Parameter {-build build id report_identifier Description Build whose build report to display. Identifier for the report to display. Use the --list command (see "Listing Build Reports" on page 86) to display report identifiers, as well as the date and time each report was generated. Project to which the build belongs. -project project 86 webMethods Deployer User's Guide Version 8.0 8 Using Deployer Commands Map Commands Important! You must have Map ACL authorization to run the commands in this section. Listing All Deployment Maps Deployer.{sh|bat} --list -candidate mapFile -host host -port port -user user_name -pwd password Exporting a Deployment Map from a Project Deployer.{sh|bat} --export -map map -project project -host host -port port -user user_name -pwd password Parameter -map map -project project Description Deployment map to export. Project to which the map belongs. Deployer creates a file that contains the deployment map. The file is named project_map.map and is stored in the Integration Server_directory\packages\ WmDeployer\replicate\ outbound directory. Editing a Deployment Map or Substitute Configuration Values After you export a deployment map or substitute configuration values, you can edit the resulting file before importing it into the other environment. For example, if you want to map a deployment set to a different target server, you could change the targetServer alias attribute to reflect the new target server name. You can open a deployment map or substitute configuration value file using any XML editor. A deployment map file has the following format: webMethods Deployer User's Guide Version 8.0 87 8 Using Deployer Commands <?xml version="1.0" encoding="UTF-8"?> <DeploymentMap description="<description of map>" mapName="<mapSetName>" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <DeploymentSets> <DeploymentSet name="<deploymentSetName>" pluginType="<pluginType>"> <targetGroups> <targetGroup alias="<targetGroupName>"/> </targetGroups> <targetServers> <targetServer alias="<targetServerAlias>"/> </targetServers> </DeploymentSet> </DeploymentSets> </DeploymentMap> To specify an additional target server, target group, or deployment set in the same deployment map, repeat the attribute for each addition. For example, a deployment set that is mapped to multiple target servers is defined as follows: <DeploymentMap> <DeploymentSets> <DeploymentSet name="deploymentsetA" pluginType="MWS"> <targetGroups> <targetGroup alias="<targetGroupName>"/> </targetGroups> <targetServers> <targetServer alias="server1"/> <targetServer alias="server2"/> <targetServer alias="server3"/> </targetServers> </DeploymentSet> </DeploymentSets> </DeploymentMap> Importing a Deployment Map Into a Project Before you can import a deployment map, you must copy the exported project_map.map file to the Integration Server_directory\packages\WmDeployer\replicate\inbound directory on the machine that hosts the target Deployer. You can edit the map before you import it (see "Editing a Deployment Map or Substitute Configuration Values" on page 87). Deployer.{sh|bat} --import -mapFile map_file -project project -overwrite {true|false} -host host -port port -user user_name -pwd password 88 webMethods Deployer User's Guide Version 8.0 8 Using Deployer Commands Parameter -mapFile map_file Description Full path to the map file that contains the deployment map to import. Map files are named project_map.map and are located in the Integration Server_directory\ packages\WmDeployer\replicate\inbound directory. Project into which to import the map. If the project already contains a map with the same name, whether the Deployer should overwrite it. If you specify false (do not overwrite), and a map with the same name exists, the Deployer issues an error and ends the command. -project project -overwrite {true|false} Exporting Substitute Configuration Values for Integration Server Assets from a Deployment Map Deployer.{sh|bat} --export -map map -project project -varsub -host host -port port -user user_name -pwd password Parameter -map map -project project -varsub Description Deployment map from which to export substitute configuration values. Project to which the map belongs. Exports the substitute configuration values. Deployer creates a file that contains the substitute configuration values. The file is named project_map.vs and is stored in the Integration Server_directory\packages\WmDeployer\ replicate\outbound directory. Note: If no substitute configuration values are specified in the deployment map, the Deployer creates a file with the complete structure but does not export any values. webMethods Deployer User's Guide Version 8.0 89 8 Using Deployer Commands Importing Substitute Configuration Variables for Integration Server Assets into a Deployment Map Before you can import substitute configuration values into a deployment map, you must copy the exported project_map.vs file to the Integration Server_directory\packages\ WmDeployer\replicate\inbound directory on the machine that hosts the target Deployer. You can edit the values before you import them (see "Editing a Deployment Map or Substitute Configuration Values" on page 87). Deployer.{sh|bat} --import -vsFile config_values_file -map map -project project -validate {true|false} -host host -port port -user user_name -pwd password Parameter -vsFile config_values_file Description Full path to the file that contains the substitute configuration values to import. These files are named project_map.vs and are located in the Integration Server_directory\ packages\WmDeployer\replicate\ inbound directory. Deployment map into which to import the values. Project that contains the map into which to import the values. Whether Deployer should check the values to make sure they are valid for the target servers. If you specify true (validate), Deployer lists any servers that are not running on the console. -map map -project project -validate {true|false} Deleting a Deployment Map from a Project Deployer.{sh|bat} --delete -map map -project project -host host -port port -user user_name -pwd password . Parameter -map map -project project Description Deployment map to delete. Project that contains the map to delete. 90 webMethods Deployer User's Guide Version 8.0 8 Using Deployer Commands Deployment Commands Important! You must have Deploy ACL authorization to run the commands in this section. Creating a Deployment Candidate Deployer.{sh|bat} --create -dc deployment_candidate -build build -map map -project project -host host -port port -user user_name -pwd password Parameter -dc deployment_candidate -build build -map map -project project Description Deployment candidate to create. Project build to use in the deployment candidate. Deployment map to use in the deployment candidate. Project to which the build and map belong. Displaying Information About a Deployment Candidate Deployer.{sh|bat} --describe -dc deployment_candidate -project project -host host -port port -user user_name -pwd password . Parameter -dc deployment_candidate Description Deployment candidate for which to obtain information, such as: Name of the build and deployment map in the candidate. Date the candidate was created. All existing deployment reports for the candidate. -project project Project to which the deployment candidate belongs. webMethods Deployer User's Guide Version 8.0 91 8 Using Deployer Commands Deleting a Deployment Candidate Deployer.{sh|bat} --delete -dc deployment_candidate -project project -host host -port port -user user_name -pwd password . Parameter -dc deployment_candidate -project project Description Deployment candidate to delete. Project to which the deployment candidate belongs. Generating a Checkpoint Important! The target servers must be available for the checkpoint generation to be successful. Deployer.{sh|bat} --checkpoint -dc deployment_candidate -project project -host host -port port -user user_name -pwd password . Parameter -dc deployment_candidate -project project Description Deployment candidate you plan to deploy. Project to which the deployment candidate belongs. Simulating a Deployment Deployer.{sh|bat} --simulate -dc deployment_candidate -project project -host host -port port -user user_name -pwd password . Parameter -dc deployment_candidate -project project Description Deployment candidate for which to simulate a deployment. Project to which the deployment candidate belongs. Deployer generates a simulation report. Display the simulation report as instructed in "Displaying a Simulation, Rollback, or Deployment Report" on page 94 and address all problems. Important! If you do not address all problems at this time, you will probably experi ence errors during deployment. 92 webMethods Deployer User's Guide Version 8.0 8 Using Deployer Commands Deploying Deployer.{sh|bat} --deploy -dc deployment_candidate -project project -host host -port port -user user_name -pwd password -force . Parameter -dc deployment_candidate -project project -force Description Deployment candidate to deploy. Project to which the deployment candidate belongs. If no checkpoint exists for the deployment candidate (for example, because you chose to generate checkpoints manually, but did not do so), Deployer will not deploy unless you specify this parameter. Important! If you deploy without a checkpoint, you will not be able to roll back target servers. The Deployer deploys the assets in the candidate's project build to the target servers in the candidate's deployment map. In addition, Deployer generates a deployment report. Display the deployment report as instructed in "Displaying a Simulation, Rollback, or Deployment Report" on page 94. Rolling Back Target Servers Deployer.{sh|bat} --rollback -dc deployment_candidate -project project -host host -port port -user user_name -pwd password . Parameter -dc deployment_candidate -project project Description Deployment candidate whose deployed assets to remove from the target servers. Project to which the deployment candidate belongs. Deployer generates a rollback report. Display the rollback report as instructed in "Displaying a Simulation, Rollback, or Deployment Report" on page 94 and address all problems. webMethods Deployer User's Guide Version 8.0 93 8 Using Deployer Commands Listing Simulation, Rollback, and Deployment Reports Deployer.{sh|bat} --list -candidate buildReport -dc deployment_candidate -project project -host host -port port -user user_name -pwd password . Parameter -dc deployment_candidate -project project Description Deployment candidate whose simulation, deployment, and rollback reports to list. Project to which the deployment candidate belongs. Displaying a Simulation, Rollback, or Deployment Report Deployer.{sh|bat} --showReport -candidate buildReport -dc deployment_candidate -id integerId -project project -host host -port port -user user_name -pwd password Parameter -dc deployment_candidate id report_identifier Description Deployment candidate whose simulation, deployment, or rollback report to display. Identifier for the report to display. Use the --list command (see "Listing Simulation, Rollback, and Deployment Reports" on page 94) to display report identifiers, as well as the date and time each report was generated. Project to which the deployment candidate belongs. -project project 94 webMethods Deployer User's Guide Version 8.0 ...
View Full Document

Ask a homework question - tutors are online