9-6 deployer users guide

302
webMethods Deployer User’s Guide Version 9.6 April 2014

Upload: harish-bandi

Post on 04-Sep-2015

282 views

Category:

Documents


50 download

DESCRIPTION

DeployerGuide

TRANSCRIPT

  • webMethodsDeployerUsersGuide

    Version 9.6

    April 2014

  • This document applies to webMethods Product Suite Version 9.6 and to all subsequent releases.

    Specications contained herein are subject to change and these changes will be reported in subsequent release notes or new editions.

    Copyright 2004-2014 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/orits aliates and/or their licensors.

    The name Software AG and all Software AG product names are either trademarks or registered trademarks of Software AG and/orSoftware AG USA Inc. and/or its subsidiaries and/or its aliates and/or their licensors. Other company and product names mentionedherein may be trademarks of their respective owners.

    Detailed information on trademarks and patents owned by Software AG and/or its subsidiaries is located athp://documentation.softwareag.com/legal/.

    Use of this software is subject to adherence to Software AG's licensing conditions and terms. These terms are part of the productdocumentation, located at hp://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s).

    This software may include portions of third-party products. For third-party copyright notices and license terms, please refer to "LicenseTexts, Copyright Notices and Disclaimers of Third Party Products. This document is part of the product documentation, located athp://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s).

    Document ID: DEP-UG-96-20140610

  • MTable of Contents

    webMethods Deployer Users Guide Version 9.6 3

    Table of Contents

    About this Guide............................................................................................................................11Document Conventions............................................................................................................ 11Documentation Installation........................................................................................................12Online Information.................................................................................................................... 12

    Concepts......................................................................................................................................... 15About webMethods Deployer................................................................................................... 16Runtime-Based Deployment.....................................................................................................16

    Overview of Runtime-Based Deployment......................................................................... 16Repository-Based Deployment................................................................................................. 17

    Composites........................................................................................................................ 18Build Script........................................................................................................................ 18Overview of Repository-Based Deployment......................................................................18

    Creating Projects...................................................................................................................... 19Deployment Sets............................................................................................................... 19Unresolved Dependencies.................................................................................................20Target Servers................................................................................................................... 20Deletion Sets..................................................................................................................... 21

    Mapping Projects...................................................................................................................... 21Deploying Projects....................................................................................................................21

    Checkpoint and Roll Back.................................................................................................22Transactional Deployment................................................................................................. 22Concurrent and Sequential Deployment........................................................................... 22

    Deployer Interfaces...................................................................................................................23Automating Project Creation.....................................................................................................24Logging..................................................................................................................................... 25

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

    Building Composites for Repository-Based Deployment..........................................................31Overview................................................................................................................................... 32Before Building Composites..................................................................................................... 32

    Adding Assets to the Source Directory............................................................................. 33Installing the Asset Build Environment..............................................................................33

    Setting the Properties for the Build.......................................................................................... 34Setting Build Properties.....................................................................................................34Setting VCS Checkout Properties..................................................................................... 40Changing JVM Memory Settings.......................................................................................41

    Running the Build Script and Rebuilding the Index................................................................. 42Running the Build Script................................................................................................... 46

  • MTable of Contents

    webMethods Deployer Users Guide Version 9.6 4

    Rebuilding the Index..........................................................................................................46Preparing BPM Assets for Repository-Based Deployment...................................................... 47

    Differences Between Manual Process Generation and Deployed Processes................... 47About the Deployment of Generation Receipts......................................................... 47About the Redeployment of Processes......................................................................47About the Deployment of Process Images................................................................ 48

    Preparing the BPM Process Development Asset Deployment Environment.....................48About build.xml Files.................................................................................................. 48Configuring the Process Project build.xml File.......................................................... 49

    Running the Build Script in a Process Project Directory...................................................51Next Steps................................................................................................................................ 51

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

    Connecting to Integration Servers and Trading Networks Servers................................... 56Connecting to Optimize Servers....................................................................................... 57Connecting to My webMethods Servers........................................................................... 58Connecting to Event Servers............................................................................................ 60Connect to Broker Servers................................................................................................61Connect to BPM Process Model Servers......................................................................... 63Connecting to EDA Deployment Endpoints...................................................................... 65Connect to Business Rules Runtimes...............................................................................66

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

    Creating and Managing Projects..................................................................................................75Enabling or Disabling Deployer GUI Audit Logging................................................................. 76Setting Default Properties for All Projects................................................................................77

    Setting the Dependency Checking Default....................................................................... 77Setting the Project Locking Default...................................................................................77Setting General Deployment Defaults...............................................................................77

    Setting the Defaults for Integration Server and Trading Networks Projects............................. 80Creating a Project.....................................................................................................................83Exporting and Importing Project Properties............................................................................. 87Permissions for Performing Tasks in Projects..........................................................................88Adding and Viewing Instructions or Notes About a Project......................................................90Editing Settings for an Individual Project................................................................................. 90Deleting a Project..................................................................................................................... 90Next Steps................................................................................................................................ 91

    Defining a Deployment Set...........................................................................................................93Creating a Deployment Set...................................................................................................... 94

  • MTable of Contents

    webMethods Deployer Users Guide Version 9.6 5

    Identify Source Servers for the Deployment Set......................................................................95Identifying Source Servers for Runtime-Based Deployment............................................. 95Identifying Source Repository for Repository-Based Deployment.....................................96

    Next Steps................................................................................................................................ 97

    Adding Assets for Runtime-Based Deployment.........................................................................99Before Adding Assets for Runtime-Based Deployment..........................................................100Adding Assets to Broker, ProcessModel, MWS, or Optimize Deployment Sets..................... 100

    About MWS Deployment Sets.........................................................................................100About ProcessModel Deployment Sets...........................................................................101Adding Assets to a Broker, ProcessModel, MWS, or Optimize Deployment Set.............101

    Adding Assets to an IS & TN Deployment Set...................................................................... 102Deploying ACLs...............................................................................................................102

    Deploying ACLs Associated with My webMethods Server Groups.......................... 102Deploying ACLs Associated with LDAP Groups...................................................... 103

    Adding Integration Server Administration Assets............................................................103Adding Integration Server Packages...............................................................................103

    Adding an Entire Package....................................................................................... 104Adding Package Components..................................................................................104Adding Package Files.............................................................................................. 105Setting Package Properties......................................................................................106

    Adding webMethods Files............................................................................................... 109Adding Trading Networks Assets.................................................................................... 110Excluding Common Assets............................................................................................. 110

    Resolving Dependencies........................................................................................................ 111Manually Adding Dependencies to a Package Component in an IS & TN Deployment Set... 113Removing Process Models from a Deployment Set.............................................................. 113Next Steps.............................................................................................................................. 114

    Adding Assets for Repository-Based Deployment.................................................................. 115Overview................................................................................................................................. 116Selecting Composites............................................................................................................. 116Selecting Individual Assets from Composites........................................................................ 117Resolving Dependencies........................................................................................................ 117

    Resolving Dependencies Automatically.......................................................................... 118Resolving Dependencies Manually................................................................................. 119

    Resolving Conflicts................................................................................................................. 121Deploying ACLs...................................................................................................................... 122

    Deploying ACLs Associated with My webMethods Server Groups................................. 122Deploying ACLs Associated with LDAP Groups............................................................. 122

    Next Steps.............................................................................................................................. 122

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

  • MTable of Contents

    webMethods Deployer Users Guide Version 9.6 6

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

    Adding Assets to a Deletion Set............................................................................................ 129Adding Assets to a Runtime-Based Deletion Set............................................................129Adding Assets to a Repository-Based Deletion Set........................................................130Adding Packages to Deletion Sets..................................................................................130

    Resolving Dependencies in Repository-Based Deletion Sets................................................ 132Exporting and Importing Deletion Set Definitions...................................................................132Next Steps.............................................................................................................................. 133

    Building a Runtime-Based Deployment Project....................................................................... 135Creating a Build......................................................................................................................136Rebuilding a Build.................................................................................................................. 137Exporting and Importing a Build.............................................................................................137Next Steps.............................................................................................................................. 138

    Mapping a Project........................................................................................................................139About Mapping a Project........................................................................................................140Mapping a Project to Target Servers and Target Groups.......................................................140Exporting and Importing a Map..............................................................................................143Substituting Configuration Values...........................................................................................144

    Substituting Configuration Values by Asset.................................................................... 145Substituting Configuration Values by Target Server (Runtime-Based)............................ 145Substituting Configuration Values by Target Server (Repository-Based)........................ 146

    Exporting and Importing Substitute Configuration Values...................................................... 146

    Deploying a Project..................................................................................................................... 149Overview................................................................................................................................. 150Preparing Integration Server to Stream Large Repository-Based Projects............................ 150Generating a Checkpoint........................................................................................................151

    Generating an Automatic Checkpoint............................................................................. 151Generating a Checkpoint Manually................................................................................. 151

    Deploying a Project................................................................................................................ 152Post-Deployment Tasks.......................................................................................................... 155Rolling Back Target Servers...................................................................................................155

    Rolling Back Target Servers Automatically..................................................................... 155Rolling Back Target Servers Manually............................................................................ 156

    Using Deployer Commands........................................................................................................159Overview................................................................................................................................. 160Installing Command Line Interface Only................................................................................ 160Creating and Running Scripts................................................................................................ 160Specifying Log On Parameters.............................................................................................. 163

    Creating a Configuration File for Log On Parameters.....................................................165Error Handling and Logging................................................................................................... 165General and Project Commands............................................................................................ 166

  • MTable of Contents

    webMethods Deployer Users Guide Version 9.6 7

    About................................................................................................................................166Deleting a Project............................................................................................................166Displaying Project Properties.......................................................................................... 166Exporting Deletion Sets from a Project...........................................................................166Importing Deletion Set Definitions into a Project............................................................ 167Exporting Project Properties............................................................................................168Importing Project Properties............................................................................................168Help..................................................................................................................................169Listing Builds, Maps, or Deployment Candidates for a Project....................................... 169Locking Projects.............................................................................................................. 170Unlocking Projects...........................................................................................................170

    Build Commands.................................................................................................................... 170Creating a Project Build.................................................................................................. 170Listing Builds for a Project.............................................................................................. 171Displaying Contents of a Build........................................................................................171Displaying Substitute Configuration Values for Integration Server Assets in a Build....... 171Displaying Contents of a Build File.................................................................................172Displaying Substitute Configuration Values for Integration Server Assets in a BuildFile................................................................................................................................... 172Exporting a Build from a Project..................................................................................... 173Importing a Build File into a Project................................................................................173Listing Build Reports....................................................................................................... 174Displaying a Build Report................................................................................................174

    Commands for Repository-Based Deployment...................................................................... 175Rebuilding the Index with the Build Script...................................................................... 175

    Map Commands..................................................................................................................... 176Listing All Deployment Maps...........................................................................................176Exporting a Deployment Map from a Project.................................................................. 176Editing a Deployment Map, Project Properties, or Substitute Configuration Values........176Importing a Deployment Map Into a Project................................................................... 177Exporting Substitute Configuration Values for Integration Server Assets from aDeployment Map............................................................................................................. 178Importing Substitute Configuration Variables for Integration Server Assets into aDeployment Map............................................................................................................. 178Deleting a Deployment Map from a Project....................................................................179

    Deployment Commands......................................................................................................... 180Creating a Deployment Candidate.................................................................................. 180Displaying Information About a Deployment Candidate..................................................180Deleting a Deployment Candidate.................................................................................. 181Generating a Checkpoint.................................................................................................181Simulating a Deployment................................................................................................ 182Deploying......................................................................................................................... 182Rolling Back Target Servers............................................................................................183Listing Simulation, Rollback, and Deployment Reports.................................................. 183Displaying a Simulation, Rollback, or Deployment Report..............................................184

  • MTable of Contents

    webMethods Deployer Users Guide Version 9.6 8

    Automating Project Creation...................................................................................................... 185Overview................................................................................................................................. 186Exporting Projects for Use in Project Automator....................................................................186Using Handles Instead of Passwords.................................................................................... 187

    Creating Password Handles............................................................................................187Modifying Password Handle Associations.......................................................................188Deleting Password Handles............................................................................................ 188

    Error Handling and Logging................................................................................................... 189Root Tag................................................................................................................................. 189Identifying Deployer................................................................................................................ 190Setting Up Aliases for Source and Target Servers................................................................ 190

    Setting Up Aliases for Source Repositories.................................................................... 191Setting Up Aliases for Source and Target webMethods Brokers.................................... 192Setting Up Aliases for Source and Target Process Model Servers................................. 197Setting Up Aliases for Source and Target Integration Servers........................................198Setting Up Aliases for Source and Target My webMethods Servers...............................200Setting Up Aliases for Source and Target Optimize Servers.......................................... 203Setting Up Aliases for Target Event Servers...................................................................204Setting Up Aliases for Target EDA Deployment Endpoints.............................................206Setting Up Aliases for Target Business Rules Runtimes................................................ 207Setting Up Aliases for Target Universal Messaging Servers...........................................209Setting Up Aliases for Target Groups............................................................................. 210

    Creating Projects.................................................................................................................... 212Defining Deployment and Deletion Sets for Runtime-Based Deployment.......................213Defining a Deployment Set for Repository-Based Deployment.......................................216Defining a Deletion Set for Repository-Based Deployment............................................ 220Building a Project for Runtime-Based Deployment......................................................... 220Mapping a Project........................................................................................................... 221Mapping a Runtime-Based Project................................................................................. 221Mapping a Repository-Based Project..............................................................................223Creating a Deployment Candidate for Runtime-Based Deployment............................... 224Creating a Deployment Candidate for Repository-Based Deployment........................... 225

    Running Project Automator.................................................................................................... 226

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

    Deploying Optimize Assets........................................................................................................ 229Overview................................................................................................................................. 230Disabling Automatic Execution of DDL Statements............................................................... 230Deploying Optimize Assets in Static DB Schema Mode........................................................ 231Optimize Deployment Usage Notes....................................................................................... 232

    Potential Problems...........................................................................................................233Deployer Batch Size.................................................................................................233Removing Assets from a Deployment Set............................................................... 233

  • MTable of Contents

    webMethods Deployer Users Guide Version 9.6 9

    Two or More Deployment Sets for the Same Analytic Engine Using One DeploymentMap...........................................................................................................................233

    Executing DDL Statements for Two or More Analytic Engines......................... 234

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

    Deployable Assets....................................................................................................................... 239BPM Process Development Assets........................................................................................240Broker Assets......................................................................................................................... 241Business Rules Assets...........................................................................................................242EDA Assets.............................................................................................................................243Event Server Assets...............................................................................................................244Integration Server Assets....................................................................................................... 245

    Integration Server Administrative Assets........................................................................ 246Adding Administrative Assets to the Source Directory.............................................246Global Values for Integration Server Administrative Assets.....................................251Integration Server Administrative Assets and Substitution Values...........................253

    ACLs..................................................................................................................253Broker Settings..................................................................................................253Cache Manager.................................................................................................255Certificate Settings............................................................................................ 256Client Certificates.............................................................................................. 256CSRF Guard Configuration...............................................................................256webMethods Enterprise Gateway Configuration...............................................257Extended Settings............................................................................................. 258File Access Control Configuration.....................................................................258Global Variables................................................................................................ 259Groups...............................................................................................................259JDBC Driver Alias............................................................................................. 259JDBC Pool Alias Configuration......................................................................... 259JDBC Functional Alias...................................................................................... 260JMS Connection Alias.......................................................................................260JNDI Alias..........................................................................................................261Keystore Alias................................................................................................... 262LDAP Configuration...........................................................................................263Metadata............................................................................................................264Enhanced Parser...............................................................................................264Ports.................................................................................................................. 265Proxy server alias............................................................................................. 269Proxy Server Bypass........................................................................................ 270Reliable Messaging Configuration.................................................................... 270Remote Server Alias......................................................................................... 273SAML Token Issuer...........................................................................................273

  • MTable of Contents

    webMethods Deployer Users Guide Version 9.6 10

    Scheduled Tasks............................................................................................... 274SFTP Server Alias............................................................................................ 275SFTP User Alias............................................................................................... 275Truststore Alias................................................................................................. 277Users................................................................................................................. 278Web Service Endpoint Alias..............................................................................278Web Service Policy........................................................................................... 280

    Integration Server Administrative Asset Dependencies........................................... 280Integration Server Package Assets.................................................................................281

    About Integration Server Packages......................................................................... 281Adding Package Assets to the Source Directory..................................................... 282Global Values for Integration Server Package Assets and Composites...................283Individual Values for Integration Server Package Assets.........................................286

    Adapter Runtime and .NET Service Assets.................................................................... 288Adding Adapter Runtime and .NET Service Assets to the Source Directory............288Adapter Runtime Assets.......................................................................................... 288Adapter Runtime Asset Dependencies.................................................................... 291.NET Asset............................................................................................................... 291

    My webMethods Server Assets..............................................................................................292Optimize Assets......................................................................................................................297Trading Networks Assets........................................................................................................298Universal Messaging Assets.................................................................................................. 299Other Assets........................................................................................................................... 301

  • MOdd Header

    webMethods Deployer Users Guide Version 9.6 11

    About this Guide

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

    Document Conventions

    Convention Description

    Bold Identies elements on a screen.

    Narrowfont Identies storage locations for services on webMethodsIntegration Server, using the convention folder.subfolder:service .

    UPPERCASE Identies keyboard keys. Keys you must press simultaneouslyare joined with a plus sign (+).

    Italic Identies variables for which you must supply values specic toyour own situation or environment. Identies new terms the rsttime they occur in the text.

    Monospace

    font

    Identies text you must type or messages displayed by thesystem.

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

    | Separates two mutually exclusive choices in a syntax line. Typeone of these choices. Do not type the | symbol.

    [ ] Indicates one or more options. Type only the information insidethe 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 (...).

  • MEven Header

    webMethods Deployer Users Guide Version 9.6 12

    Documentation InstallationYou can download the product documentation using the Software AG Installer. Thedocumentation is downloaded to a central directory named _documentation in the maininstallation directory (SoftwareAG by default).

    Online InformationYou can nd additional information about Software AG products at the locations listedbelow.

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

    Access the latest version of productdocumentation.

    SoftwareAG Documentation website

    hp://documentation.softwareag.com

    Find information about product releasesand tools that you can use to resolveproblems.

    See the Knowledge Center to:

    Read technical articles and papers.

    Download xes and service packs (9.0SP1 and earlier).

    Learn about critical alerts.

    See the Products area to:

    Download products.

    Download certied samples.

    Get information about productavailability.

    Access older versions of productdocumentation.

    Submit feature/enhancement requests.

    Empower Product Support website

    hps://empower.softwareag.com

    Access additional articles, demos, andtutorials.

    SoftwareAG Developer Community forwebMethods

  • MOdd Header

    webMethods Deployer Users Guide Version 9.6 13

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

    Obtain technical information, usefulresources, and online discussion forums,moderated by Software AG professionals,to help you do more with Software AGtechnology.

    Use the online discussion forums toexchange best practices and chat withother experts.

    Expand your knowledge about productdocumentation, code samples, articles,online seminars, and tutorials.

    Link to external websites that discussopen standards and many webtechnology topics.

    See how other customers are streamliningtheir operations with technology fromSoftware AG.

    hp://communities.softwareag.com/

  • MEven Header

    webMethods Deployer Users Guide Version 9.6 14

  • MOdd Header

    webMethods Deployer Users Guide Version 9.6 15

    1 Concepts About webMethods Deployer ....................................................................................................... 16

    Runtime-Based Deployment ........................................................................................................ 16

    Repository-Based Deployment ..................................................................................................... 17

    Creating Projects .......................................................................................................................... 19

    Mapping Projects ......................................................................................................................... 21

    Deploying Projects ....................................................................................................................... 21

    Deployer Interfaces ...................................................................................................................... 23

    Automating Project Creation ........................................................................................................ 24

    Logging ......................................................................................................................................... 25

  • MEven Header

    webMethods Deployer Users Guide Version 9.6 16

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

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

    Deployer supports two scenarios for deploying assets:

    In a runtime-based deployment scenario, Deployer deploys assets from webMethodsruntimes to which Deployer is connected.

    In a repository-based deployment scenario, Deployer deploys assets built from sourcesin a development environment or VCS and stored on a repository.

    Runtime-Based DeploymentIn runtime-based deployment, you deploy assets directly from webMethods sourceruntimes to target runtimes.

    You can deploy assets from and to these webMethods runtimes:

    webMethods Brokers.

    BPM (ProcessModel) runtimes. A ProcessModel runtime is an Integration Server thathosts the webMethods Process Engine and executes business processes.

    Integration Servers, including hosts for Trading Networks Servers.

    My webMethods Server.

    Optimize runtimes. An Optimize runtime is an Optimize Analytic Engine.

    Overview of Runtime-Based DeploymentThe runtime-based deployment process involves the following basic stages:

    Stage 1 Dene a deployment project.

  • MOdd Header

    webMethods Deployer Users Guide Version 9.6 17

    You use Deployer to create connections to target and sourcewebMethods runtimes. You then dene a deployment set, for whichyou select user-created assets to include in the project directly fromsource webMethods runtimes.

    For more information about projects and deployment sets, see "CreatingProjects" on page 19.

    Stage 2 Build the project.

    You build your project for deployment to the target runtimes. Whenyou build a project, Deployer creates a le that contains the actual assetsreferenced in the project. If you later change the project, or if the buildcontains assets that you know have changed on the source runtimes,you can re-create the build to bring it up to date.

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

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

    Stage 4 Deploy the assets in the project build to the target runtimes.

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

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

    Repository-Based DeploymentIn repository-based deployment, you build the assets from your developmentenvironment or version control system (VCS) and store them on a repository. Therepository is a specic directory structure to which you map Deployer. Deployerdeploys the assets contained in the repository to target servers, target groups, or both.

    You can use repository-based deployment to deploy assets from the following kinds ofwebMethods runtimes to target servers:

    BPM Process Development

    Broker

    Business Rules

    EDA

    Event Server

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

  • MEven Header

    webMethods Deployer Users Guide Version 9.6 18

    Integration Server

    My webMethods Server

    Optimize

    Trading Networks

    Universal Messaging

    CompositesComposites are compressed les that contain the denitions of the assets and theirdependencies you build in a development environment. Each composite denes assetsfrom one webMethods runtime type. You build the assets into the composite le duringthe build process and store them in a repository for deployment.

    Deployer can use the assets from several dierent composites (and webMethods runtimetypes) to construct a deployment set. The assets in each composite le retain the samerelationships they share in the development environment.

    The build process that creates the composites for your assets also creates an AssetComposite Denition Language (ACDL) descriptor (descriptor) for each composite.The descriptor is an XML schema that serves as a manifest for each composite anddescribes all of the assets included in the composite le. Deployer reads the descriptor todetermine which assets are present in each composite.

    Build ScriptIn repository-based deployment, you use a build script (build.xml) to build compositesand their associated descriptors from the development environment. The buildproperties le (build.properties) contains the seings the build script uses to build theassets.

    For more information about seing build seings and running the build script, see"Building Composites for Repository-Based Deployment" on page 31.

    Overview of Repository-Based DeploymentThe following graphic illustrates the asset deployment process in repository-baseddeployment:

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

  • MOdd Header

    webMethods Deployer Users Guide Version 9.6 19

    Stage 1 Create assets on your development environment.

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

    Stage 2 Build the composites and descriptors.

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

    Stage 3 You use Deployer to do the following:

    1. Dene a deployment project and deployment sets. You select user-createdassets from the ACDL composite stored on the repository to identifythe assets to include in the project. For more information aboutdeployment projects, see "Creating Projects" on page 19. For moreinformation about deployment sets, see "Deployment Sets" on page19.

    2. Map the contents of the deployment project to target servers. For moreinformation, see "Mapping Projects" on page 21.

    3. Deploy the assets in the project build to the target servers. For moreinformation, see "Deploying Projects" on page 21.

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

    Creating ProjectsA deployment project identies the user-created assets on source servers (for runtime-based deployment) or a repository (for repository-based deployment) that you want todeploy to target servers. To create a project, you assign the project a name and set itsproperties, and then you authorize users to perform the project tasks.

    When you create a project, Deployer automatically creates an HTML home page for theproject. You can modify this page to contain instructions or notes about the project thatyou want users to view. For example, you might want to list the target servers for theusers who will perform the mapping task, or you might want to provide instructions forusers who will test the deployed solution.

    Deployment SetsYou identify the assets to include in the project using deployment sets. Each deploymentset identies the user-created assets you want to deploy from one type of source serveror repository to a target server.

  • MEven Header

    webMethods Deployer Users Guide Version 9.6 20

    A single project can include deployment sets with assets from dierent types ofwebMethods applications. For example, a single project can include Integration Serverdeployment sets and ProcessModel deployment sets.

    Note: A project can contain deployment sets whose assets were selected from only one ofthe following:

    Source webMethods runtime types (for runtime-based deployment)A composite in a repository (for repository-based deployment)

    A project cannot contain both types of deployment sets.

    Unresolved DependenciesIf assets in your deployment set depend on assets that are not part of the deploymentset, Deployer identies these missing assets as unresolved dependencies. For example, ifyou add a trigger to an Integration Server deployment set, but do not add the servicethat is invoked by the trigger, Deployer identies the missing service as an unresolveddependency. Deployer enables you to resolve unresolved dependencies.

    Target ServersTo control to which targets assets are deployed, you dene target servers. You denetarget servers according to the kind of assets you want to deploy. For example, if youwanted to deploy Integration Server assets to one set of target Integration Servers, youcould dene a single deployment set that identies those assets.

    To deploy some Integration Server assets to one set of target Integration Servers andother Integration Server assets to a second set of target Integration Servers, you mustdene two dierent deployment sets.

  • MOdd Header

    webMethods Deployer Users Guide Version 9.6 21

    Deletion SetsDeployment projects that contain deployment sets whose assets were selected fromsource webMethods servers or repositories can also contain a deletion set for each targetserver. A deletion set lets you specify user-created assets to delete from the targetserver before you deploy the assets in the project's deployment sets. You can also exportdeletion set denitions from one project and import them into another.

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

    Deploying ProjectsTo deploy a project, you rst create a deployment candidate, which is a combination of adeployment set and a deployment map. For runtime-based deployment projects, thedeployment candidate also includes the project build. Deployer does the following whenyou deploy the project:

  • MEven Header

    webMethods Deployer Users Guide Version 9.6 22

    For projects that include deletion sets, Deployer deletes the identied assets from thetarget servers.

    Copies the contents of each deployment set in the deployment candidate's project tothe target servers identied in the deployment candidate's deployment map.

    Creates a deployment report that lists all actions that occurred during deployment.

    For an IS & TN deployment set for which you specied substitute congurationvalues, Deployer substitutes those values during deployment.

    Checkpoint and Roll BackIf a deployment to a target server fails and the target environment is in an inconsistentstate, or a deployment is successful but the deployed assets are not working as expected,you can use Deployers roll back feature to undo the deployment.

    For deployment sets, you create a checkpoint to which you want to roll back the targetserver before you deploy. The checkpoint contains a copy of the assets on the targetserver 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 setsadded assets to the target servers, the roll back removes them.

    You can set Deployer to automatically create a checkpoint and roll back deployment setswhen deployment fails. For deletion sets, Deployer automatically creates the checkpointfor the target server. If deployment fails, Deployer automatically rolls back the targetserver.

    For more information about seing project checkpoints and roll back seings, see "Seing General Deployment Defaults" on page 77.

    Transactional DeploymentFor repository-based deployment, you can deploy assets and composites usingtransactional deployment. When transactional deployment is enabled, Deployerautomatically creates the checkpoint for the target server when you deploy thedeployment set. If deployment fails, Deployer automatically rolls back all of the targetservers to the state they were in when Deployer created the checkpoint. For moreinformation about seing transactional deployment, see " Creating a Project" on page83.

    Concurrent and Sequential DeploymentDeployer supports both sequential and concurrent asset deployment.

    In a concurrent deployment, Deployer uses the host Integration Server thread pool tocreate a separate thread in order to deploy the assets to all target servers simultaneously.This is the default seing. You should congure the minimum and maximum threads inthe pool to accommodate your system. For more information about seing the minimum

  • MOdd Header

    webMethods Deployer Users Guide Version 9.6 23

    and maximum thread pools, see webMethods Integration Server Administrators Guide.Deployer writes records to the Audit Log to indicate that the main deployment threadhas created new deployment threads for the specic target server. This allows you totrack which thread belongs to each deployment request.

    In a sequential deployment, Deployer deploys the assets to all target servers one by onein the order that the targets were added to the deployment map. If the project is not setto use concurrent deployment, Deployer deploys assets sequentially.

    You can set concurrent deployment for all projects in the system when you set thedefault seings for Deployer as described in " Seing General Deployment Defaults"on page 77. If the default seing is set to sequential deployment and you want touse concurrent deployment for a specic project (or vice versa), you can override thedefault seing for that project during creation. For more information about overridingthe default seings for a project, see " Creating a Project" on page 83.

    Deployer InterfacesDeployer oers a graphical user interface (GUI), a command line interface, and aProject Automator tool. Using the command line interface you can enter commands ata command prompt or you can create scripts that execute commands automatically.The Project Automator allows you to specify project information in an XML le forautomated project creation.

    The table below shows which tasks you can perform from each type of Deployerinterface.

    Task GUI CommandLine

    ProjectAutomator

    Add and view instructions or notes aboutprojects.

    X

    Authorize groups to work on projects. X

    Congure communication between Deployerand the source servers or repositories andtarget servers.

    X X

    Create project builds. X X X

    Create projects. X X

    Dene deployment and deletion sets. X X

  • MEven Header

    webMethods Deployer Users Guide Version 9.6 24

    Task GUI CommandLine

    ProjectAutomator

    Delete projects and set default properties forprojects

    X X

    Export and import project properties anddeletion set denitions.

    X X

    Generate a checkpoint or roll back targetservers, list and display rollback reports.

    X X

    Generate progress reports. X

    List, create, display, or delete deploymentcandidates; simulate deployments; deploy;list and display simulation and deploymentreports.

    X X

    List, display, export, import, and deletedeployment maps.

    X X

    List, export, and import builds; display buildcontents; list and display build reports.

    X X

    Map deployment and deletion sets to targetservers.

    X X

    Select assets from an ACDL descriptor le X X X

    Automating Project CreationDeployer enables you to automate the following:

    Creation of projects.

    Denition of aliases for source servers and repositories and target servers.

    Creation of deployment and deletion sets.

    Creation of builds, maps, and deployment candidates.

    You provide the necessary specications in an XML le, then run Deployer's ProjectAutomator tool. Optionally, you can export projects created in the GUI to an XML

  • MOdd Header

    webMethods Deployer Users Guide Version 9.6 25

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

    LoggingDeployer writes audit log entries to these logs:

    The Deployer GUI audit log. This log contains information about actions that usersperform through the Deployer GUI, such as creating builds and deploying.

    The Deployer command line audit log. This log contains error messages wrien byDeployer commands executed by users.

    The Deployer Project Automator audit log. This log contains information and errormessages wrien by the Project Automator during execution of an XML le.

    Deployer writes journal entries to the Integration Server server log. The server logcontains information about operations and errors that occur on Integration Server, suchas the starting of Integration Server subsystems and the loading of Integration Serverpackages such as Deployer. For complete information about the Integration Serverserver log, see webMethods Integration Server Administrators Guide.

  • MEven Header

    webMethods Deployer Users Guide Version 9.6 26

  • MOdd Header

    webMethods Deployer Users Guide Version 9.6 27

    2 Getting Started Getting Started with Runtime-Based Deployment ....................................................................... 28

    Getting Started with Repository-Based Deployment .................................................................... 29

  • MEven Header

    webMethods Deployer Users Guide Version 9.6 28

    Getting Started with Runtime-Based DeploymentYou will perform the following general tasks to deploy assets in a runtime-baseddeployment scenario:

    Task See...

    Start Deployer. "Starting Deployer " on page 54

    Set up connections to source andtarget servers.

    "Connecting to Integration Servers andTrading Networks Servers" on page 56

    "Connecting to Optimize Servers" on page57

    "Connecting to My webMethods Servers" onpage 58

    "Connecting to Event Servers" on page 60

    "Connect to Broker Servers" on page 61

    "Connect to BPM Process Model Servers" onpage 63

    "Connect to Business Rules Runtimes" on page66

    " Creating Target Groups" on page 70

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

    Dene deployment set. "Dening a Deployment Set" on page 93

    Add assets to the deploymentset.

    "Adding Assets for Runtime-BasedDeployment" on page 99

    Dene deletion set (optional). "Dening a Deletion Set" on page 125

    Build the project. "Building a Runtime-Based DeploymentProject" on page 135

    Map assets to target servers andtarget groups.

    "Mapping a Project" on page 139

  • MOdd Header

    webMethods Deployer Users Guide Version 9.6 29

    Task See...

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

    Getting Started with Repository-Based DeploymentYou will perform the following general tasks to deploy assets in a repository-baseddeployment scenario:

    Task See...

    Build composites on yourrepository.

    "Building Composites for Repository-BasedDeployment" on page 31

    Start Deployer. "Starting Deployer " on page 54

    Set up connections to the sourcerepository and target servers.

    "Connecting to a Repository for Repository-Based Deployment" on page 68

    "Connecting to Integration Servers andTrading Networks Servers" on page 56

    "Connecting to Optimize Servers" on page57

    "Connecting to My webMethods Servers" onpage 58

    "Connecting to Event Servers" on page 60

    "Connect to Broker Servers" on page 61

    "Connect to BPM Process Model Servers" onpage 63

    "Connect to Business Rules Runtimes" on page66

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

    Dene a deployment anddeletion sets.

    "Dening a Deployment Set" on page 93

    "Dening a Deletion Set" on page 125

    Add assets to the deploymentset.

    "Adding Assets for Repository-BasedDeployment" on page 115

  • MEven Header

    webMethods Deployer Users Guide Version 9.6 30

    Task See...

    Map assets to target servers ortarget groups.

    "Mapping a Project" on page 139

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

  • MOdd Header

    webMethods Deployer Users Guide Version 9.6 31

    3 Building Composites for Repository-BasedDeployment

    Overview ....................................................................................................................................... 32

    Before Building Composites ......................................................................................................... 32

    Setting the Properties for the Build ............................................................................................. 34

    Running the Build Script and Rebuilding the Index ..................................................................... 42

    Preparing BPM Assets for Repository-Based Deployment .......................................................... 47

    Next Steps .................................................................................................................................... 51

  • MEven Header

    webMethods Deployer Users Guide Version 9.6 32

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

    Stage 1 Create the assets and export or copy them from the source developmentplatform to the source directory.

    Developers create the assets on the development environment andexport or copy them to a le system or version control system (VCS)from which the build process can obtain them. This guide assumesthat the assets have already been created. For more information aboutcreating and exporting assets, see the documentation for the applicablewebMethods runtime. For more information about adding assets to thesource directory, see "Adding Assets to the Source Directory" on page33.

    Stage 2 Install the webMethods Asset Build Environment on the build machine.

    The Asset Build Environment supplies the scripts and librariesnecessary to build assets into composites that Deployer then deploys totarget servers and groups. For more information about the Asset BuildEnvironment, see "Installing the Asset Build Environment" on page33. For information about installing the Asset Build Environment,see Installing webMethods and Intelligent Business Operations Products.

    Stage 3 Specify the parameters of the build.

    Modify the build.properties le to dene the parameters used by themaster build script to build composites. For more information, see"Seing the Properties for the Build" on page 34.

    Stage 4 Run the master build script.

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

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

    Before Building CompositesBuilding composites for repository-based deployment requires that you do thefollowing:

  • MOdd Header

    webMethods Deployer Users Guide Version 9.6 33

    Create the assets you want to deploy and add them to a le system or VCS that isaccessible to build scripts.

    Install the webMethods Asset Build Environment version 8.2 SP1 or greater.

    Adding Assets to the Source DirectoryIn repository-based deployment scenarios, you create assets with a webMethodsruntime and store them in a le system or version control system (VCS). The directory ofthe le system or VCS in which you store the assets is the source directory.

    Most webMethods runtimes supply a means of exporting or saving the assets youcreate to the source directory. Other runtimes require you to manually copy the assetsfrom one directory to another. For example, you can use My webMethods Server toexport Broker assets to the source directory. However, to add mostIntegration Serveradministrative assets to the source directory, you must manually copy or check in theIntegration Server_directory/cong folder to the source directory. For a complete list ofles and directories to copy or check in to the source directory for Integration Serveradministrative assets, see "Adding Administrative Assets to the Source Directory" onpage 246.

    When specifying the properties for the build.properties le, you use the build.source.dirparameter to specify the full path of each source directory. Then, when you run thebuild script, it packages the contents of the source directories into the correct compositele format for deploying those assets to target servers. For more information aboutspecifying parameters for the build.properties le, see "Seing the Properties for theBuild" on page 34. For more information about the composite les created the buildscript, see "Running the Build Script and Rebuilding the Index" on page 42.

    Keep the following points in mind while adding assets to the source directory:

    The source directory must be accessible to the build script.

    If the source directory is a le system on a VCS, you must supply the propercredentials for accessing and checking out the composite les from the sourcedirectory. For more information about supplying the VCS checkout properties, see"Seing VCS Checkout Properties" on page 40.

    Installing the Asset Build EnvironmentTo build composites for deployment, you must rst install the webMethods Asset BuildEnvironment. The Asset Build Environment installs the build script and build propertiesle that you use to build deployment composites for webMethods runtimes.

    For testing purposes, you can install the Asset Build Environment on the computer thatyou use to create assets in the development environment. For daily or continuous builds,you should install the Asset Build Environment on a separate computer, known as abuild machine. The build machine is the computer on which you build the assets intocomponents that Deployer can deploy to target servers.

  • MEven Header

    webMethods Deployer Users Guide Version 9.6 34

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

    Setting the Properties for the BuildThe Asset Build Environment installs the following les that you can customize toprovide the build script the properties it needs to build composites for repository-baseddeployment:

    build.properties. Set the properties in this le before running the build script. Formore information about seing the properties in build.properties, see "Seing BuildProperties" on page 34.

    build-number.xml. The build script uses this le to automatically version the assetsincluded in the build incrementally. You can customize the le to generate the buildnumber as needed (example, to match the VCS revision number).

    build-source-checkout.xml. If the build source directory is a version control system, youcan use this le as a template to create an Ant task that checks out sources from aversion control system (VCS). For information about seing the properties in build-source-checkout.xml, see "Seing VCS Checkout Properties" on page 40.

    build.bat or build.sh. When building assets that are large in number or size, you shouldincrease the Java memory available to the build process. For more information aboutadjusting Java memory seings, see "Changing JVM Memory Seings" on page41.

    Important: When you overinstall later releases of the Asset Build Environment, yourchanges to these les are retained. You do not need to move the les unless youuninstall and reinstall the Asset Build Environment.

    The Software AG Installer installs all three les in the following location as part of theAsset Build Environment:

    Software AG_directory\common\AssetBuildEnvironment\master_build

    Setting Build PropertiesThe master properties le, build.properties, controls the build seings for the repository-based build process. It contains a set of switches that enable and disable the build tasksfor the corresponding runtime types in the build.

    To set the build properties

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

    2. Set the following properties:

  • MOdd Header

    webMethods Deployer Users Guide Version 9.6 35

    Property Definition

    sag.install.dir Path of the directory where Software AG productsare installed.

    Root directory where the build script will place theoutput (composites and descriptors) of the build.Use a forward slash "/" as path separator.

    The build script creates a subdirectory with thecurrent build number in this directory, as well as asubdirectory for the composites and descriptors foreach runtime type included in the build as follows:

    If your build contains assetsfrom...

    The build scriptcreates the followingsubdirectory...

    BPM ProcessDevelopment

    BPM

    Broker Broker

    Business Rules Rules

    EDA EDA

    Integration Server IS

    My webMethods Server MWS

    Optimize Optimize

    Trading Networks TN

    build.output.dir

    Universal Messaging UniversalMessaging

    build.source.dir Separated list of the full paths of the sourcedirectories that contain assets to build. Alldirectories in the list must contain projectdirectories (IS packages, CAF projects, TN exports,etc.) as direct children. Use ; as the delimiter formore than one folder. Use a forward slash / aspath separator.

  • MEven Header

    webMethods Deployer Users Guide Version 9.6 36

    Property Definition

    For example, if you want to include IntegrationServer and Trading Networks assets, you wouldenter the following:

    /root_path /project_name /IS;/root_path /project_name /TN

    Where root_path is the root directory of the source,project_name /IS is the directory holding IntegrationServer assets, and project_name /TN is the directoryholding Trading Networks assets.

    build.source.project.dir Separated list of project folders containing theassets that the build script will build. All foldersin the list must contain project folders only. Thisproperty is dierent from the build.source.dir asit denes individual project directories

    Use ; as delimiter for more than one folder. Use aforward slash / as path separator.

    Note: If you are building an Integration Server projectand specify a value for this property, you must alsospecify a value for is.acdl.cong.dir.

    enable.archive Species whether the build script archives theoutput directory. If you set this eld to true, youmust provide a value for build.archive.dir.

    build.archive.dir Required if enable.archive is set to true. Locationof the archive directory for the output. The buildscript creates a new subdirectory with the name ofthe build number. It then moves the contents of theoutput directory (set in build.output.dir) to thisnewly created directory.

    build.version Version number of the current build. The buildscript appends an automatically-generatedincremental build number to this property to get thenal build number.

    For example, if you set this property to 8.2, thegenerated build number for the rst build is 8.2.1and the build number for the next build is 8.2.2.

  • MOdd Header

    webMethods Deployer Users Guide Version 9.6 37

    Property Definition

    enable.checkout Species whether the build script should check outthe source les from a VCS.

    To enable the check out task, set to true. The buildscript invokes the default target you set in build-source-checkout.xml.

    To disable check out task, set to false.

    Note: If this property is set to true, you must congurethe properties in build-source-checkout.xml tosynchronize with your VCS system. For moreinformation, see "Seing VCS Checkout Properties"on page 40.

    Species the runtime types for which the buildscript should build composites. Each runtime typehas a separate property. Set to:

    true to build composites for the specied runtimetype.

    false to exclude the specied runtime type.

    Set this property... To build composites forassets of this type...

    enable.build.IS Integration Server

    enable.build.MWS My webMethodsServer

    enable.build.BPM BPM ProcessDevelopment

    enable.build.TN Trading Networks

    enable.build.Optimize Optimize

    enable.build.Broker Broker

    enable.build.EDA EDA

    enable.build

    enable.build.RULES Business rules

  • MEven Header

    webMethods Deployer Users Guide Version 9.6 38

    Property Definition

    enable.build.

    UniversalMessaging

    Universal Messaging

    build.log.enable Species whether to enable logging for the build.Set to:

    true to enable logging.

    false to disable logging.

    build.log.leName Name of the log le. The default le name isbuild.log. The build script creates the log le in thefollowing directory:

    Software AG_directory\common\AssetBuildEnvironment\master_build

    build.logLevel Logging level to include in the log. Possible valuesare:

    Specify... To record...

    debug Debug, informational,warning, error, andfatal messages.

    error Error and fatalmessages.

    info (default) Informational,warning, error, andfatal messages.

    verbose No possible valuesdened for log level.

    warn Warning, error, andfatal messages.

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

    Note: See "Preparing BPM Assets for Repository-Based Deployment" on page 47for BPM project-level behaviors and instructions.

  • MOdd Header

    webMethods Deployer Users Guide Version 9.6 39

    Property Definition

    bpm.acdl.model.ids Optional. Semicolon-separated list of process IDs(that is, a concatenation of process project nameand process model le name).

    If the process does not exist in the source directoryor one of its subdirectories, the value is ignored.If left empty, all process model IDs are included.This property can be used with or without thebpm.acdl.model.version property.

    bpm.acdl.bam.model.ids Optional. Semicolon-separated list of BAM processmodel IDs to add to the composite. BAM processmodels are tracking only and do not declare anydependencies. For example: testProcessProject/testProcessModel;testProcessProject2/

    testProcessModel2. If the process does not exist inthe source directory or a child directory of it, thevalue is ignored. If left empty, no process modelIDs are included. All process models are assumedto be BPM processes and will generate thestandard process dependencies. This property canbe used with or without the bpm.acdl.model.ids orbpm.acdl.model.version properties.

    bpm.acdl.model.version Optional. Version number of the process modelsto include in the build. Enter a single integer value(example, 1 ).

    If this value is set, the build script includes onlythose process models in the source directory orone of its subdirectories that match the versionnumber. If left empty, the build script includesprocess models of all versions. You can use thisproperty with or without the bpm.acdl.model.idsproperty.

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

    Property Definition

    optimize.acdl.validation Species whether to switch the XSD validation ofthe generated composite and descriptor les. Setto:

    On to use XSD validation.

  • MEven Header

    webMethods Deployer Users Guide Version 9.6 40

    Property Definition

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

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

    Property Definition

    RULES.skip.on.validation.warning Species whether the build script shouldcreate a rule project archive and compositewhen the rule project issues validationwarnings. Set to:

    true to create a project archive andcomposite.

    false to turn o project archive andcomposite creation. This is the default.

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

    Property Definition

    is.acdl.cong.dir Species the full path of the Integration Servercong directory. For example:

    Software AG_directory\IntegrationServer\cong

    Important: If you set this property, you must alsospecify a value for build.source.project.dir. If you donot specify a value for build.source.project.dir, thebuild script ignores this value.

    7. Save and close the file.

    Setting VCS Checkout PropertiesIf you set enable.checkout in build.properties to true, congure the properties in build-source-checkout.xml to check out the assets from a VCS.

    To set VCS checkout properties

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

  • MOdd Header

    webMethods Deployer Users Guide Version 9.6 41

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

    Note: The build-source-checkout.xml template is specic to an SVN version controlsystem. You might have to add more properties to make the le work with otherVCS types.

    Property Definition

    svn.jars.dir Location of the open source SvnAnt libraries (hp://subclipse.tigris.org/svnant.html). These libraries arerequired by the checkout Ant task.

    To use a VCS other than SVN, modify this parameteraccordingly.

    svn.user User name of the SVN.

    svn.password Password of the SVN.

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

    build.checkout.dir The root directory from which the build script willcheck out the asset sources. This property can pointto only one directory; therefore, it should be the rootdirectory containing all projects that will be built.

    For example, if your solution contains an IntegrationServer project, your full project directory might be /root/project/builds/webM/IS. In this case, you would notinclude /IS in the path. Instead, you would enter /root/project/src/webM/.

    3. Save and close the file.

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

    Changing JVM Memory SettingsYou can adjust the JVM memory seings available to the build. This is helpful whenbuilding a large number of assets or assets that contain a large amount of data.

    To change the JVM memory settings

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

  • MEven Header

    webMethods Deployer Users Guide Version 9.6 42

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

    Windows Software AG_directory\common\AssetBuildEnvironment\bin\build.bat

    UNIX Software AG_directory/common/AssetBuildEnvironment/bin/build.sh

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

    JAVA_MAX_PERM_SIZE

    3. Save and close the file.

    Running the Build Script and Rebuilding the IndexThe build script uses the properties you specied for the build.properties le in"Seing the Properties for the Build" on page 34 to build the assets created in thedevelopment environment into composites. Specically, the build script:

    Checks out the asset sources. The build script can use a VCS to obtain the asset sourcesto build into composites. If you use a VCS to store your assets, you must set theenable.checkout property in build.properties to true and set the properties in build-source-checkout.xml to access the VCS. For more information, see "Seing BuildProperties" on page 34 and "Seing VCS Checkout Properties" on page 40.

    Creates and indexes the repository. The build script creates the repository in thespecied structure. This is the source from which Deployer selects the assets fordeployment. For more information about dening a repository in Deployer, see"Connecting to a Repository for Repository-Based Deployment" on page 68.

    Versions the assets. The build script uses the build-number.xml le to automaticallyversion the assets included in the build in the format version_number .build_number .

    Builds the composites and descriptors in the repository. The build script generates thefollowing les for each runtime type in the build:

    ACDL descriptor le in the format project_name .acdl

    This is the descriptor le that contains the metadata that lists the assets anddependencies contained in the composite.

    A compressed composite le that contains the denitions of the assets andtheir dependencies for deployment. The composite le is in the formatproject_name .composite_le_type where:

  • MOdd Header

    webMethods Deployer Users Guide Version 9.6 43

    For this runtimetype...

    project_name is the... composite_file_typeis...

    BPM processmodel

    Process ID with / replacedby _. For more informationabout process models, seewebMethods BPM ProcessDevelopment Help.

    .process

    Broker Name of the le youexported using MywebMethods Serverprexed with Broker_or Provider_ dependingon whether you exportedBroker assets or JNDI assets,respectively.

    When you export Brokerassets (document, client, orclient group), Broker createsan ADL le for the Brokerassets.

    Note: If you export assetsfrom webMethods Broker8.2 SP2 or earlier, you mustmigrate the assets from XMLformat to ADL format foruse in Deployer. For moreinformation about migratingBroker assets from XML toADL format, see UpgradingwebMethods and IntelligentBusiness Operations Products.

    When you export JMSdestinations (JMS queuesand JMS topics) created by awebMethods JNDI provider,Broker creates a separateXML le for a JNDI context.

    For more information aboutexporting Broker assets, seeAdministering webMethodsBroker.

    .adl (Broker assets)

    .xml (JNDI assets)

  • MEven Header

    webMethods Deployer Users Guide Version 9.6 44

    For this runtimetype...

    project_name is the... composite_file_typeis...

    Business Rules Name of the rules project. .jar

    EDA Name of the Event Typesproject.

    .zip (Event Typeassets)

    IntegrationServer

    For package, adapterruntime, and .Net assets,this is the name of theIntegration Server package.For more information aboutadding package assets tothe source directory forinclusion in the build, see"Adding Package Assetsto the Source Directory"on page 282. Formore information aboutadding adapter runtimeor .Net assets to the sourcedirectory for inclusion inthe build, see "AddingAdapter Runtime and .NETService Assets to the SourceDirectory" on page 288.

    For administrative assets,this is isconguration. Formore information aboutadding administrativeassets to the sourcedirectory for inclusion inthe build, see "A