help.serena.com · table of contents part 1: introduction...

SERENA®DEPLOYMENTAUTOMATION

Plug-ins Guide

Serena Proprietary and Confidential Information

Copyright © 2013-2014 Serena Software, Inc. All rights reserved.

This document, as well as the software described in it, is furnished under license and may be used or copied onlyin accordance with the terms of such license. Except as permitted by such license, no part of this publicationmay be reproduced, photocopied, stored in a retrieval system, or transmitted, in any form or by any means,electronic, mechanical, recording, or otherwise, without the prior written permission of Serena. Any reproductionof such software product user documentation, regardless of whether the documentation is reproduced in wholeor in part, must be accompanied by this copyright statement in its entirety, without modification. This documentcontains proprietary and confidential information, and no reproduction or dissemination of any informationcontained herein is allowed without the express permission of Serena Software.

The content of this document is furnished for informational use only, is subject to change without notice, andshould not be construed as a commitment by Serena. Serena assumes no responsibility or liability for any errorsor inaccuracies that may appear in this document.

License and copyright information for 3rd party software included in this release can be found on the product'snews page at http://support.serena.com/ProductNews/default.aspx and may also be found as part of thesoftware download available at http://www.support.serena.com.

Trademarks

Serena, TeamTrack, StarTool, PVCS, Comparex, Dimensions, Prototype Composer, Mariner and ChangeMan areregistered trademarks of Serena Software, Inc. The Serena logo, Version Manager and Mover are trademarks ofSerena Software, Inc. All other products or company names are used for identification purposes only, and maybe trademarks of their respective owners.

U.S. Government Rights

Any Software product acquired by Licensee under this Agreement for or on behalf of the U.S. Government, itsagencies and instrumentalities is "commercial software" as defined by the FAR. Use, duplication, and disclosureby the U.S. Government is subject to the restrictions set forth in the license under which the Software wasacquired. The manufacturer is Serena Software, Inc., 1850 Gateway Drive, 4th Floor, San Mateo, CA 94404.

Part number: Product version: 5.1.2

Publication date: 2014-08-05

2 Serena® Deployment Automation

Table of ContentsPart 1: Introduction .......................................................................................... 15

Chapter 1: Deployment Automation Plug-ins ...................................................... 17

What are Plug-ins? ....................................................................................... 17

Standard Plug-ins.......................................................................................... 19

Chapter 2: List of Available Plug-ins .................................................................. 21

Chapter 3: Examples of Plug-in Usage ............................................................... 25

Deploying a Tomcat App and Web Components ................................................ 25

Tomcat Example Prerequisite Setup............................................................... 25

Designing a Process to Deploy the APP Component .......................................... 27

Step 1: Delete Files and Directories ............................................................ 27

Step 2: Download Artifacts ........................................................................ 28

Step 3: Undeploy Application ..................................................................... 28

Step 4: Start Tomcat................................................................................. 29

Step 5: Deploy Application ........................................................................ 30

The APP Component Deployment Graphic Process ....................................... 32

Designing a Process to Deploy the Web Component ....................................... 33

Step 1: Delete Files and Directories from the Environment ........................... 33

Step 2: Download Artifacts ........................................................................ 33

Step 3: Delete Files and Directories from the Website .................................... 34

Step 4: Copy Directories ........................................................................... 34

The Web Component Deployment Graphic Process ....................................... 35

Configuring the Component Environment Properties ....................................... 35

Designating Values for the Properties in the Environment ................................. 37

Designing an Application Process to Run the Deployment ................................. 39

Deploying the Application ........................................................................... 41

Creating Components and Mapping Artifacts According to Type ........................... 41

Single-component Deployment with Two Scheduled Processes ........................... 42

Deploying to a WebSphere Application Server ................................................... 43

Plug-ins Guide 3

Part 2: Application Server Management Plug-ins ................................................... 45

Chapter 4: Apache HTTP Server Plug-in ............................................................ 47

Creating an Apache Start Step ........................................................................ 47

Creating an Apache Stop Step ........................................................................ 47

Chapter 5: Apache Tomcat Plug-in..................................................................... 49

Creating a Tomcat Deploy Application Step ...................................................... 49

Creating a Tomcat Undeploy Application Step ................................................... 50

Creating a Tomcat Start Application Step ......................................................... 50

Creating a Tomcat Stop Application Step ......................................................... 50

Creating a Tomcat Start Step ........................................................................ 51

Creating a Tomcat Stop Step ........................................................................ 52

Creating a Check if Tomcat is Alive Step ......................................................... 53

Chapter 6: GlassFish Plug-in ........................................................................... 55

Chapter 7: IBM WebSphere Application Server Plug-in ....................................... 57

Creating a WebSphere Check Application is Not Running Step ........................... 58

Creating a WebSphere Check Application is Running on Server or Cluster Step ...... 60

Creating a WebSphere Check if Config Object Exists Step ................................. 61

Creating a WebSphere Check Initial Heap Size Step .......................................... 62

Creating a WebSphere Check Maximum Heap Size Step .................................... 63

Creating a WebSphere Check Status Step......................................................... 64

Creating a WebSphere Create Cluster step ...................................................... 66

Creating a WebSphere Create Cluster Member Step .......................................... 66

Creating a WebSphere Create DataSource Step ................................................ 67

Creating a WebSphere Create DataSource for Cluster Step ................................. 69

Creating a WebSphere Create JDBCProvider for Cluster Step .............................. 71

Creating a WebSphere Create JDBCProvider Step ............................................. 72

Creating a WebSphere Create a SIBJMSConnectionFactory Step ........................ 73

Creating a WebSphere Create SIBJMSQueue Step ............................................. 75

Creating a WebSphere Create SIBJMSTopic Step ............................................. 76

Creating an WebSphere Execute wsadmin Script Step ....................................... 77


Creating a WebSphere Export DataSource Properties from a Cluster Step ............ 79

Creating an WebSphere Export JVMHeapSizes from Server Step ........................ 80

Creating a WebSphere Export Application Step ................................................ 81

Creating a WebSphere Generate Plugin Step ................................................... 82

Creating a WebSphere Import DataSource Properties into Cluster Step ............... 84

Creating a WebSphere Import JVMHeapSizes for Cluster Step ........................... 85

Creating a WebSphere Install Application Step ................................................ 86

Creating a WebSphere Install or Update Application Step.................................... 88

Creating a WebSphere Modify Application ClassLoaders Step .............................. 90

Creating a WebSphere Restart Application Step ................................................ 91

Creating a WebSphere Restart Server Step ...................................................... 92

Creating a WebSphere Start Application Step ................................................... 94

Creating a WebSphere Start Server Step ......................................................... 95

Creating a WebSphere Stop Application Step ................................................... 96

Creating a WebSphere Stop Server Step ......................................................... 97

Creating a WebSphere Synchronize Nodes Step ................................................ 99

Creating a WebSphere Uninstall Application Step ............................................. 99

Creating a WebSphere Update J2EEResourceProperty on a Config Object Step ... 101

Creating a WebSphere Update Simple Attribute on Object Step ........................ 102

Creating a WebSphere Update Application Step ............................................. 103

Creating a WebSphere Wait for Application Step............................................. 105

Creating a Websphere Wait for Server or Cluster Step .................................... 107

Chapter 8: IBM WebSphere MB Plug-in............................................................ 109

Creating a WebSphere WMB Set Broker Properties Step ................................. 109

Creating a WebSphere WMB Set Execution Group Properties Step..................... 110

Creating a WebSphere WMB Set Message Flows Property Step ........................ 111

Creating a WebSphere WMB Delete Flows Using RegEx Step ........................... 112

Creating a WebSphere WMB Deploy Step ...................................................... 113

Creating a WebSphere WMB Start Message Flows Step.................................... 114

Plug-ins Guide 5

Creating a WebSphere WMB Stop Message Flows Step .................................... 115

Chapter 9: IBM WebSphere MQ ..................................................................... 117

Creating a WebSphere Create Queue Manager Step ....................................... 117

Creating a WebSphere Manage Queue Depth Step .......................................... 118

Creating a WebSphere Start Queue Manager Step .......................................... 118

Creating a WebSphere Stop Queue Manager Step .......................................... 119

Creating a WebSphere Define Queue Step ................................................... 119

Creating a WebSphere Run MQ Script Step ................................................... 120

Chapter 10: JBoss Plug-in ........................................................................... 123

Creating a Deploy Application Step ............................................................... 124

Creating a Deploy JDBC Driver Step ............................................................ 124

Creating an Undeploy Application Step ......................................................... 125

Creating a Start JBoss Step ........................................................................ 126

Creating a Stop JBoss Step ........................................................................ 126

Creating an Add Data Source Step ............................................................... 127

Creating an Add JMS Queue Step ............................................................... 127

Creating an Add JMS Topic Step .................................................................. 128

Creating an Add JMS Connection Factory Step................................................ 129

Creating a Remove JMS Connection Factory Step .......................................... 129

Creating a Create Server Group Step ............................................................ 130

Creating a Run Script Step ........................................................................ 130

Creating a Check Deployment Status Step ................................................... 131

Creating an Enable Application Step ............................................................ 132

Creating a Disable Application Step ............................................................ 132

Chapter 11: IIS AdminScripts Plug-in ............................................................ 133

Creating an AdsUtil Step ........................................................................... 133

Creating an Update WebSiteProperties Step................................................... 134

Creating an Update VDirProperties Step ...................................................... 134

Creating a Set .Net Version Step .................................................................. 134

Chapter 12: IIS AppCmd Plug-in .................................................................. 137


Creating a Create Application Step ............................................................... 137

Creating a Delete Application Step ............................................................... 138

Creating a Create Site Step ........................................................................ 138

Creating a Delete Site Step ........................................................................ 139

Creating a Start Site Step ........................................................................... 139

Creating a Stop Site Step ........................................................................... 140

Creating a Check if Site Exists Step ............................................................ 140

Creating a Check if Site is Stopped Step ...................................................... 141

Creating a Check if Site is Running Step ...................................................... 141

Creating a Create Virtual Directory Step ...................................................... 142

Creating a Delete Virtual Directory Step ...................................................... 142

Creating a Create Application Pool Step......................................................... 143

Creating a Delete Application Pool Step ......................................................... 143

Creating a Start Application Pool Step ......................................................... 144

Creating a Stop Application Pool Step ......................................................... 144

Creating a Recycle Application Pool Step ...................................................... 145

Creating an AppCmd Step ........................................................................... 145

Chapter 13: Microsoft IIS MS-Deploy Plug-in ................................................... 147

Creating a Synchronize Step........................................................................ 147

Creating an MSDeploy Step ........................................................................ 149

Creating a Delete Step .............................................................................. 150

Creating a Stop Application Step .................................................................. 151

Creating a Recycle Application Step ............................................................ 152

Chapter 14: Oracle WebLogic WLDeploy Plug-in ............................................. 153

Part 3: Build Management Plug-ins .................................................................. 155

Chapter 15: Apache Ant Plug-in ..................................................................... 157

Creating an Execute an Ant Script Step ......................................................... 157

Chapter 16: Apache Maven Plug-in ............................................................... 159

Chapter 17: MS Build Plug-in ........................................................................ 161

Chapter 18: UrbanCode AnthillPro Plug-in ...................................................... 163

Plug-ins Guide 7

Part 4: Change and Service Management Plug-ins ............................................. 165

Chapter 19: CollabNet Teamforge Plug-in ...................................................... 167

Chapter 20: Microsoft Sharepoint Plug-in......................................................... 169

Chapter 21: Serena ChangeMan ZMF Plug-in ................................................... 171

Creating a ZMF Approve Step ..................................................................... 172

Creating a ZMF Audit Step........................................................................... 173

Creating a ZMF Backout Step ..................................................................... 176

Creating a ZMF Confirm for Backout Step ...................................................... 177

Creating a ZMF Confirm for Freeze Step ...................................................... 178

Creating a ZMF Confirm for Promotion Step ................................................... 179

Creating a ZMF Confirm for Revert Step ...................................................... 181

Creating a ZMF Delete Package Step ............................................................ 182

Creating a ZMF Delete Scheduled Deployment Step ....................................... 183

Creating a ZMF Demote a Package Step ...................................................... 184

Creating a ZMF Demote and Delete Contents Step .......................................... 186

Creating a ZMF Freeze a Package Step ......................................................... 187

Creating a ZMF Get App Params Step............................................................ 188

Creating a ZMF Get App Promotion Areas Step ............................................. 189

Creating a ZMF Get App Sites Step ............................................................... 190

Creating a ZMF Get Approvers Step ............................................................ 192

Creating a ZMF Get Install Sites Step............................................................ 193

Creating a ZMF Get Instructions Step............................................................ 194

Creating a ZMF Get Properties Step ............................................................ 195

Creating a ZMF Get User Variables Step ...................................................... 196

Creating a ZMF Hold Deployment Step ......................................................... 197

Creating a ZMF Promote Package Step ......................................................... 198

Creating a ZMF Query Package Step ............................................................ 200

Creating a ZMF Reject Package Step ............................................................ 206

Creating a ZMF Release Deployment Step...................................................... 207

Creating a ZMF Revert Package Step ............................................................ 208


Creating a ZMF Undelete Package Step ......................................................... 209

Chapter 22: Serena Dimensions CM Plug-in ................................................... 211

Creating a Dimensions CM Action Baseline Step ............................................. 211

Creating a Dimensions CM Create Baseline Step ............................................. 212

Creating a Dimensions CM Deliver to a Stream Step ....................................... 213

Creating a Dimensions CM Demote Baseline Step .......................................... 214

Creating a Dimensions CM Deploy Baseline Step............................................. 215

Creating a Dimensions CM Get Baselines Step................................................ 217

Creating a Dimensions CM Get Deployment Areas Step ................................. 217

Creating a Dimensions CM Get Products Step ................................................ 218

Creating a Dimensions CM Get Projects and Streams Step .............................. 219

Creating a Dimensions CM Get Stages Step ................................................... 220

Creating a Dimensions CM Promote Baseline Step .......................................... 220

Creating a Dimensions CM Rollback Area Version Step .................................... 222

Creating a Dimensions CM Upload Local File or Directory Step ........................ 222

Chapter 23: Serena PVCS VM Plug-in ............................................................ 225

Creating a PVCS Export Step ..................................................................... 225

Chapter 24: ServiceNow Plug-in ..................................................................... 227

Chapter 25: Subversion Plug-in ..................................................................... 229

Creating a Subversion Add Step .................................................................. 229

Creating a Subversion Checkout Step ......................................................... 230

Creating a Subversion Clean Up Step ............................................................ 231

Creating a Subversion Commit Step ............................................................ 231

Creating a Subversion Create Branch or Tag Step .......................................... 232

Creating a Subversion Create Repository Step................................................ 233

Creating a Subversion Delete Step ............................................................... 233

Creating a Subversion Export Step (5.0.1 Plug-in Version) .............................. 234

Creating a Subversion Get Lock Step ............................................................ 234

Creating a Subversion Import Step............................................................... 235

Creating a Subversion Move Step ............................................................... 236

Plug-ins Guide 9

Creating a Subversion Release Lock Step ...................................................... 236

Creating a Subversion Revert Step ............................................................... 237

Creating a Subversion Switch Step ............................................................... 238

Creating a Subversion Update Step ............................................................ 239

Creating a Subversion Export Step (4.5.1 Plug-in Version) .............................. 239

Part 5: Database Management Plug-ins ............................................................ 241

Chapter 26: DBDeploy Plug-in........................................................................ 243

Creating a Run DbDeploy Step ..................................................................... 243

Chapter 27: DBUpgrader Plug-in .................................................................. 245

Chapter 28: SQLCMD Plug-in ........................................................................ 247

Chapter 29: SQL*Plus Plug-in ........................................................................ 249

Creating a Run SQLPlus Script Step ............................................................ 249

Chapter 30: SQL-JDBC Plug-in ..................................................................... 251

Creating an Execute SQL Scripts Step ......................................................... 251

Part 6: Integration Plug-ins ........................................................................... 253

Chapter 31: Informatica Plug-in ..................................................................... 255

Chapter 32: Microsoft BizTalk Plug-in ............................................................ 257

Part 7: Network Management Plug-ins............................................................... 259

Chapter 33: Citrix NetScaler Plug-in ............................................................... 261

Chapter 34: F5 BIG-IP Plug-in........................................................................ 263

Chapter 35: Nagios XI Plug-in ........................................................................ 265

Part 8: Quality and Test Management Plug-ins ................................................... 267

Chapter 36: Atlassian Jira Plug-in .................................................................. 269

Chapter 37: Deploy Tools Plug-in .................................................................. 271

Chapter 38: HP Quality Center Plug-in ............................................................ 273

Creating a Create Issue Step ..................................................................... 273

Creating an Update Issues Step .................................................................. 274

Creating an Add Comments Step.................................................................. 276

Creating a Publish Issue Report Step ............................................................ 277

Creating a Run Test Set Step ..................................................................... 278

Creating a Publish Test Set Report Step ...................................................... 278


Creating a Check Status Step ..................................................................... 279

Creating a Query Defects Step ..................................................................... 280

Chapter 39: QuickTest Pro Plug-in .................................................................. 283

Chapter 40: Rally Plug-in .............................................................................. 285

Chapter 41: Selenium Plug-in ........................................................................ 287

Part 9: Deployment and Release Automation Plug-ins.......................................... 289

Chapter 42: BMC ARA Plug-in ........................................................................ 291

Chapter 43: Nolio Plug-in .............................................................................. 293

Creating a Nolio Get Agents Step ............................................................... 293

Creating a Nolio Get Applications Step ......................................................... 294

Creating a Nolio Get Environments Step ...................................................... 295

Creating a Nolio Get Process Tags Step ......................................................... 296

Creating a Nolio Get Processes Step ............................................................ 297

Creating a Nolio Get Server Types Step......................................................... 298

Creating a Nolio Run Process Step ............................................................... 298

Creating a Nolio Schedule Process Run Step ................................................ 299

Chapter 44: Serena DA Application Plug-in ...................................................... 301

Chapter 45: Serena DA Component Plug-in...................................................... 303

Chapter 46: Serena DA Configuration Management Plug-in .............................. 305

Chapter 47: Serena DA Environment Plug-in ................................................... 307

Chapter 48: Serena DA Resource Plug-in ......................................................... 309

Chapter 49: Deployment Automation System Plug-in ....................................... 311

Creating a Deployment Automation System Property Step .............................. 311

Chapter 50: Serena DA Version Plug-in ......................................................... 313

Chapter 51: Serena DA VFS Plug-in ............................................................... 315

Part 10: System Tools and Scripting Plug-ins ................................................... 317

Chapter 52: 7zip Plug-in .............................................................................. 319

Creating a 7zip Extract Archive Step ............................................................ 319

Chapter 53: CA AutoSys Plug-in ..................................................................... 321

Chapter 54: FileUtils Plug-in ........................................................................ 323

Plug-ins Guide 11

Chapter 55: Groovy Plug-in ........................................................................... 325

Chapter 56: Microsoft Message Queuing (MSMQ) Plug-in ................................. 327

Chapter 57: Microsoft Software Installer (MSI) Plug-in .................................... 329

Chapter 58: Microsoft Windows Service Control Manager Plug-in ........................ 331

Chapter 59: Windows System Tools Plug-in ................................................... 333

Chapter 60: Red Hat Package Manager (RPM) Plug-in ....................................... 335

Creating an Install RPM Step ..................................................................... 335

Creating an Uninstall RPM Step .................................................................. 335

Creating an Update RPM Step ..................................................................... 335

Chapter 61: Shell Plug-in .............................................................................. 337

Creating a Run a Shell Script Step ............................................................... 337

Creating a Run a Shell Script with X Arguments Step .................................... 338

Chapter 62: System Information Plug-in ......................................................... 339

Part 11: Virtual and Cloud Environment Management Plug-ins .............................. 341

Chapter 63: Amazon EC2 Plug-in .................................................................. 343

Creating an Amazon EC2 Launch Instance Step ............................................. 343

Creating an Amazon EC2 Security Group Step................................................ 344

Amazon EC2 Start, Stop, and Terminate Instance Steps ................................. 345

Creating an Amazon EC2 Wait for Instance Step............................................. 346

Creating an Amazon EC2 Associate IPs Step ................................................ 346

Creating an Amazon EC2 Register Instances with LoadBalance Step .................. 347

Creating an Amazon EC2 Deregister Instances with LoadBalance Step ............... 347

Creating an Amazon EC2 Get Public DNS Step................................................ 348

Chapter 64: Microsoft Windows Azure Plug-in................................................... 349

Chapter 65: VMware vSphere ESXi Plug-in ...................................................... 351

Chapter 66: VMware vCenter Plug-in ............................................................ 353

Chapter 67: VMware Workstation Plug-in......................................................... 355

Creating a Clone VM Step ........................................................................... 355

Creating a Delete Snapshot Step .................................................................. 356

Creating a Revert to Snapshot Step ............................................................ 356


Creating a Start VM Step ........................................................................... 356

Creating a Stop VM Step ........................................................................... 357

Creating a Suspend VM Step........................................................................ 357

Creating a Take Snapshot Step .................................................................. 357

Part 12: Creating Your Own Plug-ins ............................................................... 359

Chapter 68: Plug-in Creation ........................................................................ 361

Plug-in Creation Overview ........................................................................... 361

The plugin.xml File .................................................................................... 362

The Header: <header> Element ............................................................... 364

The Plug-in Steps: <step-type> Element ................................................... 364

Step Properties: <properties> Element ...................................................... 365

Step Commands: <command> Element...................................................... 367

Step Post-Processing: <post-processing> Element ....................................... 368

The upgrade.xml file ................................................................................. 369

The info.xml File ....................................................................................... 370

Chapter 69: Custom Plug-in Examples ............................................................ 371

Simple Test Demo .................................................................................... 371

Simple Test Demo plugin.xml file ............................................................... 371

Simple Test Demo upgrade.xml file ............................................................ 372

Simple Test Demo info.xml file .................................................................. 372

Simple Test Demo Groovy file .................................................................. 373

Simple Test Demo Properties ..................................................................... 373

Simple Test Demo Results ........................................................................ 373

GUI Test Demo .......................................................................................... 374

GUI Test Demo plugin.xml file .................................................................. 374

GUI Test Demo upgrade.xml file ............................................................... 375

GUI Test Demo info.xml file ..................................................................... 376

GUI Test Demo Groovy file ........................................................................ 376

GUI Test Demo Properties ........................................................................ 376

GUI Test Demo Results ........................................................................... 377

Plug-ins Guide 13

Property Test Demo.................................................................................... 378

Property Test Demo plugin.xml file ............................................................ 378

Property Test Demo upgrade.xml file ......................................................... 379

Property Test Demo info.xml file ............................................................... 380

Property Test Demo Groovy file ............................................................... 380

Property Test Demo Properties .................................................................. 381

Property Test Demo Results ..................................................................... 382

Step Test Demo ....................................................................................... 383

Step Test Demo plugin.xml file .................................................................. 383

Step Test Demo upgrade.xml file ............................................................... 385

Step Test Demo info.xml file ..................................................................... 385

Step Test Demo Groovy file ..................................................................... 385

Step Test Demo Properties ........................................................................ 386

Step Test Demo Results ........................................................................... 387

Input Output Test Demo ........................................................................... 387

Input Output Test Demo plugin.xml file ...................................................... 388

Input Output Test Demo upgrade.xml file ................................................... 389

Input Output Test Demo info.xml file ......................................................... 389

Input Output Test Demo Groovy file ......................................................... 390

Input Output Test Demo Properties ............................................................ 391

Input Output Test Demo Results ............................................................... 392


Part 1: Introduction

This section contains the following information:

• Chapter 1: Deployment Automation Plug-ins [page 17]

• Chapter 2: List of Available Plug-ins [page 21]

• Chapter 3: Examples of Plug-in Usage [page 25]

Plug-ins Guide 15

Chapter 1: Deployment Automation Plug-ins

This guide lists and describes the plug-ins included with Deployment Automation. Whenyou are creating processes, use these plug-ins to configure and execute steps needed foryour deployment, such as requests to application servers, build management tools,database and file management systems, and test automation tools.

All of the plug-ins include self-documentation. As you use plug-ins within the processes,click the ? icon beside the properties fields to see a short description of each property.

See the User's Guide for more information on designing processes.

Note: If you require documentation for a plug-in beyond that provided in theDeployment Automation guides, please check the Serena SupportKnowledgebase at serena.com and follow your usual Serena Supportprocedures.

Important: The plug-in steps specified in the Deployment Automationprocesses often require pre-existing conditions, such as existing accounts,licenses, security, and login credentials. You should consult the integratingproducts' documentation for information on how to configure and use theintegrating software.

• What are Plug-ins? [page 17]

• Standard Plug-ins [page 19]

What are Plug-ins?Deployment Automation plug-ins provide tools for creating component processes. Plug-insconsist of configurable steps which can be thought of as distinct pieces of automation.Plug-ins integrate many third-party tools into Deployment Automation, such as applicationservers and software configuration management products.

By combining steps in the Deployment Automation editor, you can create fully-automateddeployment processes. For example, the Tomcat and WebSphere plug-ins provide stepsthat start and stop those servers, install and uninstall applications, as well as performother tool-specific tasks.

Each plug-in step consists of a number of properties, a command that performs thefunction associated with the step, and post-processing instructions, which typically areused to ensure that expected results occurred. Step properties can serve many purposes,from providing information required by the step's command, to supplying some or all ofthe actual command itself.

When you create a process, you drag steps onto the editor's design area and define theirproperties as you go. Property values can be supplied when defining a component processor at run-time. The process flow is defined by drawing connections between steps.

Plug-ins Guide 17

http://help.serena.com/doc_center/doc_center.html#rlmraDoc

http://knowledgebase.serena.com

In the following figure, you can see a series of plug-in steps and the connections betweenthem. For information about creating component processes and creating your own post-processing scripts, see the Serena Deployment Automation User's Guide.



Plug-ins at Run-time

Component processes are run by agents installed in the target environment. For a processto run successfully, the agent must have access to all resources, tools, and files requiredby the plug-in steps used in the process. When installing an agent, ensure that:

• The agent running the process has the necessary user permissions to executecommands and access any required resources. This typically entails grantingpermissions if an external tool is installed as a different user; installing the agent asa service; or impersonating the appropriate user.

• Any external tools required by plug-in steps are installed in the target environment.

• The required minimum version of any external tool is installed.

Standard Plug-insDeployment Automation includes a standard set of plug-ins that appear in the UI bydefault. You do not need to load these plug-ins unless you have removed them and needto re-add them, or you want to upgrade them to the latest version.

The standard plug-ins are listed and described in the following table.

Plug-in Description

Utility Steps Used to acquire process locks, execute a manual task, setstatus, run generic processes, and do other general processoperations.

Repositories/Artifact/Serena DA

Used to upload artifacts to a Deployment Automation (VFS)artifact repository.

Resource Tools/AgentPropertiesCollector

Used for retrieving environment and resource propertiesfrom a resource.

Resource Tools/ConfigurationManagement

Used for downloading and uploading configurationtemplates from and to Deployment Automation.

Scripting/Shell Used to run custom shell scripts during the deploymentprocess.

Serena DA /Applications Used for creating and managing Deployment Automationapplications.

Serena DA/Components

Used for creating and managing Deployment Automationcomponents.

Serena DA/Environments

Used for creating and managing Deployment Automationenvironments.

Serena DA /Resources Used for managing Deployment Automation Resources.

Plug-ins Guide 19

Plug-in Description

Serena DA /System Used for managing Deployment Automation systemproperties and global settings.

Serena DA /Version Used for editing Component Versions in DeploymentAutomation.

System Utility/SystemInformation

Used to verify that a deployment can succeed or hassucceeded by checking system information such asconnectivity, environment variables, available disk space.

Utilities/FileUtils Used to perform folder and file level tasks as part of adeployment process. Includes steps for deleting andcreating directories and replacing tokens in a file.



Chapter 2: List of Available Plug-ins

The plug-ins provided with Deployment Automation are listed here, divided into broadusage categories.

Note: New plug-ins are actively in development. If you don't see a plug-in thatyou need in this list, please search the Serena Support Knowledgebase atserena.com and follow your usual Serena Support procedures.

Part 2: Application ServerManagement Plug-ins [page 45]

Part 3: Build Management Plug-ins[page 155]

• Chapter 4: Apache HTTP Server Plug-in [page 47]

• Chapter 5: Apache Tomcat Plug-in[page 49]

• Chapter 6: GlassFish Plug-in [page55]

• Chapter 7: IBM WebSphereApplication Server Plug-in [page 57]

• Chapter 8: IBM WebSphere MB Plug-in [page 109]

• Chapter 9: IBM WebSphere MQ [page117]

• Chapter 10: JBoss Plug-in [page 123]

• Chapter 11: IIS AdminScripts Plug-in[page 133]

• Chapter 12: IIS AppCmd Plug-in[page 137]

• Chapter 13: Microsoft IIS MS-DeployPlug-in [page 147]

• Chapter 14: Oracle WebLogicWLDeploy Plug-in [page 153]

• Chapter 15: Apache Ant Plug-in [page157]

• Chapter 16: Apache Maven Plug-in[page 159]

• Chapter 17: MS Build Plug-in [page161]

• Chapter 18: UrbanCode AnthillProPlug-in [page 163]

Plug-ins Guide 21

http://knowledgebase.serena.com

Part 4: Change and ServiceManagement Plug-ins [page 165]

Part 9: Deployment and ReleaseAutomation Plug-ins [page 289]

• Chapter 19: CollabNet TeamforgePlug-in [page 167]

• Chapter 20: Microsoft SharepointPlug-in [page 169]

• Chapter 21: Serena ChangeMan ZMFPlug-in [page 171]

• Chapter 22: Serena Dimensions CMPlug-in [page 211]

• Chapter 23: Serena PVCS VM Plug-in[page 225]

• Chapter 24: ServiceNow Plug-in[page 227]

• Chapter 25: Subversion Plug-in [page229]

• Chapter 42: BMC ARA Plug-in [page291]

• Chapter 43: Nolio Plug-in [page 293]

• Chapter 44: Serena DA ApplicationPlug-in [page 301]

• Chapter 45: Serena DA ComponentPlug-in [page 303]

• Chapter 46: Serena DA ConfigurationManagement Plug-in [page 305]

• Chapter 47: Serena DA EnvironmentPlug-in [page 307]

• Chapter 48: Serena DA Resource Plug-in [page 309]

• Chapter 49: Deployment AutomationSystem Plug-in [page 311]

• Chapter 50: Serena DA Version Plug-in[page 313]

• Chapter 51: Serena DA VFS Plug-in[page 315]

Part 5: Database Management Plug-ins [page 241]

Part 6: Integration Plug-ins [page253]

• Chapter 26: DBDeploy Plug-in [page243]

• Chapter 27: DBUpgrader Plug-in[page 245]

• Chapter 28: SQLCMD Plug-in [page247]

• Chapter 29: SQL*Plus Plug-in [page249]

• Chapter 30: SQL-JDBC Plug-in [page251]

• Chapter 31: Informatica Plug-in [page255]

• Chapter 32: Microsoft BizTalk Plug-in[page 257]



Part 7: Network Management Plug-ins [page 259]

Part 8: Quality and Test ManagementPlug-ins [page 267]

• Chapter 33: Citrix NetScaler Plug-in[page 261]

• Chapter 34: F5 BIG-IP Plug-in [page263]

• Chapter 35: Nagios XI Plug-in [page265]

• Chapter 36: Atlassian Jira Plug-in[page 269]

• Chapter 37: Deploy Tools Plug-in[page 271]

• Chapter 38: HP Quality Center Plug-in[page 273]

• Chapter 39: QuickTest Pro Plug-in[page 283]

• Chapter 40: Rally Plug-in [page 285]

• Chapter 41: Selenium Plug-in [page287]

Plug-ins Guide 23

Part 10: System Tools and ScriptingPlug-ins [page 317]

Part 11: Virtual and CloudEnvironment Management Plug-ins[page 341]

• Chapter 52: 7zip Plug-in [page 319]

• Chapter 53: CA AutoSys Plug-in[page 321]

• Chapter 54: FileUtils Plug-in [page323]

• Chapter 55: Groovy Plug-in [page325]

• Chapter 56: Microsoft MessageQueuing (MSMQ) Plug-in [page 327]

• Chapter 57: Microsoft SoftwareInstaller (MSI) Plug-in [page 329]

• Chapter 58: Microsoft WindowsService Control Manager Plug-in[page 331]

• Chapter 59: Windows System ToolsPlug-in [page 333]

• Chapter 60: Red Hat PackageManager (RPM) Plug-in [page 335]

• Chapter 61: Shell Plug-in [page 337]

• Chapter 62: System InformationPlug-in [page 339]

• Chapter 63: Amazon EC2 Plug-in [page343]

• Chapter 64: Microsoft Windows AzurePlug-in [page 349]

• Chapter 65: VMware vSphere ESXiPlug-in [page 351]

• Chapter 66: VMware vCenter Plug-in[page 353]

• Chapter 67: VMware Workstation Plug-in [page 355]



Chapter 3: Examples of Plug-in Usage

Following are a few high-level examples of how plug-ins are used in componentprocesses. As you design your processes, your deployment and other automation needswill determine what plug-in steps you need to use.

• Deploying a Tomcat App and Web Components [page 25]

• Creating Components and Mapping Artifacts According to Type [page 41]

• Single-component Deployment with Two Scheduled Processes [page 42]

• Deploying to a WebSphere Application Server [page 43]

Note: These examples focus on using plug-in steps within componentprocesses. For a complete walk-through of configuring and deploying a simpleapplication in Deployment Automation, see Example: helloWorld Deployment inthe User's Guide.

Deploying a Tomcat App and Web ComponentsAs you begin automating your deployment processes, you will likely find that you needone or more plug-ins to prepare the target environments as shown in the followingexample.

The fictitious Qlarius QSocial application includes an APP portion (Java-based) and a WEBportion (files). In this example, two processes are used to deploy the two QSocialapplication components, or artifacts.

You will design the processes for the two components. The prerequisite setup and the twoprocesses are described in the following topics:

• Tomcat Example Prerequisite Setup [page 25]

• Designing a Process to Deploy the APP Component [page 27]

• Designing a Process to Deploy the Web Component [page 33]

• Configuring the Component Environment Properties [page 35]

• Designating Values for the Properties in the Environment [page 37]

• Designing an Application Process to Run the Deployment [page 39]

• Deploying the Application [page 41]

Tomcat Example Prerequisite Setup

This example focuses on the processes to execute some common Tomcat plug-in steps.Before you can successfully execute the processes, you must have configured theprerequisite entities.

Plug-ins Guide 25


This example assumes the following configuration has already been completed.

Important: If you use values other than the example values given here, makesure that you note the machine names, agent names, port numbers, and otherdetails as you set up your environment, and change these accordinglythroughout the subsequent configuration.

Application and Environment Configuration

• An application named QSocial exists

• An environment named INT exists

Agent Configuration

• An agent named INT_Agent has been installed on your target machine, rademo inour example, and is online

• The agent, INT_Agent, has been added as a resource to the INT environment

Target Tomcat Server Configuration

• A Tomcat server for the QSocial application is installed on the target machine wherethe agent is installed. This is on rademo on port 9095 in our example

• The context.xml file for your Tomcat configuration has antiResourceLocking set toallow undeploy while Tomcat is still running. For example, in <tomcat_home>/conf/context.xml, ensure that the Context tag is set as follows: <ContextantiResourceLocking="true" privileged="true" >

Component Configuration

Two components exist that:

• are named QSocial App and QSocial Web, respectively

• use a Source Config Type of File System (Versioned)

• use Import Versions Automatically

• point to the following base directories, respectively, which are populated with thefiles to import for each component:

C:\QSocial\1_DEV\APP

C:\QSocial\1_DEV\WEB

The two components have been:

• added to the QSocial application

• mapped to the INT environment resource, INT_Agent

Plug-in Configuration

You will design the processes for the two components. These processes use the followingplug-ins, which you should have already loaded into Deployment Automation as needed:

• Apache Tomcat

• FileUtils (a standard plug-in)



• Serena DA Versioned File Storage (VFS) (a standard plug-in)

Designing a Process to Deploy the APP Component

The APP component of our QSocial application is a Java application contained in a .warfile. The process you will design to automate the APP component deployment is detailed inthe following topics:

1. Delete existing files

2. Save the latest artifacts to the destination server

3. Undeploy the existing APP

4. Invoke the Tomcat server

5. Install the latest APP

The plug-in steps and property settings are shown in the following topics:

• Step 1: Delete Files and Directories [page 27]

• Step 2: Download Artifacts [page 28]

• Step 3: Undeploy Application [page 28]

• Step 4: Start Tomcat [page 29]

• Step 5: Deploy Application [page 30]

• The APP Component Deployment Graphic Process [page 32]

Step 1: Delete Files and Directories

The first step will delete the files from all subdirectories, starting at the base directory forthe QSocial App component.

1. Select the QSocial App component and select Processes.

2. Click Create New Process.

3. Enter the name "Deploy QSocial APP" and accept defaults for the rest of the settings.

4. Select the process and in Available Plugin Steps, from Utilities > FileUtils, dragDelete Files and Directories to the graphical design space.

5. Set the properties as follows:

• In Base Directory, enter the path to the directory from which you want to deletethe entire contents. For example:

C:\_Demo\2_INT\INT_DeployArea\QSocial\APP

• In Include, enter **/*.

• Use defaults for the remaining fields.

Plug-ins Guide 27

Step 2: Download Artifacts

The second step will download all of the artifacts for the current APP component versionfrom CodeStation to the component's base directory.

From Repositories > Artifact > SerenaRA, drag Download Artifacts to the graphicaldesign space.

Set the properties as follows:

• In Directory Offset, enter the path to the directory into which you want todownload the artifacts. For example:

C:\_Demo\2_INT\INT_DeployArea\QSocial\APP



Step 3: Undeploy Application

The third step will delete all files from all directories, starting at the base directory for thecomponent.

From Application Server > Java > Tomcat, drag Undeploy Application to the graphicaldesign space.




• In the Tomcat Manager URL field, enter ${p:environment/tomcat_url}/manager/text.

• In the Tomcat Manager Username field, enter the username. For example,tomcat.

• In the Tomcat Manager Password field, enter the password. For example, tomcat.

• In the Context Name field, enter web application for this virtual host. For example,/qsocial.

• Select the Allow Failure option.


In case of a valid failure, such as if the QSocial application was not previouslydeployed in this environment, this causes the process to continue with the next step.

Step 4: Start Tomcat

The fourth step will start the Tomcat application server.

From Application Server > Java > Tomcat, drag Start to the graphical design space.


• In the Launcher field, enter the variable value ${p:environment/tomcat_start}.

• In the Startup timeout field, enter the value 30.

• In the Port field, enter the variable value ${p:environment/tomcat_port}.

• In the Hostname field, enter the variable value ${p:environment/tomcat_host}.

• In the Catalina Home field, enter the variable value ${p:environment/tomcat_home}.

Plug-ins Guide 29

• Select the Allow Failure option.

In case of a valid failure, such as if the step tries to start the Tomcat server and it isalready running, this causes the process to continue with the next step.


Related Topics

Chapter 5: Apache Tomcat Plug-in [page 49]

Step 5: Deploy Application

The fifth step will deploy the qsocial application.

From Application Server > Java > Tomcat, drag Deploy Application to the graphicaldesign space.




• In the Tomcat Manager URL field, enter ${p:environment/tomcat_url}/manager/text.

• In the Tomcat Manager Username field, enter the username. For example,tomcat.

• In the Tomcat Manager Password field, enter the password. For example,tomcat.

• In the Context Name field, enter /qsocial.

• In the War File Path field, enter ${p:environment/war_path}.


Plug-ins Guide 31

The APP Component Deployment Graphic Process

After selecting the preceding steps and filling in their properties, connect the steps asshown in the following graphical view of the QSocial APP component process.



Designing a Process to Deploy the Web Component

The Web component of the QSocial application is represented by a directory of image filesused throughout a Web site.

The process you will design to automate the Web component deployment will do thefollowing:

1. Delete files and directories from the environment

2. Download the updated artifacts

3. Remove the Web site files from the Tomcat server structure

4. Copy the replacements back into the proper place for Tomcat to serve them

The plug-in steps and property settings are shown in the following topics:

• Step 1: Delete Files and Directories from the Environment [page 33]

• Step 2: Download Artifacts [page 33]

• Step 3: Delete Files and Directories from the Website [page 34]

• Step 4: Copy Directories [page 34]

• The Web Component Deployment Graphic Process [page 35]

Step 1: Delete Files and Directories from the Environment

The first step will delete all files from all directories, starting at the base directory for theQSocial Web component.

1. Select the QSocial Web component and select Processes.

2. Click Create New Process.

3. Enter the name Deploy QSocial WEB and accept defaults for the rest of the settings.

4. Select the process and from Available Plugin Steps, Utilities > FileUtils, dragDelete Files and Directories to the graphical design space.

5. Set the properties as follows:

• In Base Directory, enter the path to the directory from which you want to deletethe entire contents. For example:

C:\_Demo\2_INT\INT_DeployArea\QSocial\WEB

• In Include, enter **/*


Step 2: Download Artifacts

The second step will download all of the artifacts for the current Web component versionfrom CodeStation to the component's base directory.

Plug-ins Guide 33

From Repositories > Artifact > SerenaRA, drag Download Artifacts to the graphicaldesign space.

Set the step properties as follows:

• In Directory Offset, enter the path to the directory into which you want todownload the artifacts. For example,C:\_Demo\2_INT\INT_DeployArea\QSocial\WEB.



Step 3: Delete Files and Directories from the Website

The third step will delete all files from all directories, starting at the base directory for thecomponent.

From Utilities > FileUtils, drag Delete Files and Directories to the graphical designspace.

Set the step properties as follows:

• Give the step a unique name, such as Delete Files and Directories fromWebsite.

• In Base Directory, enter ${p:environment.tomcat_home}/webapps/qsocial/images.



Step 4: Copy Directories

The fourth step will copy all files from all directories, starting at the base directory for thecomponent.

From Utilities > FileUtils, drag Copy Directory to the graphical design space.


• In the Source Directory field, enter the path to the directory from which you want tocopy. For example:

C:\_Demo\2_INT\INT_DeployArea\QSocial\WEB\images

• In the Destination Directories field, enter the path to the directory to which you wantto copy. For example:

${p:environment/tomcat_home}/webapps/qsocial/images




The Web Component Deployment Graphic Process

After selecting the preceding steps and filling in their properties, connect the steps asshown in the following graphical view of the QSocial Web component process.

Configuring the Component Environment Properties

You must configure the environment properties for the components so that the propertyvalues are filled in uniquely for each environment. This is done in two parts, as describedin the following sections:

• Adding the Component Environment Properties [page 36]

• Designating Values for the Properties in the Environment [page 37]

Plug-ins Guide 35

Adding the Component Environment Properties

You must first add the properties to the components in the Environment Properties sectionfor each component. At this time, you define the properties, but do not yet give them avalue. Remember that you used variables in the processes when you referenced theTomcat information. Add the properties for the two components as follows:

1. Select the QSocial APP component Properties tab and in the EnvironmentProperty Definitions section, set the following properties with no values:

• tomcat_home

• tomcat_host

• tomcat_port

• tomcat_start

• tomcat_url

• war_path

2. Select the QSocial WEB component Properties tab and in the EnvironmentProperty Definitions section, set the following properties with no values:

• tomcat_home

Important: The tomcat_home property must be set for each component, eventhough they share the value in the associated environment.



The properties now set for the QSocial APP component are shown in the following figure.

Designating Values for the Properties in the Environment

After you create the environment properties in the components, the properties appearunder each environment to which the component is mapped, and you can fill in the valuesthere.

Plug-ins Guide 37

Now designate values for the properties at the environment level so that the variables inthe component processes will be appropriately resolved for each environment you run theprocess against. In this example, this is the INT environment.

Select the INT environment Properties tab and then select and set the properties usingthe following examples:

• tomcat.home: c:\tomcat8

• tomcat_host: rademo

• tomcat_port : 9095

• tomcat.start: c:\tomcat8\bin\startup.bat

• tomcat.stop: c:\tomcat8\bin\shutdown.bat

• tomcat.svcname: Tomcat8

• tomcat.url: http://rademo:9095/

• war.path: c:\_Demo\2_INT\INT_DeployArea\QSocial\APP\qsocial.war

The properties now set for the INT environment are shown in the following figure.

Note: Since the tomcat_home property is set in both components, you canchoose Split Values Per Component if you need to set different values. In thiscase, the value is the same for both components, so you should use Set SingleValue.



Designing an Application Process to Run the Deployment

Now you will design an application process for the QSocial application that will kick off thetwo component processes that you have set up.

For the QSocial application, you will create an application process called Deploy QSocialApplication.

1. Select the QSocial application and select Processes.

2. Click Create Process.

3. Enter the name Deploy QSocial Application and accept defaults for the rest ofthe settings.

Next, design the application process, Deploy QSocial Application, as follows:

Plug-ins Guide 39

1. Execute the APP Component process

Drag and drop the Install Component step to the design space and fill in theproperties as follows:

• In the name field, enter Install QSocial App.

• In Component, select QSocial App.

• In Component Process, select Deploy QSocial APP.

2. Execute the Web Component process

Drag and drop the Install Component step to the design space and fill in theproperties as follows:

• In the name field, enter Install QSocial WEB.

• In Component, select QSocial Web.

• In Component Process, select Deploy QSocial WEB.

After selecting the preceding steps and filling in their properties, connect the steps asshown in the following graphical view of the application process, Deploy QSocialApplication.



Deploying the Application

To perform our example deployment, run the application process from the INTenvironment as follows:

1. Select the QSocial application.

2. In the INT environment label box, click Request Process.

3. Specify the version of each component to deploy.

4. Look for and resolve any warnings at the bottom of the dialog box beforesubmitting.

5. Click Submit.

If your deployment was successful, you should be able to access the deployed version ofthe QSocial application using the following URL:

http://rademo:9095/qsocial

In Deployment Automation, validate successful deployment details or resolve faileddeployments as follows:

1. In the application History tab, click View Request to view the list of componentprocesses you requested.

2. Expand the component process and beside the component version, click Details tosee the step-by-step results for that process and version.

3. To view the results of a step, in the Actions column, click the Output Log icon, .Use the Output log to validate step results and resolve any issues.

Tip: If you have already done a successful deployment, but want to change theprocess configuration and deploy using the same version, deselect the OnlyChanged Versions checkbox before submitting.

Creating Components and Mapping Artifacts Accordingto TypeAnother example of plug-in usage is to take artifacts from a source control system, suchas PVCS, and map the ones that get deployed to an HTTP server into one component,those that get deployed to a J2EE container to another, and those that get deployed to adatabase to yet another.

In this example you could use the following plug-ins:

• Serena DA Component

• Serena DA Application

The steps in the process for this mapping would be similar to the following:

Repeat the following two steps for each of the three components you want to create, oneeach for the HTTP server, J2EE container, and database artifacts.

Step 1: From Serena DA > Components, Create Component


Plug-ins Guide 41

• Enter the component Name

• Set Source Config Type to PVCS

• In Source Config Properties, specify values for the PVCS Source Config properties,such as the following:

PCLI Path=<your_value>

Database Path=<your_value>

Base Path=<your_value>

Project Path=<your_value>

Archive Path=<your_value>

Includes=<your_value>

Excludes=<your_value>

User=<your_value>

Step 2: From Serena DA > Applications, Add Component To Application


• Enter the application your want to add the components to for Application Name

• Enter the name from the previous step for Component Name

For more information on the PVCS Source Config Type, see the Serena DeploymentAutomation User's Guide.

Single-component Deployment with Two ScheduledProcessesFor another example, you may have a single-component deployment that consists of twoprocesses: the first moves component files to a server on Friday night (a lengthyoperation), while the second deploys the files Saturday morning. You could use multipleplug-in steps to determine if the first process created all of the prerequisite conditionsbefore allowing the second scheduled process to begin.

This example could be done using the following operations:

1. Create the directory for the first component's files

2. Copy the first component's files to the server, scheduled for Friday night's date

3. Detect if the first component's files exist on the server

4. Make sure the designated JBoss application server is running

5. Deploy the copied .war files to the application server

6. Deploy other files and do other configuration steps as needed



Deploying to a WebSphere Application Server

If you want to deploy a J2EE EAR file to a WebSphere Application Server, you'll need toinclude several steps in your process.

Deploying a J2EE EAR file to WebSphere Application Server typically consists of thefollowing operations:

1. Transfer the EAR file to the target machine.

2. Stop the WebSphere server instance.

3. Invoke wsAdmin with deployment properties.

4. Start the WebSphere instance.

5. Verify that the deployment succeeded by accessing a specified URL.

Note: The WebSphere Application Server plug-in provides a configurableprocess step for each operation.

Plug-ins Guide 43

Part 2: Application Server ManagementPlug-ins


• Chapter 4: Apache HTTP Server Plug-in [page 47]

• Chapter 5: Apache Tomcat Plug-in [page 49]

• Chapter 6: GlassFish Plug-in [page 55]

• Chapter 7: IBM WebSphere Application Server Plug-in [page 57]

• Chapter 8: IBM WebSphere MB Plug-in [page 109]

• Chapter 9: IBM WebSphere MQ [page 117]

• Chapter 10: JBoss Plug-in [page 123]

• Chapter 11: IIS AdminScripts Plug-in [page 133]

• Chapter 12: IIS AppCmd Plug-in [page 137]

• Chapter 13: Microsoft IIS MS-Deploy Plug-in [page 147]

• Chapter 14: Oracle WebLogic WLDeploy Plug-in [page 153]

Plug-ins Guide 45

Part 2: Application Server Management Plug-ins


Chapter 4: Apache HTTP Server Plug-in

Apache HTTP Server is a public domain open source Web server for UNIX and Windows NToperating systems.

This plug-in has the following steps for you to add to your processes:

• Creating an Apache Start Step [page 47]

• Creating an Apache Stop Step [page 47]

For information about Apache HTTP Server, see http://httpd.apache.org/.

Related TopicsChapter 5: Apache Tomcat Plug-in [page 49]

Creating an Apache Start StepThis step starts Apache HTTP server.

Required properties: None

Optional properties:

PropertyName

Description

apachectlexecutablepath

The full path (including the executable) to the apachectl script, if noton the path. This is used only on *nix systems.

WindowsService name

The name of the Windows server used to control the Apache HTTPserver. This is only used on Windows systems.

Creating an Apache Stop StepThis step stops Apache HTTP server.



PropertyName

Description

apachectlexecutablepath

The full path (including the executable) to the apachectl script, if noton the path. This is used only on *nix systems.

Plug-ins Guide 47

http://httpd.apache.org/

PropertyName

Description

WindowsService name

The name of the Windows server used to control the Apache HTTPserver. This is only used on Windows systems.



Chapter 5: Apache Tomcat Plug-in

Apache Tomcat is an open source Web application server and servlet container. TheTomcat plug-in may be used during deployments to execute Tomcat runbook automationand deploy or un-deploy Tomcat applications.


• Creating a Tomcat Deploy Application Step [page 49]

• Creating a Tomcat Undeploy Application Step [page 50]

• Creating a Tomcat Start Application Step [page 50]

• Creating a Tomcat Stop Application Step [page 50]

• Creating a Tomcat Start Step [page 51]

• Creating a Tomcat Stop Step [page 52]

• Creating a Check if Tomcat is Alive Step [page 53]

For information about Apache Tomcat, see http://tomcat.apache.org/tomcat-7.0-doc/index.html.

Related TopicsChapter 4: Apache HTTP Server Plug-in [page 47]

Creating a Tomcat Deploy Application StepThis step deploys a Web application to Tomcat.

Required properties:

Property Name Description

Tomcat Manager URL The URL of the Tomcat Manager interface.

Tomcat ManagerUsername

The username to use to login to the Tomcat Managerinterface.

Tomcat ManagerPassword

The password to use to login to the Tomcat Managerinterface.

Context Name The context that is being deployed.

War File Path The path to the war file being deployed.

Plug-ins Guide 49

http://tomcat.apache.org/tomcat-7.0-doc/index.html

http://tomcat.apache.org/tomcat-7.0-doc/index.html



Context XMLpath

The path of the context configuration file for this application, ifany.

Creating a Tomcat Undeploy Application StepThis step undeploys a Web application on Tomcat.









Optional properties: None

Creating a Tomcat Start Application StepThis step starts a Web application that is already deployed on Tomcat.










Creating a Tomcat Stop Application StepThis step stops a Web application that is already deployed on Tomcat.












Creating a Tomcat Start StepThis step starts Tomcat on the agent machine.


PropertyName

Description

Launcher The location of the Tomcat startup script. For example: /opt/tomcat/bin/startup.sh.


PropertyName

Description

Options New line-separated list of additional options to pass to startup script.

Startuptimeout(inseconds)

Enter a value here if you want the step to wait for the Tomcat instance tocomplete the boot process before continuing. You need to provide a portvalue below which will be used to detect when the boot process iscomplete.

Port Enter a port which the step would use to detect when the Tomcat instanceis up and running. You can specify any of the connector ports yourinstance is configured with.

Hostname If your Tomcat instance is not listening on localhost then provide thehostname where it can be reached when it's running. Only used if waitingfor Tomcat to complete its boot sequence. Defaults to localhost if notspecified.

Plug-ins Guide 51

PropertyName

Description

CatalinaHome

Provide a value if you want to overwrite the CATALINA_HOMEenvironment variable or if one is not available.

JDKHome

Provide a value if you want to overwrite the JAVA_HOME environmentvariable or if one is not available.

JRE Home Provide a value if you want to overwrite the JRE_HOME environmentvariable or if one is not available.

Creating a Tomcat Stop StepThis step stops Tomcat on the agent machine.


PropertyName

Description

Launcher The location of the Tomcat startup script. For example: /opt/tomcat/bin/startup.sh.


PropertyName

Description

Options New line-separated list of additional options to pass to startup script.

Shutdowntimeout(inseconds)

Enter a value here if you want the step to wait for the Tomcat instance tocomplete the shutdown sequence before continuing. You need to provide aport value below which will be used to detect when the shutdown processis complete.



CatalinaHome

Provide a value if you want to overwrite the CATALINA_HOMEenvironment variable or if one is not available.



PropertyName

Description

JDKHome

Provide a value if you want to overwrite the JAVA_HOME environmentvariable or if one is not available.

JRE Home Provide a value if you want to overwrite the JRE_HOME environmentvariable or if one is not available.

Creating a Check if Tomcat is Alive StepThis step checks to see if Tomcat is running on the agent machine.



PropertyName

Description

Checktimeout(inseconds)

Enter a value here if you want the step to wait for Tomcat to appear atselected host and port. Defaults to no timeout. Checks just once.



Plug-ins Guide 53

Chapter 6: GlassFish Plug-in

GlassFish is an open source application server project started by Sun Microsystems for theJava EE platform; it is now sponsored by Oracle Corporation.


• Deploy Application

• Undeploy Application

• Redeploy Application

• Enable Application

• Disable Application

• Start Domain

• Stop Domain

• Execute asadmin

For information about GlassFish, see https://glassfish.java.net/documentation.html.

Plug-ins Guide 55

https://glassfish.java.net/documentation.html

Chapter 7: IBM WebSphere ApplicationServer Plug-in

The IBM WebSphere Application Server, also known as WAS, is an Application Server builtusing J2EE, XML, and Web Services. WAS is supported on Windows, AIX, and Linux, aswell as other operating systems.

IBM WebSphere Application Server provides a Java application server runtimeenvironment and it can be used to connect website users to servlets. It allows users tocreate and manage sophisticated business websites.


• Creating a WebSphere Check Application is Not Running Step [page 58]

• Creating a WebSphere Check Application is Running on Server or Cluster Step [page60]

• Creating a WebSphere Check if Config Object Exists Step [page 61]

• Creating a WebSphere Check Initial Heap Size Step [page 62]

• Creating a WebSphere Check Maximum Heap Size Step [page 63]

• Creating a WebSphere Check Status Step [page 64]

• Creating a WebSphere Create Cluster step [page 66]

• Creating a WebSphere Create Cluster Member Step [page 66]

• Creating a WebSphere Create DataSource Step [page 67]

• Creating a WebSphere Create DataSource for Cluster Step [page 69]

• Creating a WebSphere Create JDBCProvider for Cluster Step [page 71]

• Creating a WebSphere Create JDBCProvider Step [page 72]

• Creating a WebSphere Create a SIBJMSConnectionFactory Step [page 73]

• Creating a WebSphere Create SIBJMSQueue Step [page 75]

• Creating a WebSphere Create SIBJMSTopic Step [page 76]

• Creating an WebSphere Execute wsadmin Script Step [page 77]

• Creating a WebSphere Export DataSource Properties from a Cluster Step [page 79]

• Creating an WebSphere Export JVMHeapSizes from Server Step [page 80]

• Creating a WebSphere Export Application Step [page 81]

Plug-ins Guide 57

• Creating a WebSphere Generate Plugin Step [page 82]

• Creating a WebSphere Import DataSource Properties into Cluster Step [page 84]

• Creating a WebSphere Import JVMHeapSizes for Cluster Step [page 85]

• Creating a WebSphere Install Application Step [page 86]

• Creating a WebSphere Install or Update Application Step [page 88]

• Creating a WebSphere Modify Application ClassLoaders Step [page 90]

• Creating a WebSphere Restart Application Step [page 91]

• Creating a WebSphere Restart Server Step [page 92]

• Creating a WebSphere Start Application Step [page 94]

• Creating a WebSphere Start Server Step [page 95]

• Creating a WebSphere Stop Application Step [page 96]

• Creating a WebSphere Stop Server Step [page 97]

• Creating a WebSphere Synchronize Nodes Step [page 99]

• Creating a WebSphere Uninstall Application Step [page 99]

• Creating a WebSphere Update J2EEResourceProperty on a Config Object Step [page101]

• Creating a WebSphere Update Simple Attribute on Object Step [page 102]

• Creating a WebSphere Update Application Step [page 103]

• Creating a WebSphere Wait for Application Step [page 105]

• Creating a Websphere Wait for Server or Cluster Step [page 107]

For information about WAS, see http://www-01.ibm.com/software/websphere/.

Creating a WebSphere Check Application is NotRunning StepThis step is used to ensure an application is not running.


PropertyName

Description

Name Enter the name of your Check Application is Not Running step.

ApplicationName

Set the name of the application that you want to check.



http://www-01.ibm.com/software/websphere/

PropertyName

Description

ConnectionType

Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:

• SOAP

• RMI

• NONE


PropertyName

Description

Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.

Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.

Server Name The name of the server to be administered.

Cluster Name The name of the cluster to be administered.

Command Path The directory location of the wsadmin command-line executable. Forexample:

/opt/IBM/WebSphere/AppServer/bin/

The default value is: ${p:resource/websphere.commandPath}.

User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.

Password The password to be used to connect to the WebSphere Node.

Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.

Host Hostname of the server to connect to.

Port The port to connect to.

AdditionalCommand LineArguments

New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.

Plug-ins Guide 59

Creating a WebSphere Check Application is Running onServer or Cluster StepUse this step to check to make sure an application is running on a server or cluster.


PropertyName

Description

Name Enter the name for your Check Application is Not Running step.

ApplicationName

Set the name of the application that you want to check.

ConnectionType


• SOAP

• RMI

• NONE


PropertyName

Description












PropertyName

Description






Creating a WebSphere Check if Config Object ExistsStepUse this step to check if a config object exists in the WebSphere Configuration byContainment Path.


PropertyName

Description

Name Enter a name for the Check if Config Object Exists step.

ConnectionType


• SOAP

• RMI

• NONE

ObjectContainmentPath

Enter the containment path to the object to check for. For example:/Cell:cellName/ServerCluster:clusterName/JDBCProvider:providerName/.

Note: The path must end with a JDBCProvider type and a "/".

Plug-ins Guide 61


PropertyName

Description

CommandPath

The directory location of the wsadmin command-line executable. Forexample:



UserName

The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.


PasswordScript

If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.



Creating a WebSphere Check Initial Heap Size StepUse this step to check the initial heap size.


PropertyName

Description

Name Enter the name for your Check Initial Heap Size step.

ConnectionType


• SOAP

• RMI

• NONE

Server Name Enter the name of the server to check.

MinimumSize (MB)

Enter the minimum expected heap size in MBs.



PropertyName

Description

MaximumSize (MB)

Enter the maximum expected heap size in MBs.


PropertyName

Description

CommandPath




UserName



PasswordScript




Creating a WebSphere Check Maximum Heap Size StepUse this step to check the maximum heap size.


PropertyName

Description

Name Enter the name for your Check Maximum Heap Size step.

ConnectionType


• SOAP

• RMI

• NONE

Plug-ins Guide 63

PropertyName

Description


MinimumSize (MB)


MaximumSize (MB)



PropertyName

Description

CommandPath




UserName



PasswordScript




Creating a WebSphere Check Status StepThis step is used to check the status of a WebSphere server or cluster.


PropertyName

Description

Name Enter the name for your Check Status step.



PropertyName

Description

ConnectionType


• SOAP

• RMI

• NONE


PropertyName

Description















Plug-ins Guide 65

Creating a WebSphere Create Cluster stepThis step is used to create a new WebSphere cluster.


PropertyName

Description

Name Enter the name for your Create Cluster step.

ConnectionType


• SOAP

• RMI

• NONE

ClusterName

Enter the name of the new cluster that you want to create.


PropertyName

Description

CommandPath




UserName



PasswordScript




Creating a WebSphere Create Cluster Member StepThis step is used to create a new WebSphere cluster member.




PropertyName

Description

Name Enter the name for your Create Cluster Member step.

ConnectionType


• SOAP

• RMI

• NONE

ClusterName

Enter the name of the new cluster member that you want to create.

Node Name Enter the name of the node for the new cluster member.


PropertyName

Description

CommandPath




UserName



PasswordScript




Creating a WebSphere Create DataSource StepUse this step to create a DataSource on a given JDBCProvider.

Plug-ins Guide 67


PropertyName

Description

Name Enter the name for your Create DataSource step.

ConnectionType


• SOAP

• RMI

• NONE

JDBCProviderLocation

Enter the containment path to the JDBCProvider. For example:/Cell:cellName/ServerCluster:clusterName/JDBCProvider:providerName/.

Note: The path must end with a JDBCProvider type and a"/".

DataSourceName

Enter the name of the datasource you want to create.

DataStoreHelperClassName

Enter the ClassName of the DataStore Helper.

DB Name Enter the database name for the datasource.

JNDI Name Enter the JNDI name for the datasource.

Auth Alias Enter the auth alias to create or use for the datasource.

AliasUsername

Enter the username for the Auth Alias if it does not already exist.

AliasPassword

Enter the password for the Auth Alias if it does not already exist.

Description Enter a description for the datasource.




PropertyName

Description

CommandPath




UserName



PasswordScript




Creating a WebSphere Create DataSource for ClusterStepThis step is used to create a DataSource on a WebSphere cluster.



Name Enter the name for your Create DataSource for Cluster step.

Connection Type Select the Connection Type to use with wsadmin. The defaultvalue is "SOAP". Possible values are:

• SOAP

• RMI

• NONE

Cluster Name Enter the name of the cluster that hosts the JDBCProvider.

JDBCProviderName

Enter the name of the JDBCProvider.

Plug-ins Guide 69


DataSource Name Enter the name of the datasource you want to create.

DataStore HelperClassName




Driver Type Enter the type of driver that is used by the datasource.

Server Name Enter the name of the server to which the datasource connects.

Port Number Enter the server's port number.


Alias Username Enter the username for the Auth Alias if it does not already exist.

Alias Password Enter the password for the Auth Alias if it does not already exist.



PropertyName

Description

CommandPath




UserName



PasswordScript






Creating a WebSphere Create JDBCProvider for ClusterStepUse this step to create a JDBCProvider on a cluster.



Name Enter the name for your Create JDBCProvider for Cluster step.


• SOAP

• RMI

• NONE

Cluster Name Enter the name of the cluster that hosts the JDBCProvider.

JDBCProviderName

Enter the name of the JDBCProvider.

DataSource Name Enter the name of the datasource you want to create.

DataStore HelperClassName




Driver Type Enter the type of driver that is used by the datasource.

Server Name Enter the name of the server to which the datasource connects.

Port Number Enter the server's port number.


Alias Username Enter the username for the Auth Alias if it does not already exist.

Alias Password Enter the password for the Auth Alias if it does not already exist.


Plug-ins Guide 71


PropertyName

Description

CommandPath




UserName



PasswordScript




Creating a WebSphere Create JDBCProvider StepUse this step to create a JDBCProvider with specified scope.


PropertyName

Description

Name Enter the name for your Create JDBCProvider step.

ConnectionType

Select the Connection Type to use with wsadmin. The default valueis "SOAP". Possible values are:

• SOAP

• RMI

• NONE

Scope Enter the scope at which to create the JDBCProvider in the format:type=name. The type can be a Cell, Node, Server, Application, orCluster, and name is a specific instance of the cell, node, server,application, or cluster that you are using.

DB Type Enter the database type of the JDBCProvider you want to create.



PropertyName

Description

Provider Type Enter the provider type of the JDBCProvider you want to create.

ImplementationType

Enter the implementation type of the JDBCProvider.

Description Enter a description for the JDBCProvider.

Class Path Enter the class path of the JDBCProvider.

Native Path Enter the native path of the JDBCProvider.


PropertyName

Description

CommandPath




UserName



PasswordScript




Creating a WebSphere Create aSIBJMSConnectionFactory StepUse this step to create a SIBJMSConnectionFactory on a give scope.

Plug-ins Guide 73



Name Enter the name for your Create SIBJMSConnectionFactorystep.

Connection Type Select the Connection Type to use with wsadmin. Thedefault value is "SOAP". Possible values are:

• SOAP

• RMI

• NONE

Scope Enter the scope, which is the containment path to theparent on which to create this SIBJMSConnectionFactory.For example: /Cell:cellName/ServerCluster:clusterName/.

Note: The path must end with a "/".

SIBJMSConnectionFactoryName

Enter a name for the SIBJMSConnectionFactory you wantto create.

JNDI Name Enter a JNDI name for the factory you want to create.

Bus Name Enter the name of the SIBus to associate with thisConnection Factory.

Type Enter the type of Connection Factory to create. Use Queueor Topic.


PropertyName

Description

CommandPath




UserName




PropertyName

Description


PasswordScript




Creating a WebSphere Create SIBJMSQueue StepThis step will create a SIBJMSQueue on a given scope.


PropertyName

Description

Name Enter the name for your Create SIMJBSQueue step.

ConnectionType


• SOAP

• RMI

• NONE

Scope Enter the scope, which is the containment path to the parent on whichto create this SIBJMSQueue. For example: /Cell:cellName/ServerCluster:clusterName/.


SIBJMSQueueName

Enter a SIBJMSQueue name for the queue you want to create.

JNDI Name Enter a JNDI name for the queue you want to create.

Queue Name Enter the queue name of the service integration bus destination towhich this queue maps.

Plug-ins Guide 75


PropertyName

Description

CommandPath




UserName



PasswordScript




Creating a WebSphere Create SIBJMSTopic StepThis step will create a SIBJMSTopic on a given scope.


PropertyName

Description

Name Enter the name for your Create SIMJBSTopic step.

ConnectionType


• SOAP

• RMI

• NONE



PropertyName

Description

Scope Enter the scope, which is the containment path to the parent on whichto create this SIBJMSTopic. For example: /Cell:cellName/ServerCluster:clusterName/.


SIBJMSTopicName

Enter a SIBJMSTopic name for the topic you want to create.

JNDI Name Enter a JNDI name for the topic you want to create.


PropertyName

Description

CommandPath




UserName



PasswordScript




Creating an WebSphere Execute wsadmin Script StepThis step is used to execute a Jython of JACL script through wsadmin.

Plug-ins Guide 77


PropertyName

Description

Name Enter the name for your Execute wsadmin Script step.

Script Path Enter the script path to call wsadmin.

Language Enter the language for the script. Possible values are: Jython or JACL.

ConnectionType


• SOAP

• RMI

• NONE


PropertyName

Description













PropertyName

Description





Creating a WebSphere Export DataSource Propertiesfrom a Cluster StepThis step is used to export the datasource properties from a cluster.


PropertyName

Description

Name Enter the name for your Export DataSource Properties from a Clusterstep.

ConnectionType


• SOAP

• RMI

• NONE

Cluster Name Enter the cluster name that hosts the JDBCProvider.

JDBCPRoviderName

Enter the name of the JDBCProvider for the datasource.

DataSourceName

Enter the name of the datasource from which to get properties.

Plug-ins Guide 79


PropertyName

Description

CommandPath




UserName



PasswordScript




Creating an WebSphere Export JVMHeapSizes fromServer StepUse this step to export the JVM heap size values from a WebSphere server.


PropertyName

Description

Name Enter the name for your Export JVMHeapSizes from Server step.

ConnectionType


• SOAP

• RMI

• NONE

ServerName

Enter the name of the server from which to export the heap size.




PropertyName

Description

CommandPath




UserName



PasswordScript




Creating a WebSphere Export Application StepThis step is used to export an application from the WebSphere server.


PropertyName

Description

Name Enter the name of your Export Application step.

ApplicationName

Set the name of the application that you want to export. This is the nameused by WebSphere for reference.

File Path Set the path of the file to store. This must be expressed as an absolutepath.

ConnectionType


• SOAP

• RMI

• NONE

Plug-ins Guide 81


PropertyName

Description















Creating a WebSphere Generate Plugin StepUse this step to generate a WebSphere plugin for WebServers to use.



Name Enter the name of your Generate Plugin step.

Application ServerRoot Directory

Enter the path for the application server root directory.




Configuration RepoRoot Directory

Enter the root directory of the configuration repo were theplugin should be created


• SOAP

• RMI

• NONE


PropertyName

Description













Plug-ins Guide 83

PropertyName

Description



Creating a WebSphere Import DataSource Propertiesinto Cluster StepUse this step to import the datasource properties into a cluster.


PropertyName

Description

Name Enter the name for your Import Datasource Properties into a Clusterstep.

ConnectionType


• SOAP

• RMI

• NONE

Cluster Name Enter the cluster name for the JDBCProvider.

JDBCPRoviderName

Enter the JDBCPRovider Name for the datasource.

DataSourceName

Enter the name of the datasource from which to get properties.

ConnectionTimeout

Enter the connection timeout to use.

StatementCache Size

Enter the statement cache size to use.




PropertyName

Description

CommandPath




UserName



PasswordScript




Creating a WebSphere Import JVMHeapSizes forCluster StepUse this step to import the JVM heap size values for all servers in a cluster.


PropertyName

Description

Name Enter the name for your Import JVMHeapSizes for Cluster step.

ConnectionType


• SOAP

• RMI

• NONE

Cluster Name Enter the name of the cluster to be updated.

Initial HeapSize

Enter the initial heap size to use for all servers in the cluster.

Plug-ins Guide 85

PropertyName

Description

MaximumHeap Size

Enter the maximum heap size to use for all servers in the cluster.


PropertyName

Description

CommandPath




UserName



PasswordScript




Creating a WebSphere Install Application StepThis step is used to install an application to the WebSphere server or cluster. It is wellsuited to installing an application to WebSphere for the first time.


PropertyName

Description

Name Enter the name for your Install or Install Application step.

Context Root Set the context root path for this application. Default is "/".

ApplicationSource

Set the location of the application to install to WebSphere.

ApplicationName

The name of the application you want to install. This is used forWebSphere reference.



PropertyName

Description

ConnectionType


• SOAP

• RMI

• NONE


MinimumSize (MB)


MaximumSize (MB)



PropertyName

Description

ApplicationPath

The path for the application to be installed on the server.

Options String The string of options to be concatenated onto the install command.









Plug-ins Guide 87

PropertyName

Description







Creating a WebSphere Install or Update ApplicationStepThis step is used to install or update an existing application to the WebSphere server orcluster. It is suited to reinstalling an application over an existing application on theWebSphere server.


PropertyName

Description

Name Enter the name for your Install or Update Application step.

Context Root Set the context root path for this application. Default is "/".

ApplicationSource

Set the location of the application to install to WebSphere.

ApplicationName

The name of the application you want to install. This is used forWebSphere reference.

ConnectionType


• SOAP

• RMI

• NONE




PropertyName

Description

MinimumSize (MB)


MaximumSize (MB)



PropertyName

Description

ApplicationPath

The path for the application to be installed on the server.

Options String The string of options to be concatenated onto the install command.













Plug-ins Guide 89

PropertyName

Description



Creating a WebSphere Modify Application ClassLoadersStepUse this step if you need to modify the classloaders for an application and itswebmodules.


PropertyName

Description

Name Enter the name for your Modify Application ClassLoaders step.

ConnectionType


• SOAP

• RMI

• NONE


PropertyName

Description






PasswordScript

If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.



PropertyName

Description



ApplicationName

The name of the application for which to update classloaders.

ApplicationClassLoader

PARENT_FIRST or PARENT_LAST. The Classloader mode to use forthe overall application. The default value is PARENT_FIRST.

WebModuleClassLoader

PARENT_FIRST or PARENT_LAST. The Classloader mode to use forthe webmodules in the given application. The default value isPARENT_FIRST.

AdditionalCommandLineArguments

New line separated list of additional commandline arguments to passto wsadmin. These will be appended as the last arguments of thecommand line.

Creating a WebSphere Restart Application StepThis step is used to restart an application on the WebSphere server or cluster.


PropertyName

Description

Name Enter the name of your Restart Application step.

ApplicationName

Set the name of the application that you want to restart. This is thename used for WebSphere reference.

ConnectionType


• SOAP

• RMI

• NONE

Plug-ins Guide 91


PropertyName

Description















Creating a WebSphere Restart Server StepThis step is used to restart a WebSphere server or cluster.


PropertyName

Description

Name Enter the name of your Restart Server step.



PropertyName

Description

ConnectionType


• SOAP

• RMI

• NONE


PropertyName

Description















Plug-ins Guide 93

Creating a WebSphere Start Application StepThis step is used to start an application on the WebSphere server or cluster.


PropertyName

Description

Name Enter the name of your Start Application step.

ApplicationName

Set the name of the application that you want to start. This is the nameused for WebSphere reference.

ConnectionType


• SOAP

• RMI

• NONE


PropertyName

Description












PropertyName

Description






Creating a WebSphere Start Server StepThis step is used to start a WebSphere server or cluster.


PropertyName

Description

Name Enter the name of your Start Server step.

ConnectionType


• SOAP

• RMI

• NONE


PropertyName

Description





Plug-ins Guide 95

PropertyName

Description











Creating a WebSphere Stop Application StepThis step is used to stop an application on the WebSphere server or cluster.


PropertyName

Description

Name Enter the name of your Stop Application step.

ApplicationName

Set the name of the application that you want to stop. This is the nameused for WebSphere reference.

ConnectionType


• SOAP

• RMI

• NONE




PropertyName

Description















Creating a WebSphere Stop Server StepThis step is used to stop a WebSphere server or cluster.


PropertyName

Description

Name Enter the name of your Stop Server step.

Plug-ins Guide 97

PropertyName

Description

ConnectionType


• SOAP

• RMI

• NONE


PropertyName

Description

















Creating a WebSphere Synchronize Nodes StepUse this step to synchronize all nodes in the WebSphere cell.


PropertyName

Description

Name Enter the name for your Synchronize Nodes step.

ConnectionType


• SOAP

• RMI

• NONE


PropertyName

Description

CommandPath




UserName



PasswordScript




Creating a WebSphere Uninstall Application StepThis step is used to uninstall an application from the WebSphere server or cluster.

Plug-ins Guide 99


PropertyName

Description

Name Enter the name of your Uninstall Application step.

ApplicationName

Set the name of the application that will be uninstalled. This is the nameused for WebSphere reference.

ConnectionType


• SOAP

• RMI

• NONE


PropertyName

Description













PropertyName

Description





Creating a WebSphere Update J2EEResourcePropertyon a Config Object StepThis step is used to create or update a J2EEResourceProperty on a config object.


PropertyName

Description

Name Enter the name for your Update J2EEResourceProperty on a ConfigObject step.

ConnectionType


• SOAP

• RMI

• NONE


Enter the path to the object on which to update a property. Forexample: /Cell:cellName/ServerCluster:clusterName/.


PropertyName

Enter the name of the property you want to update.

Value Enter the value for the property.

Type Enter the type of the property.

Plug-ins Guide 101


PropertyName

Description

CommandPath




UserName



PasswordScript




Creating a WebSphere Update Simple Attribute onObject StepUse this step to update a simple attribute on a config object.


PropertyName

Description

Name Enter the name for your Update Simple Attribute on Object step.

ConnectionType


• SOAP

• RMI

• NONE



PropertyName

Description


Enter the path to the object on which to update an attribute. Forexample: /Cell:cellName/ServerCluster:clusterName/.


AttributeName

Enter the name of the attribute you want to update.

Value Enter the value for the attribute.


PropertyName

Description

CommandPath




UserName



PasswordScript




Creating a WebSphere Update Application StepThis step is used to update an application on the WebSphere server or cluster.


PropertyName

Description

Name Enter the name of your Install Application step.

Plug-ins Guide 103

PropertyName

Description

ApplicationName

Set the name of the application that is being updated. This is the nameused for WebSphere reference.

ContentType

Set the content type for the update. Possibile values are:

• Application

• File

• Module File

• Partial Application

Operation Set the operation to be performed during this update. (If this is anapplication update or a partial application update, you must enterUpdate.) Possible values are:

• Update

• Add

• Delete

• Add or Update

ContentPath

Set the location of the contents that will update the application.

ConnectionType


• SOAP

• RMI

• NONE


PropertyName

Description

Content URI If the content type is File, this should be the location of the file to beupdated, relative to the EAR root.

Options String The string of options to be concatenated onto the update command.



PropertyName

Description















Creating a WebSphere Wait for Application StepThis step is used to create a wait step while a WebSphere server or cluster becomesready.


PropertyName

Description

Name Enter the name of your Wait for Application step.

Plug-ins Guide 105

PropertyName

Description

ApplicationName

Set the name of the application to wait for.

ConnectionType


• SOAP

• RMI

• NONE


PropertyName

Description















PropertyName

Description



Creating a Websphere Wait for Server or Cluster StepUse this step to build in a wait period for a WebSphere server or cluster to be started.


PropertyName

Description

Name Enter the name of your Wait for Server or Cluster step.

ConnectionType


• SOAP

• RMI

• NONE


PropertyName

Description








Plug-ins Guide 107

PropertyName

Description










Chapter 8: IBM WebSphere MB Plug-in

The IBM WebSphere Message Broker (WebSphere MB) API is also known as theConfiguration Manager Proxy (CMP) or CMP API. The CMP API consists of a Javaimplementation and allows applications to control brokers and their resources.

WebSphere MB can translate messages between two devices using different protocols forcommunication. This allows heterogeneous applications to communicate without having toknow specific implementation details about the application with which they are trying tocommunicate.

The WebSphere MB plug-in enables you to deploy broker archives and start and stopmessage flows using the CMP API.


• Creating a WebSphere WMB Set Broker Properties Step [page 109]

• Creating a WebSphere WMB Set Execution Group Properties Step [page 110]

• Creating a WebSphere WMB Set Message Flows Property Step [page 111]

• Creating a WebSphere WMB Delete Flows Using RegEx Step [page 112]

• Creating a WebSphere WMB Deploy Step [page 113]

• Creating a WebSphere WMB Start Message Flows Step [page 114]

• Creating a WebSphere WMB Stop Message Flows Step [page 115]

For information about WebSphere MB, see http://www-03.ibm.com/software/products/us/en/integration-bus.

Creating a WebSphere WMB Set Broker Properties StepThis step sets runtime properties for the broker.


PropertyName

Description

Properties A newline-separated list of properties that you want to set, provided inname=value format.

IP The IP address of the target server.

Port The port of the target server.

Plug-ins Guide 109

http://www-03.ibm.com/software/products/us/en/integration-bus

http://www-03.ibm.com/software/products/us/en/integration-bus

PropertyName

Description

QueueManager

The WebSphere Queue Manager that the broker is using.


PropertyName

Description

Username Specify an alternate username for authentication against WMQ in case thestep is running as an invalid user.

Trace File Used to specify the trace logging file. If no value is supplied, then tracelogging is disabled.

Jar Path The full path that contains both the ConfigManagerProxy.jar and thecom.ibm.mq.jar. For example: C:\ProgramFiles\IBM\MQSI\7.0\classes\ConfigManagerProxy.jar:C:\ProgramFiles\IBM\WebSphere MQ\java lib\com.ibm.mq.jar

Creating a WebSphere WMB Set Execution GroupProperties StepThis step sets runtime properties for an execution group.


PropertyName

Description

ExecutionGroup

The name of the Execution Group to deploy to.




QueueManager





PropertyName

Description




Creating a WebSphere WMB Set Message FlowsProperty StepThis step sets runtime properties on a list of message flow.



Execution Group The name of the Execution Group to deploy to.



Queue Manager The WebSphere Queue Manager that the broker is using.


PropertyName

Description

DirectoryOffset

The path under the current working directory where the step shouldexecute. Absolute paths are not allowed.

MessageFlows

A newline-separated list of message flows.


Plug-ins Guide 111

PropertyName

Description

PropertyFile

The name and path to a property file that contains the properties. Thiscan be used instead of explicitly providing all the properties in theProperties field and the flows in the Message Flows field. You mustspecify the property file in the same format as the mqsiapplybaroverridecommand.




Creating a WebSphere WMB Delete Flows Using RegExStepThis step deletes WMB flows that have been deployed using the BAR file that matches aprovided regular expression. This is useful for deploying into shared execution groups.


PropertyName

Description

RegEx A Java compliant regular expression that is used to locate the correct BARfile of deployed flows by matching its filename.

ExecutionGroup

The name of the Execution Group to deploy to.



QueueManager





PropertyName

Description

Timeout The amount of time to wait for each BAR file deploy result to come return(in milliseconds). The default value is 60000.




Creating a WebSphere WMB Deploy StepThis step deploys a broker archive.



BAR File Names A comma-separated list of broker archive files to deploy.

Execution Group The name of the Execution Group to deploy to.





PropertyName

Description

Value forFullDeploy

If selected, the execution group is emptied before deploy.

Timeout The amount of time to wait for each BAR file deploy result to come return(in milliseconds). The default value is 60000.

Plug-ins Guide 113

PropertyName

Description

Value forStart/StopMessageFlows

If selected, all message flows in the execution group are stopped beforedeployment and started after deployment.




Creating a WebSphere WMB Start Message Flows StepThis step starts message flows that are stopped.



Execution Group The name of the execution group.





PropertyName

Description

MessageFlows

A newline-separated list of message flow names to start.





PropertyName

Description


Creating a WebSphere WMB Stop Message Flows StepThis step stops message flows that are running.



Execution Group The name of the execution group.





PropertyName

Description

MessageFlows

A newline-separated list of message flow names to stop.




Plug-ins Guide 115

Chapter 9: IBM WebSphere MQ

The IBM WebSphere Message Queuing enables multiple heterogeneous applications tocommunicate across a network of dissimilar components such as processors, operatingsystems, subsystems, and communication protocols, using a consistent API so that themessage delivery process is decoupled from the actual application. Any type of data canbe transported as messages.


• Creating a WebSphere Create Queue Manager Step [page 117]

• Creating a WebSphere Manage Queue Depth Step [page 118]

• Creating a WebSphere Start Queue Manager Step [page 118]

• Creating a WebSphere Stop Queue Manager Step [page 119]

• Creating a WebSphere Define Queue Step [page 119]

• Creating a WebSphere Run MQ Script Step [page 120]

For information about WebSphere MQ, see http://www-01.ibm.com/software/websphere/.

Creating a WebSphere Create Queue Manager StepThis step runs the executable to create a Queue Manager.


PropertyName

Description

QueueName

The name of the queue manager you want to create.

CommandDirectory

Directory of the WebSphere MQ commands. For example: C:\ProgramFiles (x86)\IBM\WebSphere MQ\bin.


PropertyName

Description

QueueDescription

Descriptive text for the Queue Manager that is being created. Themaximum description length is 64 characters.

Plug-ins Guide 117

http://www-01.ibm.com/software/websphere/

PropertyName

Description

AdditionalArguments

Any additional arguments for the Create Queue Manager command.

Creating a WebSphere Manage Queue Depth StepThis step manages the queue depth.


PropertyName

Description

QueueManagerName

The name of the queue manager you want to edit.

Queue Name The name of the queue you want to edit.

CommandDirectory




High Depth Level The percentage of a Queue depth that constitutes "high".

Low Depth Level The percentage of a Queue depth that constitutes "low".

Max Depth Level The maximum number of messages in the queue.

AdditionalArguments

Any additional arguments for the Manage Queue Depthcommand.

Creating a WebSphere Start Queue Manager StepThis step starts a queue manager.




PropertyName

Description

QueueManagerName

The name of the queue manager you want to start.

CommandDirectory




AdditionalArguments

Any additional arguments for the Create Queue Managercommand.

Note: The queue manager must be created before it can be started.

Creating a WebSphere Stop Queue Manager StepThis step stops a queue manager.


PropertyName

Description

QueueManagerName

The name of the queue manager you want to stop.

CommandDirectory




AdditionalArguments


Creating a WebSphere Define Queue StepThis step defines a queue.

Plug-ins Guide 119


PropertyName

Description

QueueManagerName

The name of the queue manager that you want to use to define aqueue.

Queue Name The name of the queue that you want to define.

CommandDirectory




AdditionalArguments


Note: The queue manager must be created before a queue can be created.

Creating a WebSphere Run MQ Script StepThis step runs a custom MQ script that consists of MQ Control commands.


PropertyName

Description

QueueManagerName

The name of the queue manager on which to run the script.

Script Data The script to be run. Enter the actual commands that the script mustrun. For example: DISPLAY QUEUE ('My Queue').

CommandDirectory






AdditionalArguments


Plug-ins Guide 121

Chapter 10: JBoss Plug-in

JavaBeans Open Source Software (JBoss) is an open-source application server thatimplements Java EE.

The JBoss plug-ins automate a number of operations for a JBoss server. There are JBossplug-ins for JBoss 6 and earlier and JBoss 7. Load the plug-in that supports the version ofJBoss you are working with.

JBoss 6This plug-in has the following steps for you to add to your processes:

• Creating a Deploy Application Step [page 124]

• Creating a Deploy JDBC Driver Step [page 124]

• Creating an Undeploy Application Step [page 125]

• Creating a Start JBoss Step [page 126]

• Creating a Stop JBoss Step [page 126]

• Creating an Add Data Source Step [page 127]

• Creating an Add JMS Queue Step [page 127]

• Creating an Add JMS Topic Step [page 128]

• Creating an Add JMS Connection Factory Step [page 129]

• Creating a Remove JMS Connection Factory Step [page 129]

• Creating a Create Server Group Step [page 130]

• Creating a Run Script Step [page 130]

• Creating a Check Deployment Status Step [page 131]

• Creating an Enable Application Step [page 132]

• Creating a Disable Application Step [page 132]

JBoss 7This plug-in has the following steps for you to add to your processes:

• Check Status

• Start and wait

• Stop and wait

Plug-ins Guide 123

For information about JBoss, see http://www.jboss.org/jbossas.

Creating a Deploy Application StepThis step deploys an application to JBoss.


PropertyName

Description

JBoss CLIPath

The path to the JBoss Command Line Interface executable. For example:C:\wildfly-8.0.0.Alpha1\wildfly-8.0.0.Alpha1\bin.

ApplicationName

The name of the application to be deployed (including its file extension).If a source is not provided, the named application will be enabled instead.



Application/JAR path The source file of the application to deploy. If a source is notprovided, a name must be provided instead.

Value for Deploy ToAll Server Groups

If selected, the step will deploy to all servers. This is onlyapplicable in Domain Mode.

Deploy To ServerGroups

A comma-separated list of the servers to deploy to. This isonly applicable in Domain Mode.

Controller Name The controller name of the JBoss instance to connect to.

Creating a Deploy JDBC Driver StepThis step deploys a JDBC driver to JBoss.


PropertyName

Description

DBCDriverPath

The path to the JDBC Driver JAR.

JBoss CLIPath




http://www.jboss.org/jbossas



Driver Name The name of the driver. If a name is not provided, the filename (including .jar) is used as the name.

Value for Deploy ToAll Server Groups

If selected, the step will deploy to all servers. This is onlyapplicable in Domain Mode.

Deploy To ServerGroups

A comma-separated list of the servers to deploy to. This isonly applicable in Domain Mode.

Creating an Undeploy Application StepThis step undeploys an application in JBoss.


PropertyName

Description

ApplicationName

The name of the file to be undeployed (including its file extension).

JBoss CLIPath




Value for KeepContent

If selected, the content of the JBoss server will be kept. Theapplication will be deactivated, but nothing will be deleted.

Value for UndeployFrom All ServerGroups

If selected, this step will undeploy from all relevant servers.This is only applicable in Domain Mode.

Undeploy FromServer Groups

A comma-separated list of the servers to undeploy from. Thisis only applicable in Domain Mode.


Note: The Keep Content checkbox is not compatible with this step.

Plug-ins Guide 125

Creating a Start JBoss StepThis step starts JBoss in either Standalone or Domain mode.


PropertyName

Description

Startup Mode Determines the mode in which JBoss should start. Values include:

• Standalone

• Domain

JBoss StartupPath

The path to the JBoss startup executable. For example:C:\wildfly-8.0.0.Alpha1\wildfly-8.0.0.Alpha1\bin.

Server StartWait Timeout

The amount of time (in milliseconds) to wait for the server to startbefore declaring timeout. The default value is 10000.

Host Name The host name of the server to be started.

Port Number The port number of the server to be started.



ServerConfiguration

Enter a file name to start the server according to a specificconfiguration.

Creating a Stop JBoss StepThis step stops JBoss in either Standalone or Domain mode.


PropertyName

Description

JBossStartupPath




PropertyName

Description

ServerMode

Specifies the server mode. Values include:

• Standalone

• Domain


PropertyName

Description

Domain ModeHost Name

The name of the host. This is only required when the server is inDomain Mode. The default value is master.

Creating an Add Data Source StepThis step stops JBoss in either Standalone or Domain mode.


PropertyName

Description

JBossStartupPath


ServerMode

Specifies the server mode. Values include:

• Standalone

• Domain


PropertyName

Description

Domain ModeHost Name

The name of the host. This is only required when the server is inDomain Mode. The default value is master.

Creating an Add JMS Queue StepThis step adds a JMS Queue to JBoss.

Plug-ins Guide 127


PropertyName

Description

JBossStartupPath


QueueName

The name of the queue that you want to create.

Entries A comma-separated list of JNDI names that the queue will be bound to.



Profile The profile to add the queue to. This is required in domain mode.


Creating an Add JMS Topic StepThis step adds a JMS topic to JBoss.


PropertyName

Description

JBossStartupPath


TopicName

The name of the topic that you want to create.

Entries A comma-separated list of JNDI names that the topic will be bound to.



Profile The profile to add the topic to. This is required in domain mode.




Creating an Add JMS Connection Factory StepThis step adds a JMS topic to JBoss.


PropertyName

Description

JBossStartupPath


TopicName

The name of the topic that you want to create.

Entries A comma-separated list of JNDI names that the topic will be bound to.



Profile The profile to add the topic to. This is required in domain mode.


Creating a Remove JMS Connection Factory StepThis step removes a JMS connection factory from JBoss.


PropertyName

Description

JBossStartupPath


FactoryName

The name of the factory that you want to remove.


PropertyName

Description

Profile The profile to remove the factory from. This is required in domainmode.

Plug-ins Guide 129

PropertyName

Description

ControllerName

The controller name of the JBoss instance to connect to.

Creating a Create Server Group StepThis step creates a server group on a JBoss domain instance.


PropertyName

Description

JBoss CLIPath


HostName

The name of the server host.

ServerName

The name to give the server to be created.

GroupName

The server group to add this server to.

SocketOffset

The socket offset for this server.



Value for Auto-Start If selected, auto-start will be set to true.


Creating a Run Script StepThis step runs a custom script on JBoss using the CLI.




PropertyName

Description

JBoss CLIPath


ScriptData

The script to be executed.




Note: For information on available commands, run this step with the followingscript: help --commands.

Creating a Check Deployment Status StepThis step gets the status information on a deployment.


PropertyName

Description

JBoss CLIPath

The path to the JBoss Command Line Interface executable. Forexample: C:\wildfly-8.0.0.Alpha1\wildfly-8.0.0.Alpha1\bin.

DeploymentName

The name of the deployment to check (the filename and extension).


PropertyName

Description

Host Name The name of the host for the deployment. This is required in domainmode.

Server Name The name of the server for the deployment. This is required indomain mode.

ControllerName

The controller name of the JBoss instance to connect to.

Plug-ins Guide 131

Creating an Enable Application StepThis step enables an application that has been deployed to JBoss (standalone mode only).


PropertyName

Description

JBoss CLIPath


ApplicationName

The name of the application to be deployed. If a source is not provided,the named application will be enabled instead.




Creating a Disable Application StepThis step disables a standalone application that has been deployed to JBoss.


PropertyName

Description

JBoss CLIPath


ApplicationName

The name of the application to be deployed. If a source is not provided,the named application will be enabled instead.






Chapter 11: IIS AdminScripts Plug-in

Microsoft IIS is a Web server application packaged with Windows Server for hostingwebsites, services, and applications. The IIS AdminScripts plug-in enables you toautomate IIS configuration changes during a deployment.


• Creating an AdsUtil Step [page 133]

• Creating an Update WebSiteProperties Step [page 134]

• Creating an Update VDirProperties Step [page 134]

• Creating a Set .Net Version Step [page 134]

For information about IIS, see http://www.iis.net/home.

Creating an AdsUtil StepThis step runs an arbitrary adsutil command.



Command The command to run using adsutil.


PropertyName

Description

Path The path of the node for which you are setting the property, combinedwith the name of the property you are setting. For example: w3svc/1/ServerComment.

Parameters A newline-separated list of parameters to be set if needed for thecommand.

AdsUtil.vbsPath

The path to the AdsUtil.vps executable including the file name. Forexample: C:\InetPub\AdminScripts\adsutil.vbs.

CscriptPath

The path to the cscript.exe executable including the file name if not onthe path. For example: C:\Windows\system32\cscript.exe.

Plug-ins Guide 133

http://www.iis.net/home

Creating an Update WebSiteProperties StepThis step sets properties on a Web site.



PropertyName

Description

Website The Web site name.

Parameters A newline-separated list of parameters to be set using the syntaxname=value.

Note: “=” is not valid as part of the name

Creating an Update VDirProperties StepThis step sets properties on a virtual directory.


PropertyName

Description

VDirOffset

The offset from the Web site path to the virtual directory. For example,with a virtual directory named test, the value would be /root/test. Thedefault virtual directory is /root.


PropertyName

Description


Parameters A newline-separated list of parameters to be set using the syntaxname=value.

Note: “=” is not valid as part of the name

Creating a Set .Net Version StepThis step sets the .NET version for a Web site.




PropertyName

Description

Version The version of .NET to set. The .NET framework for this version must beinstalled, and it must contain the aspnet_regiis executable in%windir%\microsoft.net\framework\${version}. You must select oneof the following values:

• 2.0

• 1.1




Plug-ins Guide 135

Chapter 12: IIS AppCmd Plug-in

Microsoft IIS is a Web server application packaged with Windows Server for hostingwebsites, services, and applications.

AppCmd.exe is a command line tool for managing IIS 7 and above. The IIS AppCmd plug-in enables you to configure and query objects on a Web server and to return output intext or XML among other things.


• Creating a Create Application Step [page 137]

• Creating a Delete Application Step [page 138]

• Creating a Create Site Step [page 138]

• Creating a Delete Site Step [page 139]

• Creating a Start Site Step [page 139]

• Creating a Stop Site Step [page 140]

• Creating a Check if Site Exists Step [page 140]

• Creating a Check if Site is Stopped Step [page 141]

• Creating a Check if Site is Running Step [page 141]

• Creating a Create Virtual Directory Step [page 142]

• Creating a Delete Virtual Directory Step [page 142]

• Creating a Create Application Pool Step [page 143]

• Creating a Delete Application Pool Step [page 143]

• Creating a Start Application Pool Step [page 144]

• Creating a Stop Application Pool Step [page 144]

• Creating a Recycle Application Pool Step [page 145]

• Creating an AppCmd Step [page 145]


Creating a Create Application StepThis step creates an application in IIS.

Plug-ins Guide 137



PropertyName

Description

Parent Site The parent site the application should be created under. For example:Default Web Site.

Virtual Path The virtual path under which the application should be created.


PropertyName

Description

Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…

CommandPath

The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrc\.

Creating a Delete Application StepThis step deletes an application in IIS.


PropertyName

Description

ID The application path or URL of the application to delete. For example:Default Web Site/Application.


PropertyName

Description


CommandPath

The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrv\.

Creating a Create Site StepThis step creates a new Web site in IIS.





Site Name The name of the Web site to create. For example: DefaultWebSite.


PropertyName

Description


CommandPath


Creating a Delete Site StepThis step deletes a Web site in IIS.



Site Name The name of the Web site to delete. For example: DefaultWebSite.


PropertyName

Description


CommandPath


Creating a Start Site StepThis step starts a Web site in IIS.



Site Name The name of the Web site to start. For example: DefaultWebSite.

Plug-ins Guide 139


PropertyName

Description


CommandPath


Creating a Stop Site StepThis step stops a Web site in IIS.



Site Name The name of the Web site to stop. For example: DefaultWebSite.


PropertyName

Description


CommandPath


Creating a Check if Site Exists StepThis step checks to see if a Web site exists in IIS.



Site Name The name of the Web site to check. For example: DefaultWebSite.




PropertyName

Description


CommandPath


Creating a Check if Site is Stopped StepThis step checks to see if a Web site is stopped in IIS.





PropertyName

Description


CommandPath


Creating a Check if Site is Running StepThis step checks to see if a Web site is running in IIS.




Plug-ins Guide 141


PropertyName

Description


CommandPath


Creating a Create Virtual Directory StepThis step creates a virtual directory in IIS.


PropertyName

Description

ParentApplication

Application identifier under which this virtual directory should be created.This refers to the application pool name followed by the applicationname.

VirtualPath

The virtual path of the virtual directory.


PropertyName

Description

Path The physical path of the virtual directory.


CommandPath


Creating a Delete Virtual Directory StepThis step deletes a virtual directory in IIS.




PropertyName

Description

VirtualDirectory Path

The virtual directory path or URL to be deleted. For example:Default Web Site/subdir.


PropertyName

Description


CommandPath


Creating a Create Application Pool StepThis step creates a new application pool in IIS.



Application Pool Name The name of the application pool that you want to create.


PropertyName

Description


CommandPath


Creating a Delete Application Pool StepThis step deletes an application pool in IIS.

Plug-ins Guide 143



Application Pool Name The name of the application pool that you want to delete.


PropertyName

Description


CommandPath


Creating a Start Application Pool StepThis step starts an application pool in IIS.



Application Pool Name The name of the application pool that you want to start.


PropertyName

Description


CommandPath


Creating a Stop Application Pool StepThis step stops an application pool in IIS.



Application Pool Name The name of the application pool that you want to stop.




PropertyName

Description


CommandPath


Creating a Recycle Application Pool StepThis step recycles an application pool in IIS.



Application Pool Name The name of the application pool that you want to recycle.


PropertyName

Description


CommandPath


Creating an AppCmd StepThis step runs an arbitrary appcmd command.



Command The command to run using appcmd.

Object Type The object type that the command should run against.

Plug-ins Guide 145


PropertyName

Description

Identifier The identifier for the object, if required.


CommandPath




Chapter 13: Microsoft IIS MS-DeployPlug-in

Microsoft IIS is a Web server application packaged with Windows Server for hostingwebsites, services, and applications.

IIS MSDeploy, also known as Web Deploy, enables you to:

• Deploy Web applications and websites to IIS servers

• Detect differences between source and destination content

• Synchronize IIS servers

It makes it easier to:

• Move servers to newer versions of IIS

• Backup servers

The MSDeploy plug-in automates:

• Synchronizing and deleting servers, sites, applications, and packages

• Starting, stopping, and recycling application pools through the MSDeploy application


• Creating a Synchronize Step [page 147]

• Creating an MSDeploy Step [page 149]

• Creating a Delete Step [page 150]

• Creating a Stop Application Step [page 151]

• Creating a Recycle Application Step [page 152]


Creating a Synchronize StepThis step synchronizes two IIS objects.

Plug-ins Guide 147



PropertyName

Description

Source ProviderType

The provider type for the source argument of the synchronize.Select a value from the list below.

• Application

• Archive Directory

• ContentPath

• Directory

• File

• Manifest

• MetaKey

• Package

• Server

• Server 6.0

• Site

Provider Source The provider path and setting for the source. Use the syntax:path,setAting1,settign2….



PropertyName

Description

DestinationProvider Type

The provider type for the destination argument of the synchronize.Select a value from the list below.

• Auto

• Application


• ContentPath

• Directory

• File

• Manifest

• MetaKey

• Package

• Server

• Server 6.0

• Site


PropertyName

Description

ProviderDestination

The Provider path and setting for the destination provided using thesyntax path,setting1,setting2….

OptionsString

A newline-separated list of arguments to concatenate onto thesynchronize command. For example: –setParam:hello,value=hi\n-setParam:goodbye,value=seeyou.

CommandPath

The directory location of the msdeploy.exe command line executable. Forexample: C:\Program Files\IIS\Microsoft Web Deploy V2\.

Creating an MSDeploy StepThis step runs an msdeploy command.

Plug-ins Guide 149



Verb The verb (operation) to be performed by msdeploy.


PropertyName

Description

SourceProviderType

The provider type for the source argument of the command. This isrequired if the provider source is supplied.

ProviderSource

The provider path and setting for the source given in the syntaxpath,setting1,setting2….

DestinationProviderType

The provider type for the destination argument of the command.

ProviderDestination

The provider path and setting for the destination provided using thesyntax path,setting1,setting2….

OptionsString

A newline-separated list of arguments to concatenate onto thesynchronize command. For example: –setParam:hello,value=hi\n-setParam:goodbye,value=seeyou.

CommandPath


Creating a Delete StepThis step deletes an IIS object.




PropertyName

Description

Provider Type The provider type for the destination argument of the delete. Select avalue from the list below.

• Application


• ContentPath

• Directory

• File

• Manifest

• MetaKey

• Package

• Site

ProviderDestination

The provider path and setting for the destination supplied using thesyntax path,setting1,setting2….


PropertyName

Description

OptionsString

A newline-separated list of arguments to concatenate onto the deletecommand. For example: –setParam:hello,value=hi\n-setParam:goodbye,value=seeyou.

CommandPath


Creating a Stop Application StepThis step stops an application in IIS.

Plug-ins Guide 151


PropertyName

Description

Target Name The name of the Web site or application. For example: Website/MyApp.


PropertyName

Description

CommandPath


Creating a Recycle Application StepThis step stops an application in IIS.


PropertyName

Description

Target Name The name of the Web site or application. For example: Website/MyApp.


PropertyName

Description

CommandPath




Chapter 14: Oracle WebLogic WLDeployPlug-in

Oracle WebLogic Server includes the wldeploy Ant task to enable you to performweblogic.Deployer functions using attributes specified in an Ant XML file. You can usewldeploy along with other WebLogic Server Ant tasks to create a single Ant build script.

The WLDeploy plug-in enables you to deploy, undeploy, and redeploy Java applicationsand start and stop WebLogic servers and clusters.


• Run WLDeploy

• Start Targets

• Stop Targets

• Check Targets

• Check Application on targets

• Wait for Application on targets

• List Applications on targets

For information about WLDeploy, see http://docs.oracle.com/cd/E13222_01/wls/docs103//programming/wldeploy.html.

Plug-ins Guide 153

http://docs.oracle.com/cd/E13222_01/wls/docs103//programming/wldeploy.html

http://docs.oracle.com/cd/E13222_01/wls/docs103//programming/wldeploy.html

Part 3: Build Management Plug-ins


• Chapter 15: Apache Ant Plug-in [page 157]

• Chapter 16: Apache Maven Plug-in [page 159]

• Chapter 17: MS Build Plug-in [page 161]

• Chapter 18: UrbanCode AnthillPro Plug-in [page 163]

Plug-ins Guide 155

Chapter 15: Apache Ant Plug-in

Apache Ant is a Java-based build tool. It is typically used to build Java applications;however, it can also be used to build C or C++ applications. With Ant, the build processand its dependencies are described using XML.

Use the Ant plug-in during deployment to automate the execution of Ant tasks defined ina build.xml file.


• Creating an Execute an Ant Script Step [page 157]

For information about Ant, see http://ant.apache.org/.

Creating an Execute an Ant Script StepThis step executes an Ant script.


PropertyName

Description

Ant ScriptFile

The name of the Ant script file.

ANT_HOME The path to the Ant installation to execute the Ant script. By default, thestep uses the agent’s ANT_HOME environment variable. This refers tothe path up to (but not including) the bin folder.

JAVA_HOME The path to the Java installation to execute Ant. By default, the agent’sJAVA_HOME environment variable is used.


PropertyName

Description

Targets The names of the targets to run in the Ant script file. If left empty, thedefault target is run.

Properties The properties passed to Ant. The properties are made available by namein the Ant script. This is supplied as a newline-separated list in the formatname=value.

AntProperties

Ant-specific arguments. For example, -v is used to indicate verboseoutput. This is supplied as a newline-separated list.

Plug-ins Guide 157

http://ant.apache.org/

PropertyName

Description

JVMProperties

JVM-specific arguments. For example -Xmx=512m is used for max memory.This is supplied as a newline-separated list.

ScriptContent

The content of the Ant script. The value provided here is written to the AntScript File, and then executed.



Chapter 16: Apache Maven Plug-in

Apache Maven is a software project management tool that can manage a project's build,reporting, and documentation.

The Maven plug-in enables you to resolve artifacts from a Maven repository.


• Maven Resolve

For information about Maven, see http://maven.apache.org/.

Plug-ins Guide 159

http://maven.apache.org/

Chapter 17: MS Build Plug-in

Microsoft Build Engine (MSBuild) automates the process of compiling source code,packaging, testing, deploying, and creating documentation. Typically MSBuild is used inconjunction with Microsoft Visual Studio.


• Run MSBuild

For information about MSBuild, see http://msdn.microsoft.com/en-us/library/ms171452(v=vs.90).aspx.

Plug-ins Guide 161

http://msdn.microsoft.com/en-us/library/ms171452(v=vs.90).aspx

http://msdn.microsoft.com/en-us/library/ms171452(v=vs.90).aspx

Chapter 18: UrbanCode AnthillPro Plug-in

UrbanCode AnthillPro is a continuous integration server that automates the process ofbuilding and testing code in software projects.


• Run Workflow

• Download Artifacts

• Assign Status

For information about AnthillPro, see http://www.urbancode.com/html/products/anthillpro/.

Plug-ins Guide 163

http://www.urbancode.com/html/products/anthillpro/

http://www.urbancode.com/html/products/anthillpro/

Part 4: Change and Service ManagementPlug-ins


• Chapter 19: CollabNet Teamforge Plug-in [page 167]

• Chapter 20: Microsoft Sharepoint Plug-in [page 169]

• Chapter 21: Serena ChangeMan ZMF Plug-in [page 171]

• Chapter 22: Serena Dimensions CM Plug-in [page 211]

• Chapter 23: Serena PVCS VM Plug-in [page 225]

• Chapter 24: ServiceNow Plug-in [page 227]

• Chapter 25: Subversion Plug-in [page 229]

Plug-ins Guide 165

Part 4: Change and Service Management Plug-ins


Chapter 19: CollabNet Teamforge Plug-in

CollabNet Teamforge is an integrated Web-based platform that enables teams to workcollaboratively through the various stages of the application life cycle, including thefollowing activities: plan, code, track, build and test, lab management, release, report,and collaborate.

The TeamForge plug-in enables Deployment Automation to create and modify artifactsand create file releases.


• Comment on Tracker Artifacts

• Create Tracker Artifact

• Create Release

• Upload Release Files

• Download Release Files

• Upload Document Files

For information about TeamForge, see http://www.collab.net/products/teamforge.

Plug-ins Guide 167

http://www.collab.net/products/teamforge

Chapter 20: Microsoft Sharepoint Plug-in

SharePoint is a collection of websites that provides intranet content management anddocument management facilities.

The Sharepoint plug-in enables Deployment Automation to deploy Windows SharePoint(WSP) and Content Migration Package (CMP) packages.


• Export SharePoint Content

• Deploy SharePoint CMP File

• Deploy SharePoint WSP File

• Activate SharePoint Feature

• Deploy SharePoint WSP File to Sandbox

For information about Sharepoint, see http://www.microsoft.com/en-gb/business/products/sharepoint-2013.aspx.

Plug-ins Guide 169

http://www.microsoft.com/en-gb/business/products/sharepoint-2013.aspx

http://www.microsoft.com/en-gb/business/products/sharepoint-2013.aspx

Chapter 21: Serena ChangeMan ZMF Plug-in

Serena ChangeMan ZMF is a configuration management tool.

The ZMF plug-in provides support for deployment of IBM z/OS files using ChangeMan ZMFchange packages.


• Creating a ZMF Approve Step [page 172]

• Creating a ZMF Audit Step [page 173]

• Creating a ZMF Backout Step [page 176]

• Creating a ZMF Confirm for Backout Step [page 177]

• Creating a ZMF Confirm for Freeze Step [page 178]

• Creating a ZMF Confirm for Promotion Step [page 179]

• Creating a ZMF Confirm for Revert Step [page 181]

• Creating a ZMF Delete Package Step [page 182]

• Creating a ZMF Delete Scheduled Deployment Step [page 183]

• Creating a ZMF Demote a Package Step [page 184]

• Creating a ZMF Demote and Delete Contents Step [page 186]

• Creating a ZMF Freeze a Package Step [page 187]

• Creating a ZMF Get App Params Step [page 188]

• Creating a ZMF Get App Promotion Areas Step [page 189]

• Creating a ZMF Get App Sites Step [page 190]

• Creating a ZMF Get Approvers Step [page 192]

• Creating a ZMF Get Install Sites Step [page 193]

• Creating a ZMF Get Instructions Step [page 194]

• Creating a ZMF Get Properties Step [page 195]

• Creating a ZMF Get User Variables Step [page 196]

• Creating a ZMF Hold Deployment Step [page 197]

• Creating a ZMF Promote Package Step [page 198]

Plug-ins Guide 171

• Creating a ZMF Query Package Step [page 200]

• Creating a ZMF Reject Package Step [page 206]

• Creating a ZMF Release Deployment Step [page 207]

• Creating a ZMF Revert Package Step [page 208]

• Creating a ZMF Undelete Package Step [page 209]

For information about Serena ChangeMan ZMF, see http://www.serena.com/index.php/en/products/mainframe/changeman-zmf/.

For information on the default implementation of the ChangeMan ZMF plug-in for use withSerena Release Manager, see the Serena Release Manager Getting Started Guide"Deployment Task Integration" section.

Creating a ZMF Approve StepThe Approve step approves a package.

The last approver will initiate the deployment, or installation, of the package intoproduction. The installation may be scheduled or set to manual. If it is set to manual, thepackage installation job is submitted as soon as the last approval is given.

Required connection properties:

PropertyName

Description

Host Address The TCP/IP address of the LPAR of the ZMF subsystem to which youwant to connect

Port Id The TCP/IP port ID for the ZMF subsystem to which you want toconnect

User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users

Password A TSO password or SERNET/ ZMF password

Optional connection properties:

PropertyName

Description

Login As UserId

The user ID that will be used to login to ChangeMan ZMF by thetrusted user ID

Login AsCurrentSerena RAUser

Use the currently logged in Deployment Automation user ID to loginto ChangeMan ZMF, even if a user ID is specified in the Login As UserId field



http://www.serena.com/index.php/en/products/mainframe/changeman-zmf/

http://www.serena.com/index.php/en/products/mainframe/changeman-zmf/

Other required properties:


Package Name The ZMF change package name

Approver Entity The ZMF approver entity

Other optional properties:

PropertyName

Description

UserInterventionRequired

Controls whether the information returned from this step is displayed ina dialog box upon successful execution of the containing process,enabling you to select specific information to be used in subsequentprocess steps. This is set to true by default, and is implicitly required,because without it, there is no way to select the information.

Creating a ZMF Audit StepThe Audit step audits a package.

The last approver will initiate the deployment or install of the package into production.The install can be scheduled or it be set to manual. If it is set to manual, the packageinstall job is submitted as soon as the last approval is given.


PropertyName

Description





Plug-ins Guide 173


PropertyName

Description

Login As UserId





PropertyName

Description

PackageName

The ZMF change package name

ScopeAppl

Enables you to change the default list of applications that will beconsidered for relationship checking for SRC/CPY and LOD/LOD (SYNCH5and SYNCH8). For multiple scope applications use semi-colon [;] as aseparator. Other separators will be treated as single scope applications.

jobCard The job card to be used. For multiple job cards use a semi-colon [;] as aseparator. Other separators will be treated as a single job card.


PropertyName

Description

AuditAutoParms

Indicates whether to use audit auto parms

Audit Lite Indicates whether to audit within staging libraries only rather than in bothstaging and baseline libraries

PromotionGroup

The ZMF promotion group from which to pull the latest files.



PropertyName

Description

AuditAutoResolve

Indicates whether you want audit to resolve out-of-sync conditionsinvolving copybooks and load modules automatically.

• true: report out-of-sync conditions and submit recompile and relinkjobs to resolve SYNCH2, SYNCH4, SYNCH5, SYNCH7, SYNCH8,SYNCH9, SYNCH15, and SYNCH16 conditions.

• false: only report out-of-sync conditions but do not resolve them.

AuditIncludeHistory

Indicates whether to include audit history. Valid values are true/false.

AuditFormatReport

Indicates whether to format the report by including printer controlcharacters in the output file. Valid values are true/false.

Audit PartAs Simple

Indicates whether to audit participating ZMF change packages as simplepackages. This option lets you omit cross-package dependencies from theaudit of a participating package and follow rules for simple packagesconcerning baseline libraries. Valid values are true/false.

Audit PartAsPrimary

Indicates whether to audit participating packages as primary packages.This option lets you include cross-package dependencies for all exceptpreviously-installed packages from the audit of participating packages.Valid values are true/false.

Audit PartBy Dept

Indicates whether to audit participating packages by department number.Valid values are true/false.

Audit RCUpdateRestrictTo Target

Indicates whether to restrict the audit return code update to the targetpackage. Valid values are true/false.

AuditTraceOption

Indicates whether to use the audit trace option. Valid values are true/false.

IncludeXAPheaders

Indicates whether to include XAP headers. Valid values are Yes, No, andTop.

SuppressNotify

Indicates whether to suppress the batch message. Valid values are true/false.

Plug-ins Guide 175

PropertyName

Description

LockPackage

Indicates whether to lock packages during audit. Valid values are true/false.

UserVariable

User variables to be used. For multiple variables, use a semi-colon [;] as aseparator. Other separators will be treated as a single user variable.

Creating a ZMF Backout StepThe Backout step backs out a package.


PropertyName

Description






PropertyName

Description

Login As UserId










Reasons Reasons for this action


PropertyName

Description

Site Name The site name to be used. For multiple site names, use a semi-colon [;]as a separator. Other separators will be treated as a single site name.




Creating a ZMF Confirm for Backout StepThe Confirm For Backout step confirms that a package is ready to be backed out.


PropertyName

Description





Plug-ins Guide 177


PropertyName

Description

Login As UserId









PropertyName

Description

SiteName

The site name to be used. For multiple site names, use a semi-colon [;] asa separator. Other separators will be treated as a single site name.

Creating a ZMF Confirm for Freeze StepThe Confirm For Freeze step confirms that a package is ready to be frozen.


PropertyName

Description






PropertyName

Description



PropertyName

Description

Login As UserId








PropertyName

Description

UserVariable


Creating a ZMF Confirm for Promotion StepThe Confirm For Promotion step confirms that a package is ready to be promoted.


PropertyName

Description



Plug-ins Guide 179

PropertyName

Description




PropertyName

Description

Login As UserId





PropertyName

Description

PackageName


PromotionSite Name

The ZMF change package promotion site name

PromotionLevel

The ZMF change package promotion or demotion level. The sequencenumber of a target promotion library in the promotion hierarchy.

PromotionName

The ZMF change package promotion or demotion level nickname





PropertyName

Description

OverlayTargetComponents

Indicates whether to overlay target library members. Valid values aretrue/false.

SuppressNotify

Indicates whether to suppress the batch message. Valid values aretrue/false.

UserVariable

User variables to be used. For multiple variables, use a semi-colon [;]as a separator. Other separators will be treated as a single uservariable.

Creating a ZMF Confirm for Revert StepThe Confirm For Revert step confirms that a package is ready to be reverted back todevelopment.


PropertyName

Description






PropertyName

Description

Login As UserId


Plug-ins Guide 181

PropertyName

Description








PropertyName

Description

SiteName


Creating a ZMF Delete Package StepThe Delete Package step marks a package for deletion.


PropertyName

Description








PropertyName

Description

Login As UserId







Other optional properties: None

Creating a ZMF Delete Scheduled Deployment StepThe Delete scheduled deployment step deletes a package promotion schedule.


PropertyName

Description






PropertyName

Description

Login As UserId


Plug-ins Guide 183

PropertyName

Description








Type Type. The default value is 2.

Creating a ZMF Demote a Package StepThe Demote a package step demotes a package.


PropertyName

Description








PropertyName

Description

Login As UserId





PropertyName

Description

PackageName


PromotionSite Name


PromotionLevel


PromotionName




PropertyName

Description



SuppressNotify


Plug-ins Guide 185

PropertyName

Description

UserVariable




Creating a ZMF Demote and Delete Contents StepThe Demote and Delete Contents step demotes a package with an option of deletingthe contents of the previous promotion libraries or areas.


PropertyName

Description






PropertyName

Description

Login As UserId









Promotion Site Name The ZMF change package promotion site name


PropertyName

Description

SuppressNotify

Indicates whether to suppress the batch message. Valid values are true/false.

UserVariable




Creating a ZMF Freeze a Package StepThe Freeze Package step freezes a package.


PropertyName

Description





Plug-ins Guide 187


PropertyName

Description

Login As UserId








PropertyName

Description

UserVariable


Creating a ZMF Get App Params StepThe Get app params step gets a list of application parameters.


PropertyName

Description








PropertyName

Description

Login As UserId






Application Name The ZMF application name


PropertyName

Description



Creating a ZMF Get App Promotion Areas StepThe Get app Promotion Areas step gets a list of application areas.


PropertyName

Description




Plug-ins Guide 189

PropertyName

Description



PropertyName

Description

Login As UserId








PropertyName

Description

Site Name The ZMF installation site name

PromotionName


PromotionLevel




Creating a ZMF Get App Sites StepThe Get App Sites step gets a list of application promotion and installation sites.




PropertyName

Description






PropertyName

Description

Login As UserId








PropertyName

Description

Site Type The ZMF installation site type



Plug-ins Guide 191

Creating a ZMF Get Approvers StepThe Get approvers step gets a list of package approvers.


PropertyName

Description






PropertyName

Description

Login As UserId










PropertyName

Description



Creating a ZMF Get Install Sites StepThe Get Install Sites step gets a list of package installation sites.


PropertyName

Description






PropertyName

Description

Login As UserId




Plug-ins Guide 193





PropertyName

Description

Site Name The ZMF installation site name



Creating a ZMF Get Instructions StepThe Get Instructions step gets package instructions.


PropertyName

Description






PropertyName

Description

Login As UserId




PropertyName

Description







PropertyName

Description



Creating a ZMF Get Properties StepThe Get Properties step gets package properties.


PropertyName

Description





Plug-ins Guide 195


PropertyName

Description

Login As UserId








PropertyName

Description



Creating a ZMF Get User Variables StepThe Get user variables step gets package user variables.


PropertyName

Description






PropertyName

Description



PropertyName

Description

Login As UserId








PropertyName

Description



Creating a ZMF Hold Deployment StepThe Hold Deployment step holds a package promotion.


PropertyName

Description


Plug-ins Guide 197

PropertyName

Description





PropertyName

Description

Login As UserId










Creating a ZMF Promote Package StepThe Promote Package step promotes a package.




PropertyName

Description






PropertyName

Description

Login As UserId





PropertyName

Description

PackageName


PromotionSite Name


PromotionLevel


PromotionName



Plug-ins Guide 199


PropertyName

Description

DeploymentDate

Deployment date

DeploymentTime

Deployment time



SuppressNotify


UserVariable




Creating a ZMF Query Package StepThe Query package step queries or searches for packages.


PropertyName

Description








PropertyName

Description

Login As UserId





PropertyName

Description

PackageList

A list of package names separated by semicolons. Other separators will betreated as single package names. Wild cards are allowed.


PropertyName

Description

WorkChangeRequest

Work change request. Wild cards are allowed.

RequestorDept

Requestor department

Search ForSimple Level

Search for simple packages?

Search ForComplexLevel

Search for complex packages?

Search ForSuper Level

Search for super packages?

Search ForPart Level

Search for participating packages?

Search ForPlannedPermType

Search for planned permanent packages?

Plug-ins Guide 201

PropertyName

Description

Search ForPlannedTempType

Search for planned temporary packages?

Search ForUn-plannedPermType

Search for unplanned permanent packages?

Search ForUn-plannedTempType

Search for unplanned temporary packages?

Search ForApprovedStatus

Search for approved packages?

Search ForBacked OutStatus

Search for backed out packages?

Search ForBaselineStatus

Search for baselined packages?

Search ForClosedStatus

Search for closed packages?

Search ForDeletedStatus

Search for deleted packages?

Search ForDevelopmentStatus

Search for development packages?

Search ForDeliveredStatus

Search for delivered packages?

Search ForFrozenStatus

Search for frozen packages?

Search ForInstalledStatus

Search for installed packages?



PropertyName

Description

Search ForOpenedStatus

Search for opened packages?

Search ForRejectedStatus

Search for rejected packages?

Search ForTempChangeCycledStatus

Search for temporary change cycled packages?

RequestorName

Requestor name

RequestorPhone

Requestor phone

ComplexSuperPackage

Complex or super package for which you want participating packagesreturned in the search results

Creator One or more creator user IDs. Multiple creator user IDs may be listed,delimited by semicolons. Wild cards are allowed.

Audit ReturnCode

Audit return code

Search FromCreated Date

Search from Created Date

Search ToCreated Date

Search to Created Date

Search FromInstalledDate

Search from Installed Date

Search ToInstalledDate

Search to Installed Date

Search FromFrozen Date

Search from Frozen Date

Plug-ins Guide 203

PropertyName

Description

Search ToFrozen Date

Search to Frozen Date

Search FromApprovedDate

Search from Approved Date

Search ToApprovedDate

Search to Approved Date

Search FromRejectedDate

Search from Rejected Date

Search ToRejectedDate

Search to Rejected Date

Search FromBaselinedDate

Search from Baselined Date

Search ToBaselinedDate

Search to Baselined Date

Search FromBacked OutDate

Search from Backed Out Date

Search ToBacked OutDate

Search to Backed Out Date

Search FromRevertedDate

Search from Reverted Date

Search ToRevertedDate

Search to Reverted Date

LastPromoter

Last promoter user ID



PropertyName

Description

LastPromotionLevel

Last promotion level

LastPromotionName

Last promotion nickname

LastPromotionSite

Last promotion site

Search ForFreezePending

Search for packages with freeze pending

Search ForApprovalPending

Search for packages with approval pending

Search ForInstallPending

Search for packages with install pending

Search ForRevertPending

Search for packages with revert pending

Search ForBackoutPending

Search for packages with backout pending

Search ForPostApprovalPending

Search for packages with post approval pending

Search ForPostRejected

Search for packages rejected in post approval

Site Name Site name

Package Title Package title

Plug-ins Guide 205

PropertyName

Description


Controls whether the information returned from this step is displayedin a dialog box upon successful execution of the containing process,enabling you to select specific information to be used in subsequentprocess steps. This is set to true by default, and is implicitly required,because without it, there is no way to select the information.

Creating a ZMF Reject Package StepThe Reject Package step rejects a package.


PropertyName

Description






PropertyName

Description

Login As UserId










Approver Entity The ZMF approver entity



Creating a ZMF Release Deployment StepThe Release Deployment step releases a previously held package promotion.


PropertyName

Description






PropertyName

Description

Login As UserId







Plug-ins Guide 207




Creating a ZMF Revert Package StepThe Revert Package step reverts a package back to development.


PropertyName

Description






PropertyName

Description

Login As UserId











PropertyName

Description

SiteName



Creating a ZMF Undelete Package StepThe Undelete Package step undeletes a package that has been marked for deletion.


PropertyName

Description






PropertyName

Description

Login As UserId




Plug-ins Guide 209

Chapter 22: Serena Dimensions CM Plug-in

Serena Dimensions CM is a configuration management tool.

The Dimensions CM plug-in provides support for deployment of Windows and UNIX/Linuxfiles using Dimensions CM baselines.


• Creating a Dimensions CM Action Baseline Step [page 211]

• Creating a Dimensions CM Create Baseline Step [page 212]

• Creating a Dimensions CM Deliver to a Stream Step [page 213]

• Creating a Dimensions CM Demote Baseline Step [page 214]

• Creating a Dimensions CM Deploy Baseline Step [page 215]

• Creating a Dimensions CM Get Baselines Step [page 217]

• Creating a Dimensions CM Get Deployment Areas Step [page 217]

• Creating a Dimensions CM Get Products Step [page 218]

• Creating a Dimensions CM Get Projects and Streams Step [page 219]

• Creating a Dimensions CM Get Stages Step [page 220]

• Creating a Dimensions CM Promote Baseline Step [page 220]

• Creating a Dimensions CM Rollback Area Version Step [page 222]

• Creating a Dimensions CM Upload Local File or Directory Step [page 222]

For information about Serena Dimensions CM, see http://www.serena.com/index.php/en/products/featured-products/dimensions-cm/?hp.

For information on the default implementation of the Dimensions CM plug-in for use withSerena Release Manager, see the Serena Release Manager Getting Started Guide"Deployment Task Integration" section.

Creating a Dimensions CM Action Baseline StepThis step performs an action on the lifecycle of a baseline on the Dimensions CM server.

Plug-ins Guide 211

http://www.serena.com/index.php/en/products/featured-products/dimensions-cm/?hp

http://www.serena.com/index.php/en/products/featured-products/dimensions-cm/?hp



User ID ID of the Dimensions CM user

Password Password of the Dimensions CM user

Server Host name or IP address of the Dimensions CM server

DB Name DB name for the Dimensions CM server

DB Connection DB connection for the Dimensions CM server



Baseline name Name of the baseline on which to perform the lifecycle action


PropertyName

Description

Targetstate

Name of the state to which the object baseline should be actioned. If noneis specified, the baseline is actioned to the next state.

Comment A descriptive statement about the lifecycle action being performed.

Creating a Dimensions CM Create Baseline StepThis step creates the baseline for the specified stage.











PropertyName

Description

ProductName

The name of the product in Dimensions CM

Baselinename

The name of the baseline in Dimensions CM

Based on Name of the project or stream the created baseline should be based on

Baselinetype

The stage to which the baselines should be moved, or demoted. If thevalue is empty, the baseline will be demoted to the previous stage.


PropertyName

Description

Attributes A new-line separated list of names and values of the attributes to set,using the syntax name=value. For example, SBM_ID=123

Creating a Dimensions CM Deliver to a Stream StepThis step delivers content to the Dimensions CM stream.








Plug-ins Guide 213


PropertyName

Description

Productname


Streamname

The name of the stream in to which the content should be delivered

Directory Specifies the name of the directory, or folder, of the work area to beupdated from the stream.


PropertyName

Description

Add Allow the delivery to a stream the changed content in your work area andnew content previously unscheduled for delivery.

Default: False

Update Specify this qualifier to allow updating and refactoring of existing contentin the repository.

Default: True

Delete Allow the deletion from a stream the changed content in your work areaand deleted content previously unscheduled for deletion. Default: False

Attributes A new-line separated list of names and values of the attributes to set,using the syntax name=value. For example, SBM_ID=123

Comment Use the specified comment when creating new item revisions. If nocomment is specified, a default will be used.

Creating a Dimensions CM Demote Baseline StepThis step demotes the baseline to the specified stage.













Product Name The name of the product in Dimensions CM

Baseline name The name of the baseline in Dimensions CM


PropertyName

Description

Projectname

The name of the project in Dimensions CM

Targetstage

The stage to which the baselines should be moved, or demoted. If thevalue is empty, the baseline will be demoted to the previous stage.

Deploy Select this field if you want automatic deployment to be performed withthe demotion. Default value: True (Selected)

Areanames

The list of areas to which the baseline should be deployed. Specify multipleareas as a new-line separated list. If the ALL value is specified,deployment will be performed on all the areas. Default value: ALL

Reason Comment that describes the reason for the demotion

Wait Wait until Dimensions CM finishes processing in batch mode for this stepand returns the result, or times out, before continuing with the nextprocess step.

Timeout Time to wait until step completion, in milliseconds. A value of -1 meansthe step will wait for 24 hours. The default value is -1.

Creating a Dimensions CM Deploy Baseline StepThis step deploys a baseline to a specified list of areas.

Plug-ins Guide 215









PropertyName

Description

ProductName


Projectname


Baselinename

The name of the baseline in Dimensions CM

Areanames



PropertyName

Description

Reason Comment that describes the reason for the deployment





Creating a Dimensions CM Get Baselines StepThis step returns a list of all the existing baselines for the specified product on theDimensions CM server.












PropertyName

Description



Creating a Dimensions CM Get Deployment Areas StepThis step returns a list of deployment areas on the Dimensions CM server, optionallyfiltered by stage, project, or stream.





Plug-ins Guide 217





Other required properties: None


PropertyName

Description

Stage name Name of the stage by which you want to filter deployment areas. If thisfield is empty, areas for all stages are returned.

Stream/Project

Name of the stream or project by which you want to filter deploymentareas. If this field is empty, areas for all streams and projects arereturned.



Creating a Dimensions CM Get Products StepThis step returns a list of all the existing products on the Dimensions CM server.












PropertyName

Description



Creating a Dimensions CM Get Projects and StreamsStepThis step returns a list of all the existing projects and streams for the specified product onthe Dimensions CM server.










Product name The name of the product in Dimensions CM

Object type Object type to get. Possible values are:

• All (default)

• Projects

• Streams

Plug-ins Guide 219


PropertyName

Description



Creating a Dimensions CM Get Stages StepThis step returns a list of all the existing stages for the specified Dimensions CM server.










PropertyName

Description



Creating a Dimensions CM Promote Baseline StepThis step promotes the baseline to the specified stage.













Baseline name The name of the baseline in Dimensions CM


PropertyName

Description

Projectname


Targetstage

The stage to which the baselines should be moved, or promoted. If thevalue is empty, the baseline will be promoted to the previous stage.

Deploy Select this field if you want automatic deployment to be performed withthe promotion. Default value: Selected

Areanames


Reason Comment that describes the reason for the promotion


Plug-ins Guide 221

PropertyName

Description


Creating a Dimensions CM Rollback Area Version StepThis step rolls back the area version for the specified area.









PropertyName

Description

Areaname

The name of the area in Dimensions CM

Areaversion

The version of the area that should be rolled back. If no version isspecified, the latest version will be rolled back.



Reason Comment that describes the reason for the rollback

Creating a Dimensions CM Upload Local File orDirectory StepThe Upload Local File or Directory step delivers content to the Dimensions CM project.











PropertyName

Description

Product The name of the product in Dimensions CM

Project name The name of the project to which the files should be uploaded

Directory The name of the directory, or folder, of the work area to be uploadedto the project


PropertyName

Description

Attributes A new-line separated list of names and values of the attributes to setusing the syntax name=value. For example, SBM_ID=123

Description The description to apply to all the newly-created items

Comment The comment to apply to all the newly-created item revisions

Plug-ins Guide 223

Chapter 23: Serena PVCS VM Plug-in

Serena PVCS Version Manager (PVCS VM) is a source revision control tool.

The PVCS VM plug-in provides support for checking out from PVCS.


• Creating a PVCS Export Step [page 225]

For information about Serena PVCS, see http://www.serena.com/index.php/en/products/pvcs-vm/.

Creating a PVCS Export StepThis step performs a PVCS checkout.



PCLI Path The path to the PCLI executable.

Database Path The path to the PVCS database.

Base Path The base path of checked-out files.

Project Path The path to the PVCS project (folder) relative to the database.

Plug-ins Guide 225

http://www.serena.com/index.php/en/products/pvcs-vm/

http://www.serena.com/index.php/en/products/pvcs-vm/



Branch The branch from which to pull the latest files.

Label The label from which to pull the latest files.

Promotion Group The promotion group from which to pull the latest files.

Value for CleanWorkspace

If selected, all files are erased from the workspace before anexport is performed.

User The authentication user.

Password The user's password.

Important: You must supply a Branch, Label, or Promotion Group propertyvalue, but only one of these properties should be used.



Chapter 24: ServiceNow Plug-in

ServiceNow provides cloud-based services that automate IT operations.

The ServiceNow Change Management plug-in enables Deployment Automation to checkapprovals and set the status of change requests by interacting with the ConfigurationManagement Database (CMDB).


• Check Approval Status

• Check Change Request Status

• Set Change Request Status

• Check Change Request’s Child Tasks Statuses

• Update Tasks Statuses

• Insert Row Into CMDB Table

• Delete Row From CMDB Table

• Delete Multiple Rows From CMDB Table

For information about ServiceNow, see http://www.servicenow.com/.

Plug-ins Guide 227

http://www.servicenow.com/

Chapter 25: Subversion Plug-in

Subversion (SVN) is an open source Version Control System (VCS).


• Creating a Subversion Add Step [page 229]

• Creating a Subversion Checkout Step [page 230]

• Creating a Subversion Clean Up Step [page 231]

• Creating a Subversion Commit Step [page 231]

• Creating a Subversion Create Branch or Tag Step [page 232]

• Creating a Subversion Create Repository Step [page 233]

• Creating a Subversion Delete Step [page 233]

• Creating a Subversion Export Step (5.0.1 Plug-in Version) [page 234]

• Creating a Subversion Get Lock Step [page 234]

• Creating a Subversion Import Step [page 235]

• Creating a Subversion Move Step [page 236]

• Creating a Subversion Release Lock Step [page 236]

• Creating a Subversion Revert Step [page 237]

• Creating a Subversion Switch Step [page 238]

• Creating a Subversion Update Step [page 239]

• Creating a Subversion Export Step (4.5.1 Plug-in Version) [page 239]

Note:

All except the last step are for the 5.0.1 version of the Subversion plug-in. Thelast step is for the 4.5.1 version of the Subversion plug-in.

For information about Subversion, see http://subversion.apache.org/.

Creating a Subversion Add StepThis step marks unversioned files to be uploaded to the repository during the nextcommit.

Plug-ins Guide 229

http://subversion.apache.org/


PropertyName

Description

Directory Location of the working directory

IncludeFiles

The list of the file paths relative to the working directory that should beadded to the repository. Wildcards can be used. Specify multiple file pathsas a new-line separated list. The default value is **/*.

Note: Use paths relative to the repository root.


PropertyName

Description

ExcludeFiles

The list of the file paths relative to the working directory that should beexcluded from the selection. Wildcards can be used. Specify multiple filepaths as a new-line separated list.


Creating a Subversion Checkout StepThis step checks out files from the remote Subversion repository to the working directory.


PropertyName

Description

URL URL to the repository from which files will be checked out

Directory Location to which the contents of the repository URL will be checkedout



PropertyName

Description

Depth Depth of the checkout operation:

Values:

• Fully recursive (default)

• Immediate children and folders

• Only file children

• Only this item


PropertyName

Description

UserName

User name of the Subversion user

Password Password of the Subversion user

Revision Number of the Subversion revision to be used during checkout. If notspecified, the HEAD revision is used.

Creating a Subversion Clean Up StepThis step recursively cleans up the working copy, removing working copy locks andresuming unfinished operations.





Creating a Subversion Commit StepThis step uploads the latest changes from the local directory to the remote repository.

Plug-ins Guide 231


PropertyName

Description


IncludeFiles

The list of the file paths relative to the working directory that should becommitted to the repository. Wildcards can be used. Specify multiple filepaths as a new-line separated list. The default value is **/*.



PropertyName

Description

UserName



ExcludeFiles



Message User message related to the commit

Creating a Subversion Create Branch or Tag StepThis step creates a tag or a branch in the repository.




Path Path to the branch or tag in the repository





User Name User name of the Subversion user


Message User message related to the branch or tag

Creating a Subversion Create Repository StepThis step creates a repository.



Directory URL to the repository to be created


Creating a Subversion Delete StepThis step removes a file or folder from the working directory.


PropertyName

Description


IncludeFiles

The list of the file paths relative to the working directory that should bedeleted. Wildcards can be used. Specify multiple file paths as a new-lineseparated list.


Plug-ins Guide 233


PropertyName

Description

ExcludeFiles



Creating a Subversion Export Step (5.0.1 Plug-inVersion)This step is for the 5.0.1 version of the Subversion plug-in. It downloads files from theremote Subversion repository to the local directory. The 4.5.1 version of the plug-in hasdifferent properties for the Export step. See Creating a Subversion Export Step (4.5.1Plug-in Version) [page 239].


PropertyName

Description

URL URL to the repository from which files will be downloaded

Directory Location to which the contents of the repository URL will bedownloaded


PropertyName

Description

UserName



Revision Number of the Subversion revision to be used during the export. If notspecified, the HEAD revision is used.

Creating a Subversion Get Lock StepThis step acquires a lock on the files in the repository.




PropertyName

Description


IncludeFiles

The list of the file paths relative to the working directory that should belocked in the repository. Wildcards can be used. Specify multiple file pathsas a new-line separated list.



PropertyName

Description

UserName



ExcludeFiles



Message User message related to the lock

Creating a Subversion Import StepThis step imports a local directory to the remote Subversion repository.



URL URL to the repository to which the files will be imported

Directory Location of the directory with imported files

Plug-ins Guide 235





Message User message related to the import

Creating a Subversion Move StepThis step moves a file or folder in the working directory to the new location.




Destination The new path to the file or folder withinthe repository

Include Files The list of the file paths relative to theworking directory that should be moved.Wildcards can be used. Specify multiplefile paths as a new-line separated list.

Note: Use paths relative to therepository root.


PropertyName

Description

ExcludeFiles



Creating a Subversion Release Lock StepThis step releases the lock on the files in the repository.




PropertyName

Description


IncludeFiles

The list of the file paths relative to the working directory that should bereleased in the repository. Wildcards can be used. Specify multiple filepaths as a new-line separated list.



PropertyName

Description

UserName



ExcludeFiles



Message User message related to the lock

Creating a Subversion Revert StepThis step rolls back all the changes made in the working directory for the specified files.


PropertyName

Description


Plug-ins Guide 237

PropertyName

Description

IncludeFiles

The list of the file paths relative to the working directory that should bereverted. Wildcards can be used. Specify multiple file paths as a new-lineseparated list. The default value is **/*.



PropertyName

Description

ExcludeFiles



Creating a Subversion Switch StepThis step switches the working directory to another path in the repository.








Path Path to the branch or tag in the repository

Revision Number of the Subversion revision to be used during the update



Creating a Subversion Update StepThis step downloads the latest changes from the remote Subversion repository andupdates the working directory.





PropertyName

Description

UserName



Force Forces the merge of conflicted versions with the best-effort attempt. Ifforce strategy is not used, the files will be marked as conflicted and shouldlater be resolved manually by the user.

Default value: Unchecked

Revision Number of the Subversion revision to be used during update. If therevision is not specified, the HEAD revision is used.

Creating a Subversion Export Step (4.5.1 Plug-inVersion)This step is for the 4.5.1 version of the Subversion plug-in. It performs a Subversioncheckout or export. The 5.0.1 version of the plug-in has different properties for the Exportstep. See Creating a Subversion Export Step (5.0.1 Plug-in Version) [page 234].



Project Path The project path to export (relative to repositoryUrl).

Repository Url The base URL of the Subversion repository.

Plug-ins Guide 239


PropertyName

Description

revisionNum Optional revision to export.

revisionDate Optional date to export.

Formats accepted:

yyyy-MM-dd HH:mm:ss z

OR

E MMM dd HH:mm:ss zzz yyyy

OR

milliseconds since UNIX Epoch

CleanWorkspace

If selected, all files are erased from the workspace before an export isperformed.

RepositoryUsername

The authentication user.

Password The user's password.

CommandPath

The location of the svn command-line executable. For example:c:\Program Files\TortoiseSVN\bin\svn.exe.



Part 5: Database Management Plug-ins


• Chapter 26: DBDeploy Plug-in [page 243]

• Chapter 27: DBUpgrader Plug-in [page 245]

• Chapter 28: SQLCMD Plug-in [page 247]

• Chapter 29: SQL*Plus Plug-in [page 249]

• Chapter 30: SQL-JDBC Plug-in [page 251]

Plug-ins Guide 241

Chapter 26: DBDeploy Plug-in

The DBDeploy plug-in enables Deployment Automation to upgrade a database.


• Creating a Run DbDeploy Step [page 243]

For information about DBDeploy, see http://dbdeploy.com/.

Creating a Run DbDeploy StepYou may use this step to upgrade your database.

To create a Run DbDeploy step:

1. Enter a Name for your Run DbDeploy step.

2. Specify values for the following required properties:

Property Description

DriverClassname

Class name of the driver for the database.

DB DriverJar BasePath

Location of the DB driver jar files.

DB DriverJars

Name of the database driver .jar file. Supports the * wildcard.

URL Database URL. For example, jdbc:hsqldb:hsql://localhost/xdb

User Username for the database login.

Password Password for the username for the database login.

SQL Filepath

The path to the directory within which the SQL files reside.

Changelogtablename

Name of the change log table to use. This is useful if the DDL andDML need to be separate when deploying to replicatedenvironments.

SQLstatementdelimiter

The delimiter to use to separate scripts into statements. Default is asemicolon ";"

Plug-ins Guide 243

http://dbdeploy.com/


SQLstatementdelimetertype

To split on the delimiter whenever it occurs, specify normal. To spliton the delimiter only if it is featured on a line by itself, specify row.Default is normal.

LineEnding

How lines should be separated in SQL statements that are issued byway of JDBC. By default, the step uses the appropriate line endingfor the platform it is running on and this is normally satisfactory.However, due to a bug in some Oracle drivers, the Windows defaultof CRLF may not always work.

This property takes the values:

• platform

• cr

• lf

• crlf

3. (Optional) You may choose to specify the following:

a. The Output File property can be used to switch to output script mode. Thename of the script that DBDeploy will output. This should include a full or relativepath.

b. The DB Type is required if script mode is used. This refers to the target DBMS.

c. The Template Directory is the directory from which to read customizedtemplate scripts. This is only relevant in script mode.



Chapter 27: DBUpgrader Plug-in

The DBUpgrader plug-in helps manage database changes, including schema changes androllbacks.

DBUpgrader uses a proprietary XML format in conjunction with a version table in yourdatabase. The XML file is used to associate changes with versions and the database tabletracks the changes that are applied. The plug-in logic is used when performing upgradesfor AnthillPro and Deployment Automation applications.


• Upgrade DB

• Rollback DB

Plug-ins Guide 245

Chapter 28: SQLCMD Plug-in

Microsoft SQL Server SQLCMD is a command line application that exposes themanagement features of SQL Server. It comes with Microsoft SQL Server.


• Run SQLCmd scripts

For information about SQLCMD, see http://msdn.microsoft.com/en-gb/library/bb545450.aspx.

Plug-ins Guide 247

http://msdn.microsoft.com/en-gb/library/bb545450.aspx

http://msdn.microsoft.com/en-gb/library/bb545450.aspx

Chapter 29: SQL*Plus Plug-in

SQL*Plus provides access to the Oracle database using the command line to enter SQL,PL/SQL, SQL *Plus and operating system commands.

The SQL*Plus plug-in enables Deployment Automation to execute SQL scripts during adeployment.


• Creating a Run SQLPlus Script Step [page 249]

For information about SQL*Plus, see http://docs.oracle.com/cd/B19306_01/server.102/b14357/toc.htm.

Creating a Run SQLPlus Script StepThis step runs a SQLPlus script.

Note: It is recommended that you use this step when you are running an SQLscript to create an Oracle function.


PropertyName

Description

SQLPlusExecutable

The full path to the sqlplus executable, the scripts to be run, or thecommand to be run, if it is on the path.

Username The username used to run the scripts.

Password The password of the user.

ConnectionID

The connection ID to be used. For example: localhost:1521/ORCL.

SQL Files A newline-separated list of SQL files to be executed. Order is preserved.Supports ‘*’ and ‘?’ as wildcards.



Oracle Home The ORACLE_HOME environment variable value.

Plug-ins Guide 249

http://docs.oracle.com/cd/B19306_01/server.102/b14357/toc.htm

http://docs.oracle.com/cd/B19306_01/server.102/b14357/toc.htm

Chapter 30: SQL-JDBC Plug-in

The SQL-JDBC plug-in is database-independent. It allows users to execute SQL scripts in aspecific order using JDBC drivers.


• Creating an Execute SQL Scripts Step [page 251]

Creating an Execute SQL Scripts StepThis step executes SQL scripts using a JDBC driver.


PropertyName

Description

Database JDBCDriver Name

The fully-qualified JDBC driver classname.

Driver Jar The full path to the JDBC driver jar to use.

ConnectionString

The connection string to be used. used to connect to the database.For example: jdbc:mysql://dbhost:3306/mydb.

Username The user name used to connect to the database.

SQL StatementDelimiter

String that separates SQL statements.

Error Handling Action to perform when a statement fails: continue, stop, or abort.


PropertyName

Description

Password The password of the user name used to connect to the database.

PasswordScript


Files A white-space or comma separated list of sqlfiles to run. These will runin order as opposed to files grabbed using Include Files. This also takesprecedence meaning if this is set Include File box will be ignored.

Plug-ins Guide 251

PropertyName

Description

IncludeFiles

Enter a new line separated set of file filters for the sql scripts toexecute. Default-value="**/*.sql"

ExcludeFiles

Enter a new line separated set of file filters for the files to exclude fromthe execution.

Autocommit Auto commit flag for database connection

Print ResultSets

Print result sets from the statements.



Part 6: Integration Plug-ins


• Chapter 31: Informatica Plug-in [page 255]

• Chapter 32: Microsoft BizTalk Plug-in [page 257]

Plug-ins Guide 253

Chapter 31: Informatica Plug-in

Informatica Data Services enables you to directly access and merge data across remotesystems in your organization.

The Informatica plug-in is executed during deployment to migrate Informaticaconfigurations, run scripts against the Informatica server, and create and deploy groups.


• Create Static Deployment Group

• Create Dynamic Deployment Group

• Deploy Deployment Group

• Roll Back Deployment Group

• Validate Deployment Group

• Apply Label

• Run PMREP Command

• Import Objects

For information about Informatica, see http://www.informatica.com/us/.

Plug-ins Guide 255

http://www.informatica.com/us/

Chapter 32: Microsoft BizTalk Plug-in

Microsoft Biztalk Server is an enterprise service bus (ESB). It enables remote systems tocommunicate based on business rules defined in the BizTalk application.

The BizTalk plug-in is used during deployment to import BizTalk applications and bindings,uninstall BizTalk applications, remove BizTalk applications, and execute BizTalk runbookautomations.

The BizTalk plug-in relies on powershell and the bts executable to import new or updatedBizTalk applications, start and stop BizTalk applications, and remove or uninstall BizTalkApplications.


• Export BizTalk Application

• Export BizTalk Application Bindings

• Import or Upgrade BizTalk Application

• Restart BizTalk host

• Remove BizTalk Application

• Uninstall BizTalk Application

• Start BizTalk Application

For information about BizTalk, see http://www.microsoft.com/en-us/biztalk/default.aspx.

Plug-ins Guide 257

http://www.microsoft.com/en-us/biztalk/default.aspx

Part 7: Network Management Plug-ins


• Chapter 33: Citrix NetScaler Plug-in [page 261]

• Chapter 34: F5 BIG-IP Plug-in [page 263]

• Chapter 35: Nagios XI Plug-in [page 265]

Plug-ins Guide 259

Chapter 33: Citrix NetScaler Plug-in

Citrix NetScaler makes applications and cloud-based services run faster by offloadingapplication and database servers, accelerating their performance, and integratingsecurity. NetScaler can be deployed before deploying Web and database servers tocombine high-speed load balancing and content switching, data compression, contentcaching, SSL acceleration, network optimization, application visibility, and applicationsecurity.

The NetScaler plug-in allows uDeploy to enable and disable servers, server groups, andservices on NetScaler servers.


• Enable Servers

• Disable Servers

• Enable Services

• Disable Services

• Enable Service Groups

• Check Service Group Status

• Check Service Group Bindings

• Disable Service Groups

For information about Citrix Netscaler, see http://www.citrix.com/products/netscaler-application-delivery-controller/overview.html.

Plug-ins Guide 261

http://www.citrix.com/products/netscaler-application-delivery-controller/overview.html

http://www.citrix.com/products/netscaler-application-delivery-controller/overview.html

Chapter 34: F5 BIG-IP Plug-in

F5 BIG-IP provides functionality such as network load balancing, access control, andapplication security for Web-based applications.

The F5 BIG-IP plug-in enables you to execute various F5 BIG-IP steps as a part of thedeployment process.


• Disable node in pool

• Disable node in all pools

• Enable node in pool

• Enable node in all pools

• Add node to pool

• Remove node from pool

• Create pool

• Delete pool

For information about F5 BIG-IP, see http://www.f5.com/.

Plug-ins Guide 263

http://www.f5.com/

Chapter 35: Nagios XI Plug-in

Nagios XI enables you to monitor critical infrastructure components such as applications,services, operating systems, network protocols, system metrics and networkinfrastructure.

The Nagios XI plug-in automates the enabling and disabling of notifications for groups andhosts during deployment.


• Disable Host Notifications

• Enable Host Notifications

• Disable Group Notifications

• Enable Group Notifications

For information about Nagios XI, see http://www.nagios.com/products/nagiosxi.

Plug-ins Guide 265

http://www.nagios.com/products/nagiosxi

Part 8: Quality and Test Management Plug-ins


• Chapter 36: Atlassian Jira Plug-in [page 269]

• Chapter 37: Deploy Tools Plug-in [page 271]

• Chapter 38: HP Quality Center Plug-in [page 273]

• Chapter 39: QuickTest Pro Plug-in [page 283]

• Chapter 40: Rally Plug-in [page 285]

• Chapter 41: Selenium Plug-in [page 287]

Plug-ins Guide 267

Chapter 36: Atlassian Jira Plug-in

Atlassian Jira is used primarily for bug tracking, issue tracking, and project management.


• Add Comments

• Create Issue

• Update Issue

• Check Status

• Publish Issue Report

For information about Jira, see http://www.atlassian.com/software/jira/overview.

Plug-ins Guide 269

http://www.atlassian.com/software/jira/overview

Chapter 37: Deploy Tools Plug-in

Deploy Tools enables you to verify the deployment of an application through an HTTPinterface.

The Deploy Tools plug-in provides automated post-deployment verification.


• Verify Deployment

• Wait for web page

Plug-ins Guide 271

Chapter 38: HP Quality Center Plug-in

HP Quality Center (HP QC) provides quality assurance through requirementsmanagement, release and cycle management, test management, defects management,and reporting.

The HP QC plug-in automates the creating and deleting of issues in HP QC among othertasks.


• Creating a Create Issue Step [page 273]

• Creating an Update Issues Step [page 274]

• Creating an Add Comments Step [page 276]

• Creating a Publish Issue Report Step [page 277]

• Creating a Run Test Set Step [page 278]

• Creating a Publish Test Set Report Step [page 278]

• Creating a Check Status Step [page 279]

• Creating a Query Defects Step [page 280]

For information about HP QC, see http://www8.hp.com/uk/en/software-solutions/software.html?compURI=1172141.

Creating a Create Issue StepThis step creates a new defect in HP Quality Center.


PropertyName

Description

Server URL The base URL of the Quality Center instance. In usually ends with/qcbin.

Username The username to authenticate with Quality Center.

Domain The domain for the defect in Quality Center

Project The project for the defect in Quality Center.

Project Key The project key in Quality Center.

Plug-ins Guide 273

http://www8.hp.com/uk/en/software-solutions/software.html?compURI=1172141

http://www8.hp.com/uk/en/software-solutions/software.html?compURI=1172141

PropertyName

Description

Assignee The user the new defect is assigned to.

Summary A summary for the new defect. By default, the max length is 255.

Detected By The person who found the defect.

Detected OnDate

The date the defect was detected. This is supplied using the format MM/DD/YYYY.

Detected InVersion

The version in which the defect was detected.

Reproducible Whether the defect is reproducible or not (Y/N).

Subject The subject of the defect.

Severity The severity of the new defect. The default values are: 1-Low,2-Medium, 3-High, 4-Very High, and 5-Urgent.


PropertyName

Description

Password The password to authenticate with Quality Center.

PasswordScript

If a property or script is used to obtain the password, enter it here andleave the password property empty.

Priority The priority of the new defect. The default values are: 1-Low, 2-Medium,3-High, 4-Very High, and 5-Urgent.

Status The status of the new defect. The default values are: Closed, Fixed, New,Open, Rejected and Reopen. The default value is New.

AdditionalFields

Additional defect fields to add. This is provided as a newline-separated listin the form name=value. Uses Java’s java.util.Properties format.

Creating an Update Issues StepThis step updates one or more defects in HP Quality Center.




PropertyName

Description

ServerURL

The base URL of the Quality Center instance. In usually ends with /qcbin.




DefectIDs

Comma-separated list of defect IDs to update.

Fail Mode The action that should be taken when a defect to be updated is not foundin Quality Center. Select one of the following values:

• Fail-fast: Fail the step immediately if a defect is not found.

• Fail: Fail the step after attempting to update all defects.

• Warn: Log a warning when a defect is not found.


PropertyName

Description


PasswordScript


Assignee The user the new defect is assigned to.

Summary A summary for the new defect. By default, the max length is 255.

Priority The priority of the new defect. The default values are: 1-Low, 2-Medium,3-High, 4-Very High, and 5-Urgent.

Severity The severity of the new defect. The default values are: 1-Low, 2-Medium,3-High, 4-Very High, and 5-Urgent.

Status The status of the new defect. The default values are: Closed, Fixed, New,Open, Rejected and Reopen. The default value is New.

Plug-ins Guide 275

PropertyName

Description

AdditionalFields

Additional defect fields to add. This is provided as a newline-separated listin the form name=value. Uses Java’s java.util.Properties format.

Comment A comment to add to the update.

Creating an Add Comments StepThis step adds comments to a defect in HP Quality Center.


PropertyName

Description

ServerURL





DefectIDs







PropertyName

Description


PasswordScript




PropertyName

Description

AdditionalComments

Additional information you can add to the Quality Center commentalong with the commit comment.

Creating a Publish Issue Report StepThis step creates a report of Quality Center defects from a list of defect IDs.


PropertyName

Description

ServerURL





DefectIDs


OutputFile

The output file for results.






PropertyName

Description


PasswordScript


Plug-ins Guide 277

Creating a Run Test Set StepThis step runs a test set using HP Quality Center.


PropertyName

Description





Folder The folder in Quality Center in which the test set resides. Usuallystarts with Root.

Test Set The test set to run.


PropertyName

Description


PasswordScript


RemoteHost

The host that runs the tests. If this is left empty, then the tests will runlocally.

Creating a Publish Test Set Report StepThis step publishes an HP Quality Center Test Set Report.


PropertyName

Description





PropertyName

Description



Folder The folder in Quality Center in which the test set resides. Usuallystarts with Root.

Test Set The test set results to publish.

Report Name The name that will be given to the report.

Output File The output file for results.


PropertyName

Description


PasswordScript


Creating a Check Status StepThis step ensures the status of issues are in the expected state.


PropertyName

Description

ServerURL





DefectIDs

A comma-separated list of defect IDs to update in HP Quality Center.

Plug-ins Guide 279

PropertyName

Description

ExpectedStatus

The status that the issues are expected to have.






PropertyName

Description


PasswordScript


Creating a Query Defects StepThis step queries defects in HP Quality Center.


PropertyName

Description








PropertyName

Description


PasswordScript


MatchCriteria

A newline-separated list of criteria names to filter by. For example:Created in Application = XXXXXXXXXX.

ReturnFields

A newline-separated list of fields to return.

Plug-ins Guide 281

Chapter 39: QuickTest Pro Plug-in

QuickTest Pro enables you to automate functional and regression tests. It can performoperations such as mouse clicks or keyboard events on objects in a GUI or Web page.


• Run QuickTestPro tests

For information about QuickTest Pro, see http://www.th-hp.com/hp-products.php?gclid=CNzr7eaGm7cCFRLLtAodoT4APg#QTP.

Plug-ins Guide 283

http://www.th-hp.com/hp-products.php?gclid=CNzr7eaGm7cCFRLLtAodoT4APg#QTP

http://www.th-hp.com/hp-products.php?gclid=CNzr7eaGm7cCFRLLtAodoT4APg#QTP

Chapter 40: Rally Plug-in

Rally is an agile project management tool that help large enterprises perfect the art ofagile development and bring products to market faster.

The Rally plug-in enables you to update Rally issues for bug or feature tracking.


• Add Comments

• Change Status

• Create Defect

• Change Rally Artifact Property

For information about Rally, see http://www.rallydev.com/.

Plug-ins Guide 285

http://www.rallydev.com/

Chapter 41: Selenium Plug-in

Selenium is a testing tool which automates Web applications. It can also be used toautomate basic browser functions and administration tasks.

The Selenium plug-in runs Selenium Remote Control (RC) commands using a SeleniumHTML test suite file.


• Run Test Suite

For information about Selenium, see http://www.seleniumhq.org/.

Plug-ins Guide 287

http://www.seleniumhq.org/

Part 9: Deployment and ReleaseAutomation Plug-ins


• Chapter 42: BMC ARA Plug-in [page 291]

• Chapter 43: Nolio Plug-in [page 293]

• Chapter 44: Serena DA Application Plug-in [page 301]

• Chapter 45: Serena DA Component Plug-in [page 303]

• Chapter 46: Serena DA Configuration Management Plug-in [page 305]

• Chapter 47: Serena DA Environment Plug-in [page 307]

• Chapter 48: Serena DA Resource Plug-in [page 309]

• Chapter 49: Deployment Automation System Plug-in [page 311]

• Chapter 50: Serena DA Version Plug-in [page 313]

• Chapter 51: Serena DA VFS Plug-in [page 315]

Plug-ins Guide 289

Part 9: Deployment and Release Automation Plug-ins


Chapter 42: BMC ARA Plug-in

BMC Application Release Automation (ARA) enables consistent, auditable deploymentprocesses for multi-tier applications and their supporting infrastructure across physicaland virtual platforms.

The BMC ARA plug-in enables you to update a server, take a snapshot of a server, andissue a deliver.


• Snapshot Server

• Preview

• Install

• Generic Rundeliver

For information about BMC ARA, see http://www.bmc.com/products/product-listing/bmc-bladelogic-application-release-automation.html.

Plug-ins Guide 291

http://www.bmc.com/products/product-listing/bmc-bladelogic-application-release-automation.html

http://www.bmc.com/products/product-listing/bmc-bladelogic-application-release-automation.html

Chapter 43: Nolio Plug-in

The Nolio plug-in enables you to get information on the primary Nolio entities andschedule and run processes defined in Nolio.


• Creating a Nolio Get Agents Step [page 293]

• Creating a Nolio Get Applications Step [page 294]

• Creating a Nolio Get Environments Step [page 295]

• Creating a Nolio Get Process Tags Step [page 296]

• Creating a Nolio Get Processes Step [page 297]

• Creating a Nolio Get Server Types Step [page 298]

• Creating a Nolio Run Process Step [page 298]

• Creating a Nolio Schedule Process Run Step [page 299]

For information about CA Nolio, see http://www.ca.com/us/products/detail/ca-lisa-release-automation.aspx.

Creating a Nolio Get Agents StepThe Get Agents step returns a list of all agents on the Nolio server.

Plug-ins Guide 293

http://www.ca.com/us/products/detail/ca-lisa-release-automation.aspx

http://www.ca.com/us/products/detail/ca-lisa-release-automation.aspx



Nolio ServerURL

The URL to the Nolio server in the following format://host:port

User The user name to use to log on to the Nolio server

Password The password of the Nolio user



PropertyName

Description



Creating a Nolio Get Applications StepThe Get Applications step returns a list of all the existing applications on the Nolio server.





Nolio ServerURL






PropertyName

Description



Creating a Nolio Get Environments StepThe Get Environments step returns a list of all environments linked to the specifiedapplication on the Nolio server.



Nolio ServerURL






Application The Nolio application name to which the Nolio environment is linked

Plug-ins Guide 295


PropertyName

Description



Creating a Nolio Get Process Tags StepThe Get Process Tags step returns a list of tag names associated with the specifiedprocess on the Nolio server.



Nolio ServerURL







Environment The Nolio environment name to which the Nolio process is linked

Process The full name of the Nolio process




PropertyName

Description



Creating a Nolio Get Processes StepThe Get Processes step returns a list of full process names linked to the specifiedenvironment on the Nolio server.



Nolio ServerURL









PropertyName

Description



Plug-ins Guide 297

Creating a Nolio Get Server Types StepThe Get Server Types step returns a list of server types associated with the specifiedenvironment on the Nolio server.



Nolio ServerURL










PropertyName

Description



Creating a Nolio Run Process StepThe Run Process step runs a process on the Nolio server.



Nolio ServerURL








PropertyName

Description




Process Tag The name of the Nolio process tag that should be used

Servers A new-line separated list of the server types and agents in the formatof <server type>=<agent-name>


PropertyName

Description

Parameters A new-line separated list of the parameter path names and values in theformat of <parameterPathName>=<value>

Wait Tells whether the step should wait until the process is completed

Timeout Time to wait until step completion, in milliseconds. A value of -1 meansthe step will wait for 24 hours.

Creating a Nolio Schedule Process Run StepThe Schedule Process Run step runs a process on the Nolio server.



Nolio ServerURL


Plug-ins Guide 299





PropertyName

Description




Process Tag The name of the Nolio process tag that should be used

Servers A new-line separated list of the server types and agents in the formatof <server type>=<agent-name>

Date The start date of the process execution. The format of the field isdd.mm.yyyy

Time The start time of the process execution. The format of the field isHH.mm.ss (24-hour format)


PropertyName

Description

Parameters A new-line separated list of the parameter path names and values in theformat of <parameterPathName>=<value>



Chapter 44: Serena DA Application Plug-in

Deployment Automation applications initiate component deployments; they bring togethercomponents with their deployment targets, and orchestrate multi-componentdeployments.

The Serena DA Application plug-in enables you to create and manage Serena DeploymentAutomation applications.


• Create Application

• Create Application Process

• Add Component To Application

• Create Application Property

• Create Application Role

• Run Application Process

• Check If Application Exists

• Add User To Role

• Add Group To Role

Note: Using Create Application Property, you can create an applicationproperty or update the value of an existing property.

For information about Deployment Automation applications, see the User's Guide.

Plug-ins Guide 301


Chapter 45: Serena DA Component Plug-in

Deployment Automation components represent deployable items along with user-definedprocesses that operate on them, usually by deploying them.

The Serena DA Component plug-in enables you to create and manage Serena DeploymentAutomation components.


• Create Component

• Create Component Property

• Create Component Role

• Add User To Role For Component

• Add Group To Role For Component

• Check If Component Exists

Note: Using Create Component Property, you can create an componentproperty or update the value of an existing property.

For information about Deployment Automation components, see the User's Guide.

Plug-ins Guide 303


Chapter 46: Serena DA ConfigurationManagement Plug-in

Deployment Automation configuration templates typically contain configuration data forserver configurations, but the data can be for any purpose.

The Serena DA Configuration Management plug-in enables you to download and uploadconfiguration templates to and from Serena Deployment Automation.


• Install Template

For information about Deployment Automation configuration templates, see the User'sGuide.

Plug-ins Guide 305



Chapter 47: Serena DA Environment Plug-in

Serena DA environments are user-defined collections of resources that host applications.

The Serena DA Environment plug-in enables you to create and manage SerenaDeployment Automation environments.


• Create Environment

• Create Component Mapping

• Create Environment Property

• Get Environment Properties

• Get Component Environment Properties

• Inactivate Environment

• Set Component Environment Property

• Add User To Role For Environment

• Add Group To Role For Environment

• Verify Inventory Status

• Check If Environment Exists

Note: Using Create Environment Property, you can create an environmentproperty or update the value of an existing property.

For information about Deployment Automation environments, see the User's Guide.

Plug-ins Guide 307


Chapter 48: Serena DA Resource Plug-in

Serena DA resources represent deployment targets, such as a physical machines, virtualmachines, databases, and J2EE containers.


• Create Resource

• Add Resource to Group

• Create Resource Group

• Create Dynamic Resource Group

• Add Name Condition To Group

• Add Property Condition To Group

• Set Agent Property

• Set Resource Property

• Set Resource Role Property

• Check If Resource Has Role

• Add Role To Resource

• Remove Role From Resource

• Delete Resource Group

• Delete Resource

• Delete Agent

• Delete Many Resources

• Delete Many Agents

• Get Agent Property

• Get Resource Property

• Get Resource Role Property

• Delete Resource Inventory For Component

• Check If Resource Exists

• Add User To Role For Resource

Plug-ins Guide 309

• Add Group To Role For Resource

• Get Component Version For Resource

• Wait For Resources

• Add User To Role For Resource Group

• Add Group To Role For Resource Group

For information about Deployment Automation resources, see the User's Guide.




Chapter 49: Deployment AutomationSystem Plug-in

The Serena DADeployment Automation System plug-in enables you to enter system, orglobal, properties to be used by a process.


• Creating a Deployment Automation System Property Step [page 311]

For information about Deployment Automation System Properties, see the User's Guide.

Creating a Deployment Automation System PropertyStepYou may use this step to enter system, or global, properties to be used by a process.

To create a Deployment Automation System Property step:

1. Enter a Name for your Deployment Automation System Property step.

2. In the Property Name field, enter the name of the Serena Deployment Automationsystem property to be set by this step.


a. The Property Value to which you want the Serena Deployment Automationsystem property set by this step.

b. Secure the Deployment Automation system property so that it is storedencrypted and its display is obscured in the Deployment Automation userinterface.

Plug-ins Guide 311


Chapter 50: Serena DA Version Plug-in

Deployment Automation provides component version control using the Versioned FileStorage (VFS) repository. CodeStation is the name of the service that manages and storesartifacts in the repository.


• Add Status to Version

• Remove Status From Version

• Create Version

For information about Deployment Automation component version control andCodeStation , see the User's Guide.

Plug-ins Guide 313


Chapter 51: Serena DA VFS Plug-in

Deployment Automation Versioned File Storage (VFS) enables you to add artifacts toDeployment Automation version repository, CodeStation .

The Serena DA VFS plug-in enables you to upload to, download to, and verify artifacts in aDeployment Automation VFS artifact repository.


• Upload Artifacts

• Download Artifacts

• Verify Local Artifacts

For information about Deployment Automation VFS, see the User's Guide.

Plug-ins Guide 315


Part 10: System Tools and Scripting Plug-ins


• Chapter 52: 7zip Plug-in [page 319]

• Chapter 53: CA AutoSys Plug-in [page 321]

• Chapter 54: FileUtils Plug-in [page 323]

• Chapter 55: Groovy Plug-in [page 325]

• Chapter 56: Microsoft Message Queuing (MSMQ) Plug-in [page 327]

• Chapter 57: Microsoft Software Installer (MSI) Plug-in [page 329]

• Chapter 58: Microsoft Windows Service Control Manager Plug-in [page 331]

• Chapter 59: Windows System Tools Plug-in [page 333]

• Chapter 60: Red Hat Package Manager (RPM) Plug-in [page 335]

• Chapter 61: Shell Plug-in [page 337]

• Chapter 62: System Information Plug-in [page 339]

Plug-ins Guide 317

Chapter 52: 7zip Plug-in

7zip is an open source file archiver that combines a number of files together into a singlefile for easier transportation and storage.


• Creating a 7zip Extract Archive Step [page 319]

For information about 7zip, see http://www.7-zip.org/.

Creating a 7zip Extract Archive StepYou may use this step to extract files from a 7zip archive.

To create a 7zip extract archive step:

1. Enter the Name for your extract archive step.

2. Use the Include Files field to list the file filters you want this step to use to selectthe files to include.

Important: Files must each be listed on a new line separated from thenext.

3. Specify from where the files should be extracted in the Extract Directory field.


a. The Directory Offset relative to the current working directory where the stepshould run.

b. Use the Exclude Files field to list file filters you want this step to exclude fromusing.

Important: Files must each be listed on a new line separated from thenext.

Plug-ins Guide 319

http://www.7-zip.org/

Chapter 53: CA AutoSys Plug-in

CA Workload Automation AutoSys Edition is a workload automation tool for defining,scheduling, and monitoring jobs.

The AutoSys plug-in provides steps for integrating with a CA Workload Automation AEserver.


• Send Autosys Event

• Check Autosys Server

• Execute JIL Script

For information about AutoSys, see http://www.ca.com/us/products/detail/CA-Workload-Automation-AE.aspx.

Plug-ins Guide 321

http://www.ca.com/us/products/detail/CA-Workload-Automation-AE.aspx

http://www.ca.com/us/products/detail/CA-Workload-Automation-AE.aspx

Chapter 54: FileUtils Plug-in

FileUtils is a file utility plug-in that automates folder and file level tasks.

The FileUtils plug-in includes steps for creating and deleting directories and replacingtokens in a file.


• Replace Tokens

• Untar Tarball

• Unzip

• Update Property File

• Copy Directory

• Move Directory

• Synchronize Directories

• Create Directories

• Check if Directory exists

• Delete Files and Directories

• Create File

• Update INI File

• Monitor File Contents

• Flip Line Endings

• Create Zip Archive

• Update XML File with XPath

• Read Property File

Plug-ins Guide 323

Chapter 55: Groovy Plug-in

Groovy is an object-oriented programming language for the Java platform. It is a dynamiclanguage that can be used as a scripting language.

The Groovy plug-in provides steps for executing user-defined Groovy scripts.


• Run Groovy Script

For information about Groovy, see http://groovy.codehaus.org/.

Plug-ins Guide 325

http://groovy.codehaus.org/

Chapter 56: Microsoft Message Queuing(MSMQ) Plug-in

Microsoft Message Queuing (MSMQ) technology enables applications running at differenttimes to communicate across heterogeneous networks and systems that may betemporarily offline. Applications send and read messages to and from queues. A queuecan hold messages that are generated by multiple sending applications and read bymultiple receiving applications.

The MSMQ plug-in enables you to create steps for starting, stopping, and creatingmessage queues in Microsoft MQ.


• Create Message Queue

• Delete Message Queue

• Grant All Queue Permissions

• Grant Queue Permissions

• Revoke All Queue Permissions

• Revoke Queue Permissions

For information about MSMQ, see http://msdn.microsoft.com/en-us/library/windows/desktop/ms711472(v=vs.85).aspx.

Plug-ins Guide 327

http://msdn.microsoft.com/en-us/library/windows/desktop/ms711472(v=vs.85).aspx

http://msdn.microsoft.com/en-us/library/windows/desktop/ms711472(v=vs.85).aspx

Chapter 57: Microsoft Software Installer(MSI) Plug-in

Microsoft Software Installer (MSI) is a software component used for the installation,maintenance, and removal of software on Microsoft Windows systems.

The MSI plug-in installs and uninstalls MSI and runs MSIexec.


• Install MSI

• Uninstall MSI

• Execute msiexec

For information about MSI, see http://support.microsoft.com/kb/310598.

Plug-ins Guide 329

http://support.microsoft.com/kb/310598

Chapter 58: Microsoft Windows ServiceControl Manager Plug-in

Windows Service Control Manager stores information about the installed services and theirstatus. It can start and stop services, transmit control requests to running services, andlock and unlock the service database.

The Service Control Manager plug-in is used during the deployment to automate Windowsservices.


• Create Service

• Delete Service

• Start Service

• Stop Service

• Check If Service Exists

• Check If Service Stopped

• Check If Service Running

• Enable Service

• Disable Service

For information about Windows Service Control Manager, see http://msdn.microsoft.com/en-us/library/d56de412(v=vs.80).aspx.

Plug-ins Guide 331

http://msdn.microsoft.com/en-us/library/d56de412(v=vs.80).aspx

http://msdn.microsoft.com/en-us/library/d56de412(v=vs.80).aspx

Chapter 59: Windows System Tools Plug-in

The Windows System Tools plugin automates various Windows system tasks.


• Modify ACLs

• Log off Notification

• Reboot

• Check File Contents

• Add or Overwrite Registry Key

• Export Registry Subkey to File

• Import Registry Files

• Configure DCOM Settings

• Create Message Queues

• Enable Windows Features

• Disable Windows Features

Plug-ins Guide 333

Chapter 60: Red Hat Package Manager(RPM) Plug-in

The Red Hat Package Manager (RPM) is an open packaging system that runs on Red HatEnterprise Linux and other Linux and UNIX systems.


• Creating an Install RPM Step [page 335]

• Creating an Uninstall RPM Step [page 335]

• Creating an Update RPM Step [page 335]

For information about Red Hat Package Manager (RPM), see http://www.rpm.org/.

Creating an Install RPM StepYou may use this step to install RPM packages.

To create an install RPM step:

1. Enter the Name for your install RPM step.

2. Use the RPM Packages field to list the RPM packages you want this step to install.

Important: Packages must each be listed on a new line separated fromthe next.

3. (Optional) You may choose to specify the following: Install Options (also in anew-line separated list) to be used during the install.

Creating an Uninstall RPM StepYou may use this step to uninstall RPM packages.

To create an uninstall RPM step:

1. Enter the Name for your uninstall RPM step.

2. Use the RPM Packages field to list the RPM packages you want this step to uninstall.


3. (Optional) You may choose to specify the following: Erase Options (also as a new-line separated list) to be used during the uninstall.

Creating an Update RPM StepYou may use this step to update RPM packages.

Plug-ins Guide 335

http://www.rpm.org/

To create an update RPM step:

1. Enter the Name for your update RPM step.

2. Use the RPM Packages field to list the RPM packages you want this step to install.


3. (Optional) You may choose to specify the following: Update Options (also in a new-line separated list) to be used during the install.



Chapter 61: Shell Plug-in

A shell is a command language interpreter that is usually included with operating systems.A shell script is a series of commands.

The Shell plug-in enables you to run custom shell scripts during the deployment process.The most common use case for this plug-in is opening and running a shell script on thetarget machine. If the step is used within a larger process, ensure that you set the ordercorrectly. For example, if you have to run a shell script prior to executing another process,you will need to add the Shell step above the other step.

Note: This plug-in is included in the standard plug-ins provided withDeployment Automation and need not be loaded unless you need to upgrade orextend it.


• Creating a Run a Shell Script Step [page 337]

• Creating a Run a Shell Script with X Arguments Step [page 338]

Creating a Run a Shell Script StepThis step executes a shell or batch script.


PropertyName

Description

DirectoryOffset

The working directory to use when executing this command. This isrelative to the current working directory.

ShellScript

Enter the script code to execute.


PropertyName

Description

Interpreter Optionally specify the interpreter to use to evaluate the command. If leftblank the following platform-specific behavior will be used: CommandLine will use the .bat file interpreter on Windows and the .com fileinterpreter on VMS. On other systems it will use the shell specified by theair/shell agent variable if present. UNIX/Linux systems may override thisby having the command line start with a #! sequence.

Plug-ins Guide 337

PropertyName

Description

Daemon Select this option to run the command in the background whilepermitting the step to complete immediately. The output will not becaptured if running as a daemon.

OutputFile

Only select this value if running as a daemon. Enter the path of the file towhich the command output is directed. Leave blank to discard the output.The output will not be captured if an output file is not specified.

Creating a Run a Shell Script with X Arguments StepThis step executes a shell or batch script a number of times equal to a multi-valued input.


PropertyName

Description

DirectoryOffset

The working directory to use when executing this command. This isrelative to the current working directory.

xargs The comma-separated values to use as input to the script. They arepassed as input to the script.

ShellScript

Enter the script code to execute.


PropertyName

Description

Interpreter Optionally specify the interpreter to use to evaluate the command. If leftblank the following platform-specific behavior will be used: CommandLine will use the .bat file interpreter on Windows and the .com fileinterpreter on VMS. On other systems it will use the shell specified by theair/shell agent variable if present. UNIX/Linux systems may override thisby having the command line start with a #! sequence.

Daemon Select this option to run the command in the background whilepermitting the step to complete immediately. The output will not becaptured if running as a daemon.

OutputFile

Only select this value if running as a daemon. Enter the path of the file towhich the command output is directed. Leave blank to discard the output.The output will not be captured if an output file is not specified.



Chapter 62: System Information Plug-in

The System Information plug-in includes a variety of checks to perform against theoperating system. You can use this plug-in to verify that a deployment can succeed or hassucceeded.


• Check Connectivity

• Check Environment Variable

• Check Available Disk Space

• Check Regex

Plug-ins Guide 339

Part 11: Virtual and Cloud EnvironmentManagement Plug-ins


• Chapter 63: Amazon EC2 Plug-in [page 343]

• Chapter 64: Microsoft Windows Azure Plug-in [page 349]

• Chapter 65: VMware vSphere ESXi Plug-in [page 351]

• Chapter 66: VMware vCenter Plug-in [page 353]

• Chapter 67: VMware Workstation Plug-in [page 355]

Plug-ins Guide 341

Part 11: Virtual and Cloud Environment Management Plug-ins


Chapter 63: Amazon EC2 Plug-in

Amazon Elastic Compute Cloud (Amazon EC2) is a web service that provides environmentsupport in the cloud.


• Creating an Amazon EC2 Launch Instance Step [page 343]

• Creating an Amazon EC2 Security Group Step [page 344]

• Amazon EC2 Start, Stop, and Terminate Instance Steps [page 345]

• Creating an Amazon EC2 Wait for Instance Step [page 346]

• Creating an Amazon EC2 Associate IPs Step [page 346]

• Creating an Amazon EC2 Register Instances with LoadBalance Step [page 347]

• Creating an Amazon EC2 Deregister Instances with LoadBalance Step [page 347]

• Creating an Amazon EC2 Get Public DNS Step [page 348]

For information about Amazon EC2, see http://aws.amazon.com.

Creating an Amazon EC2 Launch Instance StepThe basic building blocks of Amazon EC2 are the Amazon Machine Images (AMI). An AMIis a template that contains a software configuration, such as an operating system,application server, or applications that you can run in an Amazon environment. Amazonhas a variety of AMIs available and you can also create you own.

To launch an instance from AMI, you need to create an Amazon EC2 Launch Instancestep.

To create an Amazon EC2 launch instance step:

1. Enter a Name for your Launch Instance step.



AccessKey Id

The EC2 access key ID to use to log in.

SecretKey

The EC2 secret key.

# ofinstances

The number of EC2 instances to startup.

Plug-ins Guide 343

http://aws.amazon.com


InstanceType

The type of instances to run. Allowed values are m1.small, m1.large,m1.xlarge, m2.xlarge, m2.4xlarge, c1.medium, c1.xlarge.

AMI ID The AMI ID of the instances to be started.

AWS Jar The full path to the AWS SDK .jar file.

3. You may choose to specify values for the following optional properties:


Security Group A comma-separated list of security group names to use.

Availability Zone The zone to start these instances in.

Keypair The keypair to start these instances with.

User data The user data to be passed to the instance.

Creating an Amazon EC2 Security Group StepThe Amazon EC2 security group acts as a firewall that controls the traffic allowed into agroup of instances.

To create a security group step:

1. Enter a Name for your Security Group step.



Access Key Id The EC2 access key ID to use to log in.

Secret Key The EC2 secret key.


3. You may choose to specify values for the following optional properties:


Name The name of the security group to create, if not using a file to addpermissions.




Description The description of the security group to create, if not using a file toadd permissions.

VPC ID The ID of the Virtual Private Cloud (VPC) to use, if not using a fileto add permissions.

DefinitionFile

The file describing the security group allowed ips/ports.

If left blank, an empty security group will be created.

Otherwise, the file has the following format:

<SecurityGroup name="name" description="description"vpcId="id_optional"> <ipPermission protocol="tcp" fromPort="nn"toPort="nn">

<ipRange value="0.0.0.0/0"/>

</ipPermission>

</SecurityGroup>

Amazon EC2 Start, Stop, and Terminate Instance StepsTo start, stop, or terminate an Amazon EC2 instance, you pass the same set ofparameters. These give the information needed to identify the instance that you want tostart, stop, or terminate. The only difference is start and stop steps accept only oneInstance ID whereas the terminate step accepts more than one instance ID.

To create a start, stop, or terminate instance step:

1. Enter a Name for your start, stop, or terminate instance step.



AccessKey Id


SecretKey

The EC2 secret key.

instanceID

The Instance ID to start or stop, or for the terminate step, a list ofinstance IDs separated by commas.


Plug-ins Guide 345

Creating an Amazon EC2 Wait for Instance StepUse to create a step that waits until the instance(s) specified in the Instance IDs fieldswitch to the state specified in the State field.

To create a Wait for Instance step:

1. Enter a Name for your Wait for Instance step.



Access KeyId



InstanceIDS

A comma-separated list of instance IDs that correspond to the IPsto associate.

State The state for instances to be in.

Timeout The timeout for this step, in milliseconds.


Creating an Amazon EC2 Associate IPs StepIn an AWS, an Elastic IP Address (EIP) enables you to reserve an IP address that you canthen assign to any AMI instance you have running. If needed, at any time you can alsochange the assignment to a different instance.

According to Amazon, this feature is designed for "dynamic cloud computing". Once anEIP has been associated with an instance, it remains associated with that instance untilyou release it.

To create an associate IPs step:

1. Enter a Name for your Associate IPs step.



Access KeyId



IPS A new-line separated list of elastic ips to associate with instances.




InstanceIDS

A comma-separated list of instance IDs that correspond to the IPsto associate.


Creating an Amazon EC2 Register Instances withLoadBalance StepElastic Load Balancing automatically distributes incoming application traffic across multipleAmazon EC2 instances. It enables you to achieve even greater fault tolerance in yourapplications, seamlessly providing the amount of load balancing capacity needed inresponse to incoming application traffic. Elastic Load Balancing detects unhealthyinstances within a pool and automatically reroutes traffic to healthy instances until theunhealthy instances have been restored.

You can enable Elastic Load Balancing within a single Availability Zone or across multiplezones for even more consistent application performance. Elastic Load Balancing can alsobe used in an Amazon Virtual Private Cloud (VPC) to distribute traffic between applicationtiers. For more details, see the Amazon Elastic Compute Cloud documentation.

To create an Amazon EC2 Register Instance with LoadBalance Step:

1. Enter a Name for your Register Instance with LoadBalance step.





Load BalancerName

The name of the load balancer in this EC2 account to registerthe instances from.

Instance Ids Instance ID to start.


Creating an Amazon EC2 Deregister Instances withLoadBalance StepThe Deregister Instances With LoadBalancer works the same as the re-registration exceptthat you have to use another step for it.

To create an Amazon EC2 Deregister Instance with LoadBalance Step:

1. Enter a Name for your Register Instance with LoadBalance step.

Plug-ins Guide 347





Load BalancerName

The name of the load balancer in this EC2 account to de-register the instances from.

Instance Ids Instance ID to start.


Creating an Amazon EC2 Get Public DNS StepYou may get the list of public DNSs that a list of Amazon EC2 instances are running on.

To create an Amazon EC2 Get Public DNS Step:

1. Enter a Name for your Get Public DNS step.



AccessKey Id


SecretKey

The EC2 secret key.

InstanceIds

A comma-separated list of instance IDs to be retrieved. The DNS listreturned will be in the same order as the IDs given.




Chapter 64: Microsoft Windows AzurePlug-in

Microsoft Windows Azure is an open cloud platform that enables you to build, deploy, andmanage applications across a global network of Microsoft-managed datacenters.

The Azure plug-in provides steps for working with Microsoft Azure cloud instances.


• Add Endpoint

• Create VM

• Delete VM

• Restart VM

• Start VM

• Stop VM

For information about Azure, see http://www.windowsazure.com.

Plug-ins Guide 349

http://www.windowsazure.com

Chapter 65: VMware vSphere ESXi Plug-in

VMware vSphere installs directly on top of a physical server and partitions it into multiplevirtual machines that can run simultaneously, sharing the physical resources of theunderlying server.

The VMware ESXi plug-in provides steps for working with VMware vSphere ESX and ESXivirtual machines.


• Delete Snapshot

• Start VM

• Stop VM

• Suspend VM

• Take Snapshot

• Revert VM to Snapshot

• VM settings

For information about VMware vSphere ESX and ESXi, see http://www.vmware.com/products/vsphere/esxi-and-esx/overview.html.

Plug-ins Guide 351

http://www.vmware.com/products/vsphere/esxi-and-esx/overview.html

http://www.vmware.com/products/vsphere/esxi-and-esx/overview.html

Chapter 66: VMware vCenter Plug-in

VMware vCenter Server provides centralized management of VMware virtual machinesfrom a single console.

The VMware vCenter plug-in provides steps for working with virtual machines defined inVMware vCenter.


• Clone VM

• Delete Snapshot

• Start VM

• Stop VM

• Suspend VM

• Take Snapshot

• Revert VM to Snapshot

• VM settings

For information about VMware vCenter, see http://www.vmware.com/products/vcenter-server/overview.html.

Plug-ins Guide 353

http://www.vmware.com/products/vcenter-server/overview.html

http://www.vmware.com/products/vcenter-server/overview.html

Chapter 67: VMware Workstation Plug-in

VMware Workstation enables you to access virtual machines running on VMware vSphere,ESXi, or another copy of VMware Workstation.

The VMware Workstation plug-in provides steps for working with VMware Workstationvirtual machines.


• Creating a Clone VM Step [page 355]

• Creating a Delete Snapshot Step [page 356]

• Creating a Revert to Snapshot Step [page 356]

• Creating a Start VM Step [page 356]

• Creating a Stop VM Step [page 357]

• Creating a Suspend VM Step [page 357]

• Creating a Take Snapshot Step [page 357]

For information about VMware Workstation, see http://www.vmware.com/products/workstation/overview.html.

Creating a Clone VM StepThe Clone VM step clones a virtual machine.



Full pathto vmrunutility

Specify the full path, including file name, to the tool that is used toexecute VMware commands. For example, C:\Program Files(x86)\VMware\VMware Workstation\vmrun.exe

Sourcepath andfile name

Please specify the full path, including file name, for the source .vmx file.



Snapshotname

If the snapshot name is included, the clone will be created from thespecified snapshot.

Plug-ins Guide 355

http://www.vmware.com/products/workstation/overview.html

http://www.vmware.com/products/workstation/overview.html


CreateLinkedClone

Creates the clone so that it shares virtual disks with the parent virtualmachine in an ongoing manner. This conserves disk space as long as theparent and clone do not change very much from their original state.

Creating a Delete Snapshot StepThe Delete Snapshot step deletes a snapshot of a virtual machine.





VM path Specify the full path, including file name, for the source .vmx file.

Snapshotname

The snapshot name or the path to the snapshot in the tree, for multiplesnapshots with the same name. For example, /snap1/snap1.1/snap1.1.2


Creating a Revert to Snapshot StepThe Revert to Snapshot step reverts to a snapshot of the virtual machine.






Snapshotname

The snapshot name or the path to the snapshot in the tree, for multiplesnapshots with the same name. For example, /snap1/snap1.1/snap1.1.2


Creating a Start VM StepThe Start VM step starts a virtual machine.









Creating a Stop VM StepThe Stop VM step stops a virtual machine.







Creating a Suspend VM StepThe Suspend VM step suspends a virtual machine.







Creating a Take Snapshot StepThe Take Snapshot step takes a snapshot of a virtual machine.

Plug-ins Guide 357






Snapshotname

Specify the snapshot name.




Part 12: Creating Your Own Plug-ins


• Chapter 68: Plug-in Creation [page 361]

• Chapter 69: Custom Plug-in Examples [page 371]

Plug-ins Guide 359

Chapter 68: Plug-in Creation

You may create your own plug-ins if there is not an existing plug-in that meets yourneeds as detailed in the following instructions.

• Plug-in Creation Overview [page 361]

• The plugin.xml File [page 362]

• The upgrade.xml file [page 369]

• The info.xml File [page 370]

Plug-in Creation OverviewA plug-in consists of a ZIP file that contains a set of required and optional files in the rootdirectory and supporting files located as needed. To make the plug-in available for generaluse, this ZIP file must be loaded into Deployment Automation through Administration >Automation > Automation Plugins > Load Plugin [button]. The plug-in files aredescribed in the following section.

Note: See also:

• Examples of custom plug-ins: Chapter 69: Custom Plug-in Examples [page 371]

• A short tutorial to create a "HelloWorld" plug-in: Serena Support Knowledgebasesolution S139965.

File Description

plugin.xml This file describes the steps provided by the new plug-in. This file alsocontains informational elements such as description, name, and thelocation of the plug-in in the Process Editor plug-in list hierarchy. It isthe main plug-in file to create. (Required)

upgrade.xml This file is used by Deployment Automation to upgrade plug-insbetween versions. Plug-ins are versioned, like all Serena DeploymentAutomation entities, and this file is used to describe how to upgradeprevious versions of the plug-in to the latest.

(Required)

info.xml This file is used to detail the high-level plug-in information such as whocreated the plug-in and its current version. Although optional, Serenarecommends the use of the info.xml file.

Other Any supporting script files required by the plug-in.

Plug-ins Guide 361

http://knowledgebase.serena.com/InfoCenter/index?page=content&id=S139965&actp=search&viewlocale=en_US&searchid=1381162258799

The plugin.xml file steps describe the functionality that can be used in the releaseprocess. Each step is defined by the use of the <step-type> element and contains thefollowing supporting information:

Element Description

<properties> A container for <property> child elements, and can contain anynumber of <property> elements. Property values can be supplied atdesign-time or run-time.

In addition to the properties defined locally in a step, a step can alsoaccess properties defined in other steps or even other plug-ins. Thiscan be done by using the namespaces of the other steps or plug-ins toreference the property that is needed. For example, <step-name>.<property-name>

<command> This element is used to detail the command that the plug-in step isinvoking. This command can be a shell script, an operating systemcommand, or a program. It has a set of additional XML attributes thatdescribe how the command is to be invoked.

<post-processing>

This element describes the logic that is to be invoked once thecommand has finished running and some kind of error-handling orpost-command processing is desired.

Plug-in steps are performed by an agent that has been configured to run on a targetenvironment, so you must ensure that any step commands configured in the plug-in areable to run on those agents. This may require additional software to be installed orlicenses to be added as needed. If the appropriate software cannot be invoked correctly,an error message will be shown.

Once a plug-in is created, load it into Deployment Automation to make it available tousers.

To load a plug-in:

1. Create a ZIP archive that contains the XML files (plugin.xml, upgrade.xml, andinfo.xml) along with any additional scripts required by the plug-in.

2. Load the ZIP file with the Automation Plug-ins pane Administration > Automation> Automation Plugins > Load Plugin.

The plugin.xml FileThe functionality that a plug-in provides is defined in the plugin.xml file. The structure ofthis file consists of the following:

• elements used by all plug-ins: the document type declaration, and the <plugin> rootelement that identifies the XML schema type, PluginXMLSchema_v1.xsd

• a header element that provides the identity, version, and description of the plug-in

• the step definitions; each step is delimited by a <step-type> element that definesthe functionality and properties available to that step



Example

The following shows an example of a typical plugin.xml file:

<?xml version="1.0" encoding="UTF-8"?><plugin xmlns="http://www.serena.com/PluginXMLSchema_v1"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><header>

<identifier id="plugin_id" version="version_number" name="Plug-in Name"/><description/><tag>Plugin_type/Plugin_subtype/Plugin_name</tag>

</header><step-type name="Step_Name">

<description/><properties>

<property name="property_name" required="true"><property-ui type="textBox" label="Driver Jar"

description="The full path to the jdbc driver jar to use."default-value="${p:resource/sqlJdbc/jdbcJar}"/>

</property></properties><post-processing>

<![CDATA[if (properties.get("exitCode") != 0) {

properties.put("Status", "Failure");}else {

properties.put("Status", "Success");}

]]></post-processing><command program="${path_to_tool">

<arg value="parameters_passed_to_tool"/><arg path="${p:jdbcJar}"/><arg file="command_to_run"/><arg file="${PLUGIN_INPUT_PROPS}"/><arg file="${PLUGIN_OUTPUT_PROPS}"/>

</command></step-type>

</plugin>

The following sections describe the elements of the plugin.xml file and their appropriateattributes.

• The Header: <header> Element [page 364]

• The Plug-in Steps: <step-type> Element [page 364]

• Step Properties: <properties> Element [page 365]

• Step Commands: <command> Element [page 367]

• Step Post-Processing: <post-processing> Element [page 368]

Plug-ins Guide 363

The Header: <header> Element

<header> Element

The mandatory header element identifies the plug-in and contains the following childelements:

<header>ChildElements

Description

<identifier> This element's three attributes identify the plug-in:

• version

API version (the version number used for upgrading plug-ins isdefined in the info.xml file).

• id

Identifies the plug-in.

• name

The plug-in name that appears on the Automation Plugins panein Deployment Automation.

All values must be enclosed within single or double quotes.

<description> Describes the plug-in. It appears on the Automation Plugins pane inthe web application interface.

<tag> Defines where the plug-in will appear on the process editor'shierarchy of available plug-ins. The location is defined by a stringseparated by slashes. For example, the Tomcat definition is:Application Server/Java/Tomcat. The Tomcat steps will be listedbeneath the Tomcat item, which in turn is nested within the othertwo.

The following is a sample header definition:

<header><identifier version="3" id="com.&company;.air.plugin.Tomcat"name="Tomcat"/><description>The Tomcat plugin is used during deployments to execute Tomcat run-bookautomations and deploy or undeploy Tomcat applications.

</description><tag>Application Server/Java/Tomcat</tag>

</header>

The Plug-in Steps: <step-type> Element



Plug-in steps are defined with the step-type element; each step-type represents asingle step in the Serena Deployment Automation process editor. A step-type elementhas a name attribute and several child elements: description, properties, command,and post-processing.

The mandatory name attribute identifies the step. The description and name specified inthe element will appear in the Process Editor.

<step-type name="Start"><description>Start Apache HTTP server</description>

Step Properties: <properties> Element

The properties element is a container for properties which are defined with theproperty tag. Each step has a single properties element; a properties element cancontain any number of property child elements.

A property tag has a mandatory name attribute, optional required attribute, and childelements, property-ui and value, which are defined in the following table.

Plug-ins Guide 365

<property> Element table

<property>ChildElements

Description

<property-ui>

Defines how the property is presented to users in the Serena Deployment AutomationProcess Editor. This element has several attributes:

• label

Identifies the name of the property shown in the Process Editor Edit Propertiesdialog box.

• description

Help shown for the property in the Edit Properties dialog box.

• default-value

The default value of the property. This is displayed in the Edit Properties dialog boxand is used by the step if left unchanged.

• type

Identifies the type of widget displayed to users. Possible values are:

▪ textBox

Enables users to enter an arbitrary amount of text, limited to 4064 characters.

▪ textAreaBox

Enables users to enter an arbitrary amount of text in a multi-line text box. Thelength of the text is limited to 4064 characters.

▪ secureBox

Used for passwords. Similar to textBox except values are redacted.

▪ checkBox

Displays a check box. If checked, a value of true will be used; otherwise theproperty is not set.

▪ selectBox

Requires a list of one or more values which will be displayed in a drop-down listbox. Configuring a value is described below.

<value> Used to specify values for a selectBox. Each value has a mandatory label attributewhich is displayed to users, and a value used by the property when selected. Valuesare displayed in the order they are defined.

Here is a sample <property> definition:



<property name="onerror" required="true"><property-ui type="selectBox"

default-value="abort"description="Action to perform when statement fails: continue, stop, abort."label="Error Handling"/>

<value label="Abort">abort</value><value label="Continue">continue</value><value label="Stop">stop</value>

</property>

Step Commands: <command> Element

Steps are executed by invoking the command line command specified by the <command>element. The <command> element's program attribute defines the location of the tool thatwill perform the command. It bears repeating that the tool must be located on the hostand the agent invoking the tool must have access to it. In the following example, thelocation of the tool that will perform the command, the scripting tool groovy is beinginvoked, but any command can be run as long as it is in the path and available.

<command program='${GROOVY_HOME}/bin/groovy'>

The actual command and any parameters it requires are passed to the tool by the<command> element's <arg> child element. Any number of <arg> elements can be used.The <arg> element has several attributes:

<arg> Element Attributes table

Attribute Description

<value> Specifies a parameter passed to the tool. Format is tool-specific; must beenclosed by single-quotes.

<path> Path to files or classes required by the tool. Must be enclosed by single-quotes.

<file> Specifies the path to any files required by the tool. Format is tool-specific;must be enclosed by single-quotes.

Because <arg> elements are processed in the order they are defined, ensured the orderconforms to that expected by the tool.

<command program='${GROOVY_HOME}/bin/groovy'><arg value='-cp' /><arg path='classes:${sdkJar}:lib/commons-codec.jar:

lib/activation-1.1.1.jar:lib/commons-logging.jar:lib/httpclient-cache.jar:lib/httpclient.jar:lib/httpcore.jar:lib/httpmime.jar:lib/javamail-1.4.1.jar' />

<arg file='registerInstancesWithLB.groovy' />

Plug-ins Guide 367

<arg file='${PLUGIN_INPUT_PROPS}' /><arg file='${PLUGIN_OUTPUT_PROPS}' />

</command>

The <arg file='${PLUGIN_INPUT_PROPS}' />

specifies the location of the tool-supplied properties file.

The <arg file='${PLUGIN_OUTPUT_PROPS}' />

specifies the location of the file that will contain the step-generated properties.

Note: New lines are not supported by the <arg> element and are shown in thisexample only for presentation.

Step Post-Processing: <post-processing> Element

When a plug-in step's <command> element finishes processing, the step's mandatory<post-processing> element is executed. The <post-processing> element optionallysets the step's output properties and error handling. The <post-processing> element cancontain any valid JavaScript script (unlike the <command> element, <post-processing>scripts must be written in JavaScript). Users can also provide their own scripts whendefining the step in the Deployment Automation editor. Although not required, Serenarecommends that scripts be wrapped in a CDATA element.

You have access to a java.util.Properties variable called properties. Theproperties variable has several special properties: exitCode contains the process exitcode, and Status contains the step's status. A Status value of Success means the stepcompleted successfully.

Another available variable, scanner, can scan the step's output log on the agent and takeactions depending on the results. The scanner variable may use the following publicmethods:

• register(String regex, function call) registers a function to be called whenthe regular expression is matched.

• addLOI(Integer lineNumber) adds a line to the lines of interest list, which arehighlighted in the Log Viewer; implicitly called whenever scanner matches a line.

• getLinesOfInterest() returns a java.util.List of lines of interest. This can alsobe used to remove lines.

• scan() scans the log. Use after all regular expressions are registered.

The post-processing script can examine the step's output log and take actions based onthe result. In the following code fragment, scanner.register() registers a string with aregular expression engine, then takes an action if the string is found. Once all strings areregistered, it calls scanner.scan() on the step's output log line by line.

![CDATA[properties.put("Status", "Success");if (properties.get("exitCode") != 0) {

properties.put("Status", "Failure");



}else {

scanner.register("(?i)ERROR at line", function(lineNumber, line) {var errors = properties.get("Error");if (errors == null) {

errors = new java.util.ArrayList();}errors.add(line);properties.put("Error", errors);properties.put("Status", "Failure");

});...scanner.scan();var errors = properties.get("Error");if (errors == null) {

errors = new java.util.ArrayList();}properties.put("Error", errors.toString());

}]]

You can also use post-processing scripts to set output properties that can then be used inother steps in the same process. This enables you to design complex workflows.Reference prior step output properties this way:

${p:stepName/propName}

The upgrade.xml fileTo upgrade a plug-in, you must create an upgrade XML file. This can be done asfollows:

1. Increment the number of the version attribute of the <identifier> element inplugin.xml.

2. Create a <migrate> element in upgrade.xml with a to-version attribute containingthe new number.

3. Place the property and step-type elements that match the updated plugin.xml filewithin this element, as shown in the following example.

<?xml version="1.0" encoding="UTF-8"?><plugin-upgrade

xmlns="http://www.&company;.com/UpgradeXMLSchema_v1"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<migrate to-version="3"><migrate-command name="Run SQLPlus script">

<migrate-properties><migrate-property name="sqlFiles" old="sqlFile"/>

</migrate-properties></migrate-command>

Plug-ins Guide 369

</migrate><migrate to-version="4">

<migrate-command name="Run SQLPlus script" /></migrate><migrate to-version="5">

<migrate-command name="Run SQLPlus script" /></migrate>

</plugin-upgrade>

Of course, you can also make a script-only upgrade, that is, an upgrade that containschanges to the step's associated scripts and files but does not change plugin.xml. Thismechanism can be useful for plug-in development and for minor bug-fixes/updates.

Any upgrade that does not change the step definitions or properties does not need toprovide an upgrade.xml. You can simply load the new version of the plug-in using theweb application Automation Plugins pane.

The info.xml FileUse the optional info.xml file to describe the plug-in and provide release notes to users.The file's <release-version> element can be used for version releases.



Chapter 69: Custom Plug-in Examples

The following topics include several custom sample plug-ins to help you write your owncustom plug-ins.

• Simple Test Demo [page 371]

• GUI Test Demo [page 374]

• Property Test Demo [page 378]

• Step Test Demo [page 383]

• Input Output Test Demo [page 387]

Simple Test DemoSimple Test Demo is an example custom plug-in that prints a line with no inputs oroutputs.

The main purpose of this example is to enable you to quickly create a plug-in to getfamiliar with the steps.

The file content used in the example and the properties are given in the following topics.

• Simple Test Demo plugin.xml file [page 371]

• Simple Test Demo upgrade.xml file [page 372]

• Simple Test Demo info.xml file [page 372]

• Simple Test Demo Groovy file [page 373]

• Simple Test Demo Properties [page 373]

• Simple Test Demo Results [page 373]

Simple Test Demo plugin.xml file

Following is the plugin.xml file content for the Simple Test Demo example. You can copyand paste this content into a file to try it.

<?xml version='1.0' encoding='UTF-8'?><plugin xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'xmlns='http://www.urbancode.com/PluginXMLSchema_v1'>

<header><identifier version='1' name='SimpleTestDemo'id='com.urbancode.air.plugin.SimpleTestDemo' />

<description>Simple Test demo plugin</description><tag>Demo Plugins/Simple Test Demo</tag>

</header>

Plug-ins Guide 371

<step-type name='SimpleTestDemo'><description>Simple Test demo plugin</description><properties></properties><post-processing><![CDATA[

if (properties.get("exitCode") != 0) {properties.put(new java.lang.String("Status"),new java.lang.String("Failure")); }

else {properties.put("Status", "Success");

}]]></post-processing><command program='${GROOVY_HOME}/bin/groovy'>

<arg file='SimpleTestDemo.groovy' /></command>

</step-type></plugin>

Simple Test Demo upgrade.xml file

Following is the upgrade.xml file content for the Simple Test Demo example. You cancopy and paste this content into a file to try it.

<?xml version="1.0" encoding="UTF-8"?><plugin-upgradexmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns="http://www.urbancode.com/UpgradeXMLSchema_v1"></plugin-upgrade>

Simple Test Demo info.xml file

Following is the info.xml file content for the Simple Test Demo example. You can copyand paste this content into a file to try it.

<?xml version='1.0' encoding='UTF-8'?><plugininfo>

<author name='Test Demo'><organization>Serena Software</organization><email>[email protected]</email><website>http://serena.com</website>

</author><integration type='Deploy' /><tool-description>Simple Test demo plugin</tool-description><release-version>1.0</release-version><release-notes>

<release-note plugin-version='1'>Initial release

</release-note>



</release-notes></plugininfo>

Simple Test Demo Groovy file

Following is the SimpleTestDemo.groovy file content for the Simple Test Demo example.You can copy and paste this content into a file to try it.

println "Simple Test demo plugin"

Simple Test Demo Properties

After you have completed your custom plug-in files, zipped them, and loaded them intoDeployment Automation, the plug-in steps appear under Demo Plugins in the list ofAvailable Plugin Steps in the process editor. If you drag and drop the step from SimpleTest Demo onto the graphic editor, its property fields will appear in the Edit Propertiesdialog box as follows:

Simple Test Demo Results

When you run the process that includes your Simple Test Demo plug-in step, the resultsappear in the output log as follows:

Plug-ins Guide 373

GUI Test DemoGUI Test Demo is an example custom plug-in that has a plug-in step with all the main GUIproperty types in it. The plug-in simply prints a line and nothing else.

The main purpose of this example is to show how to define GUI elements.


• GUI Test Demo plugin.xml file [page 374]

• GUI Test Demo upgrade.xml file [page 375]

• GUI Test Demo info.xml file [page 376]

• GUI Test Demo Groovy file [page 376]

• GUI Test Demo Properties [page 376]

• GUI Test Demo Results [page 377]

GUI Test Demo plugin.xml file

Following is the plugin.xml file content for the GUI Test Demo example. You can copyand paste this content into a file to try it.

<?xml version='1.0' encoding='UTF-8'?><plugin xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'

xmlns='http://www.urbancode.com/PluginXMLSchema_v1'><header>

<identifier version='1' name='GUITestDemo'id='com.urbancode.air.plugin.GUITestDemo' />

<description>GUI Test demo plugin</description><tag>Demo Plugins/GUI Test Demo</tag>

</header><step-type name='GUITestDemo'>

<description>GUI Test demo plugin</description>

<properties><property name="textBoxDemoM" required="true"><property-ui type="textBox"

label="Mandatory Text Box"description="This is a mandatory text box."/>

</property><property name="textBoxDemo">



<property-ui type="textBox"label="Text Box"

default-value="Default value here"description="This is a text box."/>

</property><property name="textAreaBoxDemo"><property-ui type="textAreaBox"

label="Test area box"default-value="Text area box"description="A new line separated list text box."/>

</property><property name="secureBoxDemo"><property-ui type="secureBox"

label="Secure Box"description="Secure box."/>

</property><property name="checkBoxDemo"><property-ui type="checkBox"

label="Check box"description="A check box" />

</property><property name="selectBoxDemo"><property-ui type="selectBox"

label="Select something"description="A simple select box"/>

<value label="Value 1">VALUE1</value><value label="Value 2">VALUE2</value><value label="Value 3">VALUE3</value></property>

</properties>

<post-processing><![CDATA[if (properties.get("exitCode") != 0) {

properties.put(new java.lang.String("Status"),new java.lang.String("Failure")); }



<arg file='GUITestDemo.groovy' /></command>


GUI Test Demo upgrade.xml file

Following is the upgrade.xml file content for the GUI Test Demo example. You can copyand paste this content into a file to try it.

Plug-ins Guide 375


xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns="http://www.urbancode.com/UpgradeXMLSchema_v1">

</plugin-upgrade>

GUI Test Demo info.xml file

Following is the info.xml file content for the GUI Test Demo example. You can copy andpaste this content into a file to try it.



</author><integration type='Deploy' /><tool-description>GUI Test demo plugin</tool-description><release-version>1.0</release-version><release-notes>

<release-note plugin-version='1'>Initial release</release-note>


GUI Test Demo Groovy file

Following is the GUITestDemo.groovy file content for the GUI Test Demo example. Youcan copy and paste this content into a file to try it.

println "GUI Test demo plugin"

GUI Test Demo Properties

After you have completed your custom plug-in files, zipped them, and loaded them intoDeployment Automation, the plug-in steps appear under Demo Plugins in the list ofAvailable Plugin Steps in the process editor. If you drag and drop the step from GUITest Demo onto the graphic editor, its property fields will appear in the Edit Propertiesdialog box as follows:



GUI Test Demo Results

When you run the process that includes your GUI Test Demo plug-in step, the resultsappear in the output log as follows:

Plug-ins Guide 377

Property Test DemoProperty Test Demo is an example custom plug-in that is based on the GUI Test Demoplug-in. It shows you how to print out the properties from the GUI elements usingGROOVY. The Property Test Demo plug-in will print out any values that have been putinto the GUI property fields.


• Property Test Demo plugin.xml file [page 378]

• Property Test Demo upgrade.xml file [page 379]

• Property Test Demo info.xml file [page 380]

• Property Test Demo Groovy file [page 380]

• Property Test Demo Properties [page 381]

• Property Test Demo Results [page 382]

Property Test Demo plugin.xml file

Following is the plugin.xml file content for the Property Test Demo example. You cancopy and paste this content into a file to try it.



<identifier version='1' name='PropertyTestDemo'id='com.urbancode.air.plugin.PropertyTestDemo' />

<description>Property Test demo plugin</description><tag>Demo Plugins/Property Test Demo</tag>

</header><step-type name='PropertyTestDemo'>


<properties><property name="textBoxDemoM" required="true"><property-ui type="textBox"

label="Mandatory Text Box"description="This is a mandatory text box."/>




<property-ui type="textBox"label="Text Box"default-value="Default value here"description="This is a text box."/>

</property><property name="textAreaBoxDemo"><property-ui type="textAreaBox"

label="Test area box"default-value="Text area box"description="A new line separated list text box."/>

</property><property name="secureBoxDemo"><property-ui type="secureBox"

label="Secure Box"description="Secure box."/>

</property><property name="checkBoxDemo"><property-ui type="checkBox"

label="Check box"description="A check box" />

</property><property name="selectBoxDemo"><property-ui type="selectBox"

label="Select something"description="A simple select box"/>

<value label="Value 1">VALUE1</value><value label="Value 2">VALUE2</value><value label="Value 3">VALUE3</value>

</property></properties>





<arg file='PropertyTestDemo.groovy' /><arg file='${PLUGIN_INPUT_PROPS}' /><arg file='${PLUGIN_OUTPUT_PROPS}' />

</command>


Property Test Demo upgrade.xml file

Following is the upgrade.xml file content for the Property Test Demo example. You cancopy and paste this content into a file to try it.

Plug-ins Guide 379



</plugin-upgrade>

Property Test Demo info.xml file

Following is the info.xml file content for the Property Test Demo example. You can copyand paste this content into a file to try it.



</author><integration type='Deploy' /><tool-description>Property Test demo plugin</tool-description><release-version>1.0</release-version><release-notes>

<release-note plugin-version='1'>Initial release</release-note>


Property Test Demo Groovy file

Following is the PropertyTestDemo.groovy file content for the Property Test Demoexample. You can copy and paste this content into a file to try it.

final def workDir = new File('.').canonicalFilefinal def props = new Properties();final def inputPropsFile = new File(args[0]);

try{

inputPropsStream = new FileInputStream(inputPropsFile);props.load(inputPropsStream);

}catch (IOException e){

throw new RuntimeException(e);}

def textBoxDemoM = props['textBoxDemoM']def textBoxDemo = props['textBoxDemo']def textAreaBoxDemo = props['textAreaBoxDemo']



def secureBoxDemo = props['secureBoxDemo']def checkBoxDemo = props['checkBoxDemo']def selectBoxDemo = props['selectBoxDemo']

println "These are the values I got..."println "-----------------------------"

println "textBoxDemoM: " + textBoxDemoMprintln "textBoxDemo: " + textBoxDemoprintln "textAreaBoxDemo: " + textAreaBoxDemoprintln "secureBoxDemo: " + secureBoxDemoprintln "checkBoxDemo : " + checkBoxDemoprintln "selectBoxDemo: " + selectBoxDemo

Property Test Demo Properties

After you have completed your custom plug-in files, zipped them, and loaded them intoDeployment Automation, the plug-in steps appear under Demo Plugins in the list ofAvailable Plugin Steps in the process editor. If you drag and drop the step fromProperty Test Demo onto the graphic editor, its property fields will appear in the EditProperties dialog box as follows:

Plug-ins Guide 381

Property Test Demo Results

When you run the process that includes your Property Test Demo plug-in step, the resultsappear in the output log as follows:



Step Test DemoStep Test Demo is an example custom plug-in that shows how to define multiple steps. Ithas two simple steps.

1. The first step takes in a single text value and then uses GROOVY to print it out.

2. The second step takes in any DOS command and then runs it, printing the output tothe screen.

The main purpose of this example is to show how to define multiple steps.


• Step Test Demo plugin.xml file [page 383]

• Step Test Demo upgrade.xml file [page 385]

• Step Test Demo info.xml file [page 385]

• Step Test Demo Groovy file [page 385]

• Step Test Demo Properties [page 386]

• Step Test Demo Results [page 387]

Step Test Demo plugin.xml file

Following is the plugin.xml file content for the Step Test Demo example. You can copyand paste this content into a file to try it.



Plug-ins Guide 383

<identifier version='1' name='StepTestDemo'id='com.urbancode.air.plugin.StepTestDemo' />

<description>Step Test demo plugin</description><tag>Demo Plugins/Step Test Demo</tag>

</header>

<step-type name='StepTestDemoStep1'><description>Step Test demo plugin Step One</description>

<properties><property name="textBoxDemo"><property-ui type="textBox"

label="Text Box"default-value="Default value here"description="This is a text box."/>






<arg file='StepTestDemo.groovy' /><arg file='${PLUGIN_INPUT_PROPS}' /><arg file='${PLUGIN_OUTPUT_PROPS}' />

</command>

</step-type>

<step-type name='StepTestDemoStep2'><description>Step Test demo plugin Step Two</description>

<properties><property name="textBoxDemo"><property-ui type="textBox"

label="Run a DOS command"default-value="(DOS command here)"description="Please enter the DOS command you wish to run."/>





}]]></post-processing><command program='call'>



<arg value='${textBoxDemo}' /></command>

</step-type>

</plugin>

Step Test Demo upgrade.xml file

Following is the upgrade.xml file content for the Step Test Demo example. You can copyand paste this content into a file to try it.



</plugin-upgrade>

Step Test Demo info.xml file

Following is the info.xml file content for the Step Test Demo example. You can copy andpaste this content into a file to try it.



</author><integration type='Deploy' /><tool-description>Step Test demo plugin</tool-description><release-version>1.0</release-version><release-notes>

<release-noteplugin-version='1'>Initial release</release-note>


Step Test Demo Groovy file

Following is the StepTestDemo.groovy file content for the Step Test Demo example. Youcan copy and paste this content into a file to try it.


Plug-ins Guide 385

try{




def textBoxDemo = props['textBoxDemo']


println "textBoxDemo: " + textBoxDemo

Step Test Demo Properties

After you have completed the example plug-in files, zipped them, and loaded them intoDeployment Automation, the Step Test Demo plug-in and its steps appear under DemoPlugins in the list of Available Plugin Steps in the process editor as follows:

If you drag and drop the step from onto the graphic editor, its property fields will appearin the Edit Properties dialog box. The property fields for StepTestDemoStep2 areshown in the following figure.



Step Test Demo Results

When you run the process that includes your Step Test Demo plug-in step, the resultsappear in the output log as follows:

Input Output Test DemoInput Output Test Demo is an example custom plug-in that shows how to pass valuesbetween plug-in steps using properties.

Plug-ins Guide 387


• Input Output Test Demo plugin.xml file [page 388]

• Input Output Test Demo upgrade.xml file [page 389]

• Input Output Test Demo info.xml file [page 389]

• Input Output Test Demo Groovy file [page 390]

• Input Output Test Demo Properties [page 391]

• Input Output Test Demo Results [page 392]

Input Output Test Demo plugin.xml file

Following is the plugin.xml file content for the Input Output Test Demo example. Youcan copy and paste this content into a file to try it.



<identifier version='1' name='InputOutputTestDemo'id='com.urbancode.air.plugin.InputOutputTestDemo' />

<description>Property Test demo plugin</description><tag>Demo Plugins/Input Output Test Demo</tag>

</header><step-type name='InputOutputTestDemo'>


<properties><property name="textBoxDemoM" required="true">

<property-ui type="textBox"label="Mandatory Text Box"description="This is a mandatory text box."/>


<property-ui type="textBox"label="Text Box"default-value="Default value here"description="This is a text box."/>

</property><property name="textAreaBoxDemo">

<property-ui type="textAreaBox"label="Test area box"default-value="Text area box"description="A new line separated list text box."/>

</property><property name="secureBoxDemo">

<property-ui type="secureBox"label="Secure Box"description="Secure box."/>

</property><property name="checkBoxDemo">



<property-ui type="checkBox"label="Check box"description="A check box" />

</property><property name="selectBoxDemo">

<property-ui type="selectBox"label="Select something"description="A simple select box"/>

<value label="Value 1">VALUE1</value><value label="Value 2">VALUE2</value><value label="Value 3">VALUE3</value>






<arg file='InputOutputTestDemo.groovy' /><arg file='${PLUGIN_INPUT_PROPS}' /><arg file='${PLUGIN_OUTPUT_PROPS}' />

</command>


Input Output Test Demo upgrade.xml file

Following is the upgrade.xml file content for the Input Output Test Demo example. Youcan copy and paste this content into a file to try it.



</plugin-upgrade>

Input Output Test Demo info.xml file

Following is the info.xml file content for the Input Output Test Demo example. You cancopy and paste this content into a file to try it.


<author name='Test Demo'>

Plug-ins Guide 389

<organization>Serena Software</organization><email>[email protected]</email><website>http://serena.com</website>

</author><integration type='Deploy' /><tool-description>

Input Output Test demo plugin</tool-description><release-version>1.0</release-version><release-notes>

<release-noteplugin-version='1'>Initial release</release-note>


Input Output Test Demo Groovy file

Following is the inoutTestDemo.groovy file content for the Input Output Test Demoexample. You can copy and paste this content into a file to try it.


final def outputPropsFile = new File(args[1]);final OutputStream outputPropsStream = null;

try{




def textBoxDemoM = props['textBoxDemoM']def textBoxDemo = props['textBoxDemo']def textAreaBoxDemo = props['textAreaBoxDemo']def secureBoxDemo = props['secureBoxDemo']def checkBoxDemo = props['checkBoxDemo']def selectBoxDemo = props['selectBoxDemo']


println "textBoxDemoM: " + textBoxDemoMprintln "textBoxDemo: " + textBoxDemoprintln "textAreaBoxDemo: " + textAreaBoxDemoprintln "secureBoxDemo: " + secureBoxDemoprintln "checkBoxDemo : " + checkBoxDemo



println "selectBoxDemo: " + selectBoxDemo

Properties outputProps = new Properties();

outputProps.put("inputoutput.test_value1", "This is a test value");outputProps.put("inputoutput.test_value2", "This is another test value");

try {outputPropsStream = new FileOutputStream(outputPropsFile);outputProps.store(outputPropsStream, "");

}finally {

if (outputPropsStream != null) {outputPropsStream.close();

}}

Input Output Test Demo Properties

The input properties for InputOutputTestDemo are shown in the following figure.

Figure 1. Input Output Test Input

The output properties for InputOutputTestDemo are shown in the following figure.

Plug-ins Guide 391

Figure 2. Input Output Test Output

Input Output Test Demo Results

When you run the process that includes your Input Output Test Demo plug-in step, theresults appear in the output log as follows:



help.serena.com · table of contents part 1: introduction...

Documents