Web Methods Deployer User's Guide

(1)

webMethods Deployer

User’s Guide

Version 7.1.1

February 2008

(2)

This document applies to webMethods Deployer Version 7.1.1 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 Software AG 2008. Copyright & Docu‐ ment ID

(3)

About This Guide

This guide explains how to use webMethods Deployer. Deployer is a tool you use to deploy assets that reside on source webMethods servers to target webMethods servers. You can deploy assets from the products listed below.

Document Conventions

Product Versions Blaze Advisor 6.5.x webMethods Broker 7.1.x webMethods Designer 7.1.x webMethods Integration Server 7.1.x My webMethods Server 7.1.x webMethods Optimize 7.1.x webMethods Trading Networks 7.1.x Convention Description Bold Identifies elements on a screen. Italic Identifies variable information that you must supply or change based on your specific situation or environment. Identifies terms the first time they are defined in text. Also identifies service input and output variables.

Narrow font Identifies storage locations for services on the webMethods

Integration Server using the convention folder.subfolder:service. Typewriter font Identifies characters and values that you must type exactly or messages that the system displays on the console. UPPERCASE Identifies keyboard keys. Keys that you must press simultaneously are joined with the “+” symbol. \ Directory paths use the “\” directory delimiter unless the subject is UNIX‐specific. [ ] Optional keywords or values are enclosed in [ ]. Do not type the [ ] symbols in your own code.

(8)

About This Guide

Additional Information

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. Starting with 7.0, you have the option of downloading the

documentation during product installation to a single directory called

“_documentation,” located by default under the webMethods installation directory. In addition, you can find documentation for all webMethods products on the

(9)

1

Concepts

webMethods Deployer . . . 10

Deployment Steps . . . 10

Access to Target Environments . . . . 14

Deployer Interfaces . . . 14

(10)

1 Concepts

webMethods Deployer

webMethods Deployer is a tool you use to deploy 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.

Deployment Steps

The deployment process involves these steps: 1 Create a deployment project by assigning the project a name, setting the project’s properties, and authorizing users to work on the project. 2 Define the project by identifying its contents. 3 Create a project build. 4 Map the contents of the project build to target servers. 5 Deploy the project to the target servers.

Create the Project

A deployment project identifies the 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.

Define the Project

When you define a project, you create project deployment sets. Each deployment set identifies assets from one type of source servers (for example, My webMethods Servers) that you want to deploy as a set to target servers of the same type. You can define these types of deployment sets within a single project:

(11)

1 Concepts The assets you include in a deployment set depend on the target servers to which you want to deploy the assets. For example, if you want to deploy a set of Integration Server assets to the same target servers, you can define a single deployment set that identifies those assets. If you want to deploy some Integration Server assets to one set of target servers and other Integration Server assets to a different set of target servers, you would have to define two different deployment sets.

Deployment Set Contents

Broker Document types and client groups from multiple source Brokers. ProcessModel Process models from one source ProcessModel server. Note: If you want to deploy process models from multiple ProcessModel servers, you must define a deployment set for each ProcessModel server. IS & TN Integration Server administrative assets such as ports, users, groups, and user‐created scheduled tasks, packages, and Web Service Descriptors. Integration Server packages. Trading Networks assets such as processing rules, document types, trading partner agreements, and partner profiles and security data from multiple source Integration Servers. Blaze Advisor rules Files from multiple webMethods installations on machines that host an Integration Server. MWS User‐created assets such as pages, portlets, CAF and task applications, rules, users, groups, roles, and directory services from multiple My webMethods Servers. Optimize Process configuration such as process and step timeouts and process extensions, and other analysis KPI metadata from multiple Optimize servers. deployment set project target servers

(12)

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

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 re‐create the build to bring it up to date.

Map a 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 re‐create 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 deployment sets project target servers

(13)

1 Concepts

scheduled tasks, ports, adapter connections, adapter notifications, and extended settings. You can substitute different configuration values for different target servers.

Deploy the Project

To deploy a project, you first create a deployment candidate, which is the combination of a project build and a deployment map. You then generate a simulation report that scans the source and target servers and alerts you to some potential problems before you deploy. You can address problems and re‐generate the simulation reports until all problems are resolved. When you are ready, you deploy the project. Deployer copies the contents of each deployment set in the specified project build to the target servers identified in the specified 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.

Checkpoint and Roll Back

If a deployment 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. To use the roll back feature, you must create a checkpoint to which you want to roll back the target servers before you deploy a deployment candidate. A checkpoint contains a copy of the assets on the target servers that will be replaced by the assets in the deployment candidate. The roll back feature rolls back the target servers to the checkpoint. If the deployment candidate added assets to the target servers, the roll back removes them. You can choose automatic or manual checkpoint, roll back, or both. If you choose automatic checkpoint or roll back, Deployer automatically generates a checkpoint as the first step when you actually deploy a project. If you choose automatic roll back and the deployment fails, Deployer automatically rolls back the target servers to the checkpoint. If you choose manual checkpoint, you can generate a checkpoint at any time before you deploy. If you take multiple checkpoints for a deployment candidate, only the latest is retained. If you choose manual roll back, you can roll back the target servers manually any time after a deployment.

(14)

1 Concepts

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

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 GUI Command Line

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 project properties Import project properties Define deployment sets Map deployment sets to target servers List, display, export, import, and delete maps Create project builds List, export, and import builds; display build contents; list and display build reports

(15)

1 Concepts

Logging

Deployer writes log 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. You control server logging using the Integration Server Administrator; you can activate or deactivate logging and specify the amount of detail to write to the log. For instructions, see the webMethods Logging Guide. Deployer logs errors that occur during command line operations in the Deployer command line log file. For more information about the log file, see the “Error Handling and Logging” on page 77. 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 Task GUI Command Line

(16)

(17)

I

Using the Deployer Graphical User Interface

Starting and Configuring Communication with Deployer . . . 19

Creating a Project . . . 25

Defining a Broker, ProcessModel, MWS, or Optimize Deployment Set . . . 33

Defining an IS & TN Deployment Set . . . 39

Building, Mapping, and Deploying a Project . . . 53

(18)

(19)

2

Starting and Configuring Communication with

Deployer

Overview . . . 20

Starting Deployer . . . 20

Configuring Communication with Brokers . . . 20

Configuring Communication with ProcessModel Servers . . . 21

Configuring Communication with Integration Servers . . . 22

Configuring Communication with My webMethods Servers . . . 23

Configuring Communication with Optimize Servers . . . 24

(20)

2 Starting and Configuring Communication with Deployer

Overview

Some servers require a special component to communicate with Deployer; you must install the appropriate communications component on each server. For most servers, you must configure communication between Deployer and the server.

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.

Configuring Communication with Brokers

1 In Deployer, go to the Servers Broker page. For every source and target Broker, click

Configure Broker Server and complete these fields:

Servers Communications Component

Brokers Built into Deployer ProcessModel servers that run process steps WmDeployerResource and WmDesigner packages Integration Servers WmDeployerResource package My webMethods Servers Built into My webMethods Server Optimize servers Built into Optimize servers (that is, Analytic Engines) Important! Deployer cannot use SSL to connect to Brokers.

To configure communication with source and target Brokers:

Box Entry

Name Name to assign to the Broker.

Host Host name or IP address of the Broker.

(21)

2 Click Configure. To test the connection, click .

Configuring Communication with ProcessModel Servers

1 In Deployer, go to the Servers ProcessModel page. For every source and target

ProcessModel server, click Configure ProcessModel Server and complete these fields:

Click Configure. To test the connection, click . 2 In Designer, a logical‐to‐physical 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 Define the physical servers in the mapping as remote servers. For instructions, see the webMethods Integration Server Administrator’s Guide.

b Go to the Packages Management page and click for the WmDesigner package.

c Click Add Logical Server and complete these fields:

Client Group Client group to use to access the Broker. For target Brokers, type

admin.

Broker Name Name of the Broker.

To configure communication with ProcessModel servers:

Box Entry Name Name to assign to the server. Host Host name or IP address of the server. Port Port for the server. User User name for a user account with Administrator authority that Deployer can use to access the server. Password Password that is associated with the user name. Use SSL Whether to encrypt communication between Deployer and the server. You can only use SSL if the server is configured to use SSL. When defining the HTTPS port that the server uses for SSL, configure the port so that it does not request client certificates. For instructions on defining the HTTPS port, see the webMethods Integration Server Administrator’s Guide. Box Entry

(22)

d Click Add Logical Server.

e Repeat these steps to duplicate the rest of the mapping.

f Repeat these steps for every process model to deploy.

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

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

Configuring Communication with 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 instructions on defining remote servers, 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, then click Install. Box Entry Name Name of a logical server in the mapping for the process model. Type Integration Server. Physical Server Physical server to which the logical server is mapped.

(23)

Configuring Communication with My webMethods Servers

1 In Deployer, go to the Servers MWS page. For every source and target My

webMethods Server, click Configure MWS Server and complete these fields:

To configure communication with My webMethods Servers:

Box Entry Name Name to assign to the server. Host Host name or IP address of the server. Port Port for the server. User User name for a user account with Administrator authority that Deployer can use to access the server. Password Password that is associated with the user name.

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

Include security

dependencies When resolving dependencies for an asset, whether to include security realms that contain that asset, as well as user/group/role references in the assetʹs security ACLs.

Root folder

aliases My webMethods Server aliases to use as root folders when selecting pages to deploy. Separate the folders using commas.

Maximum folder

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

Enable additional

MWS logging 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 folder

depth Maximum number of My webMethods Server folder levels to display when you are defining and choosing assets to include in an MWS deployment set. Use SSL Whether to encrypt the communication between Deployer and the server. You can only use SSL if My webMethods Server is configured to use SSL. When using the My webMethods Server Configurator to define the HTTPS port that the server uses for SSL, configure the port so that it does not request client certificates. For instructions, see the My webMethods Server Administrator’s Guide.

(24)

Configuring Communication with Optimize Servers

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

Configuring Target Groups

1 In Deployer, go to the Target Group server page.

2 Click Configure server Target Groups.

3 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. 4 In the Description box, type a description for the target group. The description length has no limit and can include any characters. 5 Click Configure.

6 In the Available Servers list, select the servers to add to the target group, and then click

Add.

7 Click Save.

8 To test the connection between Deployer and the target group, click .

To configure communication with Optimize servers:

Box Entry Name Name to assign to the server. Host Host name or IP address of the server. Port Port for the server. Use SSL Whether to encrypt the communication between Deployer and the Optimize server. You can only use SSL if the server is configured to use SSL. When defining the HTTPS port that the server uses for SSL, configure the port so that it does not request client certificates. For instructions on defining the HTTPS port, see the webMethods Integration Server Administrator’s Guide.

(25)

3

Creating a Project

Setting Default Properties for Projects . . . 26 Creating a Project . . . 29 Authorizing Groups to Perform Tasks on a Project . . . 31 Adding and Viewing Instructions or Notes About a Project . . . 31

(26)

3 Creating a Project

Setting Default Properties for Projects

Deployer uses default properties for all projects. You can change these properties, and you can override many of those properties for individual projects if necessary. To set these properties, click Settings in the Deployer menu. When you are done, click Save.

Setting the Default for Dependency Checking

Under the Dependency Checking Defaults area on the Settings page, indicate how to check dependencies in deployment sets.

Setting the Default Properties for Deployment

Under the General Deployment Defaults area on the Settings page, indicate whether the options below should be set manually by you or automatically by Deployer. Option Description Automatic Tells Deployer to automatically check dependencies regularly as you modify the project and progress through the different phases of deployment. Reduced Tells Deployer to automatically check dependencies when you create a project build and when you deploy. You can trigger additional dependency checking at different steps yourself. Manual You trigger dependency checking at different steps yourself. Option Entry Checkpoint

Creation To have Deployer automatically create a checkpoint for a deployment candidate before it is deployed, click Automatic. If you only want to

generate checkpoints when you choose to (see “Generating a

Checkpoint” on page 60), click Manual.

Roll back

on Error To have Deployer automatically roll back a deployment candidate after a failed deployment, click Automatic. If you only want to roll back the

project when you choose to (see “Rolling Back the Target Servers” on page 62), click Manual. Cluster Support To deploy to each clustered Integration Server yourself, click Manual. To deploy to a single Integration Server in a cluster and have that Integration Server automatically propagate the deployment to the other Integration Servers in the cluster, click Automatic. For instructions on

setting up this feature, see Chapter 7, “Deploying to Clustered

(27)

Setting Default Properties for Integration Server and Trading

Networks Projects

The default properties for Integration Server and Trading Networks projects apply to all assets except Integration Server packages. You specify package properties for each

package individually, as described in “Setting the Package Properties” on page 45.

1 Under the Suspend During Deployment area, 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; polling notifications; enables the disabled ports, and stops preventing the scheduled tasks.

To set default properties for Integration Server and Trading Networks projects:

Asset Description Click...

Triggers Allow all running trigger operations to complete, then suspend all trigger execution and document retrieval on the target Integration Servers. 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. None This option is obsolete. Selected Ports Whether to disable ports on the target Integration Servers that match ports you are trying to deploy. Scheduled

Tasks 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 Not suspend adapter listeners or polling notifications. None Choose individual adapter listeners and polling notifications to suspend from the packages in the project. You choose the notifications when you set package properties. For instructions, see “Setting the Package Properties” on page 45. Selected

(28)

2 Under the Overwrite Existing area, indicate how Deployer should proceed when it finds

that assets you are trying to deploy already exist on target Integration Servers.

3 Under Activate After Deployment, 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.

4 Click Save.

For this option... Indicate whether Deployer should...

TN Rules Overwrite existing Trading Networks processing rules or append the processing rules you are trying to deploy to the ones that already exist.

ACL Maps Deploy the mapping of ACLs to services for any services you choose to deploy. You would choose to deploy ACL maps if you want to assign the same ACLs to the deployed services on the target Integration Server that you assigned to the source services on the source Integration Servers.

Other Non-Package

Items Overwrite existing assets. This option applies to all assets except the following:

Trading Networks processing rules (see TN Rules, above). Integration Server ACL maps (see ACL Maps, above). Integration Server packages. You specify the overwrite option for Integration Server packages on a package‐by‐ package basis, as described in “Setting the Package Properties” on page 45. Note: Before you deploy a project, you can find out which assets Deployer will overwrite by generating the simulation report. Note: If you choose to activate ports, and one of the ports you deploy uses the same port number as an existing port on a target Integration Server, Deployer will display a message to that effect and will not activate the port.

(29)

Creating a Project

You can create a project by creating a new, blank project or by copying an existing project and modifying it. 1 On the Projects page, create a project using one of these methods: 5 Review the default properties for projects in the right‐hand pane and override any if necessary, then click Save.

For explanations of the Dependency Checking Options, General Deployment Options, and IS

& TN Deployment Options properties, see “Setting Default Properties for Projects” on page 26.

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.

To create a project:

Create... Steps

New 1 Click Create Project.

2 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. 3 In the Description box, type a description for the project. The description length has no limit and can include any characters. 4 Click Create. From existing 1 Click Copy Project. 2 In the Project to Copy box, click the project to copy.

3 In the New Project Name box, type the name to use for the new

project. The name can be up to 32 characters long and can include any characters that are valid for a file name in your operating system.

(30)

If the project is for My webMethods Server, you can set these properties for the project under the MWS Deployment Options area:

6 Click Save.

For this property... Indicate whether Deployer should... Enable process for

execution Enable webMethods‐executed business process versions for execution after deployment. When a process version is enabled, the Process Engine uses the enabled version when starting new process instances. When a process is disabled, the Process Engine does not use the process version for new process instances. Only one version of a process can be enabled at a time. If there are no enabled process versions, the Process Engine will not start any process instances of the process.

Enable process for

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

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

Subscriptions Deploy subscriptions for My webMethods Server assets you are deploying.

Export Access

Control Lists Deploy ACLs for My webMethods Server assets you are deploying.

Export Principal

Attributes Include attributes contained in attributes providers when exporting users, groups, and roles.

Export Content As

Reference Export a reference to the page content without deploying the content.

Alias Prefix Apply the specified prefix to every automatically generated My webMethods Server alias.

Export Version

History Include all versions of an asset in Portal version control. This applies to the content within a page or folder.

Auto Generate

Aliases Automatically generate an alias on the target My webMethods Server for every My webMethods Server asset that is deployed. If an asset already has one or more aliases, then the aliases are retained when the auto‐generated alias is added.

Export Content

(Documents) Deploy content referenced by portal pages and folders you are deploying (for example, a PDF document that has been published on a portal page you are deploying).

(31)

Authorizing Groups to Perform Tasks on a Project

You authorize users to perform tasks by selecting a task and assigning Integration Server security groups to it. After you authorize certain groups to perform tasks on projects, the users in those groups will see only those projects to which they are authorized when the users display the Projects page. You must have Administrator ACL authorization to create projects and authorize other users to perform tasks in Deployer. Users must have Developer ACL authorization to perform tasks in Deployer. 1 All users you want to authorize to perform certain tasks (by authorizing their groups to perform the tasks) must belong to the Developers security group. You can also create intuitively named groups for use with Deployer (for example, you could create groups named viewProjects, buildProjects, mapProjects, deployProjects, and defineProjects). For instructions on assigning users to security groups and creating security groups, see the webMethods Integration Server Administrator’s Guide. 2 In Deployer, go to the Projects page. 3 Locate the project to which to authorize users. In the Authorize column for the project, click . 4 In the Select Authorization list, click a task to which to authorize users.

5 The Not Specified box lists all groups defined on the local Integration Server. Using the

arrow buttons, move each group to assign to the selected task into the Allowed box. Move each group that you do not want to assign to the selected task into the Denied box.

6 Click Update. The Resulting users with this Authorization lists all users that belong to the

groups you assigned to the task (that is, the groups you moved into the Allowed box).

Adding and Viewing Instructions or Notes About a Project

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

(32)

(33)

4

Defining a Broker, ProcessModel, MWS, or Optimize

Deployment Set

Creating the Deployment Set . . . 34 Identifying the Source Servers . . . 35 Adding Assets to the Deployment Set . . . 35 Resolving Dependencies . . . 36 Removing Process Models . . . . 38

(34)

4 Defining a Broker, ProcessModel, MWS, or Optimize Deployment Set

Creating the Deployment Set

1 In Deployer, go to the Projects page. In the Name column, click the project in which to

create a deployment set.

2 In the right‐hand pane, click Define.

3 Click Create Deployment Set.

4 In the Type list, click Broker, MWS, ProcessModel, or Optimize, and then complete these

fields:

5 Click Create.

To create the deployment set:

Box Entry Name 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 Description for the deployment set. The description length has no limit and can include any characters. All other

items 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. Packages For a ProcessModel or Optimize deployment set, 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.

(35)

Identifying the Source Servers

1 On Deployer Projects project Define page, in the left‐hand pane in the Name column,

click the name of the deployment set for which to identify source servers. In the right‐ hand pane in the Select Source type Servers area, Deployer lists all servers of the appropriate type (for example, ProcessModel servers for a ProcessModel deployment set) that you set up to work with Deployer. 2 In the Select column, select the check box next to each server that contains assets to add to the deployment set. 3 Click Save.

Adding Assets to the Deployment Set

1 In the Deployment Sets area, under the deployment set to which to add assets, click the

Broker, ProcessModel, MWS, or Optimize folder. In the right‐hand pane, Deployer lists the

source servers of the type you selected.

2 In the right‐hand pane, open the tree to show the assets on the source servers, then

select the check box next to each asset to add to the deployment set. Keep in mind the following:

To identify the source servers:

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

and Configuring Communication with Deployer”.

To add assets to the deployment set:

For... Note Broker 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. ProcessModel The process models displayed are those that were ʺBuilt for executionʺ on the Integration Server. MWS The My webMethods Server folder is listed twice within its directory, as a container preceded by and as an asset preceded by . If you want to add a folder with all the assets it contains to the deployment set, select the folder where it appears next to the square icon. If you want to add individual assets in the folder without adding the folder itself, open the

(36)

3 Click Save. Deployer shows your choices in the left‐hand pane under the Broker,

ProcessModel, MWS, or Optimize folder for the deployment set.

Resolving Dependencies

For any project, 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. In the project properties (“Setting the Default for Dependency Checking” on page 26), you indicated how you want to check dependencies in the deployment sets. When Deployer automatically checks dependencies and finds unresolved dependencies in a deployment set, it shows in the Unresolved Dependencies column for the deployment set; when there are no unresolved dependencies, Deployer shows in the column. When

you can check dependencies manually, Deployer shows in the Unresolved Dependencies

column for each deployment set; click Check next to the . If necessary, you can later “un‐resolve” or remove a dependency you have resolved and resolve it again a different way. 1 In the Unresolved Dependencies column for the deployment set, click Check. Deployer shows all unresolved dependencies on the Unresolved Dependencies page. The Referenced Item column lists the missing referenced assets. The next column offers the Deployment Set Example

Broker If you add a client group to a Broker deployment set, but do not add the documents that the client group can publish or subscribe to, then Deployer identifies the documents as unresolved dependencies. ProcessModel If you add a process model to a ProcessModel deployment set, but do not add the flow services that are called by that process model, Deployer identifies the flow services as unresolved dependencies. MWS If you add a page to an MWS deployment set, but do not add the portlets that are referenced by that page, Deployer identifies the portlets as unresolved dependencies. Optimize If you add a rule to a deployment set, but do not add the dimensions used by that rule, Deployer identifies the dimensions as unresolved dependencies. To resolve dependencies:

(37)

4 Defining a Broker, ProcessModel, MWS, or Optimize Deployment Set possible ways you can resolve the unresolved dependency. The Project Item column shows the dependent assets. 2 Tell Deployer how to resolve each unresolved dependency as described below. If you want to resolve all assets in a folder the same way, you can set the resolution at the folder level rather than at the level of the individual assets. 3 Click Save. Deployer moves dependencies you resolved using the Exists or Ignore option to the Resolved Dependencies page. 4 To see the resolved dependencies, click Resolved Dependencies. You can un‐resolve a resolved dependency and re‐resolve it differently. To un‐resolve a dependency, go to the Resolved Dependencies page, select the check box in the Delete column for the resolved dependency, and click Delete. Deployer returns the dependency to the Unresolved Dependencies page. Go to that page and re‐resolve the dependency. Option Description Add If the referenced asset does not exist on the target servers and you want to deploy the referenced asset to them, use this option. Deployer adds the referenced asset to the deployment set. Exists If you believe the referenced asset already exists on the target servers and you want to continue working, but you want Deployer to make sure the asset does in fact exist later, use this option. Deployer will check for the referenced asset when you map the project to target servers. If Deployer does not find the asset, an icon alerts you during the mapping task. If you do not address the problem during the mapping task, Deployer will write a message about the problem to the simulation report. If you deploy without addressing the problem, Deployer will not deploy the deployment set. Ignore If you want to bypass dependency checking for the referenced asset at this time so you can continue working, use this option. You might use this option if the referenced asset is missing on the source server. Missing referenced assets are marked with a question mark (?) on the Unresolved Dependencies page. Before deploying, make sure either that the referenced asset exists on the target server or that the referenced asset is unnecessary. If the referenced asset does not exist on the target server, Deployer might not be able to deploy correctly; if it can deploy, the deployed assets will not run correctly. Deployer will list ignored assets in the simulation report and in the deployment report.

(38)

Removing Process Models

When you add a process model to a 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.

(39)

5

Defining an IS & TN Deployment Set

Creating the IS & TN Deployment Set . . . 40 Identifying Source Integration Servers . . . 41 Adding Integration Server Administration Assets . . . 41 Adding Integration Server Packages . . . 42 Adding webMethods Files . . . 48 Adding Trading Networks Assets . . . 49 Resolving Dependencies . . . 50 Manually Adding Dependencies to a Package Component . . . 51

(40)

5 Defining an IS & TN Deployment Set

Creating the IS & TN Deployment Set

1 In Deployer, go to the Projects page. In the Name column, click the project in which to

create an IS & TN deployment set.

2 In the right‐hand pane, click Define.

3 Click Create Deployment Set.

4 From the Type list, select IS & TN, then complete these fields:

5 Click Create.

To create the IS & TN deployment set:

Box Entry Name 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 Description for the deployment set. The description length has no limit and can include any characters. Packages After you choose the source Integration Servers, Deployer will display all packages on those servers. You can use the Packages field to narrow the display. Type a regular expression that specifies the text that the package names must contain in order to be listed.

All other items After you choose the source Integration Servers, Deployer will display all assets on those Integration 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.

(41)

Identifying Source Integration Servers

1 On the Deployer Projects project Define page, in the left‐hand pane in the Name

column, click the deployment set for which to identify source Integration Servers. In the right‐hand pane, in the Select Source Servers area, Deployer lists all remote servers defined to the Integration Server that hosts Deployer. 2 In the Select column, select the check box next to each Integration Server that contains assets to add to the deployment set. 3 Click Save. 4 Make sure every Integration Server you identified as a source is equipped with the

Deployer resource package. To do so, go to the Servers IS & TN page and click in

the Test column. If the left‐hand pane shows the message ʺSuccessfully connected to Integration Server host...,ʺ the Deployer resource package is installed. If the pane shows the message “Error connecting to Integration Server...,ʺ you must install the resource package on the Integration Servers. In the Install column, select the check box next to each Integration Server you identified as a source, then click Install.

Adding Integration Server Administration Assets

1 In the Deployment Sets area, under the deployment set to which to add Integration Server administration assets, click the Administration folder. In the right‐hand pane, Deployer lists the source Integration Servers you identified. 2 In the right‐hand pane, open the tree to show the administration assets on the source Integration Servers, then select the check box next to each asset to add to the deployment set. 3 Click Save. Deployer shows your choices in the left‐hand pane under the Administration folder for the deployment set. 4 If you are not going to add any more assets to the deployment set, go to “Resolving

To identify source Integration Servers:

Note: If an Integration Server you want to use as a source does not appear in the

list, you must define it as a remote server to the host Integration Server. This includes the host Integration Server; to use it as a source, you must define it as a remote server to itself. For instructions, see the webMethods Integration Server

Administrator’s Guide. After you define a new remote server with the Integration

Server Administrator, click Refresh this Page on Deployer to update the list of servers.

(42)

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

Adding Integration Server Packages

When you add an Integration Server package to the deployment set, you can do one of the following: Add the package in its entirety. Add selected package components only. Add selected package files only. A package from which you have added only selected components or files is called a partial package. You can add both entire packages and partial packages to a deployment set. If you add a partial package of 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

1 In the Deployment Sets area, under the deployment set to which to add packages, click the Packages folder. In the right‐hand pane, Deployer lists the source Integration Servers you identified. 2 In the right‐hand pane, open the tree to show the packages on the source Integration Servers, then select the check boxes next to the packages to add in their entirety. 3 Click Save. Deployer shows the entire package icon ( ) in the left‐hand pane under the Packages folder for the deployment set. Deployer also shows the entire package icon for selected packages in the package list in the right‐hand pane, and the check boxes next to the packages are marked with a black check mark. 4 If you are done adding packages to the deployment set, go to “Setting the Package Properties” on page 45. 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.

(43)

Adding Package Components

1 In the Deployment Sets area, under the deployment set to which to add package components, click the Packages folder. In the right‐hand pane, Deployer lists the source Integration Servers you identified. 2 In the right‐hand pane, open the tree to show the packages on the source Integration Servers, then click the name of a package that contains components to add to the deployment set. 3 In the Select Components area, open the tree to show the components in the package, then select the check box next to each component to add to the deployment set. 4 Click Save.

5 Click Return to Package List. Deployer shows the partial package icon ( ) in the left‐

hand pane under the Packages folder for the deployment set. Deployer also shows the partial package icon for the selected package in the package list in the right‐hand pane, and the check box next to the package is marked with a gray check mark (as opposed to the black check mark used for selected entire packages). 6 If you are done adding packages to the deployment set, go to “Setting the Package Properties” on page 45. 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 components, and then select files, Deployer only allows you to add files from the package file list. If you first select files, and then select components, Deployer might overwrite certain file selections to ensure consistency.

To add package components:

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

(44)

Adding Package Files

1 In the Deployment Sets area, under the deployment set to which to add package files, click the Packages folder. In the right‐hand pane, Deployer lists the source Integration Servers you identified. 2 In the right‐hand pane, open the tree to show the packages on the source Integration Servers, then click the name of a package that contains files to add to the deployment set. 3 Click Select Files. Deployer lists all files in the package. Do one of the following: 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 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:

To add... Do this...

All the files in the list Click All files.

Only files you select in the list

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

right‐hand pane. Only files other than those

you select in the list

Click All except selected files, then press the CTRL key and click each file to exclude from the deployment set. All files in the list whose

name contains a specified string

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

Click All except files specified by filter, then type the string on which to match the files to exclude from the

deployment set. You can use an asterisk (*) as a wild card (for example, *.java or *.class).

Web Methods Deployer User's Guide

webMethods Deployer

User’s Guide

Version 7.1.1

February 2008

Table of Contents

About This Guide

Document Conventions

Additional Information

1

Concepts

webMethods Deployer

Deployment Steps

Create the Project

Define the Project

Build the Project

Map a Project

Deploy the Project

Checkpoint and Roll Back

Access to Target Environments

Deployer Interfaces

Logging

I

Using the Deployer Graphical User Interface

2

Starting and Configuring Communication with

Deployer

Overview

Starting Deployer

Configuring Communication with Brokers

Configuring Communication with ProcessModel Servers

Configuring Communication with Integration Servers

Configuring Communication with My webMethods Servers

Configuring Communication with Optimize Servers

Configuring Target Groups

3

Creating a Project

Setting Default Properties for Projects

Setting the Default for Dependency Checking

Setting the Default Properties for Deployment

Setting Default Properties for Integration Server and Trading

Networks Projects

Creating a Project

Authorizing Groups to Perform Tasks on a Project

Adding and Viewing Instructions or Notes About a Project

4

Defining a Broker, ProcessModel, MWS, or Optimize

Deployment Set

Creating the Deployment Set

Identifying the Source Servers

Adding Assets to the Deployment Set

Resolving Dependencies

Removing Process Models

5

Defining an IS & TN Deployment Set

Creating the IS & TN Deployment Set

Identifying Source Integration Servers

Adding Integration Server Administration Assets

Adding Integration Server Packages

Adding an Entire Package

Adding Package Components

Adding Package Files