help-drops.arcadsoftware.comguide.pdf · northamerica&latam emea(hq) asiapacific...

North America & LATAM EMEA (HQ) Asia Pacific70 Main Street, Suite 203Peterborough NH 03458USA1-603-371-90741-800-676-4709 (toll free)[email protected]

55 Rue Adrastée – Parc Altaïs74650 Chavanod/AnnecyFrance+33 450 578 [email protected]

c/o Pramex Intl Ltd1 Austin Rd West Intl Commerce Centre7107B 71/F Tsim Sha Tsui HONG KONGYau Ma TeiHong [email protected]

User GuideDROPS

Version 2.8.1

Publication Date: March, 2018

Prepared by the DROPS Documentation Team

DROPS v2.8.1User Guide |

Copyright © 2015-2018 by DROPS. All rights reserved.

The following terms are names owned by International Business Machines Corporation in the United States, othercountries, or both: AS/400®, ClearCase, ClearQuest®, DB2, DB2 Connect™, DB2 Universal Database™, ibm.com,IBM i, iSeries, System i, OS/400, Rational®, SP2, Service Pack, WebSphere. Java and all names based on Java areowned by Oracle Corp. in the United States, other countries, or both. Eclipse is a registered trademark of EclipseFoundation, Inc. Other names of companies, products or services are the property of their respective owners.

/ 315DROPS • Copyright © 2018• All Rights reserved. • arcadsoftware.com

http://www.arcadsoftware.com/

DROPS v2.8.1Contact DROPS | User Guide

Contact DROPSHeadquartered in France at the foot of the Alps, DROPS offers global services and has offices and partnersall over the world. ARCAD partners with leading-edge companies throughout the world to ensure you havethe local support you need and best-of-breed contacts for all of your softwaremanagement solutions. Ourglobal partners are located strategically around the globe to offer full services, close to home.

Visit our website to Contact Us and find out more about our company and partners!

DROPS guarantees consultant support 24 hours a day, 5 days a week (24/5) to registered members. Callsreceived are redirected to a central systemwhich, according to the hour, puts you in contact with aconsultant in or near your timezone.

The Customer Portal is intended for current and potential customers that have full or trial versions ofARCAD software. If you already use or are interested in using an ARCAD product, the portal lets you viewall of your current licenses and generate your own temporary license keys for most ARCAD products. Itgrants you access to the ARCAD product knowledge base (FAQ, new releases, fixes, etc.) and ticketingsystem/Helpdesk as well as all of the Release Notes and current documentation for each of your products.

Do you have a request for change or have you encountered a bug? Log into the Helpdesk and create aticket.

Country Address Contact

FranceARCAD Software (HQ)55 Rue Adrastée74650 Chavanod

+33 4 50 57 83 96 or Fax +33 4 50 57 52 [email protected]@arcadsoftware.com

USAARCAD Software Inc.1 Phoenix Mill Lane #203Peterborough, NH 03458

+1 (603) 371-9074 or +1 (800) [email protected]@arcadsoftware.com

SwedenARCAD Software Nordic ABProstvägen 36141 43 HUDDINGE

+46(0) 70-793 [email protected]@arcadsoftware.com

Germany

ARCAD Software Deutschland GmbHc/o Pramex International GmbHIm Trutz, Frankfurt 55,60322 Frankfurt am Main

Hong Kong

ARCAD Software Asiac/o Pramex Intl Ltd1 Austin Rd West Intl Commerce Centre7107B 71/F Tsim Sha Tsui HONG KONGYau Ma TeiHong Kong

+852 3618 [email protected]@arcadsoftware.com

ChinaOffice E05, 31st floorAgile Center26 Huaxia Road, Zhejiang New Town, Tianhe

+86 (020)22324643+86 (020)22324649

India D-280/281/282, Vibhuti KhandOpposite Urdu Academy, Gomti Nagar, Lucknow

Table 1: Contact DROPS


https://arcadsoftware.com/about/#_contact

https://arcadsoftware.com/customer/

http://helpdesk.drops-software.com/

mailto:[email protected]









DROPS v2.8.1User Guide | Preface

PrefaceDocument PurposeThis document is intended to guide all DROPS users through low-level studio configuration process andhow to use the DROPS Studio.

Intended AudienceThis document is intended for the following DROPS users, among others:

l administratorsl configuration managersl releasemanagersl deployment process designersl deployment operators

About the examplesExamples are unique to an illustrative environment, created only for documentation purposes, and are notnecessarily exhaustive.

Examples are presented in the following format:

ExampleLorem ipsum dolor sit amet, consectetur adipiscing elit. Nam risus ipsum,vulputate et semper quis, cursus vitae leo. Sed pretium nisi non molestieporta. Nullam eu tincidunt felis. Etiammalesuada urna tempor velitimperdiet mattis.

About the Entity Access TablesAt the beginning of most of the chapters in this document, an Entity Access Table contains importantpieces of information concerning the entity described in the chapter.

Required Roles Environment ReleaseManager and/or Release Operator

Required Rights(by category) Deployment Process Instances

Perspective Operational ConsoleManagement

Access DROPS Server→ Deployment Process→ Deployment Process Instances

1. If a Role is required in order to carry out any action concerning the entity described, it is listed. Not allRoles are required for all of the actions described.

2. If any rights are required for the User's profile in order to access, edit, delete, manage, etc. anythingconcerning the entity described, the parent right category is listed.

3. The perspective in which the entity is found.

4. The path to the entity in the Configuration Explorer or Console Explorer.

ReferenceFor more information about how to navigate inside the DROPS Studio,



DROPS v2.8.1Preface | User Guide

refer to the Overview of the DROPS Studio on page 29.

Related Documentation

Related Documentation

DROPS Configuration Guide

DROPS Datasheet

DROPS Installation Guide

DROPS Release Notes

DROPS Script Reference Guide

DROPS Server Exploitation Guide

DROPS System Requirements

DROPSWhite Paper

SYSchange User's Guide

ARCAD Installation DocumentationTable 2: Related Documentation

Publication Record

Unless stated otherwise, all content is valid for themost current version of DROPS listed as well as everysubsequent version.

ProductVersion

DocumentVersion

PublicationDate Update Record

≥ 2.8.1 1.9 March, 2018

Primarily a corrective versionDocumentation updated for product evolution:

l Added new variables for The ARCAD Import Strategyl Added option to download import and export logs in .json formatl Added option to set the status for Activities that do not deploy any Artifacts

2.8 1.8 September,2017

Documentation updated for product evolution:l Added option to export properties (see Properties)l Added option to Create an Instance to deploy Multiple Releases to anEnvironment

l Added option to search for Environmentsl Changed the term Deployment Groups to Deployment Tagsl Modified the management of Deployment Tags (see Managing DeploymentTags)

l Added option to automatically select the response to Interruption Messageswhen only one is available

l Added option to Import new users from an external LDAP (Active Directory)l Improved the Client APIs

2.7 1.7 May, 2017

Documentation was not published for v2.7, however the following modificationswere made.Documentation updated for product evolution:

l Save Files imported by the IBM i and Arcad Import Strategies are saved as.txt attachments (see Viewing attachments)

l Added option to Duplicate an Environmentl Added options to Clean Root Directory before execution and to Clean RootDirectory after execution to Import Strategies

Table 3: DROPS User Guide Publication Record



DROPS v2.8.1User Guide | Preface

ProductVersion

DocumentVersion


l Added option to view deployment log in real-time while executing (see:Executing Deployment Process Instances manually)

l Added an advanced log viewer for Deployment Instances (see View theLogs)

l Added option for Viewing a server’s log.l Added the Environment Extension Type Configuration the correspondingsubstitution variables

l Added all of the elements required for DROPS for Docker (see The DockerSimple Import Strategy and Docker extended configuration)

Corrections:l Can duplicate built-in scriptsl Corrected instructions for exporting scriptsl Corrected extended configuration/substitution variable information

Modifications:l Modified multiple icons for consistency

2.6 1.6 December,2016

Documentation updated for product evolution:l Added option to zip Artifacts before transferl Added Infra. Item column to Interruption Messages search viewl Added option to select deployment type when sending a notificationl Added to the descriptions of the Deployment Process Instance executionresults

Modifications:l Modified multiple icons in import and deployment execution views(Operational Console Management perspective)

2.5 1.5 October, 2016

No functional changesModifications:

l Added reference to new Script Reference Guidel Improved UI and replaced outdated screen shots

Corrections:l Revised Release purging descriptionl Corrected Replacement Rule screen shots


Documentation updated for product evolution:l Updated the Roles appendixl Added the Rights appendixl Revised Roles and Rights for all entities


Documentation updated for product evolution:l Updated contact informationl Updated Working with the Deployment Process Schedulerl Updated Working with Import Process Instancesl Updated Working with Deployment Process Instancesl Added Monitor the connection to an Infrastructure Item (Agent)automatically

l Added Working with Environment Groupsl Added Managing Deployment Tagsl Added Working with Process Templatesl Added Client APIsl Added option to archive deployment logs (see View the Logs)l Added option to create Releases manuallyl Added option to purge Releasesl Revised Reportsl Removed User Groups




DROPS v2.8.1Preface | User Guide

ProductVersion

DocumentVersion


1.5 1.2 October, 2015 Official publication

1 RC1 1.1 September,2015

Modifications:l Agent type added to definition of Infrastructure Items. Correspondingupdates made throughout document

l Interruption Messagesl Rollback appendix




DROPS v2.8.1User Guide | Contents

Contents

Contact DROPS 3

Preface 4

Contents 8

Tables 16

Figures 18

Introduction1 About DROPS 211.1 About the DROPS Server 221.2 About the DROPS Studio 231.3 About the DROPS Agent 231.4 About the DROPS Web Server 241.5 About the DROPS Web Console 241.6 About DROPS for ARCAD 251.7 About DROPS for z/OS 25

2 The simplified concepts 27

3 Overview of the DROPS Studio 29

4 Functional constraints 304.1 Unattended actions 30

Getting Started5 Managing the DROPS Server connection 325.1 Adding a DROPS Server 325.2 Connecting to a server 335.3 Configuring a server’s preferences 335.4 Configuring a server 335.5 Viewing a server’s log 335.6 Verifying a server’s version 345.7 Deleting a server connection 34

6 Changing your password 35

User AdministrationIntroduction to User Administration 37

7 Working with User Accounts 387.1 Searching for Users 387.2 Creating Users 39



DROPS v2.8.1Contents | User Guide

7.2.1 Create new users in the DROPS Studio 39

7.2.2 Import new users from an external LDAP (Active Directory) 39

7.3 Editing a User's ID 407.3.1 Define a User's login credentials 40

7.4 Assigning profiles to Users 417.4.1 View the rights granted to profile(s) 42

7.5 Deleting Users 42

8 Assigning entity-level Roles 438.1 Removing assigned Roles 44

9 Accessing your profile and rights 45

Configuring the Import ProcessIntroduction to configuring the Import Process 47

10 Working with Applications 4910.1 Accessing Applications 4910.2 Creating Applications 5010.3 Editing Application details 5010.4 Deleting Applications 55

11 Working with Components 5611.1 Accessing Components 5611.2 Creating Components 5711.3 Editing Component details 5711.4 Deleting Components 59

12 Working with Import Strategies 6012.1 Accessing Import Strategies 6112.2 Creating Import Strategies 6112.2.1 Create a new Strategy 62

12.2.2 Use or Copy from Strategy Templates 62

12.3 Editing Import Strategy details 6312.4 Deleting Import Strategies 66

13 Working with Strategy Templates 6713.1 Accessing Strategy Templates 6713.2 Creating Strategy Templates 6713.3 Editing Strategy Templates 6813.4 Deleting Strategy Templates 69

14 Working with Releases 7014.1 Searching for Releases 7014.2 Creating Releases 7114.3 Editing Release details 72




14.4 Viewing Environments to which a Release has been deployed 7314.5 Making comments 7314.6 Viewing attachments 7314.7 Locking and unlocking Releases 7414.8 Viewing the Artifacts in Releases 7414.9 Purging the Artifacts imported by Releases 7414.10 Deleting Releases 75

15 Working with imported Artifacts 7615.1 Searching for imported Artifacts 7615.2 Viewing an Artifact's import history 77

Configuring the Deployment ProcessIntroduction to configuring the Deployment Process 80

16 Working with multiple Clients 82

17 Working with Environments 8417.1 Searching for Environments 8417.2 Creating Environments 8517.2.1 Create a new Environment 86

17.2.2 Duplicate an Environment 86

17.3 Editing Environment details 8717.4 Adding Infrastructure Items to Environments 8917.5 Defining Applications allowed for Environments 8917.6 Viewing the Releases already deployed to an Environment 9017.7 Viewing an Environment's Deployment History 9017.8 Changing the Extension Type of an Environment 9117.9 Deleting Environments 92

18 Working with Environment Groups 9318.1 Accessing Environment Groups 9318.2 Creating Environment Groups 9418.3 Editing Environment Group details 9418.4 Adding Environments to Groups 9518.5 Deleting Environment Groups 96

19 Working with Infrastructure Items 9719.1 Searching for Infrastructure Items 9819.2 Creating Infrastructure Items 9919.2.1 Create individual Infrastructure Itemsmanually 99

19.2.2 Create multiple Infrastructure Items automatically 100

19.3 Testing the connection to an Infrastructure Item (Agent) 10219.3.1 Test the connection to an Infrastructure Item (Agent) manually 103

19.3.2 Monitor the connection to an Infrastructure Item (Agent) automatically 103




19.3.2.1 Accessing the Remote Agent Monitoring List 104

19.4 Editing Infrastructure Item details 10419.5 Changing the Type of an Infrastructure Item 10919.6 Changing the OS Family of an Infrastructure Item 10919.7 Managing an Infrastructure Item’s remote installation properties 11019.7.1 Generating an Infrastructure Item’s remote installation properties 111

19.7.2 Creating remote installation information in the DROPS database 111

19.8 Viewing the Releases deployed on an Infrastructure Item 11119.9 Viewing an Infrastructure Item's Deployment History 11219.10 Deleting Infrastructure Items 112

20 Working with Deployment Schemas 11320.1 Accessing Deployment Schemas 11420.2 Creating Deployment Schemas 11420.3 Editing Deployment Schemas 11520.3.1 Manage Deployment Rules 115

20.4 Deleting Deployment Schemas 116

21 Working with Replacement Rules 11721.1 Accessing Replacement Rules 11821.2 Creating Replacement Rules 11921.3 Editing Replacement Rules 11921.4 Deleting Replacement Rules 120

22 Working with scripts 12122.1 Searching for scripts 12222.2 Creating scripts 12322.2.1 Create a new script 123

22.2.2 Duplicate a script 123

22.2.3 Create a new version of a script 124

22.3 Importing scripts 12422.4 Editing scripts 12522.4.1 Edit script details 125

22.4.2 Edit script content 127

22.5 Exporting scripts 12822.6 Executing scripts 12922.7 Deleting scripts 130

23 Working with Deployment Process Diagrams 13123.1 Accessing Deployment Processes 13123.2 Creating Deployment Processes 13223.2.1 Create a newDeployment Process 132

23.2.2 Duplicate a Deployment Process 133

23.3 Changing a Deployment Process' status 135




23.4 Defining Default Deployment Processes 13523.5 Deleting Deployment Processes 13523.6 Building Deployment Process Diagrams 13623.6.1 Manage Deployment Activities 136

23.6.1.1 Create a newDeployment Activity 137

23.6.1.2 Use a Deployment Activity Template 138

23.6.1.3 Define the order in which to deploy Activities 139

23.6.1.4 Rearrange Deployment Activity boxes 140

23.6.1.5 Delete Deployment Activities 141

23.6.2 Manage Deployment Process Stages 141

23.6.2.1 Add new Stages to Deployment Activities 142

23.6.2.2 Add Template Stages to Deployment Activities 142

23.6.2.3 Delete Stages from Deployment Activities 143

23.6.3 Manage Deployment Actions 143

23.6.3.1 Add Deployment Actions to Activities and Stages 143

23.6.3.2 Delete Deployment Actions 145

23.6.4 Create "Wait For" Connections 145

23.6.5 Print Deployment Process Diagrams 145

23.7 Editing Deployment Process properties 14623.7.1 Edit global Deployment Process details 146

23.7.2 Edit global Deployment Process properties 148

23.7.2.1 Use a Properties Template 151

23.7.3 Edit Deployment Activity properties 152

23.7.4 Edit Deployment Action properties 157

24 Working with Process Templates 16124.1 Searching for Process Templates 16224.2 Creating Process Templates 16324.2.1 Create a Process Template manually 163

24.2.2 Create an Activity or a Stage Template from an existing Diagram 163

24.3 Editing Process Templates 16424.4 Viewing the Process Diagrams that use a Template 16424.5 Deleting Process Templates 165

Importing ArtifactsIntroduction to importing Artifacts 167

25 Managing Applications 16825.1 Managing Allow-to-Release Applications 16825.2Managing favorite Applications 16825.3 Viewing import history by Application 168

26 Importing Artifacts immediately by Application 170

27 Working with Import Process Instances 173




27.1 Searching for Import Process Instances 17327.2 Creating Import Process Instances 17427.2.1 Create new Import Process Instances 175

27.2.2 Duplicate an Import Process Instance 177

27.3 Executing Import Process Instances 17727.3.1 Pausing scheduled Import Process Instances 178

27.4 Understanding Import Process Instance results 17827.4.1 View the Logs 179

27.4.2 View the Results for each Import Strategy 179

27.5 Deleting Import Process Instances 180

Deploying ReleasesIntroduction to deploying Releases 182

28 Working with Deployment Process Instances 18428.1 Searching for Deployment Process Instances 18428.2 Creating Deployment Process Instances 18728.2.1 Create new Instance 187

28.2.2 Create an Instance to deploy Multiple Releases to an Environment 189

28.2.3 Create Multiple Instances to deploy one Release to an Environment Group 190

28.2.4 Duplicate a Deployment Process Instance 192

28.3 Changing the Release to deploy 19328.4 Managing Deployment Tags 19328.5 Defining an Instance's Deployment mode 19428.5.1 Mark an Instance to deploy in Full-Transfer mode 195

28.5.2 Mark an Instance to deploy in Transfer-Only mode 195

28.5.3 Create Installation-Only Instances 196

28.6 Executing Deployment Process Instances manually 19628.6.1 Execute Full-Transfer and Transfer-Only Instances 197

28.6.2 Execute Installation-Only Instances 197

28.7 Scheduling Deployment Process Instances 19828.7.1 Schedule Full-Transfer and Transfer-Only Instances 199

28.7.2 Schedule Installation-Only Instances 199

28.7.2.1 Managing an Installation-Only Instance's Automatic-Schedule 200

28.7.3 Modify any Instance's Schedule 200

28.8 Understanding Deployment Process Instance results 20128.8.1 View the steps carried out 202

28.8.2 View the Logs 203

28.8.3 View the Attachments 205

28.9 Rolling back a deployed Deployment Process Instance 20628.9.1 Roll back a Deployment manually 206

28.9.2 Schedule a Deployment's rollback 206




28.10 Canceling Deployment Process Instances 20728.11 Deleting Deployment Process Instances 207

29 Working with the Deployment Process Scheduler 20829.1 Searching for Deployment Process Instances 20929.2 Creating Deployment Process Instances 21029.2.1 Create newDeployment Process Instances 211

29.2.2 Create new Instances with predefined information using the Scheduler's sections 212

29.2.3 Duplicate a Deployment Process Instance 213

29.3 Rescheduling Deployment Process Instances 21329.4 Changing the Release to deploy 21329.5 Defining an Instance's Deployment mode 21429.5.1 Mark an Instance to deploy in Full-Transfer mode 214

29.5.2 Mark an Instance to deploy in Transfer-Only mode 214

29.5.3 Schedule Installation-Only Instances 214

29.6 Executing Deployment Process Instances manually 21529.7 Scheduling a Rollback Instance 21529.8 Viewing Deployment Process Instance details and results 21529.9 Deleting Deployment Process Instances 216

30 Working with Interruption Messages 21730.1 Accessing pending Interruption Messages 21730.2 Responding to Interruption Messages 21830.3 Reviewing processed Interruption Messages 219

31 Working with Suspended Actions 22031.1 Accessing pending Suspended Actions 22031.2 Responding to Suspended Actions 22131.3 Reviewing processed Suspended Actions 222

32 Working with Validation Requests 22332.1 Accessing pending Requests 22332.2 Responding to Requests 22432.2.1 Fill out the Validation Request editor 224

32.2.2 Validate immediately 225

32.3 Reviewing processed Requests 226

ReportsIntroduction to DROPS Reports 228

33 Working with DROPS reports 22933.1 The Application Analysis report 22933.2 The Deployment Statistics reports 23033.2.1 The Deployment Incident Statistics by Application report 230

33.2.2 The Deployment Incident Statistics by Environment report 230




33.2.3 The Deployment Results Statistics by Environment report 231

33.2.4 The Deployment Results Statistics by Application report 231

33.3 The Environment Analysis report 23133.4 The ReleaseMap Reporting reports 23133.4.1 The Application Deployment Map 231

33.4.2 The Environment Release Deployment Map 231

33.4.3 The Infrastructure Item Release Deployment Map 231

33.4.4 The Release Deployment Map 231

33.5 The Security Policy reports 23233.5.1 The Role report 232

33.5.2 The Users report 232

AppendicesEntity types 234

Properties 239

Roles 241

Rights 244

Substitution Variables 246

Import Strategy Type Configuration 255

Infrastructure Item Type Extended Configuration 274

Environment Extension Type Configuration 277

Rollback 278

Client APIs 280

DROPS for z/OS 287

Troubleshooting 293

Glossary 298



DROPS v2.8.1User Guide | Tables

Tables

Table 1: Contact DROPS 3Table 2: Related Documentation 5Table 3: DROPS User Guide Publication Record 5Table 4: Edit user login credentials 41Table 5: Edit Applications 51Table 6: Edit Components 58Table 7: Edit Import Strategies- Main properties 64Table 8: Edit Releases 73Table 9: Edit Environments 88Table 10: Edit Environment Groups 95Table 11: Edit Infrastructure Items: Identification and Connection sections 105Table 12: Edit Infrastructure Items: License Type section 107Table 13: Edit Infrastructure Items: Deployment Information section 108Table 14: DROPS Agent Installation properties 110Table 15: Deployment Rule example 113Table 16: Edit Replacement Rules 119Table 17: Create a new version of a script 124Table 18: Edit script details 126Table 19: Script parameters 126Table 20: Edit Deployment Process details 147Table 21: Edit Deployment Process properties 148Table 22: Edit Initialization Activity properties 153Table 23: Edit Infrastructure Item Activity properties 154Table 24: Edit Deployment Action properties 158Table 25: Import Process Instance statuses & results 174Table 26: Deployment Process Instancemodes 186Table 27: Deployment Process Instance statuses & Results 186Table 28: Entity types: Configuration 234Table 29: Definitions of user Roles and the required rights 242Table 30: Server Administrator and other high-profile rights 244Table 31: Substitution Variables 246Table 32: Import Process substitution variables 247Table 33: Deployment Process substitution variables 249Table 34: Activity-level substitution variables 253Table 35: Action-level substitution variables 254Table 36: Import Strategy types: Configuration 255Table 37: ARCAD Strategy extended configuration 257Table 38: Command Line Strategy extended configuration 260Table 39: CVS Repository Import Strategy extended configuration 262Table 40: File System Strategy extended configuration 264Table 41: File System Strategy extended configuration 265Table 42: GIT Import Strategy extended configuration 268Table 43: IBM i Strategy extended configuration 269Table 44: IBM z/OS Import Strategy extended configuration 270



DROPS v2.8.1Tables | User Guide

Table 45: IBM z/OS Initial Import Strategy extended configuration 271Table 46: SVN Import Strategy extended configuration 273Table 47: Infrastructure Item types: Configuration 274Table 48: ARCAD Infrastructure Item extended configuration 274Table 49: Docker Infrastructure Item extended configuration 274Table 50: IBM i Infrastructure Item extended configuration 275Table 51: IBM z/OS Infrastructure Item extended configuration 275Table 52: JDBC Infrastructure Item extended configuration 276Table 53: Tomcat Infrastructure Item extended configuration 276Table 54: Environment Extension types 277Table 55: ARCAD Environment extended configuration 277Table 56: Client APIs: Configuration 280Table 57: The drops.import.filter element’s attributes 280Table 58: The drops.instance task attributes 280Table 59: The drops.import.release task's attributes 281Table 60: The release.deploy task's attributes 283Table 61: Troubleshooting 293



DROPS v2.8.1User Guide | Figures

Figures

Figure 1: DROPS in the ARCAD Group product suite 22Figure 2: DROPS functional diagram 22Figure 3: Accessing the DROPS Server options 32Figure 4: Change your password (Preferences menu) 35Figure 5: The Users search view 38Figure 6: The User editor 40Figure 7: Assigning Entity-Level Roles 43Figure 8: Current User Information (Preferences menu) 45Figure 9: The Configuration Management perspective - Artifact Repository 47Figure 10: Accessing Applications 50Figure 11: The Application editor 51Figure 12: The Application editor - Components 57Figure 13: The Component editor 58Figure 14: The Component editor - Import Strategies 61Figure 15: The Import Strategy editor 63Figure 16: The Strategy Templates view 67Figure 17: The Releases search view 71Figure 18: The Release editor 72Figure 19: The Artifacts search view 77Figure 20: The Artifact History view 77Figure 21: The Configuration Management perspective - Infrastructure Repository 80Figure 22: Views named for multiple Clients 83Figure 23: The Environments search view 85Figure 24: The Environment editor 87Figure 25: The Deployed Releases tab in the Environment editor 90Figure 26: The Deployment History tab in the Environment editor 91Figure 27: The Environment Group view 94Figure 28: The Environment Group editor 95Figure 29: The Infrastructure Items search view 98Figure 30: Example of .csv file used to import multiple Infrastructure Items 100Figure 31: Infrastructure Agents included in theMonitoring List 103Figure 32: The Remote Agent Monitoring List view 104Figure 33: The Infrastructure Item editor 105Figure 34: The Deployment Schemas view 114Figure 35: The Deployment Schema editor 115Figure 36: Example of a .properties file prepared for Replacement Rules 118Figure 37: The Replacement Rules view 118Figure 38: The Replacement Rules editor 119Figure 39: The Scripts search view 122Figure 40: The Script editor 125Figure 41: Edit script content 128Figure 42: Example of an exported script 129Figure 43: The Process List view 132Figure 44: The Deployment Process editor 136



DROPS v2.8.1Figures | User Guide

Figure 45: Create a new Infrastructure Item Activity 137Figure 46: Activity Templates in the Deployment Process Diagram 139Figure 47: Create ordered connections between Deployment Activities 140Figure 48: Add Stages to Activities 142Figure 49: Drag and drop Actions into Activities or Stages 144Figure 50: Create "wait for" connections between Deployment Actions 145Figure 51: The Deployment Process details editor 147Figure 52: The Deployment Process properties editor 148Figure 53: Global-level Properties Templates in the Deployment Process Diagram 152Figure 54: The Deployment Activity properties editor 153Figure 55: The Deployment Action properties editor 158Figure 56: The Process Templates search view 162Figure 57: Viewing Deployment Process that use Process Templates 165Figure 58: The Operational ConsoleManagement perspective - Importing 167Figure 59: Importing Artifacts by Application 171Figure 60: The Import Process Instance search view 173Figure 61: Consulting Import Execution results in real-time (Console) 178Figure 62: The Import Results view - Logs 179Figure 63: The Operational ConsoleManagement perspective - Deploying 182Figure 64: The Deployment Process Instances search view 185Figure 65: Deployment Process Instances for Release Sets 190Figure 66: Tagged Deployment Process Instances 194Figure 67: Consulting Deployment Execution results in real-time (Console) 197Figure 68: Overview of the Deployment Process Instance results 201Figure 69: The Deployment Result view - Steps 202Figure 70: The Deployment Results view ≥v2.7 - Logs 204Figure 71: The Deployment Results view ≤v2.6 - Logs 205Figure 72: The Deployment Result view - Attachments 205Figure 73: The Deployment Process Scheduler 209Figure 74: The Scheduler's Environment/Application rows 210Figure 75: Parent and child instances are connected in the Scheduler 210Figure 76: Drag an Instance to Reschedule in the Scheduler 213Figure 77: Hover to see Instance details in the Scheduler 216Figure 78: The Interruption Messages view 218Figure 79: The Interruption Messages editor 219Figure 80: The pending Suspended Actions view 220Figure 81: The Suspended Action editor 221Figure 82: The pending Validation Requests view 224Figure 83: The Validation Request editor 225Figure 84: The Configuration Management perspective - Dashboard 228Figure 85: The Report List view 229Figure 86: Example of the Target Environments report 230Figure 87: Create Component Types 235Figure 88: Create Environment Types 236Figure 89: Create Infrastructure Item Types 238Figure 90: The Properties manager 239Figure 91: The Invalid Items view 294



Introduction

DROPS v2.8.11 About DROPS | User Guide

1 About DROPS

Automatically or selectively create packages on any environment and "drop" themon designated target Environments

Previously, the software development lifecycle revolved around fixed requirements to be implemented bylocal in-house development teams, and delivered as "big bang" projects. Hundreds of modules weredelivered at distant intervals, and then review by stakeholders was performed at the final delivery. Thiswaterfall approach to development resulted in themajority of software projects failing to deliver in termsof cost, timeliness, and end-user satisfaction. Today, IT projects deal with evolving requirements,geographically dispersed development teams, ongoing stakeholder engagement, and incremental delivery.To stay ahead, massive software changes must be delivered with increasing frequency and at higher levelsof quality. Agile methods were born to deal with these needs. Agile development allows organizations toreact more quickly and deal with ever-changing requirements, while assuring quality with fewer resources.

Yet as Agile shortens development cycles, operations teams have struggled to keep up. Faster deliveryincreases the risk in each software release, as multiple teams push "change sets" in interdependent systems.The goal of operations – to keep applications available – conflicts with development that is measured on thespeed and reactivity of their upgrades. To balance these conflicting interests, "dev" and "ops" needcommon tools to cooperate closely and becomemore proficient in rolling changes into production. For thisreason, both agile methods and, in turn, the DevOps lifecycle are now central to ReleaseManagement,reconciling pragmatism, accountability, and a "need for speed".

At the same time, the introduction of Web and mobile components has made application architecturesmore complex. Mobile, cloud and Web-based interfaces make new demands concerning ReleaseManagement tools every year. The changes impact the downstream phases of software delivery anddeployment, and in particular the boundary between development and operations departments.Information systems span multiple platforms, with often a legacy business application at the core. ReleaseManagement tooling must thereforemanage the dependencies between diverse technologies and facilitatecollaboration between disparate teams.

DROPS offers a unique solution for themanagement and automation of application and systems softwaredeployment across multiple platforms - including IBM i, Windows, UNIX, Linux, and System z. In supportof DevOps, DROPS is production-oriented, shifting the bias from development to operations. DROPSfocuses on the deployment of functions, rather than on technical components. This makes the solutionintuitive and easy-to-use, assisting development and operations teams in working closely together tosmoothly manage an accelerated delivery schedule. DROPS also supports continuous integration anddelivery, so teams can use agile methods efficiently and deliver value to customers faster. DROPS deploysby process, to maximize automation and give real-time transparency on release status for all parties.

The real power of DROPS is derived from its comprehensivemanagement capabilities, automation, and thediverse Technical Platforms it supports. The deployed software on open systems, IBM i and z/OS platformscan be traced at any time enabling Operations Managers to closely watch inflow of systems and applicationsoftware changes at all times.



DROPS v2.8.1User Guide | 1 About DROPS

Figure 1: DROPS in the ARCAD Group product suite

Figure 2: DROPS functional diagram

1.1 About the DROPS Server

Host your Deployment Processes

The DROPS Server is an independent AFS server on which DROPS creates and stores specializedrepositories to be used in your Deployment Process. It is an OSGi™ application server which hosts yourreferences on an H2 database by default. The AFS' default port number is 5252.




It exposes REST web services in order to communicate with other applications in the system, for instance tocreate a continuous deployment process with Jenkins, and can be installed on Linux, Windows and IBM i.

The DROPS Server conforms to your company's security policies, authentication and delegationmechanisms and to your method(s) of assigning Roles. It delegates process execution to the DROPS Agentwhich actually performs the action(s) requested on your target machine(s) while respecting the projectarchitecture you describe.

The size limit of the DROPS Server depends solely on the size of your system's hard drive or the spaceavailable on the system.

The DROPS Studio, the DROPS Web Console and client APIs connect directly to the DROPS Server via http(s). The DROPS Server connects to the V2DROPS Agent via TCP/IP and to the V3 DROPS Agent via http(s). These connections enable you to execute any or all of the various import and deployment functionsDROPS offers.

ReferenceFor more information about installing the DROPS Server, refer to theDROPS Installation Guide.

For more information about configuring the DROPS Server, refer to theDROPS Configuration Guide.

1.2 About the DROPS Studio

Design your Deployment Processes

Created for Administrators, ReleaseManagers, Deployment Process Designers, Deployment Operatorsand anyone else included in DevOps, the DROPS Studio simplifies the configuration and execution of theImport and Deployment Processes involved in application deployment, all from a single, powerful yet easy-to-learn Eclipse RCP.

The DROPS Studio breaks the deployment process up into three phases: configuration, import anddeployment. Roles and tasks are carefully defined for each phase and the powerful scheduler can automateyour validated processes.

For reporting, the DROPS Studio relies on the supplementary DROPS Web Server.

ReferenceFor more information about installing the DROPS Studio, refer to theDROPS Installation Guide.

For more information about configuring the DROPS Studio, refer to theDROPS Configuration Guide.

1.3 About the DROPS Agent

Connect to your target system(s)




DROPS is multi-platform by design which means it enables you to deploy content to any environment thatcan host a JRE. The DROPS Agent is a module that must be installed on every target system to which youintend to deploy. It contains and relies on the ANT engine which actively contributes to themechanicalorchestration of the DROPS solution. It includes a library with over 300 built-in scripts which can beexpanded with your own personalized scripts. The DROPS Agent is the tool that the DROPS Server uses tocommunicate with your target system.

The DROPS Server can connect to the V2Agent on your target machine via a TCP/IP SSL connection or tothe V3 Agent via http(s). Each type of connection is defined in the Infrastructure Item associated with eachAgent. During deployment, the Agent receives instructions from the DROPS Server and executes them onthe target system.

The DROPS Agent can be remotely or manually installed and uninstalled.

ReferenceFor more information about installing the DROPS Agent, refer to theDROPS Installation Guide.

1.4 About the DROPS Web Server

Generate Reports and deploy via the web

The DROPS Web Server is aWeb Application Container (Jetty), which is a J2EE Application Server. Bydefault, it grants access to the DROPS Web Console and to the DROPS reports.

ReferenceFor more information about installing the DROPS Web Server, refer to theDROPS Installation Guide.

1.5 About the DROPS Web Console

Execute your deployments via the web

The DROPS Web Console is a web application that runs on the DROPS Web Server by default but can alsobe installed manually on anyWeb Application Container. It is an RIA intended specifically for DeploymentOperators which makes executing Deployment Processes easy. Operators can schedule sequential tasksand execute simultaneously or according to personalized procedures. Depending on the context, a Releasecan be deployed individually, or in groups by creating cumulative Releases. At any time and in real-time, anoperator can execute and monitor an execution process as well as view deployment progress or history byusing any internet browser.

To access the DROPS Web Server enter the following address in your browser:

<web_server_address>:<web_server_port>/drops

The DROPS Web Console is accessible from anywhere, from any web browser.




NoteThe DROPS Web Console does not include access to the ConfigurationManagement perspective. It only enables you to perform the actionsavailable in the Operational Console Management perspective.

ReferenceFor more information about installing the DROPS Web Console, refer totheDROPS Installation Guide.

1.6 About DROPS for ARCAD

DROPS for ARCAD is a DROPS extension used to import and deploy Artifacts that either come from or areintended to be deployed to an ARCAD v10 server.

There are very few differences between using DROPS and DROPS for ARCAD. This extension is accessed invarious steps of the Import and Deployment Processes. The ARCAD-specific options must be definedconsistently when importing from or deploying to an ARCAD Server.

l When defining an Import Strategy, select theARCAD Strategy type (see Import Strategy TypeConfiguration on page 255).

l When defining an Infrastructure Item, select theARCAD Server type, which requires specificextended configuration (see Infrastructure Item Type Extended Configuration on page 274).

l When creating a Deployment Process, ARCAD-specific scripts are available to execute ARCAD macro-commands and ARCAD commands (see Building Deployment Process Diagrams on page 136 andWorking with scripts on page 121).

1.7 About DROPS for z/OS

DROPS for z/OS is a DROPS extension used to import and deploy Artifacts that either come from or areintended to be deployed to an IBM z/OS server. This extension works with the product SYSchange,provided by Pristine Software, which is required.

There are very few differences between using DROPS and DROPS for z/OS. This extension is accessed invarious steps of the Import and Deployment Processes and the z/OS-specific options must be definedconsistently when importing from or deploying to a z/OS Server.

l When defining an Initial Import Strategy, select the IBM z/OS Initial Import type (refer to The IBMz/OS Import Strategy on page 270 in the appendix).

l When defining an Import Strategy, select the IBM z/OS Import type (refer to The IBM z/OS InitialImport Strategy on page 271 in the appendix).

l When defining an Infrastructure Item, select the IBM z/OS type, which requires specific extendedconfiguration (refer to Infrastructure Item Type Extended Configuration on page 274 in the appendix).

l When creating a Deployment Process, use the set of dedicated scripts provided that enable z/OScommands (refer to Building Deployment Process Diagrams on page 136 and Working with scripts onpage 121).




ReferenceFor more information about SYSchange and how to use DROPS for z/OS,refer to DROPS for z/OS in the appendix.



DROPS v2.8.12 The simplified concepts | User Guide

2 The simplified concepts

Amulti-platform system automating continuous application deployment

ReferenceRefer to the Glossary on page 298 for complete definitions of the termsbelow.

DROPS is intended to help you set up and automate the Deployment Process. To do this, DROPS usesdedicated repositories secured in the DROPS Server to organize your file structure and shape and storeyour Releases.

Releases to deploy to target Environments contain Artifacts from the Artifact Repository. A Release iscreated each time a pre-defined Import Strategy is launched and Artifacts from your source location arecopied to the Artifact Repository. The repository stores Artifacts using the following structure:Application/Component/Artifact.

Once the import is complete, the Release is available to be deployed. Define Infrastructure Items tostructure your deployment Environment and connect to your target machine(s). Deploying to multiplemachines is made easy by grouping Infrastructure Items in Environments and organizing Environments byClient.

The Deployment Process is organized using a completely customizable Deployment Process Diagramsupplemented with the Actions necessary for your deployment, all driven by ANT scripts. Applications andtheir Components are partnered with Environments and their individual Infrastructure Items in theDeployment Process Diagram in order to make sure the correct content is always making it to its intendeddestination(s).

Scheduling imports and deployments makes it easy to create completely autonomous processes.



DROPS v2.8.1User Guide | 2 The simplified concepts

Checks and balances are taken care of in DROPS via Validation Requests and Suspended Actions whichautomatically pause processes if authorization is required or an error occurs.

DROPS enables you to track deployment stages in real time. In addition to providing full deployment logs,it keeps a history of all actions, executions, and transition times.

The option to roll back is always available. Before deployment, Actions automatically register a copy of theexisting Release on your target machine(s) and the Infrastructure Item backs it up to a rollback directory.

Certain functions are common to all DROPS processes. Actors are defined for each configuration, togetherwith their Role(s) in the approval process. Your company's processes, Roles and access rights, approval andvalidation requirements, scheduling, and reporting are all taken into account and can bemanaged insideDROPS.

Following the Deployment Process, DROPS is able to manage the installation of delivered software.



DROPS v2.8.13 Overview of the DROPS Studio | User Guide

3 Overview of the DROPS Studio

DROPS is an independent Eclipse studio. There are two perspectives dedicated to DROPS that contain allthe features available in the tool. Each is intended for different types of users.

A perspective defines the initial set and layout of views in the workbench window. Within the window, eachperspective shares the same set of editors. Each perspective provides a set of capabilities aimed ataccomplishing a specific type of task or working with specific types of resources. For example, the JavaTMperspective combines views that you would commonly use while editing Java source files, while the Debugperspective contains views that you would use while debugging a program. Perspectives contain views andeditors and control what appears in certain menus and tool bars.

Views in DROPS are context sensitive. To see a view that is not currently active, open it by accessing theShow View dialog (Window > Show view > Other) and selecting the view. Re-position views by draggingand dropping them to the desired location in the studio. Click an edge and drag to re-size a view. Double-click on any view's toolbar to maximize it. This is helpful when a view contains a lot of information;maximizing the viewmakes it fill the entire window. Double-click again to minimize the view.

To re-set the perspective to the default layout, clickWindow > Reset Perspective.

The Configuration Management perspectiveThis perspective is intended for ReleaseManagers and both Import and Deployment Process Designersbecause it provides access to all of the actions necessary to organize Artifacts, to construct themanyentities required for the Import and Deployment Processes. Additionally, Reports are generated and entity-level configuration is managed inside this perspective.

NoteThe DROPS Web Console does not include access to the ConfigurationManagement perspective. It only enables you to perform the actionsavailable in the Operational Console Management perspective.

ReferenceFor more information about this perspective, refer to the Introduction toUser Administration on page 37, Introduction to configuring the ImportProcess on page 47, Introduction to configuring the Deployment Processon page 80 and the Introduction to DROPS Reports on page 228.

The Operational Console Management perspectiveThis perspective is intended for ReleaseManagers and both Import and Deployment Operators because itprovides access to all of the actions necessary to design, schedule, launch and monitor Import and Deploy-ment Processes.

ReferenceFor more information about this perspective, refer to the Introduction toimporting Artifacts on page 167 and the Introduction to deploying Releaseson page 182.



DROPS v2.8.1User Guide | 4 Functional constraints

4 Functional constraints

4.1 Unattended actions

Like all ReleaseManagement software, DROPS cannot complete operations that contain manualmanipulations necessarily carried out in a GUI or front-end terminal.

Examplel entering content in mandatory fields that have no default value;l clicking buttons in an installation wizard.

However, DROPS provides solutions if your process contains manual actions in order to automate themajority of your Deployment Process seamlessly.



Getting Started

DROPS v2.8.1User Guide | 5 Managing the DROPS Server connection

5 Managing the DROPS Server connection

Required Roles n/a

Required Rights(by category) Server Administration

Perspective Configuration Management and/or Operational ConsoleManagement

Access Connections

In order to use and manage the DROPS Server and access DROPS functions, a connection must beestablished between it and the DROPS Studio. Connections must be defined in both of the perspectivesavailable in the DROPS Studio and in the DROPS Web Console.

Define a connection by first adding a DROPS Server to the DROPS Studio then connecting to it using thelogin credentials specific to it.

To access the DROPS Server options, right-click on it.

Figure 3: Accessing the DROPS Server options

5.1 Adding a DROPS Server

Follow the subsequent steps to define a server.

Step 1 Add a new connection.

Right-click on Connections and select Add a new connection.

Step 2 Define the server connection.

1. Enter a unique name for the server connection in the Connection field.2. Enter the specific URL and port for the server in theURL field.

The port for the server is defined during the server installation process.

3. Click Finish to close the window and activate the connection or clickNext.



DROPS v2.8.15 Managing the DROPS Server connection | User Guide

4. If you clicked next, define the proxy parameters necessary to connect to the server.5. Click Finish to close the window and activate the connection.

Result The server is defined and can bemanaged and edited.

Step 3 Connect to the server.

1. Right-click on the new server, then select Connect.2. Enter the following user name/password to access the server for the first time:

admin/quadra.

Result The server connection is established. It is suggested to log in with the admin account to configurethe server.

5.2 Connecting to a server

To connect to a DROPS Server, right-click on it in the Connections list then select Connect. TheDROPS splash screen displays the user and password fields required to connect. Each DROPS user has hisown login/password.

5.3 Configuring a server’s preferences

To configure a server’s preferences, right-click on it in the Connections list then select Preferences.

ReferenceFor more information about configuring the DROPS Server, refer to theDROPS Configuration Guide.

5.4 Configuring a server

To configure a DROPS Server, right-click on it in the Connections list then select Configure....

ReferenceFor more information about configuring the DROPS Server, refer to theDROPS Configuration Guide.

5.5 Viewing a server’s log

To view a server’s log, right-click on it in the Connections list then select Log file. The log opens in anexternal text editor.



DROPS v2.8.1User Guide | 5 Managing the DROPS Server connection

5.6 Verifying a server’s version

To verify the version of a DROPS Server, right-click on it in the Connections list then selectVersion.... A small dialog displays the selected server’s version.

5.7 Deleting a server connection

To delete a connection to a DROPS Server, right-click on it in the Connections list then selectDelete.

Deleting a server connection does not permanently affect the DROPS Server or the DROPS Studio. Youcan reconnect to any server by following the steps outlined above.



DROPS v2.8.16 Changing your password | User Guide

6 Changing your password

Required Roles n/a

Required Rights(by category) Server Administration

Perspective Configuration Management and/or Operational ConsoleManagement

Access Connections→ right click on the DROPS Server

To change your user’s password, right-click on the active DROPS Server and select Preferences.

Open the Current User Information node in the Preferences menu and select Change Password.

Figure 4: Change your password (Preferences menu)

ClickApply to push the changes live without closing the Preferences menu.

ReferenceFor more information about users, refer to Working with User Accounts onpage 38.



User Administration

DROPS v2.8.1Introduction to User Administration | User Guide

Introduction to User AdministrationDROPS administrators are in charge of managing Users, Roles and rights. It is important to define yourteam's Users and associate the correct Roles and rights with each one because the individuals who useDROPS at different stages in the Deployment Process must have accurate authority levels in order toaccess and, in some cases, create and/or edit the various processes.

User information is stored locally in DROPS and the login credentials for each User aremanaged by anadministrator or any User with the corresponding rights. Any User can change his or her own password (seeChanging your password on page 35).

This section covers all of an administrator's tasks associated with:

l Users (seeWorking with User Accounts on page 38),

l Roles (see Assigning entity-level Roles on page 43),

l Profiles (see Accessing your profile and rights on page 45).



DROPS v2.8.1User Guide | 7 Working with User Accounts

7 Working with User Accounts

Required Roles n/a

Required Rights(by category) User Management

Perspective Configuration Management

Access DROPS Server→ Configuration→ ( Client→ ) Users

Chapter Summary7.1 Searching for Users 387.2 Creating Users 397.3 Editing a User's ID 407.4 Assigning profiles to Users 417.5 Deleting Users 42

User Accounts are what define the access rights for your team. Each account is associated with one emailaddress and has a unique login. Users are assigned Roles for the Import and Deployment Processes andgiven rights to access certain functions.

7.1 Searching for Users

Follow the subsequent steps to search for a User in order to view or manage their account.

Step 1 Select Users from the Configuration node in the Configuration Explorer.

If you are in multi-client mode, select the Client first.

ReferenceFor more information about managing multiple clients, refer toWorking with multiple Clients on page 82.

Figure 5: The Users search view

Step 2 When the search view is opened, the list of Users is empty. Use the search criteria sections to filter



DROPS v2.8.17 Working with User Accounts | User Guide

the search.

l To search for Users by Title,Name or Email address, enter all or part of it in thecorresponding field.

Enter any combination of the above search criteria, then click the Search button to display theresults. To display the complete list, click the Search button without entering any search criteria.

To display all of the items by default each time the search view is opened, select the AutoSearch icon.

Result The Users search view displays all of the Users defined for the current server (and for theselected Client, if applicable) that meet the search criteria.

7.2 Creating Users

User information can either be stored and completely managed in the DROPS Server, or imported from anexternal LDAP which manages login credentials.

7.2.1 Create new users in the DROPS StudioFollow the subsequent steps to create a newUser.

Step 1 To access the Create a new Userwizard, either click the Create icon in the Users searchview or right-click anywhere in the view and select Create a new User.

Step 2 Complete at least one of the fields in order to create the account.

Step 3 Click Finish.

Result The new account is created and the User editor opens automatically.

Important!It is important to continue editing the newUser's information rightaway to complete the user configuration and assign a login andpassword.

7.2.2 Import new users from an external LDAP (Active Directory)

NoteTo import users from an external LDAP a connection to the LDAP must bedefined and the user attributes mapped.

ReferenceFor more information about configuring the LDAP settings, refer to theDROPS Configuration Guide.

A REST web-service is used to import users from an external LDAP, likeWindows Active Directory.




Connect to the following URL and use the POST method to import each user from the LDAP individually:

http://dropsserver:<port>/admin/ldap/import/<user_to_import>

The <user_to_import> valuemust be replaced by each user to import before themethod is run. It is thisvalue that must match an object with the LDAP Login Attribute.

Le REST web-service is protected by an BASIC authentication and intended for admin-level users.

7.3 Editing a User's ID

To view or edit a User's information, connection details or profile(s), either right-click on the User thenselect Edit, select the User then click the Edit icon or double-click. The User editor is openedwhere all of its details aremanaged.

Important!If users were imported via LDAP (Active Directory), their details are notmanaged in DROPS. There is nothing to configure or edit for importedusers

Figure 6: The User editor

Edit the details displayed in the Personal Information tab of theUser editor by making changes in thefields necessary.

Changing the User's ID (display name and the email address DROPS uses when sending automatic emails)are simple edits.

Save the changes (Ctrl+S or File > Save).

7.3.1 Define a User's login credentialsIf Users are stored in the internal database, and not an external LDAP, their DROPS log-in credentials mustbe defined.



DROPS v2.8.17 Working with User Accounts | User Guide

Important!If users were imported via LDAP (Active Directory), their login andpassword are not managed in DROPS.

Select Application stored login from the Login storage drop-down list, then complete the necessaryfields.

Field Description

Login

The User name to enter when accessing DROPS.

NoteSpaces cannot be used in user names.

Passwordvalidity

Select the date the User's login password will expire. If the password should never expire,leave this field blank.

Password

Either enter a password for the User or click the Random Password button to generatea random password. A confirmation window displays the random password generated bythe system.

Important!It is important to write down what it is before clicking Yesbecause after you accept a random password there is noway to recover it.

Any user can change his password after they access theiraccount.

NoteThe password field is encrypted. It will always display 6bullets, no matter what the length of the real password is.

Confirmation Re-enter the password chosen. The confirmation is automatically filled in for randompasswords.

LockedIf this checkbox is ticked, the User cannot access DROPS. A User’s account is lockedautomatically if the User tries to access DROPS too many times using the incorrectpassword. The administrator can lock accounts manually by ticking the checkbox.

Table 4: Edit user login credentials


7.4 Assigning profiles to Users

At least one profile is required for every User because they grant the rights required to manipulate entitiesor items. If a User has no profile, they have no rights to access, create or edit anything.

Select the Profiles tab of the User editor to view and manage the User's profile(s).




To assign a profile to a User, click the Add button and select the profile from the list, then clickOK. Thelist of profiles is prepopulated with the profiles created in the Preferences menu.

To remove a User's profile, select it then click Delete.

ReferenceFor more information about profiles, refer to Accessing your profile andrights on page 45.

For more information about creating profiles and managing the rights foreach one, refer to theDROPS Configuration Guide.

7.4.1 View the rights granted to profile(s)Follow the subsequent steps to view the rights granted to a profile.

Step 1 Open the Preferencesmenu (right-click on the current DROPS Server→ Preferences).

Step 2 Click Profiles to view the rights granted to a specific profile.

Step 3 Select the profile from the list and click Rights.

7.5 Deleting Users

Warning!Deleted Users cannot be accessed or recovered. If a deleted User was givena Role, the Role is no longer linked to that account.

To delete a User, search for it in the Users search view. Either right-click on it and select Delete orselect it and click the Delete icon. ClickOK to confirm or click Cancel to keep the User.



DROPS v2.8.18 Assigning entity-level Roles | User Guide

8 Assigning entity-level Roles

Required Roles The User must have the Administrator Role for the related entity or for all instances ofthat entity type (global-level user admin)



Access

DROPS Server→ Artifacts→ Applications DROPS Server→ Artifacts→ Apps→ ( App)→ Releases DROPS Server→ Configuration (→ Client)→ Infra. Items DROPS Server→ Configuration (→ Client)→ Environments DROPS Server→ Configuration (→ Client)→ Envmnt Groups

Assigning Users Roles enables an administrator to manage who is authorized to execute certain proceduresduring the Import or Deployment Process or who can assign or carry out a task.

DROPS Users are assigned Roles on the entity-and global-level. Assigning Roles to users at the entity-levelis done by the administrator or the User who already has the admin Role for that entity.

ReferenceFor more information about the different Roles available for each entity,refer to Roles in the appendix.

For more information about assigning Roles at the global-level, refer to theDROPS Configuration Guide.

The Application, Release, Infrastructure Item, Environment and Environment Groupeditors each contain a Roles tab.

Figure 7: Assigning Entity-Level Roles

Follow the subsequent steps to assign a User to a Role at the entity-level.



DROPS v2.8.1User Guide | 8 Assigning entity-level Roles

Step 1 In the entity's Rolesmanager, select a Role from the drop-down list.

Step 2 Click the Add button to display theUser Selection dialog. This dialog is prepopulated with all ofthe Users defined for the current Client.

Step 3 Select the User's name from the list, then clickOK.

Result The User is assigned the Role.


8.1 Removing assigned Roles

Follow the subsequent steps to remove a User from his assigned Role at the entity-level. Roles can bereassigned if necessary.

Step 1 In the entity's Roles manager, select the Role the User is currently assigned from the drop-down list.

Step 2 Select the User's name from the list, then click Remove.

Result The User no longer appears in the list for that Role and is no longer associated with it at the entity-level.




DROPS v2.8.19 Accessing your profile and rights | User Guide

9 Accessing your profile and rights

Required Roles n/a


Perspective Preferencesmenu

Access right-click on the DROPS Server→ Preferences

Rights grant Users the possibility to create, view and modify entities. Profiles are defined and grantedrights by the administrator in the Preferences menu.

If you do not have the rights to access a certain DROPS entity, when you try to, an error message displaysinforming you that you are not allowed to use that feature.

ReferenceFor more information about granting rights to user profiles, refer to theDROPS Configuration Guide or contact your administrator.

For more information about assigning profiles to Users, refer to Workingwith User Accounts on page 38.

If you have the rights to access theUsers view, you can see which profile(s) your User is assigned in theUser editor.

If you cannot access theUser editor, you can still view the list of your User's current rights in thePreferences menu. Click Current User Information to view all of the rights granted to your currentUser.

Figure 8: Current User Information (Preferences menu)



Configuring theImport Process

DROPS v2.8.1Introduction to configuring the Import Process | User Guide

Introduction to configuring the Import ProcessDROPSmakes it easy to import and organize heterogeneous applications developed on different platformsand technologies to prepare them for deployment. For this, it uses amulti-platform Artifact Repository,structured by Application and Component, and loaded by Import Strategy. These entities, and more, mustbe configured in able to import the up-to-date Releases which feed Deployment Processes.

The configuration described in this section covers process-level configuration completed using theConfiguration Management perspective (see Overview of the DROPS Studio on page 29).

NoteMost of the high-level configuration necessary in the DROPS Studio mustbe performed by a DROPS admin who has the right(s) to configure globaloperations.

ReferenceFor more information about high-level configuration, refer to theDROPSConfiguration Guide.

About the Configuration Explorer - Artifact Repository

Figure 9: The Configuration Management perspective - Artifact Repository

The Configuration Explorer provides access to the Artifact Repository. This perspective is theconfiguration side of DROPS.

The Artifact Repository refers to the content managed from the Artifacts node under the currentlyconnected DROPS Server. All of the Applications defined for that server are configured, managed andaccessed from the Applications node. Each Application is displayed using its code and (name). Double-clicking a node opens theApplication editor where the following Application-level configuration entitiesaremanaged:

l Applications (seeWorking with Applications on page 49). Under each Application node is the entrypoint to:



DROPS v2.8.1User Guide | Introduction to configuring the Import Process

o the Artifacts it contains (seeWorking with imported Artifacts on page 76),o the associated Releases created after importing Artifacts (seeWorking with Releases onpage 70).

l Components (seeWorking with Components on page 56),

l Import Strategies (seeWorking with Import Strategies on page 60).

To update the content of any menu list, right-click then select Refresh.



DROPS v2.8.110 Working with Applications | User Guide

10 Working with Applications

Required Roles Application Administrator and/or Repository Manager

Required Rights(by category) Applications


Access DROPS Server→ Artifacts→ Applications

Chapter Summary10.1 Accessing Applications 4910.2 Creating Applications 5010.3 Editing Application details 5010.4 Deleting Applications 55

Applications are the entities that contain the imported Artifacts you intend to deploy. They are the highestlevel container in the Artifact Repository and house Components, which contain individual Artifacts. Eachversion of an Artifact is contained in a Release.

The ideal way to manage an Application is to insure it contains all of the pieces necessary to complete theset of content you will deploy, no matter what their type, source location or target destination is.

ExampleYou are deploying a software product that uses a web-based interface toconnect to a server. In order to function correctly, your Application mightcontain HTML files, the .css style sheet and all of the files required to installand launch the server. Even if these elements were created on differentmachines or if they must be deployed to different machines, they shouldbe contained in the same Application.

10.1 Accessing Applications

All of the Applications defined for the current server are nested under the parent Applications node inthe Configuration Explorer. They are listed, from top to bottom, in the order in which they werecreated.



DROPS v2.8.1User Guide | 10 Working with Applications

Figure 10: Accessing Applications

10.2 Creating Applications

Follow the subsequent steps to create a newApplication.

Step 1 Right-click the Applications node in the Configuration Explorer, then select Create anew Application.

Step 2 Define the two mandatory properties: the App. Code and App. Name. These values can be editedlater.

Important!Two Applications cannot have the same ID. Every application’sCodemust be unique.


Result NewApplications are nested under the Applications node.

10.3 Editing Application details

To edit an Application’s details, either right-click on the Application then select Edit, or double-clickon it. The Application editor is opened where all of the entity's details aremanaged.




Figure 11: The Application editor

The information that defines Applications can be edited at any time by Users with the rights to do so.

ReferenceFor more information about the different actions managed from the tabsin the Application editor that are not described in this chapter, refer to:

l Working with Components on page 56

l Properties on page 239

l Assigning entity-level Roles on page 43

Field Description

App. Code A unique string that identifies Applications. This label is used throughout DROPS to selectthe entity.

App.Name

A string used to give additional information about the Application. This label is usedthroughout DROPS to select the entity.

PackagingType

This value is used by the Deployment Processes when the Package Type field is set to FromApplication.

Set the default packaging type at the Application-level to assure that every time theApplication is delivered by a Deployment Process, the packaging will be consistent. However,this default value can be overridden by choosing another value in the Package Type fieldwhen defining the Deployment Process (see Edit global Deployment Process properties onpage 148).

[default] Unitary packaging deploys only the Release selected.Table 5: Edit Applications




Field Description

Cumulative packaging deploys the selected Release and all of the preceding Releases thathave been imported into DROPS but have not yet been deployed to the target Environment.A cumulative Packaging Type deploys only themost recent Artifacts in each Release. Thisensures that all of themost up-to-date Artifacts are deployed and that the deployedApplication is accurately updated.

ExampleYou have imported 4 versions of your Release but onlydeployed the first version to the target Environment. The 4thRelease contains the same version of all the Artifacts that the3rd Release contains, except for one file. Now, you select the4th Release to deploy and choose a cumulative PackagingType. Result: The 2nd, 3rd and 4th Releases will all bedeployed in order, finishing with themost current version ofevery Artifact and Release. The Artifacts from the 3rd Releaseare all current except the one, which is deployed with the 4thRelease.

CurrentRelease

Select the Release that should be considered current for the Application. If "Current Release"is selected during the Import Process, the Release defined in this field will be updated withrefreshed Artifacts. Instead of creating a newRelease with the new versions of the Artifacts,DROPS replaces the old versions in the Current Release with the new versions.

The current Release will also be used automatically if an external file management systemcalls DROPS and uses the current Release to import its deliverable(s).

Important!The Current Release field is not automatically populatedwith themost recently imported Release.

Click the Browse button to open theRelease Selection dialog, which is prepopulated withthe Releases that have already been imported for the current Application.

ReferenceFor more information about the Import Process, refer toIntroduction to importing Artifacts on page 167.

For more information about managing Releases, refer toWorking with Releases on page 70.

DefaultImportedVersionfile name

Predefine which version of an Artifact to import. This option can also be defined in theArtifact Import wizard's Component Filter page by listing all of the versions from thepotentially many external applications.

Alternatively, you can create a properties file that connects the desired version from theexternal system to the appropriate Component and Strategy in DROPS. This properties filemust be stored on the same system that the DROPS Server is installed on.

Table 5: Edit Applications




Field Description

Important!You can use variables, however the syntax in this propertiesfilemust follow this standard: component code.strategycode=external version.

ExampleIf version V1.10.00 should be used for a Component with thecode "Commands" and the Strategy with a code "import", thesyntax for one line of the properties file must beCommands.import=V1.10.00.

Enter the full path to the defined properties file in this field. The External file name field intheArtifact Import wizard will be automatically populated with this path.

ReferenceFor more information about theArtifact Import wizard,refer to Importing Artifacts immediately by Application onpage 170.

ReleaseNumberTemplate

Releases are organized by number. This version number is set by default when the Release iscreated during the Import Process and is based on a predefined template that can includefixed text and/or variables. When a Release is created multiple times, the version numberincreases corresponding to the variables defined in its Application. The User defines whichpart of the version to increment for each import in order to conformwith the increasingRelease versions according to the Automatic Release Number Generation Algorithm.

The default value for this field is defined in the Preferences menu (refer to theDROPSConfiguration Guide).

To manually override the global default value and create a new default value for thisApplication, edit the field to include any combination of fixed text and/or the versionvariables available.

l ${major}

l ${minor}

l ${build}

l ${revision}

l ${qualifier}

Important!The hierarchy of these variables is always in this order:major > minor > build > revision. Be sure to keep this inmind when entering the order of the variables in yourtemplate.

The Automatic Release Number Generation Algorithm is an intelligent counter that increasesTable 5: Edit Applications




Field Description

the version number of each Release by one automatically according to the element selectedto increase. When a newRelease is imported the algorithm follows these rules:

1. IF ${major} variable is used and IF the selected element to increment isMajor:l Increment the value in the Current Major Item field of the related Application.l Use the new value as the replacement value.l Reset all values lower than major to 0.

2. IF ${minor} variable is used and IF the selected element to increment isMINOR:l Increment value in the Current Minor Item field of the related Application.l Use the new value as the replacement value.l Reset all values lower than minor to 0.

3. IF ${build} variable is used and IF the selected element to increment is BUILD:l Increment the value in the Current Build Item field of the related Application.l Use the new value as the replacement value.l Reset all values lower than build to 0.

4. IF ${revision} variable is used and IF the selected element to increment is REVISION:l Increment the value in the Current Revision Item field of the related Application.l Use the new value as the replacement value.

5. IF ${qualifier} substitution variable is used:l IF theQualifier field in the related Application is empty, assign ${timestamp}.

o Replace ${timestamp} variable with the current date and time.o Use the new value as the replacement value

l IF theQualifier field in the related Application contains content, use that content.

Qualifier

The value entered here replaces the ${qualifier} variable when a newRelease is created. Youmight use it as a suffix or a prefix for your version number.

If theQualifier field is left blank, the ${qualifier} variable will be automatically replaced bythe special tag ${timestamp}. The timestamp variable represents the current date and time.

If you enter a value into theQualifier field, the timestamp variable will not be included in theRelease version unless you include it manually in theQualifier field.

ExampleVersion-${timestamp}_

CurrentMajor,Minor,Build andRevisionsItems

The values entered in these fields replace the ${major}, ${minor}, ${build} and ${revision}variables when a newRelease is created.

The values are automatically updated when a newRelease is imported and the versionnumber is increased. However, these fields can be updated manually to control the nextgeneration of your Release Package. Only whole numbers can be entered in these fields.

Table 5: Edit Applications





10.4 Deleting Applications

Warning!Deleted Applications cannot be accessed or recovered. Any associatedComponents are also deleted.

To delete an Application, right-click its node in the Applications menu, then select Delete. ClickOK to confirm or click Cancel to keep the Application.



DROPS v2.8.1User Guide | 11 Working with Components

11 Working with Components

Required Roles n/a



Access DROPS Server→ Artifacts→ Applications→ Application editor→Components tab

Chapter Summary11.1 Accessing Components 5611.2 Creating Components 5711.3 Editing Component details 5711.4 Deleting Components 59

Components are unique, functional subdivisions of Applications used to structure Releases created whenArtifacts are imported into the Artifact Repository. Components should group an Application's Artifacts bythe intended deployment target because every Artifact in a Component will be deployed to the sameInfrastructure Item.

A Component can only belong to one Application but an Application can havemany Components. They areused to manage Import Strategies and are the parent entity for imported Artifacts in the ArtifactRepository's hierarchy. Artifacts that belong to a Component can come from different sources whichmeans that a Component can contain multiple Import Strategies, which each provide DROPS access to theArtifacts to import.

During the Deployment Process, the contents of Components (Artifacts) are deployed to target systemsfollowing the same directory structure defined in the Artifact Repository. The structure inside theComponent node is defined in each Import Strategy.

ExampleYour Application is a software product that uses a web-based interface toconnect to a server. Both the website and the server are required for theApplication to work correctly. The server is located in NewYork but thewebsite's source HTML files and the .css style sheet must be hosted inParis. The Application should contain two Components - one for eachdestination.

11.1 Accessing Components

Components are defined and accessed in Applications. To access the list of Components defined for anApplication, select the Application from the Applications node in the Configuration Explorer andrefer to the Components tab.

This tab displays all of the Components defined for the current Application.



DROPS v2.8.111 Working with Components | User Guide

Figure 12: The Application editor - Components

11.2 Creating Components

Follow the subsequent steps to create a newComponent.

Step 1 Open the Application for which you want to create a newComponent.

Step 2 Click the New button in the Components tab of an Application to open the Create a newComponent wizard.

Step 3 Define the two mandatory properties: the Component Code and Component Name. These valuescan be edited later.

Step 4 Select a pre-defined Component Type from the Component Type drop-down list. This element isnot mandatory but may help to organize Components.

ReferenceFor more information about entity types, refer to Entity types inthe appendix.


Result NewComponents are displayed in the Components manager.

11.3 Editing Component details

To view or edit a Component, double-click it or select it then click Edit to open the Componentseditor.



DROPS v2.8.1User Guide | 11 Working with Components

Figure 13: The Component editor

The information that defines Components can be edited at any time by Users with the rights to do so.

ReferenceFor more information about the different actions managed from the tabsin the Components editor that are not described in this chapter, referto:

l Working with Import Strategies on page 60.

Field Description

ComponentCode

A unique string that identifies Components. This label is used throughout DROPS to selectthe entity.

An Application cannot contain multiple Components with the same code. This means thatall of the Components in one Application must have unique codes, but that two differentApplications can contain two different Components even if they both use the same code.

ComponentName

A label used to give additional information about the Component. This label is usedthroughout DROPS to select the entity.

ComponentType

A value used to assign a type to the Component. This drop-down list is prepopulated withComponent Types defined by the administrator in the Preferencesmenu.

ReferenceFor more information about entity types, refer to Entitytypes in the appendix.

Table 6: Edit Components



DROPS v2.8.111 Working with Components | User Guide


11.4 Deleting Components

Warning!Deleted Components are no longer associated with their parent Applicationand cannot be accessed or recovered. Any associated Import Strategies arealso deleted.

To delete a Component, select the item in the Components tab of an Application, then click Delete.ClickOK to confirm or click Cancel to keep the Component.




DROPS v2.8.1User Guide | 12 Working with Import Strategies

12 Working with Import Strategies

Required Roles n/a



Access DROPS Server→ Artifacts→ Applications→ Application editor→Components editor→ Import Strategy manager

Chapter Summary12.1 Accessing Import Strategies 6112.2 Creating Import Strategies 6112.3 Editing Import Strategy details 6312.4 Deleting Import Strategies 66

The Artifact Repository is populated with Artifacts imported from external sources, sometimes calledartifact providers. Import Strategies are dedicated engines that communicate with one particular artifactprovider in order to find the defined Artifacts and import them, nested under the associated Component,into the Artifact Repository.

When defining Import Strategies, the link to the external source that points to the Artifacts to retrievecreates, by default, the directory structure to respect when storing the imported Artifacts. Strategies arecreated inside the Component editor so they are linked by default to that Component. The importedArtifacts are automatically stored under that Component in the Artifact Repository. DROPS ensures thateach Artifact is associated with the correct Application and Release via the Component.

An external artifact provider may be a simple file system or a complex SCM. Choosing the type of ImportStrategy to use depends solely on the kind of source fromwhich you are importing Artifacts. Only onesource type can be defined per Import Strategy but a Component can contain multiple strategies in orderto import Artifacts from different sources.

Import Strategies can be configured to recognize updated files in the defined paths and only import them,instead of the entire group of Artifacts available.

Strategies reach the Artifacts to import via the object's absolute path. The Artifacts in this Root Directoryare browsed after the import is launched to determine which to import or not.

Some Import Strategy parameters can be defined using properties.

ExampleThe two Components in your Application are to be deployed to twodifferent destinations (a server in NewYork and a website host in Paris).The server's installation files are all imported from the same location - thereis only one Import Strategy necessary for the NewYork ServerComponent. However, the website Component for Paris must containHTML files that your web designer created and sent to you via email andthe .css style sheet that your company hosts on a shared network. In orderto import all of these Artifacts from two different source locations, you will



DROPS v2.8.112 Working with Import Strategies | User Guide

need two different Import Strategies: one for each source location.

12.1 Accessing Import Strategies

Import Strategies are defined and accessed in Components. To access the list of Import Strategies for aComponent, select it from the Components tab in the Application editor and refer to the ImportStrategies section.

This tab displays all of the Strategies defined for the current Component.

Figure 14: The Component editor - Import Strategies

12.2 Creating Import Strategies

NoteThe order in which Import Strategies are created is the order in which theywill be carried out when the Import Process begins.

There are three ways to create Import Strategies:

1. Create a new Strategy using the Create a new Import Strategy wizard.2. Use or Copy from Strategy Templates to quickly create a Strategy with predefined parameters.

a. Using a templatemeans that whenever the template is changed, the changes will be carriedover to all of the Strategies that use it. There is a connection between the template and the new




Strategy which permanently inherits the template's parameters.

b. Copying from a template creates a copy of the template's parameters which can bemodified.There is no on-going connection between the template and the new Strategy.

Important!No matter how you create an Import Strategy, you must edit it once it iscreated to finish the configuration. However, how you configure a Strategydepends on which type of Strategy you create.

Refer to the instructions that correspond to the type of Strategy created tofinish the Import Strategy configuration.

12.2.1 Create a new StrategyFollow the subsequent steps to create a new Import Strategy.

Step 1 Open the Component for which you want to create a new Import Strategy.

Step 2 Click the Add button in a Component's Import Strategies manager to open the Create a newImport Strategy wizard.

Step 3 Define the Strategy Code, Strategy Name and the Root Directory. These values can be edited later.By default the Root Directory is set to *AUTO.

ClickNext > to continue.

Step 4 Select the Strategy Type to use.

Important!Take care when selecting the type to use based on the type ofsource your Artifacts are coming from.


Result New Import Strategies are displayed in the Import Strategiesmanager. It is important to edit theStrategy and finish the configuration before using it.

12.2.2 Use or Copy from Strategy TemplatesFollow the subsequent steps to create a new Import Strategy by either using or copying from a Template.

Step 1 Click the Use a Template or the Copy from a Template button in a Component's ImportStrategies manager. See above for more information about the differences between using andcopying from Strategy Templates.

Step 2 Select the Template from the Strategy Templates dialog.

The list of available Templates is prepopulated with the Templates created by Users who have therights to do so.





ReferenceFor more information about creating Strategy Templates, refer toWorking with Strategy Templates on page 67.

Step 3 ClickOK.

Result New Import Strategies are displayed in the Import Strategiesmanager. If a Strategy uses aTemplate, the name of the Template is displayed in the Template Name column to remind youthat it is linked to the Template. It is important to edit the Strategy and finish the configurationbefore using it.

12.3 Editing Import Strategy details

To view or edit an Import Strategy, double-click it or select it then click Edit to open the ImportStrategy editor. It is important to edit Import Strategies before using them in order to configure themcorrectly based on your artifact provider.

Figure 15: The Import Strategy editor

The information that defines Import Strategies can be edited at any time by Users with the rights to do so.

ReferenceFor more information about the different actions managed from the tabs




in the Import Strategy editor that are not described in this chapter,refer to:


TheMain Properties tab contains the details common to all of the different types of Import Strategies,however each type requires very specific configuration as well.

The Import Strategy's parent entities are displayed in the Parent Items section.

Field Description

StrategyCode

A unique string that identifies Import Strategies. This label is used throughout DROPS toselect the entity.

StrategyName

A label used to give additional information about the Import Strategy. This label is usedthroughout DROPS to select the entity.

RootDirectory

The directory path where retrieved Artifacts are temporarily stored before being importedinto the DROPS repository.

For all of the types of Import Strategies except the File System Strategy, the rootdirectory is used to temporarily store the Artifacts to be imported before DROPS actuallyimports them into the Artifact Repository. When the import is launched, DROPS:

1. [clears the root directory IF OPTION IS SELECTED];2. fills it with the appropriate Artifacts for temporary storage;3. communicates with the DROPS Server parameters to learn what directory structure

to use to store the Artifacts in the Artifact Repository;4. copies the Artifacts to the Artifact Repository;5. [clears the root directory IF OPTION IS SELECTED].

For the File System Strategy, the root directory must be the absolute root of all of theArtifacts to be imported using this Strategy. Only the path up to the artifacts' shared rootshould be entered in this field. When the import is launched, DROPS:

1. [clears the root directory IF OPTION IS SELECTED];2. analyzes this root path to find the Artifacts to import;3. communicates with the DROPS Server parameters to learn what directory structure

to use to store the Artifacts in the Artifact Repository;4. copies the Artifacts to the Artifact Repository;5. subtracts the exact path of theRoot Directory field from the absolute path of each

Artifact and appends the results to the Artifact Repository path;6. [clears the root directory IF OPTION IS SELECTED].

The path to the imported Artifact is no longer c://rootdirectory/../.artifact, but is now${root}/app${application}/cmp${component}/rls${release}/../.artifact (where ${root} is theRepository Storage Area defined in the DROPS Server parameters).

Table 7: Edit Import Strategies- Main properties




Field Description

Enter a path here or keep the default value (*AUTO) to point to the default path defined inthe high-level server configuration. By default, this path leads to a relative tmp path wherethe DROPS Server is installed.

Important!This pathmust be on the samemachine as theDROPS Server.

ReferenceFor more information about defining the temporary andfinal locations involved in the import process, refer to theDROPS Configuration Guide.

Clean RootDirectorybeforeexecution

If ticked, the content of the Root Directory will be cleaned before executing the import.This option is active by default for all strategies except the File System Import Strategy.

Warning!Be careful using this option as you may lose content youdid not intended to be cleaned! This is especially importantif you havemultiple strategies that point to the same RootDirectory.

Clean RootDirectoryafterexecution

If ticked, the content of the Root Directory will be cleaned after executing the import. Thisoption is active by default for all Import Strategies.

Warning!Be careful using this option as you may lose content youdid not intended to be cleaned! This is especially importantif you havemultiple strategies that point to the same RootDirectory.

InitializationStrategy

If ticked, the Import Strategy is only used when running an Initial Import.

ReferenceFor more information about Initial Imports, refer toImporting Artifacts immediately by Application onpage 170.

StrategyType

This drop-down list contains all the available strategy types provided by DROPS. Bydefault it is set to the type selected when the Import Strategy was created. Each type ofstrategy requires different extended configuration and it is essential that the typecorrespond to themethod you use to collect Artifacts to import.

Warning!If the extended configuration for an Import Strategy hasalready been defined, changing the type will delete all of





Field Description

the existing information.

To create a different type of Strategy and keep theinformation defined in the current one, create a newImport Strategy.

ReferenceFor more information about the extended configurationnecessary for each type of Import Strategy, refer toImport Strategy Type Configuration in the appendix.



12.4 Deleting Import Strategies

Warning!Deleted Import Strategies cannot be accessed or recovered.

To delete an Import Strategy, select the item from the Components editor then click Delete. ClickOK to confirm or click Cancel to keep the Strategy.



DROPS v2.8.113 Working with Strategy Templates | User Guide

13 Working with Strategy Templates

Required Roles n/a

Required Rights(by category) Strategy Templates


Access DROPS Server→ Configuration→ Strategy Templates

Chapter Summary13.1 Accessing Strategy Templates 6713.2 Creating Strategy Templates 6713.3 Editing Strategy Templates 6813.4 Deleting Strategy Templates 69

Users with the rights to do so can create Strategy Templates that can be selected and then modified inorder to save timewhile creating new Import Strategies. A Strategy Template can contain some or all of thedetails required to use the Import Strategy, including properties.

13.1 Accessing Strategy Templates

To access the Strategy Templates view, select Strategy Templates from the Configurationnode in the Configuration Explorer.

The Strategy Templates view displays all of the Strategy Templates defined for the current server.

Figure 16: The Strategy Templates view

13.2 Creating Strategy Templates

Follow the subsequent steps to create a new Strategy Template.

Step 1 To access the Create a new Strategy Template wizard, either click the Create icon in theStrategy Templates view or right-click anywhere in the view and select Create a new



DROPS v2.8.1User Guide | 13 Working with Strategy Templates

Strategy Template.

Step 2 Define the template's Code,Name and the Root Directory. These values can be edited later.


Step 3 Select the Strategy Type. The type of Strategy to use for a template cannot be changed.



Result NewStrategy Templates are available in the Strategy Templates view after refreshing thelist. It is recommended that you edit the Template’s details before using it.

ReferenceFor more information about using Strategy Templates, refer toUse or Copy from Strategy Templates on page 62.

13.3 Editing Strategy Templates

To edit Strategy Template details, either right-click on it then select Edit, select it then click the Editicon or double-click it.

Follow the instructions in Editing Import Strategy details to modify the details of a Strategy Template.

Important!Anymodifications made to Strategy Templates are automatically carriedover to ALL of the Import Strategies that use it but not to the Strategiesthat were copied from it.

Using properties in Strategy Templates can help you automate the Import Process by calling informationdefined in Applications, Components and Import Strategies.

The following properties/substitution variables can be called into the extended configuration of an ImportStrategy or a Strategy Template:

l any user-defined property in an Applicationl the ${activity.[activityID].component.code} substitution variablel any user-defined property in an Import Strategy

ExampleUsing the ${importStrategy.props.env} variable in a templateenables you to create an "env" property in the Strategy that uses thetemplate which will be called when the extended configuration is taken intoaccount.



DROPS v2.8.113 Working with Strategy Templates | User Guide

ReferenceFor more information about using properties, refer to Properties andSubstitution Variables in the appendix.

13.4 Deleting Strategy Templates

Warning!Deleted Strategy Templates cannot be accessed and does not appear in thelist of templates to use when creating a new Import Strategy.

If an active Import Strategy is linked to a Strategy Template and thetemplate is deleted, the link to the template is broken. The Strategy is thenindependent from any template but can still be used and still contains theinformation carried over from the original template.

To delete a Strategy Template, either right-click on it in the Strategy Templates view then selectDelete or select it, then click the Delete icon. ClickOK to confirm or click Cancel to keep the template.



DROPS v2.8.1User Guide | 14 Working with Releases

14 Working with Releases

Required Roles n/a

Required Rights(by category) Releases


Access DROPS Server→ Artifacts→ Applications→ Application→ Releases

Chapter Summary14.1 Searching for Releases 7014.2 Creating Releases 7114.3 Editing Release details 7214.4 Viewing Environments to which a Release has been deployed 7314.5 Making comments 7314.6 Viewing attachments 7314.7 Locking and unlocking Releases 7414.8 Viewing the Artifacts in Releases 7414.9 Purging the Artifacts imported by Releases 7414.10 Deleting Releases 75

Releases are consistent sets of Artifacts identified by a unique number and created when Artifacts areimported into the Artifact Repository. They are contained in Components.

During the Deployment Process, Releases are selected to deploy, not individual Artifacts. All of the Artifactsincluded in a Release are deployed at the same time, unless Release Sets are deployed. Sets of Releases areparsed to only include themost recent version of an Artifact, if the same artifact is included in multipleReleases. The Release with themost recent version of the Artifact will include it during deployment and theReleases with outdated versions of that Artifacts will not.

14.1 Searching for Releases

Follow the subsequent steps to search for Releases that have already been imported into an Application.

Step 1 Expand the Application into which the Release was imported.

Step 2 Double-click on the Releases node to open the Releases search view.



DROPS v2.8.114 Working with Releases | User Guide

Figure 17: The Releases search view

Step 3 When the search view is opened, the list of Releases is empty. Use the search criteria sections tofilter the search.

l To search for an existing Release by its Release Number or name, enter all or part of theinformation in the Identification section.

l To search for an existing Release by when it was created or the last time it was modified,select a date range in the Creation Date section.



Result The Releases search view displays all of the Releases that have been imported into the currentApplication that meet the search criteria.

TheRelease Number column displays each Release's official version number.

TheRelease Description column displays the notes made for the Release, if any.

TheOpened the column displays the date the Release was created.

The Status column displays the code for the Release's status, if defined.

The Locked column displays either a Locked or Unlocked icon.

14.2 Creating Releases

Releases are either created automatically during the Import Process or manually from the Releasessearch view.

ReferenceFor more information about the Import Process and howReleases arecreated automatically, refer to Importing Artifacts on page 166.

Follow the subsequent steps to create a newReleasemanually.




Step 1 To access the Create a new Release wizard, either click the Create icon in the Releasessearch view or right-click anywhere in the view and select Create a new Release.

Step 2 Define the Release Number, if applicable, and the Release Description. These values can be editedlater.

NoteVariables cannot be used.


Result The newRelease is available in the Releases search view and can be used to import Artifacts.

14.3 Editing Release details

To edit Release details, either right-click on it in the Releases search view then select Edit, select theitem then click the Edit icon or double-click it. The Release editor is opened where all of the entity'sdetails aremanaged.

Figure 18: The Release editor

The information that defines Releases can be edited at any time by Users with the rights to do so.

ReferenceFor more information about the different actions managed from the tabsin the Release editor that are not described in this chapter, refer to:






Field Description

Application A static field that displays the Release's parent Application.

ReleaseNumber

If a Release was created automatically, the Release Number is automatically populatedfollowing the template defined in the Release Number Template field in the parentApplication.

Change the value in this field to modify the Release Number.

ReleaseDescription

Manually enter a description for an existing Release to easily identify it in theRelease viewand the Deployment Process.

Status

Select a status for the Release that will enable users to easily recognize how or when to use itin the Import and Deployment Processes.

Closed Releases cannot be deployed.

The list is prepopulated with the statuses defined in the Preferences menu.

ReferenceFor more information about defining Release statuses, referto theDROPS Configuration Guide.

Table 8: Edit Releases

The Release Dates section displays the static dates that the Release was created and closed. These fieldscannot bemodified.

14.4 Viewing Environments to which a Release has been deployed

If a Release has been deployed, all of the target Environments to which it was delivered, and thecorresponding delivery dates, are displayed in the Receiver Environments tab in the Release editor.

14.5 Making comments

Use the Comment tab in the Release editor to enter any details that Users should be aware of whenusing the Release to import or deploy content.

14.6 Viewing attachments

Attachments can be automatically added to Releases if an Import Strategy includes this action. TheStrategy defines which files can be saved as attachments. View any attachments added during the ImportProcess from the Attachments tab in the Release editor.

NoteThe content of Save Files imported using the IBM i and Arcad ImportStrategies are saved as .txt attachments by default. This makes it easy to




refer to the content of the Save File outside of IBM i after it has beenimported into the DROPS Studio.

Double-click on an attachment or select it and click the Open button to open it in a new tab in thestudio.

Download an attachment by selecting it and clicking the Detach button.

14.7 Locking and unlocking Releases

Locked Releases cannot be used to import Artifacts.

To lock or unlock a Release and prevent Users from using it to import Artifacts, either right-click on it in theReleases search view then select Lock/ Unlock or select the item then click the corresponding

icon.

14.8 Viewing the Artifacts in Releases

To view the Artifacts imported in a Release, either right-click on it in the Releases search view thenselect Show Artifacts or select the item then click the Artifacts icon.

Search for the Artifacts in a Release in the Release Artifact view by name, file type (Extension) orComponent. To display the complete list of Artifacts imported into the current Release, click the Searchbutton without entering any search criteria.

Imported Artifacts are nested under their corresponding Components' node and found in their sourcedirectory structure. Select an Artifact and either right-click, then select Show History, or click the Show the Release History icon to open the Artifact History view.

This view displays when the Artifact was added (its first Release), and when it was modified (imported inother Releases).

ReferenceFor more information about this view, refer to Viewing an Artifact's importhistory on page 77.

14.9 Purging the Artifacts imported by Releases

Warning!Purged Releases cannot be accessed, used to import, deployed orrecovered.




Purging the Artifacts from closed or outdated Releases creates space on the DROPS Server and cleans upthe Artifact Repository. The history of each Release is maintained and the name(s) of the imported Artifactscan still be found, but the Artifacts themselves no longer appear in the repository.

NoteReleases must be locked before they can be purged fromDROPS.

Step 1 To purge a Release, search for it in the Release search view. Either right-click on it then selectPurge or select it, then click the Purge icon.

Step 2 Tick theArchive the Release's Artifacts before purging checkbox to zip and archive the Artifactsin the Release before purging it. Archived artifacts are removed from the repository but the zip canstill be consulted manually in the Archived Files Storage Area destination on the Server.

ReferenceFor more information about configuring this storage area, refer totheDROPS Configuration Guide.

Step 3 Click Finish to confirm or click Cancel to cancel the purge request.Release. If required, confirm thepurge again.

Result The log file is opened automatically in your default text editor. If the purge was successful, theArtifacts have been zipped and archived (if required), then deleted from the repository. The purged icon is displayed in the Release’s instance in the Release search view.

14.10 Deleting Releases

Warning!Deleted Releases cannot be accessed, used to import, deployed orrecovered. Deleting a Release does not delete the Artifacts that havealready been imported by it. Only the trace of the Release’s container itselfis removed. To remove the Artifacts from the repository, they must bepurged before the Release is deleted.

To delete a Release, search for it in the Release search view. Either right-click on it, then selectDelete or select it, then click the Delete icon. ClickOK to confirm or click Cancel to keep the Release.



DROPS v2.8.1User Guide | 15Working with imported Artifacts

15 Working with imported Artifacts

Required Roles Application Repository Manager

Required Rights(by category)

ApplicationsArtifacts


Access DROPS Server→ Artifacts→ Applications→ Application→ Repository

Chapter Summary15.1 Searching for imported Artifacts 7615.2 Viewing an Artifact's import history 77

Artifacts are individual files imported into the Artifact Repository which together create functionalApplications ready for deployment. They are imported via Releases and grouped into Components in orderto categorize different parts of Applications. Artifacts are imported following the instructions in ImportStrategies and their versions aremanaged in Releases.

15.1 Searching for imported Artifacts

Follow the subsequent steps to search for Artifacts that have already been imported into an Application.

Step 1 Expand the Application into which the Artifact was imported.

Step 2 Double-click on the Repository node to open the Artifacts search view for that Application.

Step 3 When the search view is opened, the list of Artifacts is empty. Use the search criteria sections tofilter the search.

l To search for an existing Artifact by name or file type, enter all or part of the information intheArtifact or Extension fields.

l To search for existing Artifacts by Component, click the Browse icon and select theComponent from the list. This list is prepopulated with all of the Components in the currentApplication.

l To search for existing Artifacts by Release, click the corresponding Browse icon. TheCreation Release and Last Update Release lists are prepopulated with all of the Releasesthat have been created for the current Application.





DROPS v2.8.115Working with imported Artifacts | User Guide

Figure 19: The Artifacts search view

Result The Artifacts search view displays all of the Artifacts that have been imported into the currentApplication that meet the search criteria.

TheArtifact column displays each Component in the Application that contains importedArtifacts. Expanding each Component displays the directory structure that DROPS copied fromthe Artifact's source location. This directory structure is repeated in the Deployment Process andcopied over to the target system.

The Creation Release and Last Update Release columns display the name of the first Releasethe Artifact was imported with and themost recent Release that contained it, respectively.

15.2 Viewing an Artifact's import history

To view an Artifact's import history, select it in the Artifacts search view and either right-click, thenselect Show History, or click the Release History icon.

The Artifact's import history is displayed in the Artifact History view.

Figure 20: The Artifact History view

TheRelease Number for each individual Release that contained the Artifact.

TheAction column displays the last action completed for the Release (Added for the first import orUpdated for when the Artifact was reimported into the same Release).

The File Name column displays the complete path to the Artifact's location on the DROPS Server, whichfollows the template defined during high-level configuration (refer to theDROPS Configuration Guide).



DROPS v2.8.1User Guide | 15Working with imported Artifacts

The imported Artifact's file size as well as the date the Release was last modified are displayed in thecorresponding columns.

ReferenceFor more information about Artifacts in Releases, refer to Working withReleases on page 70.



Configuring theDeployment Process

DROPS v2.8.1User Guide | Introduction to configuring the Deployment Process

Introduction to configuring the Deployment ProcessDROPSmakes it easy to deploy Applications developed on different platforms and technologies to anytarget environment platform. For this, it uses amulti-platform Deployment Infrastructure Repository,structured around Environments and Infrastructure Items, and complemented by task-specific scripts,Deployment Schemas and Replacement Rules.

These entities, and more, must be configured in able to create functional elements to feed into DeploymentProcesses.

The configuration described in this section covers process-level configuration completed using theConfiguration Management perspective (see Overview of the DROPS Studio on page 29).

NoteMost of the high-level configuration necessary in the DROPS Studio mustbe performed by a DROPS admin who has the right(s) to configure globaloperations.

ReferenceFor more information about high-level configuration, refer to theDROPSConfiguration Guide.

About the Configuration Explorer - Deployment Infrastructure Repository

Figure 21: The Configuration Management perspective - Infrastructure Repository

The Configuration Explorer provides access to the Deployment Infrastructure Repository. Thisperspective is the configuration side of DROPS.



DROPS v2.8.1Introduction to configuring the Deployment Process | User Guide

The Deployment Infrastructure Repository refers to the content managed from the Configurationnode under the currently connected DROPS Server. All of the following items are defined, configured,managed and accessed in the Deployment Infrastructure Repository:

l Clients (seeWorking with multiple Clients on page 82),

l Users (seeWorking with User Accounts on page 38),

l Environments (seeWorking with Environments on page 84),

l Environment Groups (seeWorking with Environment Groups on page 93),

l Infrastructure Items (seeWorking with Infrastructure Items on page 97),

l Deployment Processes (seeWorking with Deployment Process Diagrams on page 131),

l Deployment Schemas (seeWorking with Deployment Schemas on page 113),

l Replacement Rules (seeWorking with Replacement Rules on page 117),

l Scripts (seeWorking with scripts on page 121),

l Strategy Templates (seeWorking with Strategy Templates on page 67),

l Process Templates (seeWorking with Process Templates on page 161).

To update the content of any menu list, right-click then select Refresh.



DROPS v2.8.1User Guide | 16 Working with multiple Clients

16 Working with multiple Clients

Required Roles n/a

Required Rights(by category) Clients


Access DROPS Server→ Configuration→ Clients

TheMultiple Clients option is activated by Users with the rights to do so. With multiple Clients, the entities'search views are renamed in order to give you full visibility of your target structure.

ReferenceFor more information about this high-level configuration, refer to theDROPS Configuration Guide.

If theMultiple Clients option is activated, one Client is created by default called DROPS Software. EachClient created contains its own set of Users, Environments and Infrastructure Items. Having multiple sets ofthese elements enables you to organize themmore efficiently per their deployment target.

To add additional Clients, right-click on the Clients node and select Create a new Client. Define theClient's code and name, then click Finish.

To change the names of a Client, right-click on it and select Edit. Modify the Client's code or displayname in the Client editor. Reconnect to the DROPS Server to see the changes made.

To delete a Client, right-click on it and select Delete. Click OK to confirm.

Warning!Deleted Clients cannot be recovered. Any associated Users, Environments,Environment Groups and Infrastructure Items are also deleted.



DROPS v2.8.116 Working with multiple Clients | User Guide

Figure 22: Views named for multiple Clients



DROPS v2.8.1User Guide | 17 Working with Environments

17 Working with Environments

Required Roles Environment Administrator, ReleaseManager and/or Release Operator


ClientsEnvironmentsInfrastructure Items


Access DROPS Server→ Configuration→ ( Client→ ) Environments

Chapter Summary17.1 Searching for Environments 8417.2 Creating Environments 8517.3 Editing Environment details 8717.4 Adding Infrastructure Items to Environments 8917.5 Defining Applications allowed for Environments 8917.6 Viewing the Releases already deployed to an Environment 9017.7 Viewing an Environment's Deployment History 9017.8 Changing the Extension Type of an Environment 9117.9 Deleting Environments 92

Environments are the highest-level container in the Infrastructure Repository; they define your targetsystems. This includes defining which Applications can be deployed to certain systems, what is done duringa deployment (instructions are defined in the Deployment Process) and to where deployed Artifacts aredelivered (defined in the Infrastructure Items). The different types of Environments enable you to clearlyoutline where a target system is, who manages it and what it's used for.

17.1 Searching for Environments

Follow the subsequent steps to search for Infrastructure Items.

Step 1 Select Environments from the Configuration node in the Configuration Explorer.





DROPS v2.8.117 Working with Environments | User Guide

Figure 23: The Environments search view

Step 2 When the search view is opened, the list of Environments is empty. Use the search criteria sectionsto filter the search.

l To search for an existing Environment by its Code orName, enter all or part of theinformation in the corresponding field.

l To search for an existing Environment by type, select it from the Type drop-down list.



Result The Environments view displays all of the Environments defined for the current server (and forthe selected Client, if applicable) that meet the search criteria.

Clicking on an Environment also opens the Process List view.

NoteIt is recommended to open the Process List view in a different areathan the Environments view. If both views are tabs in the same area, itis difficult to access the Environment editor.

ReferenceFor more information about the Process List view, refer to Workingwith Deployment Process Diagrams on page 131.

17.2 Creating Environments

There are two ways to create Environments:




1. Create a brand new Environment using the Create a new Environment wizard.2. Duplicate an existing Environments. Duplicating creates a copy of an existing Environment that can be

modified.

17.2.1 Create a new EnvironmentFollow the subsequent steps to create a new Environment.

Step 1 To access the Create a new Environment wizard, either click the Create icon in theEnvironments view or right-click anywhere in the view and select Create a new Environment.

Step 2 Complete all of the fields. These values can be edited later.

1. Define the *Env. Code and *Env. Name.2. Select the type. The *Env. Type drop-down list is prepopulated with Environment Types

defined by the administrator in the Preferencesmenu.

ReferenceFor more information about entity types, refer to Entity typesin the appendix.

3. [Optional] If you are working with ARCAD, select the ARCAD Extension Type.


Step 3 Select the Infrastructure Items to which Releases should be deployed on this Environment. The listis automatically populated with the Items available for the current server (and Client).


Result NewEnvironments are available in the Environments view after refreshing the list and can beused to configure the Deployment Process.

17.2.2 Duplicate an EnvironmentDuplicating an Environment is a quick way to apply an existing set of Items, Applications and ProcessDiagrams to a different target.

ExampleYou have similar Environments that include processes made largely fromtemplates. Instead of creating themultiple environments, create one thenduplicate it and manually define which of the original Items, Apps and/orProcesses should be changed.

NoteThe Releases deployed for an Environment are not duplicated into the newcopy because they have not been deployed to that version of the target.The deployment history for these new Environments is also empty.




The users attributed to the original Environment are carried over to thenew version as well as the Infrastructure Items assigned to it and allowedApplications.

All of the original Environment’s Deployment Process Diagrams and theircomplete configuration are also duplicated.

Follow the subsequent steps to duplicate an existing Environment in order to create a new one

Step 1 To open theDuplicate an Environment wizard, either select an existing Environment in theEnvironments view then click the Duplicate icon, or right-click on it and select Duplicate.

Step 2 Define the new Environment’s *Env. Code and *Env. Name. These values can be edited later butmust be unique.


Result NewEnvironments are available in the Environments view after refreshing the list and can beused to configure the Deployment Process.

17.3 Editing Environment details

To edit Environment details, either right-click on it in the Environments view then select Edit, selectthe item then click the edit icon or double-click it. The Environment editor is opened where all of theentity's details aremanaged.

Figure 24: The Environment editor




The information that defines Environments can be edited at any time by Users with the rights to do so.

ReferenceFor more information about the different actions managed from the tabsin the Environment editor that are not described in this chapter, referto:



The Environment's parent entity is displayed in the Client section.

Field Description

*Env. Code A unique string that identifies Environments. This label is used throughout DROPS toselect the entity.

*Env. Name A label used to give additional information about the Environment. This label is usedthroughout DROPS to select the entity.

*Env. Type

A value used to assign a type to the Environment. This drop-down list is prepopulatedwith Environment Types defined by the administrator in the Preferencesmenu.


ExtensionType A read-only value set to the Environment’s Extension Type selected when it was created.

ExtendedConfiguration

Some Environment Extension Typed require extended configuration. If the currentextension type does, this field will be a link to the type-specific configuration editor.

ReferenceFor more information about the extended configurationeditors, refer to Environment Extension TypeConfiguration in the appendix.

Is Template

Tick this checkbox to transform the Environment into a template. TemplateEnvironments cannot be used to deploy content but may be duplicated to create otheractive Environments that contains the pre-defined elements defined in the template.

You cannot select a Template Environment in a Deployment Instance to use it as a targetfor your deployment but you can filter the list of Environments using a web service toselect only the templates. Template Environments cannot be added to EnvironmentGroups.

Important!If an Environment that is already part of an EnvironmentGroup is changed to be a Template Environment,

Table 9: Edit Environments




Field Description

NONE of the Environments in the group can be used inany Deployment Instance until the TemplateEnvironment is either removed from the group orchanged to not be a Template any longer.

Template Environments are indicated by the Template Environment icon.Table 9: Edit Environments


17.4 Adding Infrastructure Items to Environments

To make the connection between Infrastructure Items and the target Environment on which they run, addthem to an Environment. Populating the Infrastructure Items tab in the Environment editor with allof the Items to which you can deploy content enables you to later select those Items in Deployment ProcessDiagrams associated with the Environment.

Important!An Environment must be linked to at least one Infrastructure Item in orderto create a functional Deployment Process.

From the Infrastructure Items tab in the Environment editor, click the Add button. TheInfrastructure Item Selection dialog is prepopulated with the Items available for the current server (andClient).

To remove an Item, select it in themanager and click the Remove button.


17.5 Defining Applications allowed for Environments

To make the connection between Artifacts and the target Environment to which they can be deployed, addtheir parent Application to an Environment. Populating theAllowed Applications tab in theEnvironment editor with all of the Applications that can be deployed to it enables you to later select thoseApplications in Deployment Process Diagrams associated with the Environment.

Important!An Environment must be linked to at least one Application in order tocreate a functional Deployment Process.

From theAllowed Applications tab in the Environment editor, click the Add button. The Select anApplication dialog is prepopulated with the Applications available for the current server.

To remove an Application from the list, select it in themanager and click the Remove button.





17.6 Viewing the Releases already deployed to an Environment

The read-only Deployed Releases tab in the Environment editor displays the complete list ofReleases that have already been deployed on the Environment.

Figure 25: The Deployed Releases tab in the Environment editor

17.7 Viewing an Environment's Deployment History

The Deployment History tab in the Environment editor displays the complete history of theDeployment Process Instances executed for the current Environment.




Figure 26: The Deployment History tab in the Environment editor

The table displays complete information about the deployment including the final Result, the Applicationand Release deployed, the date and time the deployment was finished, the Package Type and theDeployment Process used to deliver.

Select a deployment and click the Edit Release button or double-click it to open the associatedRelease's editor.

In addition to the automatically-generated references to deployments, entries in this view can be createdmanually. Manually-generated history entries are not linked to any Deployment Process and do notreference any Deployment Process Instance. They are for information only. TheDeployed By Processcolumn displays the term *MANUAL for any history entry that is not linked to a DROPS deployment. Toadd a deployment history referencemanually, click the Add button and define the required Application,Release and Package Type.

To remove a deployment from the list, select it in themanager and click the Delete button. Deleting anitem from the list in the Deployment History view does not affect theDeployment Process Instancessearch view.

17.8 Changing the Extension Type of an Environment

To change the Extension Type of an Environment, either right-click on it in the Environments view thenselect Change Extension Type, or select the it then click the Change Type icon.

The drop-down list to select the new extension type is prepopulated with Environment Extension Typesavailable. ClickOK then close the editor and refresh the view. When the Environment is opened again, thechange is visible.

Warning!If the extended configuration for an Environment has already beendefined, changing its extension type will delete all of the information.




ReferenceFor more information about this, refer to Environment Extension TypeConfiguration on page 277 in the appendix.

17.9 Deleting Environments

Warning!Deleted Environments cannot be accessed or recovered.

To delete an Environment, either right-click on it in the Environments view, then select Delete orselect it, then click the Delete icon. ClickOK to confirm or click Cancel to keep the Environment.



DROPS v2.8.118 Working with Environment Groups | User Guide

18 Working with Environment Groups

Required Roles Environment Group Administrator


ClientsEnvironment Groups


Access DROPS Server→ Configuration→ ( Client→ ) Environment Groups

Chapter Summary18.1 Accessing Environment Groups 9318.2 Creating Environment Groups 9418.3 Editing Environment Group details 9418.4 Adding Environments to Groups 9518.5 Deleting Environment Groups 96

Environment Groups are sets of Environments that share the same Application. They are used to createmultiple Deployment Process Instances, which all deploy the same Release, at the same time.

Important!The Deployment Instance(s) created using the Environment Group mustalways deploy the same Release so it is important that all of theEnvironments in a group allow the same Application(s) and each have aDeployment Process defined to deploy the shared Application(s).

Important!If an Environment that is already part of an Environment Group is changedto be a Template Environment, NONE of the Environments in the groupcan be used in any Deployment Instance until the Template Environment iseither removed from the group or changed to not be a Template anylonger.

NoteIt is recommended to define a default Deployment Process for eachEnvironment in a group.

ReferenceFor more information about ensuring the above parameters are defined forall of your Environments, refer to Defining Applications allowed forEnvironments on page 89 and Working with Deployment ProcessDiagrams on page 131.

18.1 Accessing Environment Groups

To access the



DROPS v2.8.1User Guide | 18 Working with Environment Groups

Environment Groups view, select the Environment Groups node in the Configuration Explorer.


ReferenceFor more information about managing multiple clients, refer to Workingwith multiple Clients on page 82.

The Environment Groups view displays all of the Groups defined for the current server (and for theselected Client, if applicable).

Figure 27: The Environment Group view

18.2 Creating Environment Groups

Follow the subsequent steps to create a new Environment Group.

Step 1 To access the Create a new Environment Groupwizard, either click the Create icon in theEnvironment Groups view or right-click anywhere in the view and select Create a newEnvironment Group.

Step 2 Define the * Env. Group Code and * Env. Group Name.


Step 3 Select the Environments to include in the group. The list is automatically populated with theEnvironments available for the current server (and Client).


Result NewEnvironment Groups are available in the Environment Groups view and can be used toconfigure the Deployment Process.

18.3 Editing Environment Group details

To edit Environment Group details, either right-click on it in the Environment Groups view then selectEdit, select the item then click the edit icon or double-click it. The Environment Group editor is

opened where all of the entity's details aremanaged.



DROPS v2.8.118 Working with Environment Groups | User Guide

Figure 28: The Environment Group editor

The information that defines Environment Groups can be edited at any time by Users with the rights to doso.

ReferenceFor more information about the different actions managed from the tabsin the Environment Group editor that are not described in this chapter,refer to:


The Environment Group's parent entity is displayed in the Client section.

Field Description

* Env. GroupCode

A unique string that identifies Environment Groups. This label is used throughout DROPSto select the entity.

* Env. GroupName

A label used to give additional information about the Environment Group. This label isused throughout DROPS to select the entity.

Table 10: Edit Environment Groups


18.4 Adding Environments to Groups

To manage the list of Environments in an Environment Group, add or remove them from theEnvironments tab.

From the Environments tab in the Environment Group editor, click the Add button. TheEnvironment Selection dialog is prepopulated with the Environments available for the current server (andClient).

To remove an Environment, select it in themanager and click the Remove button.



DROPS v2.8.1User Guide | 18 Working with Environment Groups


18.5 Deleting Environment Groups

Warning!Deleted Environment Groups cannot be accessed or recovered.

To delete an Environment Group, either right-click on it in the Environment Groups view and selectDelete, or select it and click the Delete icon. ClickOK to confirm or click Cancel to keep theEnvironment Group.



DROPS v2.8.119 Working with Infrastructure Items | User Guide

19 Working with Infrastructure Items

Required Roles Infrastructure Item Administrator, Manager and/or Contributor


ClientsInfrastructure Items


Access DROPS Server→ Configuration→ ( Client→ ) Infrastructure Items

Chapter Summary19.1 Searching for Infrastructure Items 9819.2 Creating Infrastructure Items 9919.3 Testing the connection to an Infrastructure Item (Agent) 10219.4 Editing Infrastructure Item details 10419.5 Changing the Type of an Infrastructure Item 10919.6 Changing the OS Family of an Infrastructure Item 10919.7 Managing an Infrastructure Item’s remote installation properties 11019.8 Viewing the Releases deployed on an Infrastructure Item 11119.9 Viewing an Infrastructure Item's Deployment History 11219.10 Deleting Infrastructure Items 112

Infrastructure Items represent individual services on target systems. They connect DROPS to the targetsystem via the DROPS Agent. Agents are installed on these deployment targets that run technical layerswhich can often support one or more services. Infrastructure Items point to individual services. Becausemultiple services can point to the same Agent on a shared machine, it is possible to createmultipleInfrastructure Items in DROPS that each connect to a different service on the same system.

DROPS licenses are based on the number of Infrastructure Items created because they represent the size,deployment workload and overall deployment needs of your company.

It is recommended to create one Infrastructure Item for each of the various services you may deploy to, nomatter howmany run on the same system. Doing this will enable you to manage the correspondencebetween Infrastructure Items and Components in the Deployment Process Diagram accurately. In theProcess Diagram, Infrastructure Items and Components arematched one-to-one, therefore, having uniqueInfrastructure Items for each service will ensure Components are deployed accurately to only the Itemrequired and not to multiple services on the system.

It is also recommended to create your Infrastructure Items before installing the DROPS Agent.

An Infrastructure Item can be added to multiple Environments and an Environment can contain multipleInfrastructure Items.

NoteIf an Infrastructure Item is not correctly connected to a DROPS Agent orthe license access is restricted, when it is used in a Deployment Process, theProcess will be suspended.



DROPS v2.8.1User Guide | 19 Working with Infrastructure Items

ReferenceFor more information about suspended Processes, refer to Working withSuspended Actions on page 220.

For more information about the DROPS Agent, refer to the DROPSConfiguration and Installation Guides.

19.1 Searching for Infrastructure Items

Follow the subsequent steps to search for Infrastructure Items.

Step 1 Select Infrastructure Items from the Configuration node in the Configuration Explorer.



Figure 29: The Infrastructure Items search view

Step 2 When the search view is opened, the list of Items is empty. Use the search criteria sections to filterthe search.

l To search for an existing item by its Code orName, enter all or part of the information in thecorresponding field.

l To search for an existing item by type, select it from the Type drop-down list.l To search for Temporary or Definitive Items only, tick the corresponding checkbox.



Result The Infrastructure Items search view displays all of the Items defined for the current server(and for the selected Client, if applicable) that meet the search criteria.




19.2 Creating Infrastructure Items

There are two ways to create Infrastructure Items:

1. Create a new Infrastructure Itemmanually using the Create a new Infrastructure Itemwizard.2. Upload a .csv file that contains the required minimum information for multiple Infrastructure Items in

order to mass-produce all of the Items you need. Creating multiple Items at the same time this waycreates multiple Items that can bemodified.

19.2.1 Create individual Infrastructure Items manuallyFollow the subsequent steps to create a new Infrastructure Item.

Step 1 To access the Create a new Infrastructure Itemwizard, either click the Create icon in theInfrastructure Items search view or right-click anywhere in the view and select Create a newInfrastructure Item.


1. Define the new Item’s *Infra. Item Code and *Infra. ItemName.2. Select the Item's Infra. Item Type. The drop-down list is prepopulated with Infrastructure

Item Types defined by the administrator in the Preferencesmenu.

ReferenceFor more information about entity types, refer to Entity typesin the appendix.

3. Enter the *URL necessary to connect to the target Infrastructure Item (the system on whichthe DROPS Agent is installed).

4. Select the *Remote Agent Type that has been or will be installed on the Item. There are twooptions:

l DROPS Agent V2: relies on TCP/IP connections.l DROPS Agent V3: relies on HTTP(S) connection.

5. Select the *OS Family that the agent is running on. There are three options:

l Windowsl Linuxl IBMi


Result New Infrastructure Items are available in the Infrastructure Items search view and are ready tobe configured and added to Environments.

Important!It is important to continue editing a new Item's information right




away to complete the configuration for the Infrastructure ItemType.

ReferenceFor more information about configuring Items, refer toInfrastructure Item Type Extended Configuration in the appendix.

19.2.2 Create multiple Infrastructure Items automaticallyFollow the subsequent steps to createmultiple Infrastructure Items automatically by uploading a pre-configured .csv file.

Step 1 Create the .csv file to upload.

The .csv file to uploadmust contain aminimum amount of information for each InfrastructureItem to create. The details should be configured in a specific order - the information correspondingto each required field must be included in the correct column in order for the upload process to besuccessful.

The details defined in the .csv file will be automatically transferred to each ItemDROPS creates. The corresponding fields will be automatically populated. The columns can beremapped but the default order is as follows.

Important!Do not include a header row in the .csv file.

Figure 30: Example of .csv file used to import multiple Infrastructure Items

Column A (the first column): the Infrastructure Item's *Infra. Item Code.




Column B: the *URL that points to the target system on which the DROPS Agent is installed.

Column C: the *Login required to connect to the target system.

Column D: the *Password required to connect to the target system.

Column E: the Infrastructure Item's Infra. Item Type. Enter only the Item Type Code, which isdefined when entity types are created in the Preferencesmenu.

ReferenceFor more information about entity types, refer to Entity types inthe appendix.

Column F: the *Remote Agent Type that is running on the remote system. There are two types ofDROPS Agents. Enter the code that corresponds to the type that the Item connects to on thetarget system. The codes are:

l 1 for DROPS Agent V2l 2 for DROPS Agent V3

Column G: The *OS Family that the remote system is running on. Enter the code that correspondsto the OS on which the DROPS Agent is running. The codes are:

l 0 for Windows (default)l 1 for Linuxl 2 for IBMi

Step 2 Import the .csv file.

To open the .csv import wizard, either right-click anywhere in the Infrastructure Items searchview and select Import from a .csv file or click the .csv import icon.

Step 3 Complete all of the fields.

Warning!These fields cannot be edited later.

1. Enter the exact path to the .csv file created in Step 1. Click the Browse button to navigateto the file.

2. If you did not change the order of the columns as suggested in Step 1, do not modify thefields in the Column Index Mapping section.

NoteIf you changed the order of the columns in the .csv file, modify thecorresponding fields' indicator(s) in the Column Index Mappingsection.

'0' corresponds to the first column on the far-left (column A), '1' tothe next column to the right (column B) and so on.

Step 4 Click Finish to launch the import.




Result All of the Infrastructure Items listed in the .csv file are created. The number of the Items createdthat are automatically active depends on your DROPS license key. If the .csv file contains moreItems than your license allows, the extra Items will be created but they will be temporary.

ExampleIf there are 45 rows with accurate and complete information in the.csv and you have a license that permits 50 Items, 45 Items will becreated. If you have a license that only permits 40 Items, all 45Items will be created, but the final 5 in the .csv will be temporaryItems. If your license does not allow the full number of Items tocreate, an email is sent to the User who uploaded the .csv file.

ReferenceFor more information about temporary Items, refer to Table 12:Edit Infrastructure Items: License Type section.

New Infrastructure Items are available in the Infrastructure Items search view and are ready tobe configured and added to Environments.

Important!It is important to continue editing a new Item's information rightaway to complete the configuration for the Infrastructure ItemType.

ReferenceFor more information about configuring Items, refer toInfrastructure Item Type Extended Configuration in the appendix.

19.3 Testing the connection to an Infrastructure Item (Agent)

It is recommended to test the connection information defined in an Infrastructure Item to ensure thatDROPS can successfully connect to it before executing the Deployment Process.

There are two ways to test the connection DROPS maintains with the Agent installed on InfrastructureItems:

1. Manually test the connection one time from the Infrastructure Items search view.2. Add the Item to a list that is regularly checked by the DROPS Server to monitor that the connections

continue to be reachable.

NoteIf an Infrastructure Item is not correctly connected, when it is used in aDeployment Process, the Process will be suspended.

ReferenceFor more information about suspended Items in Process deployment, refer




to Working with Suspended Actions on page 220.

19.3.1 Test the connection to an Infrastructure Item (Agent) manuallyTo test the connection to an Agent manually, either right-click on it in the Infrastructure Items searchview, then select Test Connection, or select the item then click the Test Connection icon.

If the connection is broken the Problem Occurred dialog is displayed confirming that the connection to theAgent could not be successfully established. Click theDetails button for more information about why theconnection failed.

If the connection is stable, the Problem Occurred dialog is displayed but the commentary confirms that theconnection to the Agent was successfully established.

19.3.2 Monitor the connection to an Infrastructure Item (Agent)automatically

To test the connection to one or more Agent(s) automatically and periodically, add Infrastructure Items totheMonitoring List. A task is scheduled on the DROPS Server to check if the Items that belong to theMonitoring List are reachable. If the Agent is not reachable, the status of the entry is set to FAILED and anotification can be sent to the user(s) in the Administrator or Contributor role.

The schedule that theMonitor List follows to verify the connection(s) to the DROPS Agent(s) is defined inthe configuration view by an Administrator.

ReferenceFor more information about defining themonitoring schedule, refer to theDROPS Configuration Guide.

If an Infrastructure Item is added to theMonitoring List, themonitor icon is displayed for that Item in theInfrastructure Items search view.

Figure 31: Infrastructure Agents included in the Monitoring List

To add one or multiple Items to theMonitoring List, select it from the Infrastructure Items search viewthen either right-click and select Add to the Monitoring List or click the monitor icon in the localtoolbar.




To remove one or multiple Items from theMonitoring List, select it from the Infrastructure Itemssearch view then either right-click and select Remove from the Monitoring List or click the monitoricon in the local toolbar.

Selecting multiple Items that may or may not be in the list already is possible. All the selected Items that aremonitored will be removed from the list and all the selected Items that are not monitored will be added tothe list.

19.3.2.1 Accessing the Remote Agent Monitoring List

To access the Remote Agent Monitoring List view, click the Monitoring List View icon in theInfrastructure Items search view toolbar.

Figure 32: The Remote Agent Monitoring List view

The Remote Agent Monitoring List view displays a list of all the Infrastructure Items in the list. Nestedunder each item is the date of the last check and the status of the entry at the last check. Selecting an entrydisplays themessage related to the connection attempt in the lower part of the view.

To refresh the content of this view, click the Refresh icon.

To delete an existing entry select it and either right-click and select Remove Entry or click the removeicon.

19.4 Editing Infrastructure Item details

To edit Infrastructure Item details, either right-click on it then select Edit, select the item then click the Edit icon or double-click it. The Infrastructure Item editor is opened where all of the entity's details

aremanaged.




Figure 33: The Infrastructure Item editor

The information that defines Infrastructure Items can be edited at any time by Users with the rights to doso.

ReferenceFor more information about the different actions managed from the tabsin the Infrastructure Item editor that are not described in this chapter,refer to:



For more information about an Item’s extended configuration, refer toInfrastructure Item Type Extended Configuration in the appendix.

The Item's parent entity is displayed in the Client section.

NoteThe values entered in the Identification and Connection sections can bereferenced by Substitution Variables.

Field Description

*Infra. ItemCode

A unique string that identifies Infrastructure Items. This label is used throughout DROPSto select the entity.

Table 11: Edit Infrastructure Items: Identification and Connection sections




Field Description

*Infra. ItemName

A label used to give additional information about the Infrastructure Item. This label isused throughout DROPS to select the entity.

Infra. ItemType

A read-only value set to the Infrastructure Item Type selected when the itemwas created.


ExtendedConfiguration

Some Infrastructure Item Types require extended configuration. If the item's current typedoes, this field will be a link to the type-specific configuration editor.

ReferenceFor more information about extended configurationeditors, refer to Infrastructure Item Type ExtendedConfiguration in the appendix.

TechnicalPlatform

[Optional] Select the type of OS that the Infrastructure Item points to. The drop-down listis prepopulated with the platforms defined by an admin in the Preferences menu.

Technical platforms refer to the service to which an Infrastructure Item points. Knowingthe type of service Item points to is helpful when selecting platform-specific scripts whenbuilding the Deployment Process.

ReferenceFor more information about Technical Platforms, refer totheDROPS Configuration Guide.

*URL

Enter the address and port in URL format that points to the system on which theDROPS Agent is installed and the port defined for it during installation. The syntax is:https://machinename:port.

ReferenceFor more information about the DROPS Agent, refer toAbout DROPS on page 21.

For more information about installing the DROPS Agent,refer to theDROPS Installation Guide.

*RemoteAgent Type

Select the type of DROPS Agent that is running or will be installed on the remote systemto which you are connecting.

If the DROPS Server must connect to the Agent using TCP/IP, selectDROPS Agent V2.

If the DROPS Server must connect to the Agent using HTTP(S), selectDROPS Agent V3.

*OS FamilyThe type of OS on which the DROPS Agent is installed. The OS can be changed in theInfrastructure Items search view. Depending on the OS family defined for the Item, theInstallation Properties will change.

Table 11: Edit Infrastructure Items: Identification and Connection sections




Field Description

InstallationProperties

The properties required to define the installation path and connection to the remote hostof the DROPS Agent. These properties are only used when the when the DROPS Agent isinstalled or updated remotely on the Infrastructure Item.

ReferenceFor more information about remote installation refer toManaging an Infrastructure Item’s remote installationproperties on page 110 and theDROPS InstallationGuide.

*Login Enter the valid (domain) user's login to connect the DROPS Server to the target systemon which the DROPS Agent is installed.

*Password Enter the related password.Table 11: Edit Infrastructure Items: Identification and Connection sections

The License Type section displays critical information concerning the current server's Activation Key.

NoteTo view the number of permanent and temporary License Units available,click the Configuration node in the Preferences menu (right-click on the DROPS Server→ Preferences→ Configuration).

Field Description

TemporaryInfrastructureItem

If this checkbox is ticked, the Activation Key associated with the current DROPS Serverdoes not have any more available License Units.

Temporary Infrastructure Items can only be created if every License Unit in the currentActivation Key's is consumed. The number of Temporary License Units available dependson the number of purchased License Units that the current Activation Key contained.

If no Activation Key has ever been registered for the current DROPS Server, only five (5)temporary Infrastructure Items can be created and used for a limited period of time (up toonemonth). This enables you to use DROPS while your Activation Key is beinggenerated.

A Temporary Infrastructure Item becomes definitive as soon as a new License Unit isavailable (as soon as a new License Unit Pack is registered).

TemporaryActivationDate

Temporary Infrastructure Items are available for onemonth starting from the currentdate (the date the Itemwas created).

NoteWhen a deployment involves a Temporary InfrastructureItem and if its Temporary Activation Date is over, when itis used in a Deployment Process, the Process will be

Table 12: Edit Infrastructure Items: License Type section




Field Description

suspended. If the Temporary Activation Date is not over,aWarning will be produced in the deployment log toremind you that you are using a TemporaryInfrastructure Item.

ReferenceFor more information about suspended Processes, referto Working with Suspended Actions on page 220.

Table 12: Edit Infrastructure Items: License Type section

TheDeployment Information section is crucial to configuring an Infrastructure Item. It enables you todefine the directories that serve as destination locations on the target system during the DeploymentProcess. The values entered here can be referenced in substitution variables during the DeploymentProcess.

Field Description

BackupDirectory

The directory path on the target system used to stock a copy of the content that iscurrently in the same location defined in the Deployment Process.

The copy of the current content stored here serves as a backup. If the deployment ofArtifacts does not work and you need to roll back the deployment, the previous version ofcontent from the target location will be reinstated. In order to reinstate it, the content iscopied during the Deployment Process and stored at this location.

RootDirectory

The directory path where the deployed Artifacts are temporary stored before beingofficially copied to the target.

The Root Directory is used to temporarily store the Artifacts to be deployed before DROPSactually deploys them. The deployable content follows the same structure that is defined ineach Component. Actions can be taken on the content before it is finally deployed,enabling you to automate steps such as unzipping, testing, transforming a configurationfile, etc or to set a requirement for validation.

Define this path manually or enter *AUTO to use the default Local Repository StorageArea path created when the DROPS Agent is installed.

ReferenceFor more information about the Local Repository StorageArea refer to theDROPS Installation Guide.

FileSeparator

Enter the standard file separator for the target system:\ for windows or / for any other system.

DeploymentSchema

To define the list of Deployment Schemas allowed for an Infrastructure Item, click theAdd button. The dialog is prepopulated with the Schemas defined for the current server.

Table 13: Edit Infrastructure Items: Deployment Information section




Field Description

Selecting an added Schema and clicking the Edit button or double-clicking it opens theDeployment Schema editor.

To remove an added Schema from the Infrastructure Item, select it and click theRemove button.

ReferenceFor more information about managing Schemas, refer toWorking with Deployment Schemas on page 113.

Table 13: Edit Infrastructure Items: Deployment Information section


19.5 Changing the Type of an Infrastructure Item

To change the Infra. Item Type of an Infrastructure Item, either right-click on it in the InfrastructureItems search view, then select Change Type, or select the item then click the Change Type icon.

The drop-down list to select the new type is prepopulated with Infrastructure Item Types defined by theadministrator in the Preferencesmenu. ClickOK then close the item editor and refresh the search list.When the Infrastructure Item is opened again, the change is visible.

Warning!If the extended configuration for an Infrastructure Item has already beendefined, changing its type will delete all of the information.

To create a different type of item and keep the information defined in thecurrent one, create a new Infrastructure Item.

ReferenceFor more information about entity types, refer to Entity types in theappendix.

19.6 Changing the OS Family of an Infrastructure Item

Changing the OS Family of an Infrastructure Item is useful if you aremigrating the DROPS Agent from oneOS to another. If you change an Agent’s OS by remotely installing it, it is important to change the OS in theInfrastructure Item and fill in the correct Installation Properties.

To change the *OS Family of an Infrastructure Item, either right-click on it in the Infrastructure Itemssearch view, then select Change OS Family, or select the item then click the ChangeOS icon.

The OS Family cannot be changed in the Infrastructure Item editor.




19.7 Managing an Infrastructure Item’s remote installationproperties

An Infrastructure Item’s Installation Properties are specific to the OS on which the correspondingDROPS Agent is installed.

To access the Item’s installation properties click the Edit Remote Installation Properties... link. TheLinux, Windows or IBM i Installation editor is displayed depending on the OS selected for theItem.

Important!If the Agent was initially installed remotely, some of the following valuesare already defined. If the Agent was initially installed manually it isrequired to create them on the DROPS database and then to define thefollowing values manually before you can update the DROPS Agentremotely. If the Infrastructure Itemwas created in an early version ofDROPS, it may be required to activate these parameters first by generatingthem.

ReferenceFor more information about the remote installation process, refer to theDROPS Installation Guide.

Field Description

InstallationPath The directory where the agent is installed.

LocalRepositoryStorageArea

The path defined when a DROPS Agent is installed that contains both the default RootDirectory and the Backup Directory. This path must be accessible to the DROPS Agent andis intended to regroup all of the content deployed to an Agent in one location. This path isused when the Backup and/or the Root Directory is set to *AUTO in an Infrastructure Item.

User &Password The user name and password used, or to use, during the remote installation process.

Table 14: DROPS Agent Installation properties

The user required to install the Agent is not necessarily the same as the user that runs the Agent after it isinstalled. To access the Agent after it is installed, to update it, the user who runs it and the correspondingconnection information are also required.

For Windows

Define theAgent User and Password required to access the profile that will run the Agent's service.

For Linux

Define theAgent User required to access the profile that will run the Agent's daemon.




For IBM i

Define the Target iASP and its child Installation Library required to hold the Agent’s objects. Define theAgent User required to access the profile that will run the Agent's job.

19.7.1 Generating an Infrastructure Item’s remote installation propertiesIf the Installation Properties link is not displayed for an Item created in the DROPS Studio v2.0 or earlier,the properties must first be generated.

NoteIf an Infrastructure Itemwas created in the DROPS Studio v2.2 or later, youdo not need to generate installation properties. They are already availableby default.

To generate the installation properties for an "older" Item, either right-click on it in the InfrastructureItems search view, then select Generate installation properties, or select the item then click the Generate installation properties icon.

After they are generated, the link to the Remote Installation Properties is displayed in the Item’s editor.

19.7.2 Creating remote installation information in the DROPS database

NoteIf an Agent was initially installed manually the installation details do notexist in the DROPS database. To update an Agent remotely, the installationinformation is required in the DROPS database so that DROPS knows theAgent has already been installed. If the install information isn’t the indatabase, when DROPS tried to update the Agent remotely, it will launch afresh installation instead of an update.

If the Agent was initially installed remotely, it is not required to create theinstallation information in the database because it was created and storedautomatically during the remote installation process.

To create (remote) installation information in the DROPS database, either right-click on the Item in theInfrastructure Items search view, then select Reference Installation, or select the item then click the Reference Installation icon. TheModule Release dialog is displayed and enables you to select a version

of the DROPS Agent to set an arbitrary remote install version.

19.8 Viewing the Releases deployed on an Infrastructure Item

The read-only Deployed Releases tab in the Infrastructure Item editor displays the complete list ofReleases that have already been deployed on the Item.




19.9 Viewing an Infrastructure Item's Deployment History

The Deployment History tab in the Infrastructure Item editor displays the complete history of theDeployment Process Instances executed for the current Item.

The table displays complete information about the deployment including the final Result, the Applicationand Release deployed, the date and time the deployment was finished, the Package Type and theDeployment Process used to deliver.

19.10 Deleting Infrastructure Items

Warning!Deleted Infrastructure Items cannot be accessed or recovered.

Any Deployment Process that references the deleted Infrastructure Itemwill not be updated and will fail if deployed. Existing Deployment Processesare never updated automatically with changes to Infrastructure Items.

To delete an Infrastructure Item search for it in the Infrastructure Items search view. Either right-clickon it and select Delete, or select it and click the Delete icon. ClickOK to confirm or click Cancel tokeep the Infrastructure Item.



DROPS v2.8.120 Working with Deployment Schemas | User Guide

20 Working with Deployment Schemas

Required Roles n/a


Infrastructure ItemsDeployment Schemas


Access DROPS Server→ Configuration→ Deployment Schemas

Chapter Summary20.1 Accessing Deployment Schemas 11420.2 Creating Deployment Schemas 11420.3 Editing Deployment Schemas 11520.4 Deleting Deployment Schemas 116

Deployment Schemas are sets of Deployment Rules used to change the destination location for Artifactswhen they are deployed to an Infrastructure Item. During regular deployment, the transferred Artifacts arecopied to theRoot Directory destination defined in the Infrastructure Item following the same directorystructure defined in the parent Component. However, you may need to change this location for a certaingroup of Artifacts.

Deployment Rules are used to assign a replacement target path for a set of Artifacts defined by a RegExfilter. During the Transfer Stage of the Deployment Process, if a Deployment Schema that has been addedto an Infrastructure Item is selected, all of the Artifacts in the Component deployed are run through theRules' RegExes. Each Artifact that matches a RegEx will be redirected to the corresponding replacementpath. Regular expressions can only be applied at the file name-level but they take into account the ArtifactKey. The Key is the relative path to the Artifact starting from its parent Component.

ExampleADeployment Rule defines a RegEx to find .sql Artifacts in the Componentdeployed to an Infrastructure Item. No matter what the paths defined inthe Components are, any Artifact that matches the .sql RegEx isredistributed to the Target Path defined in the Deployment Rule. Thisenables you to regroup Artifacts in your target service that come frommultiple Strategies which may each have a different source directorystructure.

The ${arcad.sourcepath} substitution variable can be used in the Target Path field. It is replaced bythe Artifact Key (relative path in the Artifact Repository).

DROPS Component directory structure <Artifact Repository>scripts/myScript.sql

No Deployment Rule:deployment path follows Component directorystructure

<RootDirectory>/scripts/myScript.sql

Deployment Rule:*.sql→ db/SQLScripts <RootDirectory>/db/SQLScripts/myScript.sql

Table 15: Deployment Rule example



DROPS v2.8.1User Guide | 20 Working with Deployment Schemas

Deployment Rule:*.sql→ db/SQLScripts/${arcad.sourcepath}

<RootDirectory>/db/SQLScripts/scripts/myScript.sql

Table 15: Deployment Rule example

The Deployment Rules are sorted by a specific order defined by the User. The order of the rules isimportant because if an Artifact matches several Rules, the target file namewill be generated by the firstrule it matches.

Important!If an Infrastructure Item contains a Deployment Schema it will always beused. It is taken into account during the Transfer Stage of the DeploymentProcess.

20.1 Accessing Deployment Schemas

To access the Deployment Schemas view, select the Deployment Schemas node in theConfiguration Explorer.

The Deployment Schemas view displays all of the Schemas defined for the current server.

Figure 34: The Deployment Schemas view

20.2 Creating Deployment Schemas

Follow the subsequent steps to create a newDeployment Schema.

Step 1 To access the Create a new Deployment Schema wizard, either click the Create icon in theDeployment Schemas view or right-click anywhere in the view and select Create a newDeployment Schema.

Step 2 Enter themandatoryName of the Schema.


Result NewDeployment Schemas are available in the Deployment Schemas view.



DROPS v2.8.120 Working with Deployment Schemas | User Guide

20.3 Editing Deployment Schemas

To edit Deployment Schema details, either right-click on it in the Deployment Schemas view then selectEdit, select the item then click the edit icon or double-click it. TheDeployment Schema editor is

opened where all of the entity's details aremanaged.

The information that defines Schemas can be edited at any time by Users with the rights to do so.

Figure 35: The Deployment Schema editor

Enter a shortDescription of the Schema to help you describe the RegExes defined in the Schema'sDeployment Rules.

TheDeployment Rulesmanager displays all of the existing rules defined for the current DeploymentSchema. TheOrder column defines the order that the rules will be run in if there is more than one Rule. Ifthe rules' order numbers are not chronological, click theReorder button and DROPS will automaticallyrenumber each rule following the order in which they are displayed.

20.3.1 Manage Deployment RulesTo create a new rule, click the New button in theDeployment Rulesmanager. In theDeploymentRule dialog, define:

1. the priority in theOrder field. This number enables you to initially select the position this rule will havein the order rules are run. Change this number to a higher number than the last rule in the list to moveit to the end of the list.

2. the regular expression in theRule field.3. the relative path on the target Infrastructure Item in the Target Path field.

Double-click an existing rule or select it and click the Edit button to change its settings.

To delete a Deployment Rule, select it then click Delete. ClickOK to confirm or click Cancel to keep therule.




DROPS v2.8.1User Guide | 20 Working with Deployment Schemas

20.4 Deleting Deployment Schemas

Warning!Deleted Deployment Schemas cannot be accessed or recovered.

Any Deployment Rules defined in a deleted Schema are also deleted.

To delete a Deployment Schema, either right-click on it in the Deployment Schemas view and selectDelete, or select it and click the Delete icon. ClickOK to confirm or click Cancel to keep the Schema.



DROPS v2.8.121 Working with Replacement Rules | User Guide

21 Working with Replacement Rules

Required Roles n/a

Required Rights(by category) Replacement Rules


Access DROPS Server→ Configuration→ Replacement Rules

Chapter Summary21.1 Accessing Replacement Rules 11821.2 Creating Replacement Rules 11921.3 Editing Replacement Rules 11921.4 Deleting Replacement Rules 120

Replacement Rules are similar to a Search & Replace on configuration files linked to an Application. Rulesenable you to activate specific commented content in Artifacts such as .properties files during deployment.This means that commented content can be selected and rendered active by automatically removing thecomment tag. The now-active content will be taken into account during the Deployment Process.

Replacement Rules are run at the beginning of the Transfer Stage of the Deployment Process if the UseReplacement Rules checkbox is ticked in the Transfer tab of a Deployment Process’ Properties view.

Files to use in relation to Replacement Rulesmust be prepared in advance. Replacement Rules areconfigured to read and convert specific comment tags which are unique to the file type. Multiple Rules canbe created but a single Rule can only refer to one file type.

Substitution Variables are often used in commented content in order to substitute the value of eachvariable with the correct context-specific content related to the different Infrastructure Items you deployto.

Important!If multiple Rules are defined they willALL be applied during theDeployment Process.

ExampleYou havemultiple Infrastructure Items that are all similar servers. They areso similar that they use the same .properties file, except there are somelines in that common properties file that are specific to each individualserver. Use a Replacement Rule to call out only the server-specificinformation for each Infrastructure Item by including all of the informationfor every server in the .properties file and turning them all into comments.Create a Rule for each Infrastructure Item that calls only the instructionspecific to the server it points to and ignores the commented content thatrefers to the other servers.

A Rule for Infra1 would pull the information between #Infra1_START and#Infra1_END into action in order to connect to the Infra1 server but it



DROPS v2.8.1User Guide | 21 Working with Replacement Rules

would not recognize the comments made for Infra2 because the Rule onlyrefers to the content between the two delimiters defined.

Figure 36: Example of a .properties file prepared for Replacement Rules

21.1 Accessing Replacement Rules

To access the Replacement Rules view, select the Replacement Rules node in the ConfigurationExplorer.

The Replacement Rules view displays all of the Rules defined for the current server.

Figure 37: The Replacement Rules view



DROPS v2.8.121 Working with Replacement Rules | User Guide

21.2 Creating Replacement Rules

NoteOnly file types that use an in-line delimiter on every line of a comment canbe referenced in Replacement Rules, such as properties files which use thepound symbol (#) at the beginning of every line of commented content.

Do NOT use .xml files. Comments are encased in beginning and ending  comment tags that are not recognized by Replacement Rules.

Follow the subsequent steps to create a newReplacement Rule.

Step 1 To access the Create a new Replacement Rule wizard, either click the Create icon in theReplacement Rules view or right-click anywhere in the view and select Create a newReplacement Rule.



Result NewReplacement Rules are available in the Replacement Rules view.

21.3 Editing Replacement Rules

To edit Replacement Rule details, either right-click on it in the Replacement Rules view then selectEdit, select the item then click the edit icon or double-click it. The Rule editor is opened where all ofthe entity's details aremanaged.

Figure 38: The Replacement Rules editor

Field Description

File Extensions The file extension to which the Rule should be applied. Use a RegEx here to apply theReplacement Rule to multiple files of the same type.

Comment StartDelimiter The first line of the commented content to replace.

Table 16: Edit Replacement Rules

DROPS v2.8.1User Guide | 21 Working with Replacement Rules

Field Description

Comment EndDelimiter The last line of the commented content to replace.

In LineDelimiter

The file type-specific comment symbol (tag) that the Rule should recognize. Thecomment delimiter is different for many file types:

l # - .properties files use the pound/hashtag symbol on every line of the comment.l rem - Windows batch files use the string 'rem'.l ; - .inf files use the semi-colon on every line of the comment.

Only the symbol or string that represents the commented content for the file typedefined in the Field Extensions field should be entered here.

Table 16: Edit Replacement Rules

21.4 Deleting Replacement Rules

Warning!Deleted Replacement Rules cannot be accessed or recovered.

To delete a Replacement Rule, either right-click on it in the Replacement Rules view and selectDelete, or select it and click the Delete icon. ClickOK to confirm or click Cancel to keep the Rule.



DROPS v2.8.122 Working with scripts | User Guide

22 Working with scripts

Required Roles n/a

Required Rights(by category) Scripts


Access DROPS Server→ Configuration→ Scripts

Chapter Summary22.1 Searching for scripts 12222.2 Creating scripts 12322.3 Importing scripts 12422.4 Editing scripts 12522.5 Exporting scripts 12822.6 Executing scripts 12922.7 Deleting scripts 130

Scripts contain one or more Ant tasks and provide coded instructions to carry out jobs for DROPS and/ortarget systems.

Actions in the Deployment Process Diagrams call ANT scripts. These ANT scripts are sets of ANT tasks.These ANT tasks are written in Java and are stored in libraries (.jar files). When ANT executes a script, itlooks for these libraries to find the tasks build into each script. The path to the directory holding thelibraries is called the ANTLIB.

DROPS provides a number of built-in scripts by default which cannot be edited but can be duplicatedthen modified if you need to make adjustments. The ANTLIB that contains all of these built-in scripts isincluded in the installation. The default, built-in ANTLIB can be updated when the database is updated torecover any modifications to default scripts or new scripts we create.

There are two ways to create brand-new, customized scripts. Use external, valid Ant projects to create newscripts that use previously-defined tasks or create new scripts manually from scratch directly in theDROPS Studio. Scripts that you create can bemodified at any time. Any kind of script can be exported andshared (imported into another DROPS Server). You can also duplicate built-in scripts to copy informationfrom them and customize a version for yourself.

Version control for DROPS scripts is an important feature that enables you to "close" valid scripts andmodify different versions of them as their purpose(s) evolve. Deployment Processes also use the sameversion control techniques. When a Process is validated, both it and all of the scripts used inside it arelocked to ensure that approved Processes and their scripts cannot be edited.

NoteThis documentation does not cover the content of Ant projects.

ReferenceFor more information about how to create a valid Ant project, refer to the



DROPS v2.8.1User Guide | 22 Working with scripts

Apache Ant documentation.

For detailed information about the parameters for each built-in script fromDROPS, refer to theDROPS Script Reference Guide or theDocumentationsection in each script.

22.1 Searching for scripts

Follow the subsequent steps to search for scripts.

Step 1 Select Scripts from the Configuration node in the Configuration Explorer.

Figure 39: The Scripts search view

Step 2 When the search view is opened, the list of scripts is empty. Use the search criteria sections to filterthe search.

l To search for a script by itsName, enter all or part of the information in the correspondingfield.

l To search for a script by category or the platform on which it can run, select thecorresponding option from one of the drop-down lists.



Result The Scripts search view displays all of the scripts, ordered by category, that meet the searchcriteria.

TheName column displays each of the categories' and individual scripts' name. The Identifiercolumn displays the unique ID of each script when a category is expanded.




22.2 Creating scripts

There are two ways to create Scripts:

1. Create a brand new script using the Create a new script wizard.2. Duplicate an existing script to quickly create a copy of the script that can bemodified.

22.2.1 Create a new scriptCreating a new script enables you to duplicate it later.

Follow the subsequent steps to create a new script.

Step 1 Click the Create icon in the Scripts search view or right-click anywhere in the view and selectCreate a new script to open the Create a new script wizard.

Step 2 Define the Identifier, Name and Script Category. These values can be edited later. The script'sExecution Platform is not mandatory.


Step 3 The new script's version is automatically 1.0. Document the initial version of the script by addingcomments.


Step 4 The final page of the dialog enables you to select an Ant file to use as the content of the script.


Result New scripts are displayed in the Scripts search view. Each script is nested under itscorresponding category.

22.2.2 Duplicate a scriptDuplicating a script is a quick way to apply existing script details or content to a new script.

Step 1 To open theDuplicate Script wizard, either select an existing script in the list then click the Duplicate icon in the Scripts search view, or right-click on it and select Duplicate.

Script content can also be duplicated by clicking the Duplicate icon in an open Script editor.

Step 2 Select the version of the original script to duplicate. By default, themost recent version is selected.


Step 3 Define the new script’s Identifier, Name and Script Category. These values can be edited later butmust be unique. The script's Execution Platform is not mandatory.





Result Duplicated scripts are displayed in the Scripts search view. Each script is nested under itscorresponding category.

22.2.3 Create a new version of a scriptTo create a new version of the script click New. The Create a new script wizard opens. To delete aversion of the script, select it and click Delete.

Version UpgradeEnter a description of the new version of the script.

SelectMajor Upgrade to increase the version number from 1.0 to 2.0 for example.

SelectMinor Upgrade to increase the version number from 1.0 to 1.1 for example.

ANT ProjectThe final page of the dialog enables you to select an Ant file to use as the content of the script.

Table 17: Create a new version of a script

22.3 Importing scripts

Archive (*.dxml) or simple (*.xml) script files that were previously exported fromDROPS can be importedinto DROPS again to create new scripts. This is an easy way to recuperate scripts from other DROPSServers.

When imported, the script's Identifier, Script Category and any of the other prepopulated details that comefrom the original exported script are retrieved from the XML structure's content, even if the values havechanged. This ID and the defined category are what registers the script as unique and is prepopulatedautomatically. In order to create a valid script in DROPS, the imported script must be a valid ANT projectand reference these <script> tags.

Importing a script enables you to modify and duplicate it later.

Follow the subsequent steps to import a DROPS script file.

Step 1 Click the Import icon in the Scripts search view, or right-click anywhere in the view and selectImport a script file.

Step 2 Select the .dxml or .xml file by clicking the Browse button.


Result If the selected script file has the same ID as an existing script, DROPS asks if it is amajor upgradefor the existing script.

l Clicking No imports the script as a minor upgrade for the existing script, changing the versionnumber from 1.0 to 1.1, for example.

l Clicking Yes imports the script as a major upgrade for the existing script, changing theversion number from 1.0 to 2.0, for example.




If an imported script file references a category that does not exist in DROPS, a new category iscreated with the name defined in the script.

If the script file has a unique ID, it is imported as a new script under the category defined (version1.0).

22.4 Editing scripts

The ANT project content of a script can be edited as well as the identification details and the variables ituses.

22.4.1 Edit script detailsTo edit script identification details, either right-click on it then select Edit, select the item then click the Edit icon or double-click it. The Script editor is opened where all of the entity's details aremanaged.

NoteIf a script is built-in, its details cannot be edited. The Script editor isopened in read-only mode.

Figure 40: The Script editor

ReferenceFor more information about the different actions managed from the tabs




in the Script editor that are not described in this chapter, refer to:


Field Description

Identifier A unique string that identifies scripts. This label is used throughout DROPS to select theentity.

Name A label used to give additional information about the script. This label is usedthroughout DROPS to select the entity.

ScriptCategory The category under which the script is nested.

ExecutionPlatform

[Optional] If the script should or can only be used on a certain platform, select it fromthe drop-down list.

VersionUpgrade Enter a description of the current version of the script.

Documentation Enter a general description of the script.Table 18: Edit script details

If the content of the script contains variables, create references to them in the Parameters tab. The valuesfor these variables are defined in the Script tab in the Deployment Diagram's Actions' properties.

ReferenceFor more information about defining the values for a script's parameters,refer to Edit Deployment Action properties on page 157.

Variables in the script's content are always referenced using the following syntax: ${Variable name}.

Click New to open the Script Parameter Definition dialog.

To edit a parameter, select it and click Edit.

To delete a parameter, select it and click Delete.

Field Description

Parametername A unique string that identifies the parameter.

VariableName The exact text used in the ${Variable name} variable found in the content of the script.

Data Type String: The content of the parameter is intended to be a string of characters (text).

Numeric: The content of the parameter is intended to be a string of numbers.Table 19: Script parameters




Field Description

Boolean: The content of the parameter is intended to be 0/1, True/False or Yes/No.

Date: The content of the parameter is intended to be a date.

DefaultValue

Enter a default value for the parameter. This can be overridden when editing theDeployment Action parameters in the Deployment Process Diagram.

OutputParameter

Tick this checkbox if the script should produce an output to be sent back in order to createanother parameter to be used after the task is over in another part of the DeploymentProcess Diagram.

IsMandatory Tick this checkbox if the parameter is mandatory and a valuemust be defined.

Description Enter a description of the parameter.Table 19: Script parameters


22.4.2 Edit script contentEditing the content of a script can be done directly in DROPS. DROPS uses Eclipse's Ant Editor which offersshortcuts (Ctrl+space) to provide easy access to all of the Ant project templates, tasks, parameters andvariables available.

Select a script from the list and click the Edit Content icon or right-click on a script and select EditContent. Script content can also be edited by clicking the Edit Content icon in the Script editor.

The Script content editor is opened where you can write or edit the content of any script except thebuilt-in scripts provided by DROPS.

NoteIf a script is “built-in”, its content cannot be edited. The Script contenteditor is opened in read-only mode.




Figure 41: Edit script content

Important!When creating or modifying scripts, the content must be a validANT project.


22.5 Exporting scripts

Exporting scripts is useful when sharing scripts between multiple DROPS servers or Users. When exported,DROPS scripts contain all of the details entered in the Script editor. Scripts that are exported from oneserver can be imported into another. Importing scripts into the new server is made easy because DROPSinterprets the ID and category, as well as any version or other information, and prepopulates these fields inthe editor automatically.

NoteTo use an external script file in DROPS, create a new script and attach theexternal file using the Create a new script wizard.




Figure 42: Example of an exported script

Scripts are exported in .xml format.

Follow the subsequent steps to export scripts.

Step 1 Either right-click on the script in the Scripts search view then select Export a script file, orselect the script then click the Export icon.

Scripts can also be exported by clicking the Export icon in an open Script editor.

Step 2 If you want to import the script into another server and have it be considered “built-in” in the newserver, clickOK in the dialog box. If you want to be able to edit the script in another server(consider it not “built-in”), click Cancel.

Step 3 Select the location in which to save the script and change the File name if needed. By default,scripts are exported with the File name {identifier}.xml.

If a script has multiple versions, the name is changed to {identifier}_{VersionNumber}.xml.

Step 4 Click Save.

22.6 Executing scripts

To test that a script functions correctly before using it in a Deployment Process, execute it. The ExecuteScript wizard recreates the external delivery Environment in a test scenario.

Step 1 To open the Execute Script wizard, either select a script from the Scripts search view and clickthe Execute icon, or right-click on a script and select Execute Script.

Script content can also be executed by clicking the Execute icon in an open Script editor.

Step 2 Modify the script's parameters in theValue column. This page recreates the Script tab in theDeployment Diagram's Action's properties.

If a parameter is not given a value, it will not be referenced when the script is tested.




Variables can be used as parameter values.

ReferenceFor more information about variables, refer to SubstitutionVariables in the appendix.


Step 3 Select the Infrastructure Item on which to test the script. It is suggested to test the script on thesame Item it is intended to be run on in the Deployment Process.

The list of Infrastructure Items is prepopulated with all of the Items defined on the current server.


Step 4 Attach an external properties file, if needed. Recreating the access properties required duringdeployment may be required.

Click the Browse button to select a .properties file.

ExampleEvery deployment is assigned a Transaction ID in order to facilitaterollback. This number will not be generated in a testenvironment. Creating an external properties file that contains adummy Transaction ID enables you to test the rollback function ina script.


Result The DROPS Agent on the target Infrastructure Item produces the results log. It is openedautomatically in the default text editor enabling you to verify that the script executed correctly.

22.7 Deleting scripts

Warning!Deleted scripts cannot be accessed or recovered.

To delete a script, search for it in the Scripts search view. Either right-click on it and select Delete, orselect it and click the Delete icon. ClickOK to confirm or click Cancel to keep the script.



DROPS v2.8.123 Working with Deployment Process Diagrams | User Guide

23 Working with Deployment Process Diagrams

Required Roles n/a


ClientsEnvironmentsDeployment Process DiagramsScripts


Access DROPS Server→ Configuration→ ( Client→ ) Environments→ click onEnvironment→ Process List

Chapter Summary23.1 Accessing Deployment Processes 13123.2 Creating Deployment Processes 13223.3 Changing a Deployment Process' status 13523.4 Defining Default Deployment Processes 13523.5 Deleting Deployment Processes 13523.6 Building Deployment Process Diagrams 13623.7 Editing Deployment Process properties 146

All of the entities configured in the Artifact and Infrastructure Repositories come together during theDeployment Process. Application(s) and the Component(s) to deploy are joined with the targetEnvironment(s) and specific Infrastructure Item(s) in Deployment Process Diagrams. It is in these diagrams,the key elements in your process, that the final location for the content to deploy and the actions to carryout during deployment are defined.

The deployment process is represented by the diagram in order to easily define and display the Activitiesand Stages required to successfully deploy Releases to each Infrastructure Item.

23.1 Accessing Deployment Processes

To access the Process List view, first open the Environments view. Either click on an Environment,right-click it and select Show Process List, or select it and click the Process icon to display the list ofProcesses associated with it.

NoteIt is recommended to open the Process List view in a different areathan the Environments view. If both views are tabs in the same area, itis difficult to access the Environment editor.

ReferenceFor more information about the Environments view, refer to Workingwith Environments on page 84.



DROPS v2.8.1User Guide | 23 Working with Deployment Process Diagrams

The Process List view displays all of the Processes defined for the current Environment.

Figure 43: The Process List view

23.2 Creating Deployment Processes

There are two ways to create Deployment Processes:

1. Create a brand newProcess using the Create a new Deployment Processwizard.2. Duplicate an existing Process. Duplicating creates a copy of an existing Process that can bemodified.

23.2.1 Create a new Deployment ProcessCreating a new process enables you to duplicate it later.

Follow the subsequent steps to create a newDeployment Process.

Step 1 Click the Create icon in the Process List view or right-click anywhere in the view and selectCreate a new Deployment Process to open the Create a new Deployment Processwizard.

Step 2 Define the Process Code and Process Name. These values can be edited later.

Step 3 Select the Application to associate with the Process. This is the Application that contains theArtifacts to deploy to the Environment.

Important!Make sure to select the correct Application! Once you click Finishand create a Deployment Process, you cannot change theApplication associated with it.

Step 4 Select the Infrastructure Item(s) to use in the Deployment Process Diagram. The list of Items isprepopulated with all of the Items defined for the selected Environment. If no Item is selected, theDeployment Process Diagramwill include all of the Infrastructure Items defined for theEnvironment.

NoteInfrastructure Items can be added and removed from the Diagramafter it is created, also.





Result NewDeployment Processes are available in the Process List view after refreshing the list. It isvery important to continue configuring a Process after it’s created before using it.

ReferenceFor more information about building and configuring DeploymentProcess, refer to Building Deployment Process Diagrams onpage 136 and Editing Deployment Process properties onpage 146.

23.2.2 Duplicate a Deployment ProcessDuplicating a Deployment Process defined for an Environment is a quick way to apply an existing methodof deploying content to another set of Infrastructure Items on a different Environment.

ExampleYou have similar Infrastructure Items in two different Environments. Theyboth require the sameDeployment Process. Instead of creating the sameprocess twice, create it once then duplicate it and manually define which ofthe original Items' Processes should be "copied" and applied to the similarItem in the second Environment.

Important!You cannot change the Application associated with a Process when youduplicate it. The newProcess will deploy the same Application as theoriginal.

Follow the subsequent steps to duplicate an existing Deployment Process in order to create a newProcess.

Step 1 To open theDuplicate a Deployment Processwizard, either select an existing Process in theProcess List view then click the Duplicate icon, or right-click on it and select Duplicate.

Step 2 Define the new process’ Process Code and Process Name. These values can be edited later butmust be unique.


Step 3 Select the version of the existing Process to duplicate.


Step 4 Define the Environment for the newProcess.

NoteIf you do not tick the Change the target Environment checkbox,the newProcess will be copied to the current Process' Environmentand use the original Infrastructure Items.

1. To change the Environment and the Infrastructure Items for the new process, tick theChange the target Environment checkbox, then select the new Environment from thedrop-down list.




The list of Environments to select is prepopulated with all of the Environments defined for thecurrent server that include the original process' Application in theAllowed Applicationsmanager. You cannot change the Application the process is linked to when duplicating it, so itmust also be allowed to be deployed to the new Environment.

Select the original Environment to duplicate the Process using different Infrastructure Items.

Important!Make sure to select the correct Environment. Once you clickFinish and create the Process, you cannot change theassociated Environment.

2. To define which of the new Environment's Infrastructure Items should use the Processesdefined, map the original Items to the new Environment's Items. The items from the originalprocess already contain defined stages and actions. In order to ensure their diagrams arematched to similar Infrastructure Items in the newProcess, define which of Items in theoriginal Process should bemapped to each target Infrastructure Item.

The Infrastructure Items that the original Process references are listed in the SourceInfrastructure Item column. Match an original Item to an Item in the new Environment bydouble-clicking in the corresponding Item's row in the Target Infrastructure Item column.

The Infrastructure Item Selection dialog is prepopulated with all of the Infrastructure Itemsdefined in the selected Environment that are also the same Type as the original InfrastructureItem. Requiring that the Types of both the original and new Items are the samewhenduplicating a Process ensures that the Actions defined in the Process are applicable to bothInfrastructure Items.

Important!Make sure to select the correct Infrastructure Item in themapping dialog. Once you clickOK and map the Process, youcannot change the individual Infrastructure Item. To reset allof themapped Items, reselect the Environment from theTarget Environment drop-down list.

All of the original Items must bemapped to a new Infrastructure Item to finish theduplication. You can edit, add and remove Items from the newProcess once it is created.


Result NewDeployment Processes are available in the Process List view after refreshing the list. It isvery important to continue configuring a Process after it’s created before using it.

ReferenceFor more information about building and configuring DeploymentProcess, refer to Building Deployment Process Diagrams onpage 136 and Editing Deployment Process properties onpage 146.




23.3 Changing a Deployment Process' status

To change the Deployment Process status, either right-click on it in the Process List view then selectChange Status or select it, then click the Change Status icon.

The list of available Deployment Process statuses is prepopulated with the statuses defined by theadministrator in the Preferencesmenu.

If a Deployment Process is marked as Production Status, it means that the Process has been validated andcannot bemodified.

ReferenceFor more information about defining statuses, refer to theDROPSConfiguration Guide.

23.4 Defining Default Deployment Processes

Defining a default Deployment Status for an Environment is not required but it is useful when creatingmultiple Deployment Process Instances at the same time using Environment Groups. The defaultDeployment Process for an Environment is always used as the process to deploy when multipleDeployment Process Instances are created using Environment Groups. Default Deployment Processes areindicated by the default icon in the Process List view.

Because Environment Groups can sharemore than one common application, default DeploymentProcesses are defined per Application. An Environment can havemultiple default Processes but only oneper Application. If a different Deployment Process with the same Application is already defined as thedefault, selecting another and clicking the Default icon will remove the title from the previous Process.

To define the default Deployment Process for an Environment, select it from the Process List view theneither right-click and select Set As Default or click the set default icon in the local toolbar.

To remove the default status of a Deployment Process, select it from the Process List view then eitherright-click and select Remove As Default or click the set default icon in the local toolbar.

ReferenceFor more information about the entities mentioned above, refer to:

l Working with Environments on page 84l Working with Environment Groups on page 93l CreateMultiple Instances to deploy one Release to an EnvironmentGroup on page 190

23.5 Deleting Deployment Processes

Warning!




Deleted Deployment Processes cannot be accessed or recovered. AnyDeployment Process Instances created from the Process are deleted aswell.

To delete a Deployment Process, either right-click on it in the Process List view and select Delete, orselect it and click the Delete icon. ClickOK to confirm or click Cancel to keep the Deployment Process.

23.6 Building Deployment Process Diagrams

The Deployment Process Diagram is a visual representation of the Deployment Process for one specificEnvironment. All of the actions and parameters that define a Deployment Process are configured in theDiagram. Diagrams can bemanaged manually or can call pre-defined templates that can be used asbuilding blocks to include consistent parameters in multiple diagrams.

Figure 44: The Deployment Process editor

ReferenceFor detailed definitions of the different elements in the Process Diagram,refer to the Glossary.

23.6.1 Manage Deployment Activities

Activities are the sum of all the Actions taken for an Infrastructure Item or the initialization or finalizationphases during the Deployment Process. They contain the different Deployment Actions to carry out.




Deployment Actions are driven by scripts which each carry out a specific ANT project. Actions are addeddirectly to the Initialization and Finalization activities during which no Artifacts aremanaged.These first and last phases' tasks should not be related to actually deploying content. They cannot beremoved from the Deployment Process Diagrams but do not require Actions.

Infrastructure Item Activities are for individual Items and are unique because each onemay havespecific requirements or because the Components deployed to multiple Items may need to be treateddifferently depending on the target setup. Therefore, the actions needed to properly deploy content to atarget service are defined inside each individual Infrastructure Item Activity in the diagram. Artifacts aredeployed during these phases and actions specific to deploying content are divided into stages. Stagesdefine where and when actions are carried out.

By default, the Infrastructure Items associated with the Environment and selected when creating theDeployment Process are included in a newDeployment Process Diagram. They are represented by Infrastructure Item Activities. NewActivities can be added only if new Infrastructure Items are added to theEnvironment or all of the Items were not selected when the Process was created.

23.6.1.1 Create a new Deployment Activity

NoteNew Initialization or Finalization Activities cannot be added.

Follow the subsequent steps to create a new Infrastructure Item Activity.

Step 1 Click theDeployment Activity node in the right-hand menu.

Step 2 Draw a box in the grid for the newActivity, guided by the shaded outline.

Figure 45: Create a new Infrastructure Item Activity

Step 3 From the dialog box that is automatically displayed, select the corresponding Infrastructure Itemand clickOK.




NoteIf the dialog box is not displayed, there are no Infrastructure Itemsassociated with the Environment that can be added to theDiagram. All of the Items must already have an Activity in theDiagram.

Result The new Activity is automatically linked to the Infrastructure Item and is ready to beedited and linked to its parent and child Activities.

Step 4 Click on the Activity to modify its properties.

ReferenceFor more information about editing an Activity's properties, referto Edit Deployment Activity properties on page 152.

Step 5 Right-click on the Activity and select Edit > Component to view and modify the Componentdefined for the Infrastructure Item if one has already been defined in the Activity's Properties.

Warning!Infrastructure Item Activitiesmust be linked to a Component inorder to save the Deployment Process. If you do not add aComponent to every Activity and you close the DeploymentProcess Diagram editor, all changes will be lost.

ReferenceFor more information about editing Components, refer toWorking with Components on page 56.

Step 6 Right-click on the Activity and select Edit > Infrastructure Item to view and/or modify theInfrastructure Item.

ReferenceFor more information about editing Items, refer to Working withInfrastructure Items on page 97.

Step 7 Save the changes (Ctrl+S or File > Save).

23.6.1.2 Use a Deployment Activity TemplatePre-defined Deployment Activity Templates can be included in any Deployment Process Diagram. Theymust include pre-defined Stages (with Actions included) and its properties must always be defined in theTemplate. The only elements in an Activity Template that can bemodified are the Component to deployand the Transfer options. When a template is used in a Diagram, the Activity or Stage is dark blue, insteadof the default gray. The difference in color makes it easy to see which parts of a diagram are inherited froma template and which are unique.




Figure 46: Activity Templates in the Deployment Process Diagram

Follow the subsequent steps to use a Deployment Activity Template in a Process Diagram.

Step 1 Create the box for a newDeployment Activity and select the Infrastructure Item to use.

Step 2 Link the Activity to its parent and child Activities.

ReferenceFor more information about linking Activities, refer to Define theorder in which to deploy Activities below.

Step 3 Right-click on the Activity and selectUse Template Activity.

Step 4 Select the Deployment Activity Template from the Process Template Selector dialog. This list isprepopulated with all of the Activity Templates available on the current DROPS Server.

Step 5 ClickOK.

Result The Activity element is now dark blue which implies that the template is applied.

Step 6 Configure the Component to deploy and the Transfer options in the Activities Properties view.

Warning!Infrastructure Item Activitiesmust be linked to a Component inorder to save the Deployment Process. If you do not add aComponent to every Activity and you close the DeploymentProcess Diagram editor, all changes will be lost.


23.6.1.3 Define the order in which to deploy ActivitiesThe hierarchical order in which the Activities in the Deployment Process are carried out is defined by theblack arrows that connect them. The flow of the Deployment Process follows the direction of the arrows.

By default, the Initialization Activity is the first Activity carried out in order and the Finalization thelast. Between the two, Infrastructure Item Activities can be carried out in a defined uni-lateral order or




simultaneously by linking two Activities to the same parent Activity. If a newDeployment Process containsmultiple Infrastructure Items, they are configured to be deployed simultaneously by default (they are bothautomatically children of the Initialization Activity).

Figure 47: Create ordered connections between Deployment Activities

Follow the subsequent steps to create connections between Deployment Activities.

Step 1 Hover over the Activity that should be carried out first during deployment.

Step 2 Click the Create connection icon and drag the cursor to the next Activity, guided by the orangedotted line.

Step 3 When the connection is made the orange line changes to a black arrow that confirms the sourceActivity will be carried out before the second Activity. The second Activity will not begin until thefirst is complete.


Warning!Infrastructure Item Activitiesmust have both a parent and a child Activity inorder to save the Deployment Process. Most commonly, the parent will bean Initialization Activity and the child a Finalization Activity. If youdo not define both parent and child Activities for every Infrastructure ItemActivity and you close the Deployment Process Diagram editor, all changeswill be lost.

To delete a connection, select the arrow and press the Delete key.

23.6.1.4 Rearrange Deployment Activity boxes

The Select and Marquee tools enable you to select individual or several Activities in the diagram tomove them around the grid. Use these tools to visually reorder the boxes on the screen.




To select multiple Activities, the whole Activity box must be included in the square drawn with theMarquee tool to include it in the section.

NoteMoving the Activities around the screen does not change the order thatActivities are carried out. Only the black connection arrows define theorder.

23.6.1.5 Delete Deployment Activities

NoteInitialization and Finalization Activities cannot be deleted.

Warning!Deleted Deployment Activities cannot be accessed or recovered. Anyassociated Stages and any Actions defined inside them are also deleted.

Deleting an Activity Template from a Deployment Process Diagram doesnot delete the template itself.

To delete an Activity, hover over its title bar and click the Delete icon or right-click on the bar and selectDelete. ClickOK to confirm or click Cancel to keep the Deployment Activity.

23.6.2 Manage Deployment Process Stages

Stages are linked to themode in which a deployment is executed and are always carried out in a specificlocation. They are added to Activities to regroup Deployment Actions in order to define where and whenthey are carried out. There are four types of stages:

1. The Preparation Stage executes Actions to prepare or transform the necessary Artifacts beforetransferring them to the target Infrastructure Item. This is the first Stage carried out when theDeployment Process is executed. All Actions are performed on the DROPS Server. This Stage is notmandatory.

2. The Transfer Stage is always performed behind the scenes and cannot be modified. The Artifacts aretransferred to the Infrastructure Item using the DROPS Agent running on the remote service.

The Transfer Stage is only activated (meaning files are transferred from the DROPS Server to thetarget DROPS Agent/Infrastructure Item) if either a Receiving or an Installation Stage is defined in theActivity. You can force the transfer of content without defining these Stages by ticking the ForceTransfer checkbox in the Activity's properties.

NoteIf a Deployment Schema is included in the Infrastructure Item, it isapplied during this Stage. If not, the Artifacts are copied directly fromthe Artifact Repository to theRoot Directory defined in theInfrastructure Item.




ReferenceFor more information about Schemas, refer to Working withDeployment Schemas on page 113.

3. TheReceiving Stage is intended to enable you to modify the deployed Artifacts once they areavailable in the Root Directory on the target Infrastructure Item. The Deployment Process can besuspended after this Stage in order to work with Artifacts before installing them onto the target item.This Stage is not mandatory.

If you execute a Deployment Process Instance in Transfer-Only mode, the process stops after thisStage is complete.

NoteFor DROPS for z/OS, the Library Name Replacement Rule xml file isgenerated according to the parameters defined for the InfrastructureItem during this Stage.

4. The Installation Stage executes Actions to deploy the Artifacts to their final destination on theInfrastructure Item. This Stage is not mandatory.If you execute a Deployment Process Instance in Transfer-Only mode, once it's finished, manuallyexecute the Instance in Installation-Only mode which executes only the Actions contained in theInstallation Stage.

23.6.2.1 Add new Stages to Deployment Activities

Figure 48: Add Stages to Activities

To add Stages to an Activity, right-click on it and hover over Add stage. Select the Stage to add. The newStage is added to the Activity and must be filled with at least one Deployment Action.


23.6.2.2 Add Template Stages to Deployment ActivitiesPre-defined Stage Templates can be included in any Activity in a Deployment Process Diagram except aDeployment Activity Template. They must include pre-defined Actions and can only bemodified in the




Template editor. When a template is used in a Diagram, the Activity or Stage is dark blue, instead of thedefault gray. The difference in color makes it easy to see which parts of a diagram are inherited from atemplate and which are unique.

Follow the subsequent steps to add a Stage Template to a Deployment Activity.

Step 1 Right-click on the Activity and select Add Template Stages.

Step 2 Select the Stage Template from the Process Template Selector dialog. This list is prepopulatedwith all of the Stage Templates available on the current DROPS Server.

Step 3 ClickOK.

Result The Stage element is now dark blue and the template is applied.


23.6.2.3 Delete Stages from Deployment Activities

Warning!Deleted Stages cannot be accessed or recovered. Any associated Actionsare also deleted.

Deleting a Stage Template from an Activity does not delete the templateitself.

To delete a Stage, hover over its title bar and click the Delete icon or right-click on the bar and selectDelete. ClickOK to confirm or click Cancel to keep the Stage.

23.6.3 Manage Deployment Actions

Actions are carried out sequentially in their parent Activity following the uneditable order of their parentStages.

23.6.3.1 Add Deployment Actions to Activities and StagesFollow the subsequent steps to add Deployment Actions to an Initialization or Finalization Activity or to aStage in an Infrastructure Item Activity. Activities cannot be added to template Activities/Stages.

Drag and drop actions inside their parent containers to reorder them.

Step 1 Click and hold theAction node in the right-hand menu.

Step 2 Drag your cursor to the Activity or Stage.




Figure 49: Drag and drop Actions into Activities or Stages

Step 3 Releasing opens the Script Selection dialog where you select the Action's script.

Use theName, Script Category and Execution Platform fields to filter the list of scriptsdisplayed on the right. Click the Search button to display all of the scripts available.

Important!When you have selected a script, be sure to also select theVersionof the selected script to ensure you have the correct file.

ClickOK.

Result The newAction is automatically created in a blue box and is ready to be configured.

ReferenceFor more information about editing an Action's properties, refer toEdit Deployment Action properties on page 157.

Right-click on the blue Action box and select Edit > Script to modify the identification details ofthe script defined for the Action.

Right-click on the blue Action box and select Edit > Script Content to modify the version of theANT script used in the diagram (defined for the Action).

ReferenceFor more information about editing scripts, refer to Edit scriptdetails on page 125 and Edit script content on page 127.





23.6.3.2 Delete Deployment Actions

Warning!Deleted Deployment Actions cannot be accessed or recovered.

To delete a Deployment Action, hover over the blue bar and click the Delete icon or right-click on the barand selectDelete. ClickOK to confirm or click Cancel to keep the Action.

23.6.4 Create "Wait For" Connections

Creating connections between Deployment Actions enables you to define which Action(s) should not beginuntil another Action in the Process defined for another Activity has completed. If an Action is linked toanother Action it will wait for that Action to finish before it begins.

Figure 50: Create "wait for" connections between Deployment Actions

Follow the subsequent steps to create a "wait for" connection between Deployment Actions.

Step 1 Hover over the Action that should wait.

Step 2 Click the Create "wait for" connection icon and drag the cursor to the Deployment Action thatmust complete, guided by the orange dotted line.

Step 3 When the connection is made the orange line changes to a blue arrow that confirms the sourceAction must "wait for" the second Action to complete before it can begin.

To delete a "wait for" connection, select it and press the Delete key.


23.6.5 Print Deployment Process Diagrams

Right-click on any Activity, Stage or Action in a Deployment Process Diagram, or anywhere in the emptygrid, then select Print to print a section of or the whole Deployment Process Diagram.




23.7 Editing Deployment Process properties

There are three levels of properties to define for a Deployment Process:

l The Global-level, where properties that affect the whole Deployment Process are defined.l The Activity-level, where properties that affect only the Initialization and Infrastructure Item Activitiesare defined.

l The Action-level, where properties that affect each individual Deployment Action are defined.

Selecting the element for which to edit the properties in the Deployment Process Diagram opens thecontext-sensitive Properties view.

NoteClick the Pin icon in this view to remove the context-sensitiveproperty. Clicking this icon ensures that the current entity's properties willstay in the view, even if you navigate away from that entity in the editor. Ifthe pin in not activated, the properties in the Properties viewwill changedepending on what entity is currently selected in the editor.

23.7.1 Edit global Deployment Process details

To edit Deployment Process details, either right-click on the Process in the Process List view then selectEdit Details or select it, then click the Edit Details icon. The Process editor is opened.




Figure 51: The Deployment Process details editor

Field Description

ProcessCode

A unique string that identifies the Deployment Process. This label is used throughout DROPS toselect the entity.

ProcessName

A label used to give additional information about the Deployment Process. This label is usedthroughout DROPS to select the entity.

RelatedEntities

The Process' Application and Environment fields are not editable. These values cannot bechanged for an established Deployment Process. Create a new process to change theApplication deployed to the current Environment. To change the Environment that the currentApplication is deployed to, duplicate the existing process.

ProcessVersion The current version of the Deployment Process.

ProcessStatus

The current status of the Deployment Process. Status are defined in the Preferencesmenu. If aDeployment Process is marked as Production Status, it means that the Process has beenvalidated and cannot bemodified.

ReferenceFor more information about changing a Process' status, refer toChanging a Deployment Process' status on page 135.

Table 20: Edit Deployment Process details





Warning!If there are errors in the Process Diagram and DROPS cannot save it, theInvalid Items view displays the problem.If you close the Process

without fixing the issues listed and successfully saving, any changes will belost! To check if a Diagram is valid at any time, right-click on any of theelements and select Check Process.

ReferenceRefer to the Troubleshooting guide in the appendix for more details on thedifferent reasons a diagram cannot be saved.

23.7.2 Edit global Deployment Process properties

To edit the global Deployment Process properties either right-click on the Process in the Process Listview then select Edit, select it then click the Edit icon or double-click it.

If the Properties view is already opened, navigating to the Deployment Process Diagramwill open theglobal properties in that view.

Figure 52: The Deployment Process properties editor

The tabs on the left enable you to modify the Process' different global properties.

Tab Field

General

Process CodeA unique string that identifies Deployment Process Instance. This label is used throughoutDROPS to select the entity.

Process NameA label used to give additional information about the Deployment Process. This label isused throughout DROPS to select the entity.

The Process' Application and Environment fields are not editable. These values cannot bechanged for an established Deployment Process. Create a new process to change theApplication deployed to the current Environment. To change the Environment that thecurrent Application is deployed to, duplicate the existing process.

Properties Refer to Properties in the appendix.

PackageSelect the Package Type for the associated Application.

If this field is set to From Application, the packaging type defined in the Application willTable 21: Edit Deployment Process properties




Tab Field

be used.

[default] Unitary packaging deploys only the Release selected.

Cumulative packaging deploys the selected Release and all of the preceding Releases thathave been imported into DROPS but have not yet been deployed to the targetEnvironment. A cumulative Packaging Type deploys only themost recent Artifacts in eachRelease. This ensures that all of themost up-to-date Artifacts are deployed and that thedeployed Application is accurately updated.

ExampleYou have imported 4 versions of your Release but onlydeployed the first version to the target Environment. The4th Release contains the same version of all the Artifactsthat the 3rd Release contains, except for one file. Now,you select the 4th Release to deploy and choose acumulative Packaging Type. Result: The 2nd, 3rd and 4thReleases will all be deployed in order, finishing with themost current version of every Artifact and Release. TheArtifacts from the 3rd Release are all current except theone, which is deployed with the 4th Release.

ErrorManagement

If the Execute Rollback on Error checkbox is ticked, when the process encounters anerror, it will automatically roll back everything it accomplished up until themoment theerror occurred.

The Process executes all of the Rollback actions for every Activity in the DeploymentProcess Diagram in reverse order.

If this checkbox is not ticked, the Process will complete even if it encounters errors. Likely,its final status will be Failed. Rollback can then be carried out manually.

Auto-scheduling

If Deployment Instances are created using Environment Groups, they can beautomatically broken into Transfer-Only and Installation-Only pairs. Installation-OnlyInstances can be automatically scheduled to execute a certain amount of time after theTransfer-Only portion is complete. This property defines when automatically-scheduledInstallation-Only Deployment Process Instances are executed.

Delay ValueThe delay, in number of days, between the end of a Transfer-Only execution and when itschild Installation-Only Instance will be scheduled to begin automatically.

If this property is set to -1, DROPS will automatically retrieve the default value defined inthe Server Configuration.

By default the delay is one (1) day.

ReferenceFor more information about defining the default, refer toTable 21: Edit Deployment Process properties




Tab Field

theDROPS Configuration Guide.

Execute at a fixed timeIf ticked, the scheduled time of day is defined by the user. If this option is activated thetwo options below are available and must be defined. If this option is left inactive, theautomatic execution will begin right after the parent Instance is finished.

HourThe hour at which the execution will take place on the day defined by the Date the parentInstance execution was completed + the Delay Value.

MinuteTheminute of the hour defined at which the execution will take place on the day definedby the Date the parent Instance execution was completed + the Delay Value.

Validation

Validation Required Before StartingTo require validation from a specific User before being able to execute the DeploymentProcess, tick the checkbox. During deployment, the Process is executed as soon as thevalidator approves the request.

Validation Requests display in the Validation Requests node ( OperationalConsole Management perspective) for the User(s) assigned the Role(s) selected. Theyalso receive an automatic email.

ReferenceFor more information about approving requests, refer toWorking with Validation Requests on page 223.

For more information about editing the default content ofautomatic emails and defining themail configuration,refer to theDROPS Configuration Guide.

Validation Request Message & CommentThe subject line and body of the email to send to the validator. If defined here, the defaultcontent of the email, defined in the Preferences menu, is overridden.

Validation Reason is MandatoryTick this checkbox if the User is required to provide a reason why they validate or rejectthe Process.

Validation RolesSelect the Role of the User or Users that should receive the Validation Request. The list ofRoles is prepopulated with the four Roles that can validate Deployment Processes.

Notification

Click the Add button to create a newNotification linked to the Deployment Process.Notifications messages are not like validation/suspension/interruption messages in thatthey are intended to be only informative. They do not require action from the user andsimply let them know that certain steps have been carried out in the process. Notificationsare sent to the email address configured for each User who is assigned the Role(s)selected.

Table 21: Edit Deployment Process properties




Tab Field

WhenOn Start sends the notifications email to the User(s) when the Process is executed.

On End sends the notifications email to the User(s) when the Process has finished.

For Deployment ModeSelect the deployment mode for which to send a notification. If you want to send anotification for a combination of modes, createmultiple notifications and set each one toa different mode.

SubjectEnter the subject line for the email in the Subject field.

MessageThe body of the email sent to the User(s).

Recipient RolesSelect the Role of the User or User's that should receive the notification. The list of Roles isprepopulated with the four Roles that can validate Deployment Process Instances.

ReferenceFor more information about Roles, refer to Roles in theappendix.

Table 21: Edit Deployment Process properties




23.7.2.1 Use a Properties TemplatePre-defined Deployment Process Properties Templates can be applied to any Deployment ProcessDiagram. These templates define the diagram’s global properties. Applying the properties defined in atemplate at the global level is not permanent. After global-level properties are applied using a DeploymentProcess Properties Template, you can edit the Diagram’s properties to continue to personalize the options.




Figure 53: Global-level Properties Templates in the Deployment Process Diagram

Follow the subsequent steps to apply the predefined global properties to a Deployment Process.

Step 1 Right-click anywhere in the editor and selectUse Deployment Process Properties Template.

Step 2 Select the Deployment Process Properties Template from the Process Template Selectordialog. This list is prepopulated with all of the global process properties templates available on thecurrent DROPS Server.

Step 3 ClickOK.

Result The properties defined in the template are applied to the current process but can bemodified.


23.7.3 Edit Deployment Activity properties

To edit the Activity-specific properties in the Deployment Process Diagram, click on the Initialization or Infrastructure Item Activity.

If the Properties view is already opened, clicking on any Activity will open its properties in that view.




Figure 54: The Deployment Activity properties editor

Click the Initialization Activity to open its Properties view. The tabs on the left enable you to modifythe Activity's properties.

Tab Field

Validation

Validation Required before startingTo require validation from a specific User before being able to execute the InitializationActivity, tick the checkbox. During deployment, the Activity is executed as soon as thevalidator approves the request.

Validation Requests display in the Validation Requests node ( Operational ConsoleManagement perspective) for the User(s) assigned the Role(s) selected. They also receive anautomatic email.


For more information about editing the default content ofautomatic emails and defining themail configuration, referto theDROPS Configuration Guide.

Table 22: Edit Initialization Activity properties




Tab Field


Validation Reason is MandatoryTick this checkbox if the User is required to provide a reason why they validate or reject theProcess.


Import

Execute ImportIf ticked, the Import Process(es) associated with the Releases to deploy are launched. It isrecommended to only re-import the Release being deployed if you are sure of its contents.This option is helpful when working in a Continuous Integration system.

Fail on ErrorIf ticked, if the operation fails for any reason at this step, the import will fail and no furtherActions will be carried out.

Table 22: Edit Initialization Activity properties

Click an Infrastructure Item Activity to open its Properties view. The tabs on the left enable you tomodify the Activity's properties.

Tab Field

General

*Identifier

[Required] Enter a unique label for the Activity. Only alphanumeric characters are allowed(no spaces).

ActiveTick this checkbox to ensure that inactive Infrastructure Item Activities do not executewhen the Deployment Process is launched.

Force TransferIf the Activity does not contain either a Receiving or an Installation Stage, or both, theTransfer Stage will not be executed, meaning that the content will not be transferred fromthe DROPS Server to the target Infrastructure Item.

Tick this checkbox to force the content to transferwithout defining Receiving or InstallationStages. If ticked, content will transfer when the Activity is executed.

Ticking this checkbox also ensures that content is transferred even if there are noDeployment Actions defined.

Zip Artifacts before transferTick this checkbox to automatically zip all of the Artifacts before transferring them andthem automatically unzip them after the transfer. This is helpful if you have a lot of small

Table 23: Edit Infrastructure Item Activity properties




Tab Field

Artifacts to transfer because the compression will save space and time.

No Artifacts to transferIn some cases, an Activity may never need to transfer any Artifacts. In other cases, if anActivity fails to detect Artifacts to transfer or fails to transfer them, it may cause problems.This option allows you to decide what status to give an Activity should no Artifacts betransferred by it.

The status can be defined for every Activity in each Process to manage the ExecutionResult in the Deployment log. If it’s normal that one Activity should not transfer anyArtifact, set the status to Succeeded. If this is abnormal, choose betweenWarning andFailed.

Validation

Validation Required before startingTick this checkbox to require a specific User to validate before the Activity can be executed.

If an Activity requires validation but has not been validated before the Process is executed,it will not run. Approved Activities in the Process will run but any unapproved Activities willnot.

Validation Requests display in the Validation Requests node ( Operational ConsoleManagement perspective) for the User(s) assigned the Role(s) selected. They also receivean automatic email.


For more information about editing the default content ofautomatic emails and defining themail configuration, referto theDROPS Configuration Guide.


Validation Reason is MandatoryTick this checkbox if the User is required to provide a reason why they validate or reject theProcess.


Component

Every Activity is required to be linked to a *Component to deploy. Click the Browsebutton to select the Component to deploy to the corresponding Infrastructure Item. TheComponent Selection dialog is prepopulated with all of the Components defined in theApplication associated with the current Deployment Process.

Only one Component can be deployed to an Infrastructure Item per Deployment Process.Table 23: Edit Infrastructure Item Activity properties




Tab Field

To deploy multiple Components to one Item, you must createmultiple DeploymentProcesses.

Important!Make sure to select the correct Component! Onceconfirmed, you cannot change it.

To edit the properties for the Component defined in an Infrastructure Item, right-click onits Activity and select Edit > Component.

Notification

Click the New button to create a newNotification linked to the Activity. Notificationsmessages are not like validation/suspension/interruption messages in that they areintended to be only informative. They do not require action from the user and simply letthem know that certain steps have been carried out in the process. Notifications are sent tothe email address configured for each User who is assigned the Role(s) selected.

WhenOn Start sends the notifications email to the User(s) when the Activity is executed.

On End sends the notifications email to the User(s) when the Activity has finished.

For Deployment ModeSelect the deployment mode for which to send a notification. If you want to send anotification for a combination of modes, createmultiple notifications and set each one to adifferent mode.

SubjectEnter the subject line for the email in the Subject field.

MessageThe body of the email sent to the User(s).

Recipient RolesSelect the Role of the User or User's that should receive the notification. The list of Roles isprepopulated with the four Roles that can validate Deployment Process Instances.

ReferenceFor more information about Roles, refer to Roles in theappendix.

Transfer

Deployment SchemaSelect the Deployment Schema to run on the Artifacts deployed to the correspondingInfrastructure Item. Click the Browse button. The Deployment Schema dialog isprepopulated with all of the Deployment Schemas defined in the Infrastructure Item.

Only one Schema can be used for an Infrastructure Item per Deployment Process.

ReferenceFor more information about adding Schemas toInfrastructure Items, refer to Editing Infrastructure Item





Tab Field

details on page 104.

Use Replacement Rules

If ticked, the substitutions defined by the Replacement Rules are activated at the beginningof the Transfer Stage for all of the Artifacts deployed to the current Infrastructure Item.This ensures that the Replacement Rules are taken into account locally before the Artifactsreach their final destination.

Important!This boxmust be ticked in order to run the ReplacementRules defined in DROPS.

If multiple Rules are defined they willALL be applied duringthe Deployment Process.

ReferenceFor more information about Replacement Rules, refer toWorking with Replacement Rules on page 117.





23.7.4 Edit Deployment Action properties

To edit the Action-specific properties in the Deployment Process Diagram, click the blue Action box.

If the Properties view is already opened, clicking on any Action will open its properties in that view.




Figure 55: The Deployment Action properties editor

Tab Field

General

*Identifier[Required] Enter a unique label for the Deployment Action. Only alphanumeric characters areallowed (no spaces). This label is viewed in the Deployment Process Diagram to easily see whatthe Action accomplishes.

CommentEnter additional information in this field to clarify the specific details of this Action.

Options

Apply script to the list of Artifacts

If ticked, this option ensures that the script will be applied to every Artifact deployed.

If not ticked, the script will run just one time.

ExampleAn email script should likely not be applied to all of the Artifacts,but 'copy to' scripts specific to a certain file type should beapplied to every Artifact to ensure that all the Artifacts arefiltered through the script.

Table 24: Edit Deployment Action properties / 315DROPS • Copyright © 2018• All Rights reserved. • arcadsoftware.com



Tab Field

Important!If any of the Action-level substitution variables are used, youmust tick this checkbox in order to ensure that the variable istaken into account at the Artifact-level. If the script is notapplied to each individual Artifact in the list, these variables willnot be applied because they are specific to individual Artifacts.

ReferenceFor more information about these variables, refer toSubstitution Variables in the appendix.

File Name PatternEnter the pattern to follow to filter the Artifacts. Artifacts that meet the pattern defined here willall be used for the current script.

Fails on Error

[Ticked by default] If ticked, if the operation fails for any reason at this step, the deployment willfail and no further Actions will be carried out.

Script

ScriptThe name and version number of the Action's current script. The associated script is selectedwhen the Action is created but it can also be changed here.

Click the Browse button to select a new script to associate with the Action.

Filter the search in the Script Selection dialog using theName, Script Category and/orExecution Platform options. To display all of the scripts available on the current server, clickSearchwithout defining any search criteria.

Select the script, then select the version of that script to use.

ClickOK to apply the selected script to the Deployment Action.

Warning!Replacing a script in an Action deletes any parameters that mayhave been defined in the original script. All changes are lost.

ParametersIf required, modify the parameters for the selected script in theValue column. The parametersin this list are prepopulated with all of the parameters defined in the Script editor.

Variables can be used as parameter values.

Tap Ctrl+Space to view a full list of the variables available for the current field. The list ofavailable variables is prepopulated with the available Properties defined in the entities and theready-to-use context-specific variables available by default.

Table 24: Edit Deployment Action properties




Tab Field

ReferenceFor more information about variables, refer to SubstitutionVariables in the appendix.

If a parameter is not given a value, it will not be referenced when the script is run during theDeployment Process.

Table 24: Edit Deployment Action properties






DROPS v2.8.124 Working with Process Templates | User Guide

24 Working with Process Templates

Required Roles n/a

Required Rights(by category) Process Templates


Access DROPS Server→ Configuration→ Process Templates

Chapter Summary24.1 Searching for Process Templates 16224.2 Creating Process Templates 16324.3 Editing Process Templates 16424.4 Viewing the Process Diagrams that use a Template 16424.5 Deleting Process Templates 165

Users with the rights to do so can create Process Templates that can be selected in order to save timewhilecreating newProcesses. A Process Template can contain some or all of the details required to deploy aRelease, including properties. The levels in a Diagram are nested and once a template is used in a Diagram itis completely uneditable, so any templatemust be configured completely.

The type of template defines which level(s) of the Deployment Process Diagram are used. There are fivedifferent types of Process Templates and each one represents a different level and all of the levels itcontains.

l Stage Templates must include Actions to predefine the steps to carry out when the stage is executed.Templates can be created for all three of the different Stages in a Deployment Process:

o Preparation Stageo Receiving Stageo Installation Stage

l Activity Templates are only for Infrastructure Item Activities. Activity Templates must include either atleast one Stage (which must also include at least one Action) or at least one Action outside of aStage. The same requirements for a normal, unique Deployment Activities apply to ActivityTemplates, including most of the properties.

NoteInitialization and Finalization Activity Templates cannot be created.These Activities must always bemodified in the Process Diagram andremain unique to each Deployment Process.

l Deployment Process Properties Templates are pre-defined process-level properties and parameterswhich can be applied to whole Deployment Process Diagrams to automatically define this informationwithout using uneditable elements (Activity or Stage Templates) in the Diagram itself.

Templates can be used in any Deployment Process Diagram but can only bemodified in the ProcessTemplate editor. Any changes made to a template are carried over to all of the Process Diagrams using it.



DROPS v2.8.1User Guide | 24 Working with Process Templates

When a template is used in a Diagram, the Activity or Stage is dark blue, instead of the default gray. Thedifference in color makes it easy to see which parts of a diagram are inherited from a template and whichare unique.

Important!Because Activity and Stage Templates can be used for any InfrastructureItem, any user-defined properties included in variables that are referencedin the templatemust be defined for every Item that may be included in aDeployment Process that uses the template. User-defined variables alwayshave .props. before the property name so you can be sure to knowwhichvariables called must be defined in the entities referenced.

ReferenceFor more information about calling user-defined properties as variables,refer to Properties and Substitution Variables in the appendix.

24.1 Searching for Process Templates

Follow the subsequent steps to search for Process Templates.

Step 1 Select Process Templates from the Configuration node in the Configuration Explorer.

Figure 56: The Process Templates search view

Step 2 When the search view is opened, the list of templates is empty. Use the search criteria sections tofilter the search.

l To search for an existing template by its ID or Type, enter all or part of the information in thecorresponding field.






Result The Process Templates search view displays all of the templates defined for the current serverthat meet the search criteria.

24.2 Creating Process Templates

There are two ways to create Deployment Activity and Stage Templates:

1. Create a new templatemanually using the Create a new Process Template wizard.2. Create a template from an existing element in a Deployment Process Diagram.

Deployment Process Templates can only be created using the Create a new Process Template wizard.

24.2.1 Create a Process Template manuallyFollow the subsequent steps to create a newProcess Template.

Step 1 To access the Create a new Process Template wizard, either click the Create icon in theProcess Templates search view or right-click anywhere in the view and select Create a newTemplate.


1. Define the template’s ID.2. Select the type. The Type drop-down list is prepopulated with the five types of Templates

available.

Important!Be sure to select the correct type based on your needs. ATemplate’s type cannot bemodified later.

ReferenceFor more information about template types, refer to theintroduction to this chapter or the Glossary on page 298.


Result New templates are available in the Process Templates search view and must be configuredcompletely before using them in a diagram. The Process Template editor or the ProcessOption Template editor is opened automatically.

24.2.2 Create an Activity or a Stage Template from an existing DiagramStep 1 From the Deployment Process editor, right-click on the Activity or Stage to use to create a

template.

NoteIt is recommended, but not required, to use completely-defined



DROPS v2.8.1User Guide | 24 Working with Process Templates

diagrams to create templates. They can be edited later in theTemplate editor.

Templates cannot be included in other templates. If the Activitychosen already contains a Stagemade from a template, the StageTemplate will not be included in the newActivity Template.

Result TheNew Process Template wizard is displayed.

Step 2 Define the template’s ID.


Result New templates are available in the Process Templates search view and must be configuredcompletely before using them in a diagram. The Process Template editor is openedautomatically.

ReferenceFor more information about using the Process Diagram to createtemplates, refer to Building Deployment Process Diagrams onpage 136.

24.3 Editing Process Templates

To edit a Template either right-click on it in the Process Templates search view then select EditTemplate, or select it, then click the Edit icon or double-click it.

Process Templates are edited in the sameway as Deployment Process Diagrams. If the Properties viewis already opened, selecting an Activity or a Stage Template will open the properties in that view. Editing aDeployment Process Template opens the Process Option Template editor.

ReferenceFor more information about how to build a Process Template diagram,refer to Building Deployment Process Diagrams on page 136.

For more information about the properties to edit for each entity in aProcess Template, refer to Editing Deployment Process properties onpage 146.

24.4 Viewing the Process Diagrams that use a Template

To view the list of Process Diagrams that use a Process Template, select the template in the ProcessTemplates search view and either click the Show the list of Processes icon or right-click on it and selectShow the list of Process that use this Template.




Figure 57: Viewing Deployment Process that use Process Templates

The Linked Processes view is displayed.

Click the Edit icon or the Properties Editor icon to modify the template diagram or its properties.

Click the Delete icon to delete the Deployment Process.

Warning!Deleting Deployment Processes from the Linked Processes viewdeletes the Process completely. It does not simply unbind the Process fromthe Template. To remove the template from a Deployment Process, openthe Deployment Process Diagram and delete the template item from thediagram.

ReferenceFor more information about the options available in this view, refer toWorking with Deployment Process Diagrams on page 131.

24.5 Deleting Process Templates

NoteIf a template is used in any Deployment Process Diagram, it cannot bedeleted. Delete the template item in the Process Diagram first then delete itfrom the template search view.

Warning!Deleted Process Templates cannot be accessed or recovered.

To delete a Process Template, either right-click on it in the Process Templates search view and selectDelete, or select it and click the Delete icon. ClickOK to confirm or click Cancel to keep the template.



Importing Artifacts

DROPS v2.8.1Introduction to importing Artifacts | User Guide

Introduction to importing ArtifactsThere are two ways to import Artifacts: initially via Initial Import Strategies, or the "normal" way via regularImport Strategies. Both use the Import ArtifactsWizard which can be accessed by:

l importing via an Application (see Importing Artifacts immediately by Application on page 170),l importing or reimporting via an existing Import Process Instance (seeWorking with Import ProcessInstances on page 173).

About the Console Explorer - Importing

Figure 58: The Operational Console Management perspective - Importing

The following actions, involved in executing the DROPS Import Processes, are completed using theOperational Console Management perspective (see Overview of the DROPS Studio on page 29) or in theDROPS Web Console.

The Console Explorer provides access to the Import Process execution procedures. This perspective isthe functional side of DROPS.

l Managing Applications (seeManaging Applications on page 168),

l Importing Artifacts (creating Releases) (see Importing Artifacts immediately by Application onpage 170 and Working with Import Process Instances on page 173).

NoteAll of the actions available in this view are also available in the DROPS WebConsole.



DROPS v2.8.1User Guide | 25 Managing Applications

25 Managing Applications

Required Roles Application Repository Manager and/or Import Operator

Required Rights(by category) Import Process Instances


Access DROPS Server→ Applications

Applications that are defined in the Configuration Management perspective are displayed in theOperational Console Management perspective under the Applications node in the Console Explorermenu. If you have the rights to import Artifacts, use the Applications listed in this menu.

Initially, all of the Applications are only listed under All Applications.

25.1 Managing Allow-to-Release Applications

This list displays all of the Applications for which your User has the Import Operator or the ReleaseManager Role. These are all of the Applications for which you can carry out the Import Process.

If you are not the Import Operator or ReleaseManager for any Application, this list will be empty and youcannot import content.

ReferenceFor more information about assigning Roles to Applications, refer toAssigning entity-level Roles on page 43 or Roles in the appendix.

25.2 Managing favorite Applications

Each User can add any defined Application to his list of favorites to easily find the Application(s) he usesmost often.

Right-click on an Application in the list and select Add to favorites. Refresh the My Favorites nodeto access it from that menu. Any Application that is in your favorites is marked by this icon in theOperational Console perspective: . To remove an Application from your favorites, right-click on it andselect Remove from favorites.

25.3 Viewing import history by Application

To view the import history for an Application, right-click on the Application in the Console Explorer, thenselect Show Import History or Show Scheduled Import Processes.

The Import Processes view is displayed giving you access to all of the imports launched for the selectedApplication.



DROPS v2.8.125 Managing Applications | User Guide

ReferenceFor more information about this view, refer to Working with ImportProcess Instances on page 173.



DROPS v2.8.1User Guide | 26 Importing Artifacts immediately by Application

26 Importing Artifacts immediately by Application




Access DROPS Server→ Applications→ All Applications

When a "normal" Import Strategy is launched via the Import Process, you can filter through theComponent's available Import Strategies and import only those that correspond to a defined version. Thismeans that if a version defined in the source provider only contains a fewArtifacts and that the rest of theArtifacts have not changed since the last Release was created, only the updated Artifacts will be re-imported. This ensures that only the Artifacts required to complete the newRelease version are taken intoaccount.

Initial import strategies are all launched together when the Initial Import option is selected in theConsole Explorer. An Import Strategy is considered 'initial' when the Initialization Strategy checkbox isticked in the Import Strategy editor. Because all of the Initial Import Strategies defined for anApplication are run at the same time, they do not require external version numbers, which means that all oftheir Artifacts will be imported, regardless of their version.

Follow the subsequent steps to import Artifacts via Initial Import Strategies or by running "normal" ImportStrategies immediately.

Step 1 Expand the All Applications node of the current server in the Console Explorer.

Step 2 Right-click on the Application for which to import the Artifacts then select either ImportArtifacts or Initial Import.



DROPS v2.8.126 Importing Artifacts immediately by Application | User Guide

Figure 59: Importing Artifacts by Application

Step 3 Fill in the required configuration in the Import Artifactswizard.

1. Select the Release in which to save the Artifacts that will be imported.

l If Current Release is selected, the Release defined in the Current Release field in theApplication is used to import (displayed in parentheses).

l If Create a New Release is selected, a newRelease will be created using the ReleaseNumber Template on page 53 defined in the Application.If this option is selected, the Increment Partmust be defined manually. Select the partof the version to increment keeping in mind that the algorithmwill update the otherparts automatically.

l Selecting an existing, active Release from the prepopulated list will import the Artifactsto that Release.

2. Tick theReset Release before importing checkbox to purge the selected Release of all of itscontents before importing the Artifacts. The current import replaces the old contentcompletely.Add a description of the replacement content, if necessary, to track the reason why theRelease's content was replaced.

If you selected to run an Initial Import Strategy, click Finish to launch the import.

3. If you selected to run a "normal" Import Strategy, the third page of the wizard enables you toselect the Import Strategy(ies) to use to feed the selected Release. Filtering the ImportStrategies of the Components in the Application enables you to select different combinationsof Artifacts for this Release.



DROPS v2.8.1User Guide | 26 Importing Artifacts immediately by Application

l Ticking No Filterwill automatically import all of the Application's Artifacts.l To use an external file that defines which Component(s) and Import Strategy(ies) to use,enter its name in the External File Name field. This can also be done in theApplicationeditor in the Default Imported Version file name field.

l Select which Import Strategies to use or not by adding or deleting them from theUser-Defined filter section.Click the Edit button to edit a Strategy already in the list.

The list displays the Import Strategies used and their corresponding Components as wellas the version of the external tool's export to import. The External Version columnrefers by default to the ${import.version} substitution variable (*RELEASE).

Important!The Import Strategies selected in this section define theComponents that will be deployed when this Release islaunched.

Only "normal" Import Strategies are available in this list. Initial Import Strategy can onlybe launched by selecting to import Initial Import Strategies.

ReferenceFor more information about strategies, refer to Workingwith Import Strategies on page 60 and Import StrategyType Configuration in the appendix.

Click Finish to launch the import.

Result The import is launched.

When an Instance’s Execution Status is Completed and the Execution Result is Succeeded its iconchanges to show that the import was successful .

ReferenceFor more information about import results, refer toUnderstanding Import Process Instance results on page 178 andWorking with imported Artifacts on page 76.



DROPS v2.8.127 Working with Import Process Instances | User Guide

27 Working with Import Process Instances




Access DROPS Server→ Import Process→ Import Process Instances

Chapter Summary27.1 Searching for Import Process Instances 17327.2 Creating Import Process Instances 17427.3 Executing Import Process Instances 17727.4 Understanding Import Process Instance results 17827.5 Deleting Import Process Instances 180

Import Process Instances are created automatically when an import is launched from the AllApplications node. Instances can also be created from the Import Processes search view and eitherexecuted manually or scheduled in order to execute them at a later date or execute them regularly.

Different Import Process Instances can be scheduled to match your development team's deliveries. Tomanage when Import Strategies are executed, schedule when an Import Process Instance should be carriedout. Scheduling the Import Process is useful if you need to continuously import content that is regularlyupdated or if you know in advance when the next batch of content to import will be ready.

A dedicated job runs on the DROPS Server that regularly scans for scheduled Import Process Instances,then triggers Import Strategies according to the schedule(s).

27.1 Searching for Import Process Instances

Follow the subsequent steps to search for Import Process Instances.

Figure 60: The Import Process Instance search view

Step 1 Select Import Process Instances from the Import Process node in the Console Explorer orright-click on an Application and select Show Import History.



DROPS v2.8.1User Guide | 27 Working with Import Process Instances

Step 2 When the search view is opened, the list of Instances is empty. Use the search criteria sections tofilter the search.

l To search for the Processes by Application or Release, select it by clicking the corresponding Browse button.

l To search only for scheduled Import Process Instances, tick the Scheduled Only checkbox.



Result The Import Process search view displays all of the finished and scheduled Import ProcessInstances that meet the search criteria.

TheApp. Code column displays the Instance's Technical ID in [brackets] as well as the name of theApplication that was used to import and one of the following icons:

l Prepared/Completed.

l Active scheduled Instance.

l Paused scheduled Instance.

TheApp. Name column displays the name of the Application as defined.

TheRelease Number column displays the official version number of the Release created by theImport Process Instance.

The Execution Status and Execution Result columns display the current statuses of eachInstance and change while the Instance is being processed.

Prepared Prepared Instances are ready to be executed.

Completed Completed Instances have already been executed.

In Progress The progress bar is displayed while the Instance is executing.

Waiting

If the Import Process is stuck and requires user action to complete.

This possibility is only active for ARCAD imports and is displayed when thesource IBM i is inMSGW status. Action must be taken on the IBM i sidebefore the DROPS Import Process can complete.

Succeeded If an Instance executed successfully.

Failed If any step in the Import Process failed to successfully execute.Table 25: Import Process Instance statuses & results

The End Date column displays the date the Instance finished importing.

27.2 Creating Import Process Instances

There are three ways to create Import Process Instances:




1. Launch an Import from an Application to automatically create an Instance that is displayed in theImport Process search view.

ReferenceFor more information about launching the Import Process from anApplication, refer to Importing Artifacts immediately by Applicationon page 170.

2. Create new Import Process Instances using the Import Artifacts wizard.3. Duplicate an existing Import Process Instance to quickly create an Instance with the same parameters

as another Instance. Duplicating creates a copy of an existing Instance that can bemodified.

27.2.1 Create new Import Process InstancesFollow the subsequent steps to create a new Import Process manually.

Step 1 To open the Import Artifactswizard, either click the Create icon in the Import Processsearch view or right-click anywhere in the view and select Create a new Import ProcessInstance.

Step 2 Select the Application that includes the Artifacts to import.


Step 3 Select the Release in which to save the Artifacts that will be imported.

l If Current Release is selected, the Release defined in the Current Release field in theApplication is used to import (displayed in parentheses).

l If Create a New Release is selected, a newRelease will be created using the Release NumberTemplate defined in the Application.If this option is selected, define the part of a Release’s version number to increment from theIncrement Part drop-down menu. Keep in mind that the algorithmwill update the otherparts automatically. By default, the part is set to the value defined in the the RepositoryStorage Area settings in the DROPS Server configuration.

l Selecting an active existing Release from the prepopulated list will import the Artifacts tothat Release.


Step 4 Tick theReset Release before importing checkbox to purge the selected Release of all of itscontents before importing the Artifacts. The current import replaces the old content completely.Enter a description, if necessary.


Step 5 Select the Import Strategy(ies) to use to feed the selected Release. Filtering the Import Strategiesof the Components in the Application enables you to select different combinations of Artifacts forthis Release.




l Ticking No Filterwill automatically import all of the Application's Artifacts.l To use an external file that defines which Component(s) and Import Strategy(ies) to use,enter it in the External File Name field. This can also be done in theApplication editor inthe Default Imported Version file name field.

l Select which Import Strategies to use or not by adding or deleting them from theUser-Defined filter section.Click the Edit button to edit an existing Strategy’s Component Filter.

The list displays the Import Strategies used and their corresponding Components as well asthe version of the external tool's export to import. By default, the External Version columnrefers to the ${import.version} substitution variable (*RELEASE).

Important!The Import Strategies selected in this section define theComponents that will be deployed when this Release islaunched.

Only "normal" Import Strategies are available in this list. Initial Import Strategies can only belaunched by importing Initial Import Strategies.

ReferenceFor more information about the two kinds of strategies, referto Working with Import Strategies on page 60 and ImportStrategy Type Configuration in the appendix.

Step 6 Schedule the Import Process.

l A schedule set to executeOnce executes the import one time at a given time. The Timemustbe set to define the time to run the execution.

l A Periodic schedule executes the import process at regular time intervals. The Intervalmustbe set, and the day(s) of the week as well, to define the time elapsed (in minutes) between twoconsecutive executions. The Process will run every day that is selected every week.

l Daily Import Process Instances will be run once on theDay(s) of the week selected, everyweek.

l Monthly Import Process Instances will be run once on dayDay of the Month defined, everymonth.


Result If the Instance was scheduled to be run immediately or wasn't scheduled at all, the import islaunched.

If the Instance was scheduled, it appears in the Import Process search view as a scheduledProcess and will launch automatically at the defined time.

When an Instance’s Execution Status is Completed and the Execution Result is Succeeded its iconchanges to show that the import was successful .




ReferenceFor more information about import results, refer toUnderstanding Import Process Instance results on the next pageand Working with imported Artifacts on page 76.

27.2.2 Duplicate an Import Process InstanceDuplicating an Instance is a quick way to create an identical Instance that you can later modify or scheduledifferently.

To duplicate an existing Import Process Instance, select it then either click the Duplicate icon, or right-click on it and select Duplicate an Import Process Instance. TheDuplicate Import Processwizard isprepopulated with most of the values defined for the original Instance. When an Import Process Instance isduplicated, the Release will be reset by default before importing, even if this option was inactive in theoriginal Instance. You can modify any settings before clicking Finish to create the duplication Instance.

Important!You cannot change the Application of a duplicated Import Instance.

The duplication Instance is automatically available in the Import Process search view and has its ownunique Technical ID.

27.3 Executing Import Process Instances

Executing an existing Import Process Instance creates a new Instance.

To execute an existing Import Process Instance, either right-click then select Execute the ImportProcess Instance, or click the Execute Import Process Instance icon in the view.

Warning!Executing a scheduled Import Process Instance will unschedule it andimport it immediately.

To viewwhat happens during the execution in real-time, open the Import Instance’s Results view andwatch the import actions take place from the Console tab.




Figure 61: Consulting Import Execution results in real-time (Console)

NoteThe Console tab is only available in Prepared Instances or those which arecurrently In Progress. If an Instance has finished executing the Console isno longer available but the log can be accessed in the Logs tab.

27.3.1 Pausing scheduled Import Process InstancesScheduled Import Process Instances will launch automatically when the defined day and time arrive.

l To pause a scheduled Import Process Instance, select it and either right-click then select StopSchedule, or click the Stop Schedule icon in the toolbar.The Icon in the search view changes from an active scheduled Instance, to paused.

l Re restart a paused scheduled Import Process Instance, select it and either right-click then selectRestart Schedule, or click the Restart Schedule icon in the toolbar.

27.4 Understanding Import Process Instance results

The Import Process Instances search view provides some details of processed Import ProcessInstances. Access more information by either double-clicking on Instance in the list, selecting it then clickingthe Results icon in the view or right-clicking then selecting Show Import Results.

The Import Results view contains multiple tabs that each contain different elements of the import.

TheOverview tab displays the uneditable general information about the Instance. The schedulinginformation for the Instance can be edited here. The End Date is left blank until the Instance is executed.




27.4.1 View the LogsAll of the activity from the import is displayed in the Logs tab. Every action carried out during a deploymentis logged.

Figure 62: The Import Results view - Logs

Filter results byMessage Code,Message Text, Component Name, or Strategy Name. Enter anycombination of search criteria then click the Search icon to display the results. To display the completelog, click Search without entering any criteria.

Filter the severity of the results displayed by selecting one or more of the Severity icons

l Fatal Only fatal errors are displayed.

l Warning Only Warnings errors are displayed.

l Info Only Important information is displayed.

l Verbose Only details are displayed.

Use the Show Previous and Next icons to quickly move through a long list of entries to find and jumpto the fatal errors.

Click the export icon to open the selected log(s) in an external text editor. By default, the editor will openautomatically.

Click the export to JSON file icon to open the selected log(s) in .json format. You will be prompted toselect where to save the file.

27.4.2 View the Results for each Import StrategyEach Import Strategy carried out during the Import Process is represented by its own tab. Each of thesetabs describe the Strategy's status and enables you to see the list of imported Artifacts (the Artifact List) byclicking theDisplay the Artifact List link.




Clicking this link opens the List Editorwhich lists each Artifact included in the Import Process Instance. Allof the relavent information is listed for each Artifact in the table, including the source path and the path tothe Artifact on the DROPS Server.

27.5 Deleting Import Process Instances

Warning!Deleted Import Process Instances cannot be accessed or recovered.Deleting an Instance does not delete the Artifacts that have already beenimported by it. Only the trace of the import is removed.

To delete an Import Process Instance search for it in the Import Process search view. Either right-clickon it, then select Delete or select it, then click the Delete icon. ClickOK to confirm or click Cancel tokeep the Instance.



Deploying Releases

DROPS v2.8.1User Guide | Introduction to deploying Releases

Introduction to deploying ReleasesReleases are deployed to your target Environments by executing Deployment Process Instances to run theActions defined in Deployment Process Diagrams.

There are two safeguards built into these Processes:

1. all Actions can be suspended if an error occurs and Users can rectify the issues before re-executing theprocess,

2. when authorization is required Users can manage validation requests to approveActions/Stages/Processes.

About the Console Explorer - Deploying

Figure 63: The Operational Console Management perspective - Deploying

The following actions, involved in executing the DROPS Deployment Processes, are all completed using theOperational Console Management perspective (see the Overview of the DROPS Studio on page 29) or inthe DROPS Web Console.

The Console Explorer provides access to the Deployment Process execution procedures. This perspectiveis the functional side of DROPS.

l Deploying Releases (seeWorking with Deployment Process Instances on page 184),

l Scheduling deployments (seeWorking with the Deployment Process Scheduler on page 208),

l Addressing Suspended Actions (seeWorking with Suspended Actions on page 220),

l Addressing Validation Requests (seeWorking with Validation Requests on page 223),

l Addressing Interruption Messages (seeWorking with Interruption Messages on page 217),



DROPS v2.8.1Introduction to deploying Releases | User Guide

NoteAll of the actions available in this view are also available in the DROPS WebConsole.



DROPS v2.8.1User Guide | 28 Working with Deployment Process Instances

28 Working with Deployment Process Instances

Required Roles Environment ReleaseManager and/or Release Operator



Access DROPS Server→ Deployment Process→ Deployment Process Instances

Chapter Summary28.1 Searching for Deployment Process Instances 18428.2 Creating Deployment Process Instances 18728.3 Changing the Release to deploy 19328.4 Managing Deployment Tags 19328.5 Defining an Instance's Deployment mode 19428.6 Executing Deployment Process Instances manually 19628.7 Scheduling Deployment Process Instances 19828.8 Understanding Deployment Process Instance results 20128.9 Rolling back a deployed Deployment Process Instance 20628.10 Canceling Deployment Process Instances 20728.11 Deleting Deployment Process Instances 207

Deployment Process Instances enable you to deploy one Application to one target Environment. Instancescan be created from the Deployment Process Instances search view and either executed manually orscheduled in order to execute them at a later date or even to execute them regularly.

Warning!If the DROPS Server is stopped during a deployment, the DeploymentProcess Instance is canceled. You cannot continue the deployment oncethe server is started again. In order to finish deploying, duplicate theInstance and execute again.

Deployment Process Instances can bemanaged in two different views: the Deployment ProcessInstances search view or the Deployment Process Scheduler. Any information changed in theScheduler is carried over to the Instances view and vice versa.

ReferenceThis chapter describes how to manage Instances from the DeploymentProcess Instances search view. For more information about the Scheduler,refer to Working with the Deployment Process Scheduler on page 208.

28.1 Searching for Deployment Process Instances

Follow the subsequent steps to search for Deployment Process Instances in the Instances view.



DROPS v2.8.128 Working with Deployment Process Instances | User Guide

Step 1 Select Deployment Process Instances from the Deployment Process node in the ConsoleExplorer.

Figure 64: The Deployment Process Instances search view

Step 2 When the search view is opened, the list of Instances is empty. Use the search criteria sections tofilter the search.

l To search for an existing Instance by the Deployment Process it uses to deploy, expand theDeployment Process section.Click the corresponding Browse button to select the associated Client, Environment and/orDeployment Process.

Important!If theNot Completed checkbox is ticked [default], onlyDeployment Instances that are not completed or notcanceled are displayed in the search results.

l To search for an existing Instance by the Release it deploys, expand theRelease section. Clickthe corresponding Browse button to select the associated Application and/or Release.

l To search for an existing Instance by the description of either its Environment or Release,expand theDescription section then enter part of the corresponding description.

l To search for an existing instance by its deployment or release status, expand theDeployment Status section then select a predefined status.

l To search for an existing Instance by the Deployment Instance Tag it belongs to, expand theDeployment Tag section then select the tag from the drop-down list.

ReferenceFor more information about tags, refer to ManagingDeployment Tags on page 193

l To search for an existing Instance by the date it was or should be executed, expand theDeployment Execution Date section. Tick the Start and/or End Date, then select the rangeusing the calendar.

l To search for an existing Instance by the date it finished, expand the Completion Datesection. Tick the Start and/or End Date, then select the range using the calendar.

l To search for an existing Instance by its scheduled deployment date, expand the ScheduleDate section. Tick the Start and/or End Date, then select the range using the calendar.






Result The Deployment Process Instances search view displays all of the finished and scheduledInstances that meet the search criteria.

TheApplication column displays the name of the Application deployed as well as one of thefollowing icons which describes themode in which the Instance is set to deploy.

Full-Transfer mode

Defining an Instance's Deployment mode on page 194 Transfer-Only mode

Installation-Only mode

RollbackRolling back a deployed Deployment Process Instance onpage 206

Table 26: Deployment Process Instance modes

TheRelease column displays the official version number of the Release deployed.

The Env Code column displays the name of the Environment to which the content was deployed.If an Instance is linked to a deleted Deployment Process, this information is not available (N/A).

The Preparation, Start and Completion Date columns display these respective dates.

The Process Name column displays the name of the Deployment Process used to deploy.

The Transaction ID column displays the automatically-generated ID of the deployment.

The Execution Status and Execution Result columns display the current deployment status andchange while the Instance is being processed.

Prepared Prepared Instances are ready to be executed or scheduled.

CompletedCompleted Instances have already been executed and cannotbe scheduled.

In Progress The progress bar is displayed while the Instance is executing.

Suspended

Suspended Deployment Process Instances are highlighted inred to bring attention to the fact that an action is requiredbefore the Instance can continue to deploy. DeploymentProcess Instances are suspended when either a ValidationRequest is required, the execution was suspended (likelybecause an Infrastructure Item cannot be reached), or theexecution was interrupted (an interruption message wassent by the DROPS Agent).

Canceled If an Instance is canceled.Table 27: Deployment Process Instance statuses & Results




Succeeded If an Instance executed all of its Actions successfully.

Succeeded with WarningsIf an Action specified not to Fail on Error encountered aproblem during the execution.

FailedIf any Action in the Deployment Process failed to successfullyexecute.

Table 27: Deployment Process Instance statuses & Results

The Scheduling Info. column displays the date and time the Instance is scheduled to deploy, ifconfigured.

If an Installation-Only Instance has been auto-scheduled, the label will be in one of thefollowing formats:

l *AUTO [+<delay_value>] if no fixed time has been chosenl *AUTO [+<delay_value>] [<hour>:<minute>] if a fixed time has been chosen

28.2 Creating Deployment Process Instances

There aremultiple ways to create Deployment Process Instances in the Instances view:

1. Create newDeployment Process Instances using the Create a new Deployment Process Instancewizard.

2. Create one Instance to deploy a set of Releases to the same Environment using the Create a newDeployment Process Instance for a Release Set wizard.

3. Createmultiple Instances to deploy a Release to a set of Environments using the Create a newDeployment Process Instance from Environment Groupwizard.

4. Duplicate an existing Instance to quickly create an Instance with the same parameters as the original.Duplicating creates a copy of an existing Instance that can bemodified.

NoteBy default, new Instances are always marked to be deployed in Full-Transfer mode, however they are not executed automatically and must beexecuted manually or scheduled to execute automatically.

ReferenceFor more information about changing themode in which to deploy anInstance, refer to Defining an Instance's Deployment mode on page 194.

For more information about executing Instances, refer to ExecutingDeployment Process Instances manually on page 196.

28.2.1 Create new InstanceA single Deployment Process Instance allows you to deploy one Release to a single Environment.




NoteCreating a new single Instance enables you to duplicate it later.

Follow the subsequent steps to create a newDeployment Process Instance in the Instances view.

Important!Be careful selecting the properties of a Deployment Instance! Most of themcannot be changed once the Instance is created.

Step 1 To open the Create a new Deployment Process Instance wizard, either click the Create iconin the Deployment Process Instances search view or right-click anywhere in the view andselect Create a new Deployment Process Instance.

Step 2 Define the Instance by clicking the Browse button for each of the following entities.

1. If multiple clients are available, select the Client to which to deploy the Release. Changing theClient alters the options available throughout the wizard. Only the entities available for theselected Client will be accessible.

2. Select the Environment to which to deploy the Release. The list is prepopulated with theEnvironments available for the selected Client. Changing the Environment alters the optionsavailable throughout the wizard. Only the entities available for the selected Environment willbe accessible.

3. Select theDeployment Process to use. The list is prepopulated with the Processes availablefor the selected Environment.

4. Select theRelease to deploy. The list is prepopulated with the Releases available for theselected Client.

5. Modify the template for the Transaction ID. The ID's syntax follows the templatemanaged inthe Preferences menu.

ReferenceRefer to theDROPS Configuration Guide.


Step 3 If required, or useful, select an existing Deployment Tag to regroup the Instance with othersimilar instances.

NoteTags can bemanaged here or in the Preferencemenu.

Warning!Deleting tags removes them from all of the Instances to which itwas linked.

ReferenceFor more information about Deployment Tags, refer to Managing




Deployment Tags on page 193.

Click Finish.

Result The newDeployment Process Instance is available in the Deployment Process Instancessearch view.

28.2.2 Create an Instance to deploy Multiple Releases to an EnvironmentThis option creates a single Deployment Process Instance that includes multiple Releases to be deployed toa single Environment.

During the deployment, the Release Set is processed just like a CUMULATIVE deployment: DROPS will firstgo through each release of the set and keep the latest version of each artifacts to build its artifacts list.

Sets of Releases are parsed to only include themost recent version of an Artifact, if the same artifact isincluded in multiple Releases. The Release with themost recent version of the Artifact will include it duringdeployment and the Releases with outdated versions of that Artifacts will not.

Follow the subsequent steps to create an Instance that will deploy a set of multiple Releases.


Step 1 To open the Create a new Deployment Process Instance for a Release Set wizard, either clickthe Create for Release Set icon in the Deployment Process Instances search view or right-click anywhere in the view and select Create for Release Set.

Step 2 Define themain properties of all the Instances by clicking the Browse button for each of thefollowing entities.

1. If multiple clients are available, select the Client to which to deploy the Releases. Changingthe Client alters the options available throughout the wizard. Only the entities available forthe selected Client will be accessible.

2. Select the Environment to which to deploy the Releases. The list is prepopulated with theEnvironments available for the selected Client. Changing the Environment alters the optionsavailable throughout the wizard. Only the entities available for the selected Environment willbe accessible.

3. Select theDeployment Process to use. The list is prepopulated with the Processes availablefor the selected Environment.

4. Modify the template for the Transaction ID. The ID's syntax follows the templatemanaged inthe Preferences menu.






Step 3 Ctrl+click to select the Releases to deploy. The list is prepopulated with the Releases available forthe selected Client.





ReferenceFor more information about Deployment Tags, refer to ManagingDeployment Tags on page 193.

Click Finish.

Result The newDeployment Process Instance is available in the Deployment Process Instancessearch view. Instances created for Release Sets are indicated by a plus sign in theRelease columnindicating that more than one release is to be included in the deployment.

Figure 65: Deployment Process Instances for Release Sets

28.2.3 Create Multiple Instances to deploy one Release to an EnvironmentGroup

Contrary to the release set option above, this option creates multiple individual Deployment ProcessInstances that each deploy the same Release to multiple Environments that are defined in an EnvironmentGroup.

Follow the subsequent steps to createmultiple Instances using an Environment Group.


Step 1 To open the Create a new Deployment Process Instance from Environment Groupwizard,either click the Create from Environment Group icon in the Deployment Process Instances




search view or right-click anywhere in the view and select Create from Environment Group.

Step 2 Define themain properties of all the Instances by clicking the Browse button for each of thefollowing entities.

1. If multiple clients are available, select the Client to which to deploy the Release. Changing theClient alters the options available throughout the wizard. Only the entities available for theselected Client will be accessible.

2. Select the Environment Group that includes the Environments to which to deploy theRelease. The list is prepopulated with the Environment Groups available for the selectedClient. Changing the Environment Group alters the options available throughout the wizard.Only the entities available for the selected Group will be accessible.

3. Select theApplication to deploy. This list is prepopulated with all of the Applications that theEnvironments in the Group share.

NoteThe Deployment Processes used to generatemultipleInstances are the Process(es) that concern the selectedApplication/Release defined as default for the Environment(s)in the Environment Group. If no default Process is defined forthe Environment/Application pair, the option to choose theDeployment Process to use is displayed.

The list of Processes to select is prepopulated with theProcesses available for each Environment/Application pair inthe Group.

4. Select theRelease to deploy. The list is prepopulated with the Releases available for theselected Client.

5. Modify the template for the Transaction ID.Modify the template for the Transaction ID. The ID's syntax follows the templatemanaged inthe Preferences menu.



Step 3 To Generate Transfer-Only and Installation-Only Instances, leave the corresponding checkboxticked [default]. If the check box is not selected, Full-Transfer Instances are created.

NoteIf both Transfer- and Installation-Only Instances arecreated, the Installation-Only Instance can be automaticallyscheduled to deploy.




ReferenceFor more information about setting the automatic schedule forInstallation Instances, refer to the DROPS Configuration Guide.




ReferenceFor more information about Deployment Tags, refer to ManagingDeployment Tags on the facing page.

Click Finish.

Step 5 If no default Deployment Process is defined for an Environment included in the EnvironmentGroup selected, the Process Selection dialog is displayed. Select the Deployment Process to useto deploy the selected Release. The list is prepopulated with the Deployment Processes availablefor the selected Environment/Application pair(s).

ReferenceFor more information about default Processes, refer to DefiningDefault Deployment Processes on page 135.

Result The newDeployment Process Instances are available in the Deployment Process Instancessearch view.

28.2.4 Duplicate a Deployment Process InstanceDuplicating an Instance is a quick way to create an identical Instance, with the same tags, that can later bescheduled differently or to which you can add different attachments.

To duplicate an existing Deployment Process Instance, select it then either click the Duplicate icon, orright-click on it and select Duplicate a Deployment Process Instance. The duplicated Instance isautomatically available in the Deployment Process Instances search view and has its own TransactionID.

NoteDuplicating a Transfer-Only or an Installation-Only Instance createsa Full-Transfer Instance.




28.3 Changing the Release to deploy

Scheduling future deployments is often very important but the exact Release to deploy at a scheduled timeisn't always defined until shortly before the deployment is to be executed. Defining an arbitrary Release inorder to schedule a Deployment Instance, then changing the Release before deployment can be helpful toschedulemultiple future releases well in advance.

NoteChanging the Release that a Deployment Instance deploys is only possibleif the Instance's Execution Status is Prepared and if it is in Full or Transfer-Only mode.

If the Release is changed for a parent Instance, the same change is alsocarried over to all of its scheduled child Installation-Only and Rollback Instances.

Follow the subsequent steps to change a Deployment Process Instance's Release in the Instances view.

Step 1 To open the Select a Release dialog, select the Instance in the Deployment ProcessInstances search view then either click the Change Release icon, or right-click on it and selectChange Release.

Step 2 Select the newRelease to deploy then clickOK or double-click it.

Result TheRelease column in the Deployment Process Instances search view is updated with thenewRelease to deploy.

28.4 Managing Deployment Tags

Deployment Tabs are intended to regroup similar Deployment Process Instances and search for theseinstances by their tag. If an Instance is duplicated, its tags are carried over to the new Instance, too.

Tags may be required for every Deployment Instance, or optional. If they are required, DeploymentProcess Instances must be tagged when they are created. If they are optional, Instance can be tagged whenthey are created or afterwords.

Tags can always be removed after an Instance is created.

TheDeployment Tags dialog is used to tag one or more Instances and manage the tags themselves afterInstances are created. Tags can be edited at any time. To access theDeployment Tags dialog, select one ormore Deployment Process Instance(s) in the search view then either click the Manage Deployment Tagsicon or right-click then select Manage Deployment Tags.

To tag the selected Instance(s), select the tag from the list and clickOK. When an Instance is tagged,that tag is highlighted.




Figure 66: Tagged Deployment Process Instances

To remove a tag from the selected Instance(s), unselect the highlighted tag(s) [Ctrl+click], then clickOK.

NoteTags can bemanaged in the Preferencemenu and in each tag selectiondialog when working with Deployment Process Instances.

ReferenceFor more information about managing tags from the Preferences menuand about making tags required, refer to theDROPS Configuration Guide.

To create a new tag click the Add button. Enter the name of the new tag then clickOK.

To edit the name of an existing tag, double-click on it or select it then click the Edit button. Modify thename of the tag, then clickOK.

To delete an existing tag, select it then click the Delete button.

Warning!Deleted Deployment Tags cannot be accessed or recovered.

Deleting a tag does not delete any of the Instances that may be linked toit. The link between the tag and the Instance is broken but the Instance’scontent is not modified.

28.5 Defining an Instance's Deployment mode

Deployment Instances can be carried out in one of threemodes: Full-Transfer, Transfer-Only or Installation-Only mode. If an Instance has not been executed, you can change themode to deploy it in atany time.




28.5.1 Mark an Instance to deploy in Full-Transfer modeDeployment Process Instances that aremarked to be deployed in Full-Transfer mode deploy all of theStages included in the Deployment Process Diagram.

NoteBy default, all newDeployment Process Instances are set to deploy in Full-Transfer mode.

NoteIf a Transfer-Only Instance already has an Installation-Only child Instance,the child instance is not deleted. It is recommended to delete the childInstance so that the installation does not run twice.

To mark a Transfer-Only or Installation-Only Deployment Process Instance to run in Full-Transfermode, either right-click on the Instance in the Deployment Process Instances search view then selectMark as Full-Transfer or select it, then click the Full-Transfer icon.

Result The Instance's icon changes to in theApplication column.

ReferenceFor more information about the different Stages of theDeployment Process, refer to Manage Deployment Process Stageson page 141.

For more information about executing a Full-Transferdeployment, refer to Executing Deployment Process Instancesmanually on the next page or Scheduling Deployment ProcessInstances on page 198.

28.5.2 Mark an Instance to deploy in Transfer-Only modeDeployment Process Instances that aremarked to be deployed in Transfer-Only mode stop deploying aftertheReceiving Stage is complete. If an Installation Stage is included in the Deployment Process it is notcarried out.

To mark a Deployment Process Instance to run in Transfer-Only mode, either right-click on the Instance inthe Deployment Process Instances search view then select Mark as Transfer-Only or select it, thenclick the Transfer-Only icon.

Result The Instance's icon changes to in theApplication column.

ReferenceFor more information about the different Stages of theDeployment Process, refer to Manage Deployment Process Stageson page 141.




For more information about executing a Transfer-Onlydeployment, refer to Executing Deployment Process Instancesmanually below or Scheduling Deployment Process Instances onpage 198.

28.5.3 Create Installation-Only Instances Installation-Only Deployment Process Instances are created from Transfer-Only Instances that

contain an Installation Stage. An Instance in Installation-Only mode is linked to its Transfer-Only parentand has the exact same Transaction ID.

ExampleIf the first Stages in a Deployment Process have already been carried out inTransfer-Only mode and any actions required for the transferred Artifactsare complete, the delivery is ready to be finalized manually which can onlybe done by creating an Installation-Only Instance.

ReferenceFor more information about the different Stages of the DeploymentProcess, refer to Manage Deployment Process Stages on page 141.

There are two ways to manually create Installation-Only Instances:

1. To create and immediately execute an Installation-Only Instance, refer to Executing DeploymentProcess Instances manually below.

2. To create and schedule an Installation-Only Instance to execute later, refer to SchedulingDeployment Process Instances on page 198.

28.6 Executing Deployment Process Instances manually

Deployment Process Instances can either be executed manually or scheduled to be executed automaticallyin the future. If an Instance is scheduled, override the schedule by executing the Instancemanually.

To viewwhat happens during the execution in real-time, open the Deployment Instance’s Results view andwatch the deployment actions take place from the Console tab.




Figure 67: Consulting Deployment Execution results in real-time (Console)

NoteThe Console tab is only available in Prepared Instances or those whichare currently In Progress. If an Instance has finished executing theConsole is no longer available but the log can be accessed in the Logs tab.

ReferenceThe Console is only activated if the corresponding preference is activated.Refer to theDROPS Configuration Guide.

28.6.1 Execute Full-Transfer and Transfer-Only Instances Full-Transfer and Transfer-Only Instances are not executed immediately when they are created.

To execute a Full-Transfer or Transfer-Only Deployment Process Instance immediately, select it inthe Deployment Process Instances search view then either click the Execute icon or right-click thenselect Execute. The deployment begins right away and any scheduling information for the Instance isoverridden.

28.6.2 Execute Installation-Only Instances Installation-Only Deployment Process Instances can be created and then executed immediately.

Follow the subsequent steps to create and execute an Installation-Only Deployment Process Instanceimmediately from the Deployment Process Instances search view.

Step 1 Select the Transfer-Only Instance in the Deployment Process Instances search view.

Step 2 Either click the Installation-Only icon, or right-click then select Execute Installation-Only.




Step 3 Click OK in the dialog to confirm.

NoteIf the Transfer-Only Stage of the Deployment Process has notbeen executed yet or was unsuccessful, a second dialog isdisplayed. You can either cancel the installation or proceed anywayand the Actions in the Deployment Diagram's Installation Stage(s)will begin.

A Transfer Stage can "fail" when any Action in the stage cannot becarried out. This means that the stage can "fail" after content istransferred by one action if the following action cannot becompleted. If an Action post-transfer fails, the transferred files canstill be installed.

ExampleIf your Transfer Stage includes an Action to send an email after atransfer is complete and the email cannot be sent (the final Actionfails) the whole Transfer Stage will have a Failed status eventhough the transfer Action completed successfully.

ReferenceTo define when an Action should be considered as complete orfailed, modify to the Action’s Fails on Error property.

Result The Installation Stage of the Deployment Process Diagram begins automatically and the Installation-Only Instance is created in the Deployment Process Instances search view.

28.7 Scheduling Deployment Process Instances

Deployment Process Instances can either be executed manually or scheduled to be executed by DROPS inthe future.

NoteAll Instances in any mode can be scheduled but theymust have aPrepared status. Instances that have already been executed once cannotbe scheduled to deploy again.

The scheduling information can bemanaged in the Deployment Process Instances search view asdescribed below or in the Deployment Process Scheduler view. Any information changed here iscarried over to the Scheduler and any changes made via the Scheduler are carried over to this view.

ReferenceFor more information about the Scheduler view, refer to Working with theDeployment Process Scheduler on page 208.




28.7.1 Schedule Full-Transfer and Transfer-Only Instances Full-Transfer and Transfer-Only Instances are not executed immediately when they are created. Any

Deployment Process Instance's schedule can bemodified up until themoment it executes.

Follow the subsequent steps to schedule a Deployment Process Instance to execute in the future from theDeployment Process Instances search view. These steps can also be used at any time to change the

schedule defined for any Instance.

Step 1 To access the Scheduling Information dialog, select the Instance then either click the Changethe scheduling information icon or right-click, then select Change the schedulinginformation.

Step 2 Tick the Scheduled checkbox to activate the schedule for the current Instance.

Step 3 Select theDate, Hour andMinute that the Instance should be executed.

Step 4 If the deployment should be carried out in Transfer-Only mode, tick the Transfer-Onlycheckbox. If this checkbox is not ticked, the Deployment Process Instance will be carried out in Full-Transfer mode.

NoteIf a Full-Transfer Instance is changed to a Transfer-Onlyhere, the Transfer-Only's child Installation-Only Instance isautomatically created and scheduled to deploy at the same time asits parent Transfer-Only Instance.

If a Transfer-Only Instance is changed to a Full-Transferhere, the Transfer-Only's child Installation-Only Instance isdeleted.

ClickOK.

Result The Scheduling Info column for the selected Instance is filled in with the date and time of thescheduled execution.

28.7.2 Schedule Installation-Only Instances Installation-Only Deployment Process Instances can be created and scheduled to be executed by

DROPS at a later date.

Follow the subsequent steps to create and schedule an Installation-Only Deployment Process Instancefrom the Deployment Process Instances search view.

NoteOnly Transfer-Only Instances can be used to schedule Installation-OnlyInstances.

Step 1 To access the Scheduling Information dialog, select the Transfer-Only Instance then either




click the Schedule Installation-Only icon or right-click then select Schedule Installation-Only.

Step 2 Tick the Scheduled checkbox to activate the schedule for the Installation operation.

Step 3 Select theDate, Hour andMinute that the Installation-Only Instance should be executed.

NoteThe Install Only checkbox is not available because the parentInstance is Transfer-Only by default.

ClickOK.

Result The Installation-Only Instance is created and the Installation Stage of the Deployment ProcessDiagramwill begin at the time defined (displayed in the Scheduling Info column).

28.7.2.1 Managing an Installation-Only Instance's Automatic-Schedule

If an Installation-Only Instance was automatically scheduled when it was created via a DeploymentTag, deactivate the automatic schedule by toggling between automatic schedule and manual schedule (orno schedule at all - N/A).

If an Installation-Only Instance has been auto-scheduled, the label will be in one of the followingformats:

l *AUTO [+<delay_value>] if no fixed time has been chosenl *AUTO [+<delay_value>] [<hour>:<minute>] if a fixed time has been chosen

To toggle between the Auto-Schedule defined in the Deployment Process and a user-defined schedulefollow the steps in Modify any Instance's Schedule below. Changing the schedule from *AUTO to theschedule defined by the user overrides the auto-schedule.

To toggle between the Auto-Schedule defined in the Deployment Process and no schedule at all, right-clickon an Instance and either select Auto-Schedule (to apply the auto-schedule) or Remove Auto-Scheduling Mode (to remove any schedule).

NoteThe Auto-Schedule for Installation-Only Instances can only be toggledon/off if the Instance has a Prepared Status and its Transfer-Onlyparent Instance is not Completed.

Important!Installation-Only Instances must always have a scheduled time todeploy. An Installation-Only Instance withN/A in the Scheduling Infocolumn will never execute. You cannot manually execute this kind ofinstance after it is created and if its schedule is toggled off.

28.7.3 Modify any Instance's ScheduleFollow the subsequent steps to modify any Deployment Process Instance's schedule from the




Deployment Process Instances search view.

Step 1 Either right-click on the Instance in the Deployment Process Instances search view then select Change the scheduling information or select it, then click the Change the scheduling

information icon to open the Scheduling Information dialog.

Step 2 Tick the Scheduled checkbox to activate the schedule for the current Instance.

Step 3 Select theDate, Hour andMinute that the Instance should be executed.

ClickOK.

Result The Scheduling Info column for the selected Instance is filled in with the date and time of thescheduled execution.

NoteWhen changes aremade to a Deployment Instance's schedule, theDeployment Process Scheduler is also updated.

ReferenceFor more information about the Scheduler view, refer to Workingwith the Deployment Process Scheduler on page 208.

28.8 Understanding Deployment Process Instance results

The Deployment Process Instances search view provides some details of processed DeploymentProcess Instances. Access more information by either double-clicking on an Instance in the list, selecting itthen clicking the Results icon in the view or right-clicking then selecting Show Deployment Results.

The Deployment Results view contains four tabs that each contain different elements of the deployment.

Figure 68: Overview of the Deployment Process Instance results




TheOverview tab displays the uneditable general information about the Instance. The End Date andExecuted by fields are blank until the Instance is executed.

28.8.1 View the steps carried outAll of the Activities and Stages included in the Deployment Process, along with their current ExecutionStatus and Result, are displayed in theDeployment Steps tab.

If a Deployment Process Instance is suspended, check this tab to see why. Often, the deployment iswaiting for approval which means that a Validation Request is pending.

ReferenceFor more information about resolving suspended Deployment Instances,refer to Working with Validation Requests on page 223 or Working withSuspended Actions on page 220.

If a file transfer fails, DROPS will retry the transfer a number of times. This number of attempts is defined inthe Server Configuration (the default value is 3). If all attempts fail, the process is aborted and theExecution Result is set to Failed.

Before trying to re-transfer the file, DROPS will check if the remote Agent is reachable. If not, DROPS willretry to reconnect a number of times, this number of attempt is also defined in the Server Configuration(the default value is 3).

If all the reconnection attempts fail, the related file transfer attempt is marked as failed.

ReferenceFor more information about defining the default numbers mentionedabove, refer to theDROPS Configuration Guide.

Figure 69: The Deployment Result view - Steps




28.8.2 View the LogsAll of the activity from the deployment is displayed in the Logs tab. Every action carried out during adeployment is logged.

To filter the records at the source and exclude specific entries that are unnecessary, create a regex andenter it in the ANT Message Filter field found in the Local Execution settings of the DROPS Server. If noregex is defined, all entries are logged in the deployment log. Refer to theDROPS Configuration Guide.

Filter results byMessage Code,Message Text, Activity ID, Stage ID or Action ID. Enter anycombination of search criteria then click the Search icon to display the results. To display the completelog, click Search without entering any criteria.

Filter the severity of the results displayed by selecting one or more of the Severity icons

l Fatal Only fatal errors are displayed.

l Warning Only Warnings errors are displayed.

l Info Only Important information is displayed.

l Verbose Only details are displayed.

Use the Show Previous and Next icons to quickly move through a long list of entries to find and jumpto the fatal errors.

Click the export icon to open the selected log(s) in an external text editor. By default, the editor will openautomatically.

Click the export to JSON file icon to open the selected log(s) in .json format. You will be prompted toselect where to save the file.

If no log entries are displayed, the log may be archived. Logs can be automatically or manually archived tocreate space in the database. If no logs are available in this view, check theAttachments tab to access thearchived .txt log file.

While only successfully deployed Instance’s logs can be automatically archived, both successful andunsuccessful deployment logs can bemanually archived. To manually archive a Deployment ProcessInstance’s log, search for it in the Deployment Process Instances search view. Either right-click on itthen select Archive Log or select it, then click the Archive Log icon. When archived, logs are removedfrom the database which liberates space.

ReferenceFor more information about activating the auto-archive option fordeployment logs and how to define the location to store archived logs,refer to theDROPS Configuration Guide.

Advanced Live-Console LogsStarting in DROPS v2.7, the way deployment logs are stored and displayed changeddramatically. Execution Instances’ logs are stored in separate databases so they do not share a commonbase. This helps to limit the space required to store deployment results. Logs are written once the




execution is complete which helps speed up the amount of time it takes to complete the deployment andrecord the results.

The steps carried out during deployment are displayed on the left in the new logs, just as they are in theDeployment Steps tab. Each step’s individual result (failed or successful) are displayed in order to quicklyaddress the step that may be causing problems in your deployment. To view the log information for anypart of the process, click on the step on the left. The log for the step selected, as well as any sub-steps/actions/scripts included in the parent selected, are displayed on the right.

ExampleTo view the entire process’ log, click on the highest-level entry in the steps.The full log is displayed on the right.

To view the log for a certain Infrastructure Item or Action carried out, clickon the step to filter the log as much as required to find the exact action inthe process that failed.

In the example below, the deployment to the Apache Infrastructure Itemfailed in general but we can see that only one Stage in that Item’s processfailed. Furthermore we can see that only one Action in the InstallationStage failed but not all of them. If we click on the Action that failed, we cansee its unique log and quickly find the problem.

Figure 70: The Deployment Results view ≥v2.7 - Logs

ReferenceThe advanced version of the logs is only activated if the correspondingpreference is activated. If this option is not active, the previous version ofthe log display is used.

For more information about this and changing the syntax displayed foreach line in the advanced log, refer to theDROPS Configuration Guide.

Simple LogsThe logs for any Execution Instance created with v2.6 or earlier are still displayed with the first version ofthe log manager. The logs from previous versions are still complete but cannot be filtered by step. If the




Use Instance Log option is not active, this version will also be displayed for any Instance created using v2.7or later.

Figure 71: The Deployment Results view ≤v2.6 - Logs

Clicking on a log entry displays the full information of the error.

28.8.3 View the AttachmentsAttachments that are automatically created represent the deployed Artifact List and .properties files.Attachments can also be added to Deployment Process Instances by the Publish File script (Action).Archived Deployment logs are automatically added to an Instance’s attachments and can be downloaded asa .txt file.

View any attachments published during the Deployment Action in theAttachments tab.

Figure 72: The Deployment Result view - Attachments

Download an attachment by selecting it and clicking the Save icon.

Open the attachment in a local viewer (if possible) by selecting it and clicking the Open icon.




28.9 Rolling back a deployed Deployment Process Instance

Any Deployment Process Instance can be rolled back in order to reinstate the previously deployed contentthat the current deployment overrode. Rollback for Deployment Process Instances can either be executedmanually or scheduled to be executed automatically in the future.

28.9.1 Roll back a Deployment manuallyFollow the subsequent steps to create and execute a Rollback Instance immediately from theDeployment Process Instances search view.

Step 1 Select the Instance to roll back in the Deployment Process Instances search view then eitherclick the Rollback icon or right-click, then select Rollback.

Step 2 ClickOK in the dialog to confirm that the Instance should be rolled back.

Step 3 ClickNo in the dialog to schedule the rollback for another time.

Result All of the Stages and Actions in the Deployment Process executed by the Instance are recalled inreverse order and the new Rollback Instance is available in the Deployment ProcessInstances search view.

28.9.2 Schedule a Deployment's rollbackFollow the subsequent steps to schedule a Rollback Instance from the Deployment ProcessInstances search view.

Step 1 Select the Instance to roll back in the Deployment Process Instances search view then eitherclick the Rollback icon or right-click, then select Rollback.

Step 2 ClickOK in the dialog to confirm that the Instance should be rolled back.

Step 3 Click Yes in the dialog to schedule the rollback for another time.

Step 4 Define theDate, Hour andMinute when the rollback should be executed.

NoteIf the Instance to roll back is already Completed, the scheduleddate/time to roll back must be after the source's Completion Date.

If the Instance to roll back is scheduled, the scheduled date/time toroll back must be after the source's Scheduled Date.

If the Instance to roll back is not completed and not scheduled, thedate/time to roll back must be after the source's Start Date.

Result The new Rollback Instance is available in the Deployment Process Instances search view.

Schedules for Rollback Instances are carried over to the Scheduler and any changes made via thescheduler are carried over to the Deployment Process Instances search view.




ReferenceFor more information about the Scheduler view, refer to Workingwith the Deployment Process Scheduler on page 208.

28.10 Canceling Deployment Process Instances

Warning!Canceled Deployment Process Instances cannot be restarted.

To cancel a Deployment Process Instance search for it in the Deployment Process Instances searchview. Either right-click on it, then select Cancel Execution or select it, then click the Cancel icon. ClickOK to confirm or click Cancel to keep the Instance.

28.11 Deleting Deployment Process Instances

NoteInstances that are In Progress cannot be deleted. To delete an Instancethat is stuck in progress, cancel it first, then delete it.

Warning!Deleted Deployment Process Instances cannot be accessed or recovered.Deleting an Instance removes the trace of the delivery.

To delete a Deployment Process Instance search for it in the Deployment Process Instances searchview. Either right-click on it, then select Delete or select it, then click the Delete icon. ClickOK toconfirm or click Cancel to keep the Instance.



DROPS v2.8.1User Guide | 29 Working with the Deployment Process Scheduler

29 Working with the Deployment Process Scheduler

Required Roles Environment ReleaseManager and/or Operator



Access DROPS Server→ Deployment Process→ Deployment Process Scheduler

Chapter Summary29.1 Searching for Deployment Process Instances 20929.2 Creating Deployment Process Instances 21029.3 Rescheduling Deployment Process Instances 21329.4 Changing the Release to deploy 21329.5 Defining an Instance's Deployment mode 21429.6 Executing Deployment Process Instances manually 21529.7 Scheduling a Rollback Instance 21529.8 Viewing Deployment Process Instance details and results 21529.9 Deleting Deployment Process Instances 216

Multiple Deployment Process Instances can be scheduled to match your team's needs. To manage whenthe first Actions included in the Deployment Process Diagram are executed, schedule when a DeploymentProcess Instance should be carried out. Scheduling the Deployment Process is useful to continuouslydeliver content that is regularly updated or if you know in advance when the next batch of content todeliver will be ready.

A dedicated job runs on the DROPS Server that regularly scans for scheduled Deployment ProcessInstances, then triggers them according to the schedule(s).

Deployment Process Instances enable you to deploy one Application to one target Environment. Instancescan be created from the Deployment Process Instances search view and either executed manually orscheduled in order to execute them at a later date or even to execute them regularly.

Warning!If the DROPS Server is stopped during a deployment, the DeploymentProcess Instance is canceled. You cannot continue the deployment oncethe server is started again. In order to finish deploying, duplicate theInstance and execute again.

Deployment Process Instances can bemanaged in two different views: the Deployment ProcessInstances search view or the Deployment Process Scheduler. Any information changed in theScheduler is carried over to the Instances view and vice versa.

ReferenceThis chapter describes how to manage Instances from the DeploymentProcess Scheduler. For more information about the Instances search view,refer to Working with Deployment Process Instances on page 184.



DROPS v2.8.129 Working with the Deployment Process Scheduler | User Guide

29.1 Searching for Deployment Process Instances

Follow the subsequent steps to search for Deployment Process Instances in the Scheduler.

Step 1 Select Deployment Process Scheduler from the Deployment Process node in the Console Explorer.

Figure 73: The Deployment Process Scheduler

Step 2 Use the search criteria sections to filter the search.

Result The Deployment Process Scheduler search view displays all of the scheduled Instances thatmeet the search criteria in a Gantt chart.

The Scheduler is divided into rows that all follow the same time line. The names on the left invertical text describe the Application, Release deployed, target Environment and DeploymentProcess. Use the Section filter options to view some or all of these entities in each row. Changingthe entity(ies) to display in the scheduler redefines the number of and reorganizes therows. Reorganizing the elements displayed enables you to view all of the Deployment ProcessInstances configured for any combination of Environtment/Application/DeploymentProcess/Release.

NoteThe sections to display can also be defined in the Preferences(refer to theDROPS Configuration Guide).

If no section is defined, all of the instances are displayed in the same row.

ExampleIf you have deployed the same Application to multipleEnvironments and only want to view the Instances that deployedit, but not those for other Applications deployed to the sameEnvironment(s), filter the Scheduler view to only displayApplications.




Figure 74: The Scheduler's Environment/Application rows

Transfer-Only Instances that are linked to Installation-Only Instances are connected with an arrowin the Scheduler.

Figure 75: Parent and child instances are connected in the Scheduler

The icons displayed for each instance correspond to the icons described in Deployment ProcessInstance statuses & Results on page 186 and Deployment Process Instancemodes on page 186.

The current time/date is indicated with a vertical green line.

To view the schedule hour by hour, day by day or even year by year, click the magnifiericons to zoom in or out in the Gantt chart.

To jump to the first, last or most recent Instance in time, click the jump-to icons.

To choose a specific date to view, click the Calendar drop-down and select thedate.

29.2 Creating Deployment Process Instances

There are three ways to create Deployment Process Instances from the Scheduler:




1. Create a new Instance using the Create a new Deployment Process Instance wizard.2. Inherit the predefined information from a row in the Scheduler to automatically set the Application,

Release and Environment for the new Instance.3. Duplicate an existing Deployment Process Instance to quickly create an Instance with the same

parameters as another Instance. Duplicating creates a copy of an existing Instance that can bemodified.

NoteBy default, new Instances are always marked to be deployed in Full-Transfer mode, however they are not executed automatically and must beexecuted manually or scheduled to execute automatically.

29.2.1 Create new Deployment Process InstancesFollow the subsequent steps to create a newDeployment Process Instance in the Scheduler.

Step 1 To open the Create a new Deployment Process Instance wizard, either right-click in the Ganttchart at the time you plan to launch the deployment and select Create a new DeploymentProcess Instance or click the Create icon in the Deployment Process Scheduler toolbar.

Step 2 Define the Instance by clicking the Browse button for each of the entities and modifying thetemplate for the Transaction ID, if needed. The ID's syntax follows the templatemanaged in thePreferences menu.

ReferenceFor more information about the default Transaction ID template,refer to theDROPS Configuration Guide.






Click Finish.




Result The new Instance is displayed in the Deployment Process Scheduler. If the Instance wascreated from the chart at a specific time, it appears at its defined execution date/time. If it wascreated from the toolbar, the Instance is displayed at the current time.

29.2.2 Create new Instances with predefined information using theScheduler's sections

Instances are displayed in the Scheduler based on how the rows are displayed. If the rows are filtered bysection to display any combination of Environtment/Application/Deployment Process/Release thisinformation can be automatically inherited by the new Instance by creating it from a specific row. This is aquick way to manage the continuous deployment of a Release or to recreate a failed execution.

Follow the subsequent steps to create predefined Deployment Process Instances in the Scheduler.

Step 1 To open the Create a new Deployment Process Instance wizard, right-click in the Gantt chart inthe row for which you want to reuse the Environment/Process/Release combination at the timeyou plan to launch the deployment and select Create Instance from section.

Step 2 The Deployment Process, Environment and Release to deploy are all pre-defined based on the rowand cannot bemodified.

Modify the template for the Transaction ID, if needed. The ID's syntax follows the templatemanaged in the Preferences menu.

ReferenceFor more information about the default Transaction ID template,refer to theDROPS Configuration Guide.






Click Finish.

Result The new Instance is displayed in the Deployment Process Scheduler at its defined executiondate/time.




29.2.3 Duplicate a Deployment Process InstanceTo duplicate an existing Deployment Process Instance from the Scheduler, right-click on it and selectDuplicate a Deployment Process Instance.

The duplicated Instance is automatically available in the Deployment Process Scheduler and has itsown Transaction ID. It is displayed at the date/time for which the original Instance is scheduled to executeand can bemodified independently.

NoteDuplicating a Transfer-Only or an Installation-Only Instance createsa Full-Transfer Instance.

29.3 Rescheduling Deployment Process Instances

Drag Deployment Process Instances to the left or right in the Gantt chart to reschedule them. The date andtime to where the Instance is dragged is displayed in a tool tip as you drag it around. Release the Instanceto reschedule it.

Zoom out on the chart to see dates further into the future to reschedule Instances for dates long inadvance then zoom back in to define the time to deploy.

Figure 76: Drag an Instance to Reschedule in the Scheduler

The gray brackets indicate the limits that the instance can be scheduled for. In the example above, the Transfer-Only Instance cannot bemoved to the right of the top bracket because it cannot be scheduled toexecute after its child Installation-Only Instance. The Installation-Only Instance cannot be scheduled toexecute less than one hour after the parent Transfer-Only Instance because the default minimum delay isset to one hour.

29.4 Changing the Release to deploy

Follow the subsequent steps to change a Deployment Process Instance's Release in the Scheduler.

Step 1 Right-click on the Instance.

Step 2 Select Change Release.




Step 3 Select the newRelease to deploy from theRelease Selection dialog then clickOK or double-clickit.

Result TheRelease is updated.

29.5 Defining an Instance's Deployment mode

Deployment Instances can be carried out in one of threemodes: Full-Transfer, Transfer-Only or Installation-Only mode. If an Instance has not been executed, you can change themode to deploy it in atany time.

29.5.1 Mark an Instance to deploy in Full-Transfer modeFollow the subsequent steps to mark a Transfer-Only Deployment Process Instance to run in Full-Transfer mode from the Scheduler.


Step 2 Select Mark as Full Execution.

Result The Instance is changed to Full-Transfer mode.

NoteIf a Transfer-Only Instance already has an Installation-Only childInstance, the child instance is not deleted. It is recommended todelete the child Instance so that the installation does not run twice.

29.5.2 Mark an Instance to deploy in Transfer-Only modeFollow the subsequent steps to mark a Full-Transfer Deployment Process Instance to run in Transfer-Only mode from the Scheduler.


Step 2 Select Mark as Transfer-Only.

Result The Instance is changed to Transfer-Only mode.

29.5.3 Schedule Installation-Only InstancesFollow the subsequent steps to schedule a new Installation-Only Deployment Process Instance from theScheduler.

Step 1 Right-click on the parent Transfer-Only Instance.

Step 2 Select Schedule Installation-Only.

Step 3 Tick the Scheduled checkbox in the Create Scheduled Install Execution dialog then define thescheduled time and date.




Result The Installation-Only Instance is created and linked to its parent Transfer-Only Instance. Thenew Instance is displayed in the Deployment Process Scheduler at its defined executiondate/time.

29.6 Executing Deployment Process Instances manually

Deployment Process Instances can be executed manually from the Scheduler to override the scheduledtime/date and deploy immediately.

NoteAll Instances in any mode can be executed manually at any time, even ifthey have already been executed.

Follow the subsequent steps to execute a Deployment Process Instancemanually from the Scheduler.


Step 2 Select Execute.

Result The Instance is launched and themoved to the current date/time in the Scheduler.

29.7 Scheduling a Rollback Instance

Follow the subsequent steps to schedule a Rollback Instance from the Scheduler.


Step 2 Select Rollback.

Step 3 Define the scheduled time and date.

Result The new Instance is displayed in the Deployment Process Scheduler at its defined executiondate/time.

29.8 Viewing Deployment Process Instance details and results

Hover over scheduled Instances to see details about the delivery in the tool tip.




Figure 77: Hover to see Instance details in the Scheduler

Double-click on an Instance or right-click then select Show Deployment Result to accessthe Deployment Results view.

ReferenceFor more information about deployment results, refer to UnderstandingDeployment Process Instance results on page 201.

29.9 Deleting Deployment Process Instances

NoteOnly Instances that are not In Progress can be deleted. To delete anInstance that is stuck in Progress, cancel it first, then delete it.

Warning!Deleted Deployment Process Instances cannot be accessed or recovered.Deleting an Instance removes the trace of the delivery.

To delete an Instance from the Scheduler right-click on it, then select Delete. ClickOK to confirm orclick Cancel to keep the Instance.



DROPS v2.8.130 Working with Interruption Messages | User Guide

30 Working with Interruption Messages

Required Roles Environment Release OperatorInfrastructure ItemManager and/or Contributor

Required Rights(by category) Suspended Actions


Access DROPS Server→ Deployment Process→ Interruption Messages

Chapter Summary30.1 Accessing pending Interruption Messages 21730.2 Responding to Interruption Messages 21830.3 Reviewing processed Interruption Messages 219

Some ANT tasks, which are called during the Deployment Process, can launch external processes on targetsystems. If an external process becomes suspended, the DROPS Agent relays the problem and the possiblesolutions back to the DROPS Server as an Interruption Message. Interruption Messages must be attendedto before deployment can continue.

If an external process is suspended, a generic notification email is automatically sent to the User(s) in thedesignated Role(s). Users with the role to do so choose the correct response to a Interruption Messagewhich pilots the action to take on the suspended external process.

NoteIf you are working with ARCAD as an external process, it must be v10.06.xxor higher.

30.1 Accessing pending Interruption Messages

Select the Pending Interruption Messages node from Interruption Messages in the ConsoleExplorer.

The Interruption Messages view displays all of the pending messages that you must reply to in orderfor the associated Deployment Process to continue forward.



DROPS v2.8.1User Guide | 30 Working with Interruption Messages

Figure 78: The Interruption Messages view

The Creation Date column displays the date themessages was sent which corresponds to the date theevent that requires problemwas encountered.

The Infra. Item Code column displays the corresponding Item’s code.

TheApp. Code and Release Number columns display the corresponding content that is to be deployedwith the current Process.

TheMessage column briefly describes the problem encountered.

TheResponse column displays the current solution to the interruption.

30.2 Responding to Interruption Messages

A notification email is sent to the Users who have the correct Role to respond to Interruption Messages.

ReferenceFor more information about editing the default content of automaticemails and defining themail configuration, refer to theDROPS Configuration Guide.

To respond to the Interruption Message you must fill out the responsemanually. Select the item in theInterruption Messages view and either click the Edit icon or right-click on it and select Respond toopen the Interruption Messages editor.



DROPS v2.8.130 Working with Interruption Messages | User Guide

Figure 79: The Interruption Messages editor

TheMessage and Comment fields display information about why the external process was interrupted.

The options fromwhich to choose to resolve the problem depend on the actual type of problemencountered. Every interruption will have different options to resolve it. Select the corresponding responsefrom theResponse drop-down menu.

If there is only one response to the problem, it is automatically selected. There will be nothing to changebut you must save to confirm that the option is confirmed.

To save changes made, click the Save button.

Important!You can only respond to an Interruption Messages once. After the selectedoption is saved, theResponse field is read-only.

30.3 Reviewing processed Interruption Messages

To view all of the processed Interruption Messages, select the Processed Interruption Messages nodefrom Interruption Messages in the Console Explorer.

The Interruption Messages view displays all of themessages that you have addressed. Double-click onamessage to open the Interruption Messages editor.



DROPS v2.8.1User Guide | 31 Working with Suspended Actions

31 Working with Suspended Actions

Required Roles Environment Release OperatorInfrastructure ItemManager and/or Contributor for the Infrastructure Item

Required Rights(by category) Suspended Actions


Access DROPS Server→ Deployment Process→ Suspended Actions

Chapter Summary31.1 Accessing pending Suspended Actions 22031.2 Responding to Suspended Actions 22131.3 Reviewing processed Suspended Actions 222

Deployment Processes are suspended when one of two things occurs. Either an Infrastructure Item in theProcess cannot be accessed (the connection is incorrect) or the license key is restricting the Item from beingused.

If a Deployment Process is suspended, a generic notification email is automatically sent to the User(s) in thedesignated Role(s). Suspended Actions must be attended to before deployment can continue.

31.1 Accessing pending Suspended Actions

Select the Pending Suspended Actions node from Suspended Actions in the Console Explorer.

The Suspended Actions view displays all of the pending Requests that you must reply to in order forthe associated Deployment Process to continue forward.

Figure 80: The pending Suspended Actions view

The Creation Date column displays the date the request was sent which corresponds to the date the eventthat requires validation launched.

TheApp. Code and Release Number columns display the corresponding content that is to be deployedwith the current Process.

TheRequest Message column briefly describes the problem encountered.

TheResponse column displays the current reply to the request.



DROPS v2.8.131 Working with Suspended Actions | User Guide

31.2 Responding to Suspended Actions

A notification email is sent to the Users who have the correct Role to respond to Suspended Actions.


To respond to the suspended action you must fill out the responsemanually. Select the request in theSuspended Actions view and either click the Edit icon or right-click on it and select Respond to openthe Suspended Action editor.

Figure 81: The Suspended Action editor

The Suspension Cause and Comment fields display information about why the Process was interrupted. Ifthis is not enough information, check the Deployment Process Instance log for more details.

There are four options to choose fromwhen selecting the response to resolve the problem. Each have adifferent effect on the processing Deployment Process Instance. Select the corresponding response fromtheResponse drop-down list.

l No Responsemaintains the current status of the request and it will remain "pending". The Process willnot continue forward.

l Retry launches the failed action only, enabling you to test it (retry the connection to an InfrastructureItem. The Suspended Action is closed if the retry is successful. It is recommended to retry only if theroot problem has been addressed.

l Stop abandons the failed Action and enables it to cause its parent Activity to fail. This leads to a failedDeployment Process Instance.

l Resume resumes the Process after the failed action. It does not retry the suspended Action andcontinues forward.




DROPS v2.8.1User Guide | 31 Working with Suspended Actions

31.3 Reviewing processed Suspended Actions

To view all of the processed Suspended Actions and their responses, select the Processed SuspendedActions node from Suspended Actions in the Console Explorer.

The Suspended Actions view displays all of the requests that you have replied to. Double-click on arequest to open the Suspended Action editor and change the response.



DROPS v2.8.132 Working with Validation Requests | User Guide

32 Working with Validation Requests

Required RolesEnvironment Release Operator and/or ManagerRelease Project ManagerApplication Database Administrator

Required Rights(by category) Validation Requests


Access DROPS Server→ Deployment Process→ Validation Requests

Chapter Summary32.1 Accessing pending Requests 22332.2 Responding to Requests 22432.3 Reviewing processed Requests 226

If a Deployment Process, or any entity included in one, requires validation before it is allowed to moveforward, a Validation Request notification is sent to the User(s) in the designated Role(s).

Validation Requests are generated during the Deployment Process if the Validation parameter isactivated. They are activated at the highest Process-level of the Deployment Process Diagram and at theActivity-level. They can be executed before any processes can begin or after they're completed. Requiredrequests must be attended to before deployment can continue and the validator may also be required toprovide a reason for either accepting or rejecting the request.

Important!To view and approve/reject Validation Requests, a User must have theRelease Operator role for the Environment in question.

ReferenceFor more information about defining when Validation Requests aregenerated, refer to Editing Deployment Process properties on page 146.

32.1 Accessing pending Requests

Select the Pending Validation Requests node from Validation Requests in the Console Explorer.

The Validation Requests view displays all of the pending Requests that you must reply to in order forthe associated Deployment Process to continue forward.



DROPS v2.8.1User Guide | 32 Working with Validation Requests

Figure 82: The pending Validation Requests view

The Creation Date column displays the date the request was sent which corresponds to the date the eventthat requires validation should have executed.

TheApp Code and Release Number columns display the corresponding content that is to be deployedwith the current Process.

If the User who created the request in the Process entered amessage it is displayed in theRequestMessage column.

TheResponse column displays the current reply to the request.

32.2 Responding to Requests

The Validation Notification email is sent to the Users who have the correct Role to respond to ValidationRequests.


There are two ways to respond to a pending Validation Request:

l Fill in the Validation Request manually,l Validate immediately.

32.2.1 Fill out the Validation Request editorTo fill out the Validation Request manually, select the Request in the Validation Requests view andeither click the Edit icon or right-click on it and select Respond to open the Validation Requesteditor.



DROPS v2.8.132 Working with Validation Requests | User Guide

Figure 83: The Validation Request editor

To validate or reject the request to carry out the corresponding Step, Activity, Action, Stage etc. select theresponse from theResponse drop-down list.

l A Rejected request will stop the action and the Process will not continue forward.l An Approved request will execute the action and enable the Process to continue.

Enter details about the decision made in the Comment field. This step may be required to save theapproved or rejected request if the User who created it ticked theValidation Reason is Mandatorycheckbox.


Important!You can only respond to a Validation Request once. After the selectedoption is saved, theResponse field is read-only.

32.2.2 Validate immediatelyTo validate a Request immediately from the Validation Requests view, select it and either click the Validate icon or right-click on it and select Validate immediately.

ClickOK.

If theValidation Reason is Mandatory checkbox is ticked in the original request, enter details about thedecision made in the dialog.

Result The Request is approved and the Process is allowed to continue.



DROPS v2.8.1User Guide | 32 Working with Validation Requests

32.3 Reviewing processed Requests

To view all of the processed Validation Requests, select the Processed Validation Requests node fromValidation Requests in the Console Explorer.

The Validation Requests view displays all of the Requests that you have replied to. Double-click on aRequest to open the Validation Request editor.



Reports

DROPS v2.8.1User Guide | Introduction to DROPS Reports

Introduction to DROPS ReportsThe reporting feature is based on the BIRT tool and provides reporting tools for different DROPS entities:

l Applications;l Environments;l Deployments;l Security Policies;l Users;l Releases.

Important!Open theHTTP Proxy Services editor to verify that the DROPS WebServer is running correctly by confirming its location ( ConfigurationCategory view→ Administration→ HTTP Proxy Services).

ReferenceFor more information about installing the DROPS Web Server, refer to theDROPS Installation Guide.

About the Configuration Explorer - Reports

Figure 84: The Configuration Management perspective - Dashboard

The Configuration Explorer view provides access to DROPS Reports. This perspective is the functionalside of DROPS.

The Dashboard node contains the Reports for everything under the currently connectedDROPS Server.



DROPS v2.8.133 Working with DROPS reports | User Guide

33 Working with DROPS reports

Required Roles n/a

Required Rights(by category) Reporting


Access DROPS Server→ Dashboard→ Reports

Chapter Summary33.1 The Application Analysis report 22933.2 The Deployment Statistics reports 23033.3 The Environment Analysis report 23133.4 The ReleaseMap Reporting reports 23133.5 The Security Policy reports 232

The pre-configured reports delivered with DROPS are compiled together in the Report List view. Therearemultiple categories and additional categories can be created if more reports are added to DROPS.

Double-click on a report to generate it in HTML format by default. To generate a report in PDF format,right-click on it and select View Report in PDF.

Figure 85: The Report List view

When generated, reports are displayed in your default external browser.

Most reports require you to select a Client, Environment, Infrastructure Item, Application and/or User fromthe first page that displays. Select the entity(ies) from the drop-down list(s) to completely configure thereport.

33.1 The Application Analysis report

The Target Environments report lists all of the Environments for which the selected Application is allowed.



DROPS v2.8.1User Guide | 33 Working with DROPS reports

Figure 86: Example of the Target Environments report

33.2 The Deployment Statistics reports

There aremultiple Deployment Statistic reports which each analyze different deployment results.

NoteThese statistics are only calculated by taking into account deployments thathave been completed. Deployments that are still processing or areprepared but not executed are not analyzed in these reports.

33.2.1 The Deployment Incident Statistics by Application reportThis report displays a chart of the different types of Deployment Instances carried out for a givenApplication over a given period of time. The results can be filtered by Environment and Application. On thefirst page of the report, select the Application and Environment (or All), then the period of time for whichyou want to see the deployment statistics for the selected pair of entities.

33.2.2 The Deployment Incident Statistics by Environment reportThis report displays a chart of the different types of Deployment Instances carried out for a givenEnvironment over a given period of time. The results can be filtered by Environment and Application. Onthe first page of the report, select the Environment and Application (or All), then the period of time forwhich you want to see the deployment statistics for the selected pair of entities.



DROPS v2.8.133 Working with DROPS reports | User Guide

33.2.3 The Deployment Results Statistics by Environment reportThis report analyzes the overall results of deployed Releases by Environment. It can be filtered by Client,Environment and Application. On the first page of the report, select the Environment then its allowedApplication (or All).

The success rate(s) per type of Deployment Instance and the full Deployment History as well as the averageduration for each type of Deployment can be included as well.

33.2.4 The Deployment Results Statistics by Application reportThis report analyzes the overall results of deployed Releases by Application. It can be filtered byApplication, Environment and Release. On the first page of the report, select the Application, then theEnvironment and the Release (or All).

The success rate(s) per type of Deployment Instance and the full Deployment History as well as the averageduration for each type of Deployment can be included as well.

33.3 The Environment Analysis report

The Environment Details report lists all of the Applications is allowed for the selected Environment(s).

33.4 The Release Map Reporting reports

33.4.1 The Application Deployment MapThis report displays the history for deployments per Application. It can be filtered by Application and thehistory per Environment and/or Infrastructure Item can also be selected.

33.4.2 The Environment Release Deployment MapThis report displays the history for deployments per Environment. It can be filtered by Environment,Application and Release and the full deployment history can also be selected.

33.4.3 The Infrastructure Item Release Deployment MapThis report displays the history for deployments per Infrastructure Item. It can be filtered by InfrastructureItem, Application and Release.

33.4.4 The Release Deployment MapThis report displays the history for a selected Release. It can be filtered by Application and Release.



DROPS v2.8.1User Guide | 33 Working with DROPS reports

33.5 The Security Policy reports

There aremultiple Security Policy reports which each analyze the Roles Users are given throughoutDROPS.

33.5.1 The Role reportThis report summarizes the Users defined for all global and entity-level Roles for each of the entities inDROPS.

33.5.2 The Users reportThis report summarizes the Roles attributed to each DROPS User.

Select the User from the drop-down list on the first page of the report to display all of the informationconcerning his or her Role(s). The list of Users is prepopulated with all of the Users available on the currentserver.



Appendices

DROPS v2.8.1User Guide | Entity types

Entity typesEntity types are used throughout the Deployment Process and some affect howDROPS operations arecarried out. Types are categories for Components, Environments and Infrastructure Items. The differenttypes of each entity are defined by an admin in the Preferences menu under Artifacts andConfiguration.

Entity types

Component Types on the facing page

Environment Types on page 236

Infrastructure Item Types on page 238Table 28: Entity types: Configuration

ReferenceFor more information about the different entity types, refer to theDROPSConfiguration Guide.



DROPS v2.8.1Entity types | User Guide

Component Types

Component Types are used to categorize Components in order to easily see what kind of Artifacts theycontain. Components can contain any type of Artifact and any combination of different Artifacts. Usually,they contain a group of Artifacts that together create an individual part of a largerapplication/software/website/etc. Categorizing them creates a way to identify these individual parts of thewhole Application.

ExampleComponent Types might beWeb Archives, Executables, SQL DatabaseArtifacts, IBM i Save Files, etc.

Choosing a Component Type does not change how the Component functions.

Component Types are selected when creating and/or editing a Component but selecting a ComponentType is not mandatory.

Figure 87: Create Component Types

ReferenceFor more information about managing Components, refer to Working withComponents on page 56.




Environment Types

Environment Types are used to categorize the nature of your Environments and to manage User Rolesand Rights according to how you use the destination site.

There are a number of Environment Types available by default which enable you to organize differentdeployment targets by their intended function.

ExampleYou may need to deploy the same content to a Test or TrainingEnvironment as well as a Production Environment.

An Environment Type is a set of properties that characterizes the Operational Need related to the creationof an Environment. The properties are:

l the nature of the Operational Need,l the workflow order,l the production flag that indicates if the Operational Need occurs on an in-production Environment.

Choosing an Environment Typemay change a User's access authorization. Global Roles can be applied toEnvironments based on their type which means that a User may have the correct Role to access/edit/deployto Testing Environments but not Production Environments.

Environment Types aremandatory and are assigned to Environments when creating and/or editing them.

Figure 88: Create Environment Types

The Development (Dev), Test (Test) and Production (Prod) check boxes mark the Environment Typeaccording to how it is used.

TheWorkflow number associated with an Environment Type controls that Type's position in DeliveryPlans.



DROPS v2.8.1Entity types | User Guide

NoteDelivery Plans are not available yet.

Environment Types should not be confused with Environment Extensionswhich may require extended configuration.

ReferenceFor more information about managing Environments, refer to Workingwith Environments on page 84.

For more information about Environment Extensions, refer toEnvironment Extension Type Configuration on page 277.




Infrastructure Item Types

Infrastructure Item Types are used to categorize the services found on target systems and to managetheir specific extended configuration. You can search for Infrastructure Items based on type. Choosing anInfrastructure Item Type is very important because the associated extended configuration options provideconnection details on a type-to-type-basis. Only default types will contain extended configuration but youcan create new types of your own to categorize your Infrastructure Items however you need to.

ExampleIf an Infrastructure Item is intended to create the link between DROPS anda TOMCAT, IBM i, ARCAD or z/OS server, a JDBC or Docker, there isnecessarily more information to configure in order for the connection to beauthorized than there is for a "normal" (ex: Windows) type destination.These types are provided by default in the DROPS Studio.

The extended configuration for an Infrastructure Item is managed in the Infrastructure Item editor afterthe type is selected.

Infrastructure Item Types aremandatory and selected when creating and/or editing an Infrastructure Item.

Figure 89: Create Infrastructure Item Types

ReferenceFor more information about managing Infrastructure Items, refer toWorking with Infrastructure Items on page 97.



DROPS v2.8.1Properties | User Guide

PropertiesProperties are pairs of keys and values that together create variables which can be used when definingactions inside Deployment Processes. If you enter a property's key in a field when defining an action, thevalue defined in the same property will be used. Properties refer to specific entity-related content and canonly be referenced if the entity in which they are defined is used in the current Deployment Process. Theyare intended to help reuse details concerning your entities.

User-defined properties are available in the following DROPS entities:

l Applicationsl Import Strategiesl Releasesl Environmentsl Infrastructure Itemsl Deployment Processes

ExampleSet a password property in an Infrastructure Item in order to use avariable when asked for a login instead of entering it manually.

ReferenceFor more information about how to refer to defined properties, refer toSubstitution Variables in the appendix.

To access and manage the properties defined in an entity, select the Properties tab in the entity'seditor.

Figure 90: The Properties manager

To create a new property manually, click the New button. Both theKey and Value fields aremandatory.

If the property is a password, check the Is Password checkbox. When the property is saved, theValue willbe hidden and display as asterisks (*).

To createmultiple properties automatically for most entities, click the Import from File button to andselect a predefined .properties file to upload. The properties to import must follow this syntax: key =value.



DROPS v2.8.1User Guide | Properties

NoteThe .properties file can contain more information than the values to importbut only the content in the key = value syntax will be imported into the listof properties.

The imported properties are only available for the current entity. To reuseimported properties in other entities, import the file again in the secondentity's editor.

To export the properties defined for any entity as a .properties file, click the Export to file button. All ofthe properties defined in the tab are exported.

To edit an existing property, double-click it, or select it, then click the Edit button.

To delete a property, select it, then click the Remove button.

Warning!Deleted properties are no longer associated with any variable and cannotbe accessed or recovered.



DROPS v2.8.1Roles | User Guide

Roles Roles are only used during process execution (importing Artifacts and deploying). They are intended to

manage a User's authorization to execute certain procedures during an Import or Deployment Process orassign a task. Users with Roles can be kept informed via notifications during process execution in order tobe able to make decisions correctly.

Having a certain Role does not automatically mean that a User is required to do something during processexecution becausemultiple Users can be assigned the same Role. However in order to carry out certainactions, like executing a Deployment Process, a User must be assigned the Role that authorizes him to doso.

The DROPS entities involved in process execution and therefore those to which Roles must be assignedare:

l Applicationsl Releasesl Environments and Environment Groupsl Infrastructure Items

Each individual instance of an entity can have different Users assigned to it depending on the needs of yourorganization.

ExampleTwo different Environments may bemanaged by two different peoplebecause deploying to a Production Environment might only be done by amanager, while deploying to a Test Environment could be done by adeveloper.

However, Roles can also be defined globally. Assigning a Role to all instances of an entity instead of justone or several enables a User to play the same Role for every entity.

ExampleAmanager with a team of 3 peoplemay be granted global access to allApplications in order to oversee all the individual Applications his teamcreates. Each of the three teammates may only need to import Artifacts forthe Application(s) they are in charge of, but not the others. Themanager'sRole is assigned on the global level by an admin using the GenericRolesmenu in the Preferences menu while the team's Roles are assignedin the individual Application(s) from the Roles view.

In terms of authorization, there is no overlap between Roles and rights. However, it is important tocarefully assign rights that correspond to an entity to a User’s profile so that when he is assigned a Role hisaccess is unrestricted.

Important!Roles are used to authorize Users to perform actions involved in the Importor Deployment Processes while rights are used to grant authorization tocreate, access and/or modify the entities involved in the processes.



DROPS v2.8.1User Guide | Roles

ExampleIf a User has the Repository Manager Role for an Application and has theright to viewApplications but does not have the right to edit them, allApplications will be read-only. The User can still carry out the processesassociated with the Application because of their Repository Manager Role,such as importing Artifacts, but he cannot manage the Release NumberVersion for the Application because his Application editing rights arerestricted.

The following table lists the entities to which Roles are available for each entity and for what a User withthat Role is responsible. The rights required for each Role are also indicated by category.

Role Authorization(s) Granted Required Rights (by category)

ApplicationAdministrator Can assign Roles in Applications. Applications

ApplicationRepositoryManager

Responsible for the content in the ArtifactRepository and the correct configuration ofApplications, Components and ImportStrategies.

Can execute the Import Process.

ApplicationsReleasesImport Process InstancesStrategy Templates

Application ImportOperator

Responsible for executing the ImportProcess.

Import Process InstancesReleases

ApplicationDatabaseAdministrator

Responsible for the Application'ssource/target database(s).

Can validate the Deployment Process.

Validation Requests

ReleaseAdministrator Can assign Roles in Releases. Releases

User Management

Release ProjectManager

Responsible for the correct configuration ofReleases.

Can validate the Deployment Process.

ApplicationsReleasesValidation Requests

EnvironmentGroupAdministrator

Responsible for creating and managingEnvironment Groups.

ClientsEnvironmentsEnvironment GroupsUser Management

EnvironmentAdministrator Can assign Roles in Environments.

ClientsEnvironmentsEnvironment GroupsUser Management

EnvironmentRelease Operator

Responsible for executing the DeploymentProcesses.

Can be selected to validate the DeploymentProcess.

ClientsDeployment Process Instances

Validation Requests

Table 29: Definitions of user Roles and the required rights



DROPS v2.8.1Roles | User Guide

Role Authorization(s) Granted Required Rights (by category)

EnvironmentReleaseManager

Responsible for the correct configuration ofthe elements involved in the DeploymentProcess.

Can execute and validate the DeploymentProcess.

ClientsDeployment PlansDeployment Process DiagramsDeployment Process InstancesDeployment Process TemplatesDeployment SchemasEnvironmentsEnvironment GroupsInfrastructure ItemsReplacement RulesScriptsValidation Requests

InfrastructureItemAdministrator

Can assign Roles in Infrastructure Items.ClientsInfrastructure ItemsUser Management

InfrastructureItemManager

Responsible for the correct configuration ofInfrastructure Items.

ClientsInfrastructure Items

InfrastructureItem Contributor

In charge of solving problems concerningInfrastructure Items. Is notified vianotification email when an issue arises.

Responsible for plan of action concerningSuspended Actions and/or InterruptionMessages.

ClientsSuspended Actions

Table 29: Definitions of user Roles and the required rights

ReferenceFor more information about assigning Roles at the entity-level, refer toAssigning entity-level Roles on page 43.

For more information about assigning Roles at the global-level, refer to theDROPS Configuration Guide.

For more information about creating and managing profiles and rights,refer to theDROPS Configuration Guide.

For more information about creating DROPS users, refer to Working withUser Accounts on page 38.



DROPS v2.8.1User Guide | Rights

RightsRights grant Users the possibility to view, create and modify various DROPS entities. If the proper accessrights are not granted to a profile, access to the corresponding entity (ex: Applications) or action (ex:editing Applications) is restricted.

Rights are granted to Users via profiles. A profile is packed with rights that determine which items a Usershould be able to access throughout DROPS and if they can edit them or not. Profiles are assigned toindividual Users. When combined with Roles, Users have complete or restricted access to all of theprocesses included in the DROPS Studio.

The DROPS Studio has one default profile that contains all of the rights available. This All Rights profile isautomatically assigned to the default Administrator User so that he can manage new profiles for all futureUsers.

There is no limit on howmany profiles can be created. If all of your Users should have access to all entities inthe DROPS Studio, theremay be no need to create new profiles. Assigning the All Rights profile to all Userswill enable everyone to have access to everything - if their Role(s) also grant them access. It may be helpfulto create profiles that correspond to the different Roles throughout DROPS to ensure that Users areassigned profiles that contain all the rights necessary for their Role(s).

In terms of authorization, there is no overlap between Roles and rights. However, it is important tocarefully assign rights that correspond to an entity to a User’s profile so that when he is assigned a Role hisaccess is unrestricted.

Important!Roles are used to authorize Users to perform actions involved in the Importor Deployment Processes while rights are used to grant authorization tocreate, access and/or modify the entities involved in the processes.

ExampleIf a User has the Repository Manager Role for an Application and has theright to viewApplications but does not have the right to edit them, allApplications will be read-only. The User can still carry out the processesassociated with the Application because of their Repository Manager Role,such as importing Artifacts, but he cannot manage the Release NumberVersion for the Application because his Application editing rights arerestricted.

The following table lists the rights that do not require a paired Role but are necessary for serveradministrators or other users that may not be involved in the configuration and execution of thedeployment process.

Task Required Rights (by category)

Creating and editing metadata Administrative Rights

Managing DROPS Modules Module Updater

Installing DROPS Modules remotely Remote Installation

Accessing server preferences and configuration Server AdministrationTable 30: Server Administrator and other high-profile rights



DROPS v2.8.1Rights | User Guide

Task Required Rights (by category)

Managing server configuration Server General Administrative RightsTable 30: Server Administrator and other high-profile rights

ReferenceFor more information about the other rights available in theDROPS Studio, refer to Table 29: Definitions of user Roles and the requiredrights which outlines the relationship between Roles and rights for eachentity in the DROPS Studio.



DROPS v2.8.1User Guide | Substitution Variables

Substitution VariablesSubstitution variables are used to reference parameters throughout DROPS by referring to various entities'properties. The properties can either be the fields used to define the entity's details, or the propertiesdefined manually in each entity.

ReferenceFor more information about defining properties in entities, refer toProperties.

These values can either be entered manually or come from property values defined in different entitieslinked to the entity. Variables enable you to change the value of parameters retroactively and consistentlywithout changing the overall definition of your entities and guarantee that the Deployment Process willwork correctly.

To declare a substitution variable, use one of the following syntaxes:

l Point to a specific field or property when the entity does not need to be defined.${field-name} or ${[property-key]}

Example${user}, ${password}, ${application.code}, ${local.root}are replaced by the value defined in the corresponding field.

l Point to attribute information defined in an entity.${[entity-name].[attribute]}

Example${importStrategy.localroot} is replaced by the path entered inthe Import Strategy's Root Directory field.

l Point to a user-defined property in a specific entity.${[entity-name].props.[property-key]}

Example${application.props.myProperty} is replaced by the value ofthe property calledmyProperty declared in the Application.

Substitution Variables

Import Process Substitution Variables on the facing page

Deployment Process Substitution Variables on page 249

Activity-level Substitution Variables on page 252

Artifact-specific Substitution Variables on page 254Table 31: Substitution Variables



DROPS v2.8.1Substitution Variables | User Guide

Import Process Substitution VariablesThe variables available to use during the Import Process represent entities that always remains the same,even if they are used in multiple Import Process Instances. The variables available for Import Processes areall the attributes and properties defined for:

l Applicationsl Import Strategiesl Components

Variable Description

${import.version}

This variable is replaced by the value of the External Versiondefined by the User when launching an import processinstance.

It is a special substitution variable that does not rely on anentity and is used to point to the version number of anexternal artifact provider's release. This value is used todefine which of the SCM's versions the Artifacts shouldcome fromwhen they are imported. The version to import isdefined in the External Version field when importing.

ReferenceFor more information aboutdefining the externalversion to import, refer toImporting Artifactsimmediately by Applicationon page 170 or CreatingImport Process Instances onpage 174.

${application.code} The App. Code.${application.text} The App. Name.

${application.number}

The Release Number of the imported release.

Important!The Release Number can becalled by manyvariables. This one is onlyfor the import process.

${application.packagetype} The Packaging Type.${application.importfile} The Default Imported Version file name.${application.releasetemplate} The Release Number Template.${application.qualifier} TheQualifier.

Table 32: Import Process substitution variables





${application.majoritem}${application.minoritem}${application.builditem}${application.revisionitem}

The Application's Current Major, Minor, Build and RevisionsItems fields. The biggest number of themost recentlyimported Application.

${component.code} The Component Code.${component.name} The Component Name.${importStrategy.code} The Strategy Code.${importStrategy.comment} The Strategy Name.

${importStrategy.localroot}

The value defined in the Root Directory field.

Important!The${importStrategy.localroot} and${local.root} variablesare not the same!

If you use the valueAUTOas the Local Root:

l ${importStrategy.localroot} is a staticvariable. It will bereplaced with AUTO.

l ${local.root} is adynamic variable. It willbe replaced with theactual root directory(i.e. the one thatDROPS generates anduses if you enter*AUTO)

${importStrategy.usetemplate} Equals 1 if the Strategy uses a template, 0 if it does not.

${importStrategy.isinitialization}

Equals 1 if the Strategy is an Initialization Strategy, 0 if it isnot

${importStrategy.order}

The order of execution.Values start at 0.

Import Strategies are executed in the order in which theyare defined. If a Strategy was the third to be created, it willbe executed after the first two Strategies and the variableswill be 3.

Table 32: Import Process substitution variables




Deployment Process Substitution VariablesThe variables available to use during the Deployment Process represent entities that always remains thesame, even if they are used in multiple Deployment Process Instances. The variables available forDeployment Processes are all the attributes and properties defined for:

l Applicationsl Releasesl Environments and their possible extended configurationl Deployment Process


${drops.home} The value of the variable called "DROPS_HOME".${process.code} The Process Code field.${process.name} The Process Name field.

${process.lastrelease.id} Releases can be tracked chronologically. This refers to thelatest deployed Release's Release Description field.

${process.lastrelease.order} Releases can be tracked chronologically. This refers to thelatest deployed Release.

${process.lastrelease.number}

Releases can be tracked chronologically. This refers to thelatest deployed Release Number.

Important!The Release Number can becalled by manyvariables. This one is onlyfor the latest deployedrelease.

${application.code} The App. Code.${application.text} The App. Name.${application.packagetype} The Packaging Type.${application.importfile} The Default Imported Version file name.${application.releasetemplate} The Release Number Template.${application.qualifier} TheQualifier.${application.majoritem}${application.minoritem}${application.builditem}${application.revisionitem}

The Application's Current Major, Minor, Build and RevisionsItems fields. The biggest number of themost recentlyimported Application.

${release.number}

The Release Number.

Important!The Release Number can be

Table 33: Deployment Process substitution variables





called by manyvariables. This one is onlyfor the deployment process.

${release.text} The Release's Release Description field.${release.creationdate} The Release's uneditableOpened the field.${release.closuredate} The Release's uneditable Closed the field.${release.isclosed} Points to closed Releases.${release.islocked} Points to locked Releases.

${release.order} Releases can be tracked chronologically. This refers to theRelease Description field of the last Release created.

${release.comment} The content defined in the Comments tab of theReleaseeditor.

${environment.code} The *Env. Code.${environment.name} The *Env. Name.

${environment.config.application} The Application Code defined in the Environment’sextension.

${environment.config.identifier} The Environment ID defined in the Environment’sextension.

${deployment.executer} The User who executed the Deployment Process Instance.

${deployment.instancetype}

The deployment mode of the Deployment Process Instance(Full, Transfer-Only, Installation-Only).

ReferenceFor more information aboutmodes, refer to Defining anInstance's Deploymentmode on page 194.

${deployment.preparedate} The value defined in the Preparation Date column of theDeployment Process Instance.

${deployment.preparer} The User who created the Deployment Process Instance.

${deployment.result} The value defined in the Execution Result column of theDeployment Process Instance.

${deployment.scheduledate} The date the schedule was created for a DeploymentProcess Instance.

${deployment.scheduled} The date a Deployment Process Instance is scheduled toexecute.

${deployment.schedulehour} The hour the Deployment Process Instance is scheduled toexecute.

Table 33: Deployment Process substitution variables





${deployment.scheduleminute} Theminute the Deployment Process Instance is scheduledto execute.

${deployment.startdate} The date the Deployment Process Instance executed.

${deployment.status} The value defined in the Execution Status column of theDeployment Process Instance.

${deployment.transactionid} The Deployment Process Instance's Transaction ID.Table 33: Deployment Process substitution variables




Activity-level Substitution VariablesAn activity-level substitution variable is a combination of multiple values found in the entities that arereunited in the Activity (the Infrastructure Item and the Component). The variables available at the activity-level are:

l all the attributes defined foro The Artifact Listo Componentso Infrastructure Items

l all the properties defined for Infrastructure Items.l the optional extended configuration of the Infrastructure Item.

To declare an activity-level substitution variable, use one of the following syntaxes:

l Point to an attribute of the activity.${activity.[activityID].[attribute]}

Example${activity.tomcat.identifier}

l Point to a related entity.${activity.[activityID].[entity.name].[attribute]}

Example${activity.tomcat.infra.url}

l Point to a property defined for a related entity.${activity.[activityID].[entity.name].props.[property_name]}

Example${activity.tomcat.infra.props.connectionurl}

l Point to an extended configuration attribute.${activity.[activityID].config.[attribute]}

Example${activity.tomcat.config.user}

ExampleArtifact Key: /database/scripts/install/scripts.sql

1. ${drop.artifact.key} = /database/scripts/install/scripts.sql2. ${drop.file.name} = scripts.sql3. ${drop.file.path} = /database/scripts/install/

NoteThe slash will be replaced by the File Separator defined for the givenInfrastructure Item.





${activity.[activityID].artifact.list} The path to the Artifact List xml file located on theDROPS Server.

${activity.[activityID].remote.artifact.list}

The path to the Artifact List xml file located on theremote Infrastructure Item.

${activity.[activityID].component.code} The Component Code.

${activity.[activityID].component.name} The Component Name.

${activity.[activityID].component.uri} The Directory Path where Components/Artifacts areimported.

activity.[activityID].component.externalversion

The External Version for a Component and itsRelease.

${activity.[activityID].identifier} The defined [Activity's] *Identifier.${activity.[activityID].infra.backupdir} The path defined in the Backup Directory field.

${activity.[activityID].infra.rootdir} The path defined in the Root Directory field.${activity.[activityID].infra.fileseparator} The path defined in the Item's File Separator field.

${activity.[activityID].infra.url} The path defined in the Item's *URL field.${activity.[activityID].infra.code} The Item's *Infra. Item Code.${activity.[activityID].infra.name} The Item's *Infra. ItemName.

${activity.[activityID].infra.login} The login name used to connect to theDROPS Agent. The Item's *Login field.

${activity.[activityID].infra.password}

The password used to connect to the DROPS Agent.The Item's *Password field.

${activity.[activityID].infra.store} Points to the directory into which the relatedComponent's Artifact(s) will be transferred.

Table 34: Activity-level substitution variables




Artifact-specific Substitution VariablesThere are no variables defined for individual Artifacts however, if you execute an action specific to anArtifact, or multiple Artifacts in the list, the following variables are available.

Important!If any of the following variables are used, youmust tick the Apply script tothe list of Artifacts checkbox in order to ensure that the variable is takeninto account at the Artifact-level. If the script is not applied to eachindividual Artifact in the list, these variables will not be applied because theyare specific to individual Artifacts.


${drop.file.name} The Artifact's file name.${drop.file.path} The relative path (without the file name) of the Artifact.${drop.artifact.key} The Artifact Key.${drop.artifact.source.file} The absolute name of the Artifact in the Artifact Repository.

${drop.artifact.target.file} The absolute name of the Artifact in the infrastructure itemstorage area.

${drop.file.basename} The base name (the final namewithout extension) of the Artifact.${drop.file.extension} The file extension (without the leading ".").

Table 35: Action-level substitution variables



DROPS v2.8.1Import Strategy Type Configuration | User Guide

Import Strategy Type ConfigurationAll of the Import Strategies follow a standard process for populating the Artifact Repository after collectingthe Artifacts to import. The Artifacts are copied to the Root Directory, then DROPS scans the content andcreates an identical directory structure inside the Artifact Repository. When the duplicate directorystructure is finished, DROPS copies the Artifacts into the correct locations in the Repository. Because thedirectory structure is redefined in the Repository, when the Artifacts are deployed, they will be deployedfollowing the same structure.

Configuring an Import Strategy is mandatory in order to collect the Artifacts to import. To quicklycommunicate with themost commonly used artifact providers and eventually incorporate their specificdelivery types, select the corresponding type of Strategy from the drop-down list in the ImportStrategy editor.

ExampleConfigure an Import Strategy to retrieve Artifacts based on a SCM's"available" versions by choosing the Strategy type for that SCM.

NoteIf a Template was used to create a new Import Strategy, the Strategy Typeconfiguration described below cannot bemodified and the entire section isgrayed out. To modify this content, either change the template (which willcarry over to all of the Strategies using it) or create a new Strategy that isnot linked to the template.





The different types of Strategies require different configuration. This section describes each type and howto configure each type.

Import Strategy types

The ARCAD Import Strategy on page 257Table 36: Import Strategy types: Configuration



DROPS v2.8.1User Guide | Import Strategy Type Configuration

Import Strategy types

The Command Line Strategy on page 260

The CVS Import Strategy on page 262

The Docker Simple Import Strategy on page 264

The File System Strategy on page 265

The GIT Import Strategy on page 267

The IBM i Import Strategy on page 269

The IBM z/OS strategies on page 270

The SVN Import Strategy on page 272Table 36: Import Strategy types: Configuration




The ARCAD Import StrategyThis Strategy populates the Artifact Repository using the content of the Root Directory after filling it byexporting data from an ARCAD version.

This Strategy executes an ARCAD macro-command to prepare a SAVF to import into the ArtifactRepository. This command must be executed on a ARCAD server that runs on an IBM i platform.

First, the system connects to the ARCAD server using the connection information defined in the ImportStrategy. Then, the defined macro-command is executed:

1. the version number is resolved,2. the variables are substituted,3. the execution of themacro-command is submitted using the defined submission parameters.

The systemwaits for the end of the submitted job and returns the execution result. If the execution is OK,a stream file is created from the target SAVF file into the temporary IFS directory. This stream file isdownloaded into the Root Directory defined by the Strategy and the content of the Root Directory isimported as Artifacts.

Important!Themacro-command must create the related version Artifacts in a SAVFthat must be named according to the value defined by the User and becreated in the library defined by the User.

NoteThe content of Save Files imported using the IBM i and Arcad ImportStrategies are saved as .txt attachments by default. This makes it easy torefer to the content of the Save File outside of IBM i after it has beenimported into the DROPS Studio.

ReferenceFor more information about DROPS for ARCAD, refer to About DROPS forARCAD on page 25.

Field Description

ARCAD Server The name or IP address of the IBM i partition hosting the ARCAD-Server.

Login A valid ARCAD user login.

Password The related password.

Instance Code The ARCAD instance code to reach. By default, the value is AD.

Language The ARCAD language (FRA or ENG).

CCSID The CCSID used by the connection.

ApplicationCode The code of the target ARCAD Application.

Env. Identifier The Environment Identifier of the environment containing the versions.Table 37: ARCAD Strategy extended configuration




Field Description

TargetVersionNumber

The number of the version fromwhich to get the Artifacts. The possible value are:

1. a fixed version number.2. (currently unavailable) *LASTPRD the last version that has been promoted into

reference.3. (currently unavailable) *LAST the last version opened on the defined Environment.

By default, the value is ${import.version}. Using this substitution variable enables theStrategy to use the external version number set using the Import Artifacts wizard.

LibraryThe library where themacro-command is located.

By default, the library is set to *LIB.

Name

The name of themacro-command to execute.

The following macro-command parameters are available:

l PREPARE APP(${arcad.application})

l EXPORT APP(${arcad.application})

l ENV(${arcad.envid})

l VERSION('${arcad.version}')

l SAVLIB(${arcad.savlib})

l SAVFILE(${arcad.savfile})

The following substitution variables are available:

l ${arcad.application}: the App codel ${arcad.envid}: the Environment Identifierl ${arcad.version}: the Version Numberl ${arcad.savlib}: the Save Libraryl ${arcad.savfile}: the Save Filel ${arcad.instance}: the ARCAD instance’s codel ${arcad.language}: the ARCAD instance’s language code

By default, the value is EXPORT APP(${arcad.application}) ENV(${arcad.envid})VERSION('${arcad.version}' SAVF(${arcad.savfile} TMPLIB(${arcad.savlib})).

SubmissionParameters

The additional parameters that will be used to submit themacro-command execution.Thesemust be valid SBMJOB command's parameters.

By default, the value is JOBQ(DROPS/DROPS) JOB(EXPORT).

TemporaryLibrary

The Temporary Library where the SAVF file will be generated.

By default, the value is ARCAD_NET.

TemporarySAVF

The name of the SAVF file that must be imported into the Artifact Repository.

By default, the value is *GEN.Table 37: ARCAD Strategy extended configuration




Field Description

TemporaryIFS Directory

The name of the IFS directory where the generated SAVFwill be copied before importingit into the Repository.

By default the value is *AUTO.Table 37: ARCAD Strategy extended configuration





The Command Line StrategyThis Strategy populates the Artifact Repository using the content of the Root Directory after filling it byexecuting a user-defined command.

This Strategy scans defined directories and retrieves their contents according to the command defined.

To define the command to execute, configure the name and parameters of the executable command andthe connection information required to access a 3rd party artifact provider via the command line.

Field Description

User The user name that can be referenced as a ${user} variable in the command if aconnection is needed.

Password The password that can be referenced as a ${password} variable in the command if aconnection is needed.

Executable The name of the file to execute.

OptionsTemplate

The blank-separated list of parameters to pass to the executable. The template caninclude substitution variables.

ReferenceFor more information about variables refer toSubstitution Variables in the appendix.

Table 38: Command Line Strategy extended configuration





To define a property, click the New button in the Command Line Strategymanager.






Warning!Deleted properties are no longer associated with the Import Strategy andcannot be accessed, recovered or called by a substitution variable.





The CVS Import StrategyThis Strategy populates the Artifact Repository using the content of the Root Directory after filling it byexporting data from a CVS repository.

Important!To correctly invoke the CVS command line processor, the DROPS Servermust know its location. This location is defined by a DROPS administratorin the CVS Strategy Settings section of theDROPS - Import Processcategory of the DROPS Server settings. The path set there will be used forall of the CVS strategies created for the current server, so the URL thatpoints to your Artifacts must correspond to it.

ReferenceFor more information about setting the path to the CVS executable, referto theDROPS Configuration Guide.

Define connection properties specific to this Strategy and the external CVS tool in the CVS RepositoryConnection Properties section. These properties are used to pass connection information to the CVScommand line when the Import Process begins.

Field Description

Protocol The protocol used to connect to the CVS server.

CVS Server The CVS server.

Port The CVS server's port.

User The user to connect to the CVS repository.

Password The user password used to connect to the CVS repository.

Repository The path to the repository to import.

Tag The tag number used to filter the export.

Module Themodule to import.Table 39: CVS Repository Import Strategy extended configuration

NoteThe parameters can use the properties defined in the parent ImportStrategy by referencing them using substitution variables.

ReferenceFor more information about this process, refer to Substitution Variables inthe appendix.








To define a property, click the New button in the CVS Import Strategymanager.








The Docker Simple Import StrategyThis Strategy populates the Artifact Repository using the content of the Root Directory after filling it byexporting a Docker Image from a reference repository in Docker.

The Docker daemon DROPS uses to manage the image(s) to import fromDocker must carry out a transferbefore DROPS can access the image(s) to import. First, the daemon duplicates the “source” image in thedevelopment repository then transfers the copy to the reference repository. DROPS can then import thetransferred “target” image from the reference repository.

Field Description

Docker DaemonHost

The connection path required to connect to the Docker development repository (thedaemon).

Use TLS Tick this checkbox if the connection is secure.

CertificatesPath

If the connection is secure, define the path to the certificates required to access thesecure Docker daemon.

ReferenceRepository Host The path to reference repository where the target image to import is stored.

User/Password The login and password required to access the reference repository.

Registry Define the sub-folder in which the target image is stored, if required.

Source ImageName The name of the source image as it appears in the development repository.

Target ImageName

The name of the duplicated copy of the image in the reference repository. You canchange the original source name of images this way.

Target Tag The name of the target image tag.Table 40: File System Strategy extended configuration




The File System StrategyThis Strategy populates the Artifact Repository using content from one or several folders found on thesamemachine as the DROPS Server. It scans the directory(ies) and retrieves content according to the filtersdefined.

In the dialog to create or edit a File System Strategy, the root path to the directory in which your Artifactsare stored is defined. To filter the defined path and tell DROPS to import only certain Artifacts instead ofeverything found in the root path, define a regular expression that filters which files to import.

There are two ways to filter by the last date Artifacts weremodified:

1. define a range of dates: all the files that have a last modification date in this range will be imported.2. define a date limit: all the files that have a last modification date before this date will be imported. This

date limit is computed by subtracting time from the execution date. To define this date, enter theamount of time to subtract and also the time (day, minute or hour).

Field Description

Directory

The root path of the directory to scan.

Important!This directory must be a sub-directory of the RootDirectory defined in the parent Import Strategy.

Filter (regExp) The regular expression to filter the Artifacts in theDirectory. By default this value is .*.

Use a DateSet Select this option to use a last modification date filter based on a date range.

Start Date [Optional] The lower limit of the date range. Any Artifacts modified after this date/timewill be imported.

End Date [Optional] The upper limit of the date range. Any Artifacts modified before this date/timewill be imported.

Use ExecutionDate Select this option to use a last modification date filter based on a date limit.

Amount tosubtract

The amount of time to subtract from the date/time of the import. Any Artifacts modifiedbetween when the import is launched and the time difference defined here will beimported. Set the number in this field and use the Part of impact field to set the value.

Part toimpact

The unit of time to use to subtract the value defined in theAmount to subtract fieldfrom the date/time the import is launched.

ExampleIf you set theAmount to 20 and the Part toMinute, anyArtifacts modified in the twenty minutes prior tolaunching the import will be imported.

Table 41: File System Strategy extended configuration

To create a File System Strategy filter, click the New button in the File System Strategymanager anddefine the directory to scan and the filters to apply.




To edit an existing filter, double-click it, or select it, then click the Edit button.

To delete a filter, select it, then click the Remove button.

Warning!Deleted filters are no longer associated with the Import Strategy andcannot be accessed or recovered.





The GIT Import StrategyThis Strategy populates the Artifact Repository using the content of the Root Directory after filling it byexporting data from a Git repository.

This Strategy executes the GIT checkout command to reach a GIT repository.

Important!To correctly invoke the GIT command line processor, the DROPS Servermust know its location. This location is defined by a DROPS administratorin theGit Strategy Settings section of theDROPS - Import Processcategory of the DROPS Server settings. The path set there will be used forall of the GIT strategies created for the current server, so the URL thatpoints to your Artifacts must correspond to it.

ReferenceFor more information about setting the path to the Git executable, refer totheDROPS Configuration Guide.

Artifacts are exported from a GIT repository when DROPS executes the following command. When thenecessary connection information is defined, DROPS uses the information to create and send thefully-defined command to the GIT.

#Local Git Repository Preparationgit clone https://username:password@git-repository-url target-export-pathgit --git-dir="target-export-path.git"

--work-tree="target-export-path"fetch--tag

#Modification retrieval for a given taggit --git-dir="target-export-path.git"

--work-tree="target-export-path"checkouttags/particular-tag

NoteThe username, password, git-repository-URL and particular-tag parameters(in bold in the example above) are either defined in theGIT RepositoryConnection Properties section or can be replaced by properties definedeither in the parent Import Strategy or the Extended Properties sectionby referencing them using substitution variables.

The target-export-path is assigned by the Root Directory.





Define connection properties specific to this Strategy and the external GIT tool in theGIT RepositoryConnection Properties section. These properties are used to pass connection information to theGIT command line when the Import Process begins.

Field Description

Repository URL The GIT repository URL. For example: https://github.com/...

User The user to connect to the GIT repository.

Password The user password used to connect to the GIT repository.

Tag The tag number used to filter the export.Table 42: GIT Import Strategy extended configuration





To define a property, click the New button in theGIT Import Strategymanager.








The IBM i Import StrategyThis Strategy populates the Artifact Repository using the content of the Root Directory after filling it byexporting data from an IBM i repository.

This Strategy is intended to retrieve and import existing SAVF files from an IBM i that match the providedSave File Name Pattern defined in the List of Save Files section. Regex can be entered in this section.

DROPS connects to the target IBM i using the provided system, login and password. It will eventually setthe iASP for the connection if one is defined (and different from *SYSBAS).

DROPS will first transfer each SAVF file found to the temporary IFS directory defined (using theCPYTOSTMF IBM i command), and then copy them to the Artifact Repository.

NoteThe content of Save Files imported using the IBM i and Arcad ImportStrategies are saved as .txt attachments by default. This makes it easy torefer to the content of the Save File outside of IBM i after it has beenimported into the DROPS Studio.

Field Description

IFS Temporary Directory The directory where DROPS will put the files listed in the List of Save Filessection.

iASP The independent auxiliary storage pool.

IBM i System, Login &Password The connection information for the target IBM i.

Library & Command An IBM i command to run before DROPS locates the files listed in the List ofSave Files section.Table 43: IBM i Strategy extended configuration

To define a SAVF file, click the New button in the List of Save Filesmanager.

To edit an existing SAVF file, double-click it, or select it, then click the Edit button.

To delete a SAVF file from the list, select it, then click the Delete button.

Warning!Deleted file patterns are no longer associated with the Import Strategy andcannot be accessed or recovered.





The IBM z/OS strategiesBoth the IBM z/OS Initial Import and the IBM z/OS Import strategies work the sameway.

They create a command file to order the package operation according to the list of libraries defined for anInitial Import Strategy or library patterns for a normal Import Strategy. Then, they connect to the z/OSserver using the connection information defined and upload this command file to the server and wait for aresponse file.

A Daemon reads this file, operates the package action and generates a response file that DROPSdownloads and parses to get the execution result and the package name.

IF a package has been generated, then it is downloaded and copied to the Artifact Repository. A responsefile is added as an attachment to the related version.

ReferenceFor more information about DROPS for z/OS, refer to About DROPS forz/OS on page 25.

to set the timeout for zOS strategies, refer to theDROPS ConfigurationGuide.

The IBM z/OS Import StrategyThis Strategy populates the Artifact Repository using the content of the Root Directory after filling it byexporting a z/OS release package from an IBM z/OS repository.

Field Description

IBM z/OS Server The name or IP address of the z/OS server to reach.

Login The login used to connect the z/OS server.

Password The related password.Table 44: IBM z/OS Import Strategy extended configuration

In the Library Pattern List section, define the list of libraries that belong to the application. A librarypattern is a string pattern that will be used by SYSchange to search for the name of the library that will bescanned to detect modifications.

To define a new library pattern list, click New button in the Library Pattern List section then enter thestring pattern in the Library Pattern dialog box.

To edit an existing list, double-click it, or select it, then click the Edit button.

To delete a list, select it, then click the Remove button.

Warning!Deleted library pattern lists are no longer associated with the ImportStrategy and cannot be accessed or recovered.





The IBM z/OS Initial Import StrategyThis Strategy populates the Artifact Repository using the content of the Root Directory after filling it byexporting a z/OS application package from an IBM z/OS repository.

Important!For this Strategy, the Initialization Strategy checkbox in the ImportStrategy editormust be checked.

Field Description

IBM z/OS Server The name or IP address of the z/OS server to reach.

Login The login used to connect the z/OS server.

Password The related password.Table 45: IBM z/OS Initial Import Strategy extended configuration

In the Library List section, define the list of libraries that belong to the application.

To define a new library list, click New button in the Library List section then enter the full, qualifiedname of a library that belongs to the application in the Library dialog box.

To edit an existing list, double-click it, or select it, then click the Editbutton.

To delete a list, select it, then click the Remove button.

Warning!Deleted library lists are no longer associated with the Import Strategy andcannot be accessed or recovered.





The SVN Import StrategyThis Strategy populates the Artifact Repository using the content of the Root Directory after filling it byexporting data from an SVN repository then following the standard process.

This Strategy executes the SVN export command to reach an SVN repository.

Important!To correctly invoke the SVN command line processor, the DROPS Servermust know its location. This location is defined by a DROPS administratorin the SVN Strategy Settings section of theDROPS - Import Processcategory of the DROPS Server settings. The path set there will be used forall of the SVN strategies created for the current server, so the URL thatpoints to your Artifactsmust correspond to it.

ReferenceFor more information about setting the path to the SVN executable, referto theDROPS Configuration Guide.

Artifacts are exported from an SVN repository when DROPS executes the following command. When thenecessary connection information is defined, DROPS uses the information to create and send thefully-defined command to the SVN.

svn export [-r revision][--ignore-externals][--depth ARG][--force][--ignore-keywords][--native-eol ARG][--quiet]svn-repository-urltarget-export-path--username username--password password--non-interactive

Define connection properties specific to this Strategy and the external SVN tool in the ConnectionInformation section. These properties are used to pass connection information to the SVN command linewhen the Import Process begins.

NoteThe parameters to define (in bold in the example above) can use theproperties defined in the parent Import Strategy or the ExtendedProperties section by referencing them using substitution variables.





Field Description

RepositoryURL The SVN repository URL. For example: SVN//ip number/repository

User The user to connect to the SVN repository.

Password The user password used to connect to the SVN repository.

Revision

[Optional] The SCM's revision to export. This value is used to define which of the SCM'sversions the Artifacts should come fromwhen they are imported.

l Entering a fixed value here will configure the default version that the Import Strategywill always deploy. It is static.

l If this field is left blank, DROPS will always import themost recent version from yourSCM.

l Enter the special substitution variable ${import.version} in this field tocommunicate with the External Version field accessed when launching an import. Youcan manually decide which of the SCM's versions to import every time the ImportStrategy is used.

ReferenceFor more information about defining the external version toimport, refer to the Section Importing Artifacts on page 166.

Table 46: SVN Import Strategy extended configuration

Define properties specific to this Strategy in the Extended Properties section. These properties can beused to add options to the connection command.

1. If a property contains a key called --force and the value is blank, the option --force will be added to thecommand parameter.

2. If a property contains a key called --native-eol and the value is CRLF, the option --native-eol CRLFwillbe added to the command parameter.

To define a property, click the New button in the SVN Import Strategymanager.







DROPS v2.8.1User Guide | Infrastructure Item Type Extended Configuration

Infrastructure Item Type Extended ConfigurationCertain Infrastructure Item Types require extended configuration to further define connection information.

If the type of Infrastructure Item chosen requires extended configuration, click the Editconfiguration... link in the Identification section to open the corresponding Extended Configurationeditor.

NoteLike any property defined in an entity, the fields in any extendedconfiguration editor can be referenced by Substitution Variables to reusethe details in the Deployment Process Diagram.

Infrastructure Item types

ARCAD Server extended configuration below

Docker extended configuration below

IBM i extended configuration on the facing page

IBM z/OS extended configuration on the facing page

Generic JDBC Connection extended configuration on the facing page

Tomcat extended configuration on page 276Table 47: Infrastructure Item types: Configuration

ARCAD Server extended configurationTo connect to an ARCAD server, select the ARCAD Server Infrastructure Item Type and enter thefollowing extended configuration information.

Field Description

ARCAD Instance The two-character instance to access.

Language The language options for ARCAD are FRA or ENG.

CCSID The Coded Character Set Identifier used to set what kind of character set (amongother things) the established connection uses.

Table 48: ARCAD Infrastructure Item extended configuration

Docker extended configurationTo connect to a DOCKER daemon, select theDocker PAAS Infrastructure Item Type and enter thefollowing extended configuration information.

Field Description

Docker DaemonHost

The connection path required to connect to the Docker development repository (thedaemon) to which to deploy the image(s).

Table 49: Docker Infrastructure Item extended configuration



DROPS v2.8.1Infrastructure Item Type Extended Configuration | User Guide

Field Description

Use TLS Tick this checkbox if the connection is secure.

Certificates Path If the connection is secure, define the path to the certificates required to access thesecure Docker daemon.

Table 49: Docker Infrastructure Item extended configuration

IBM i extended configurationTo connect to an IBM i server, select the IBMi Infrastructure Item Type and enter the following extendedconfiguration information.

Field Description

IFS TemporaryDirectory

The preliminary location to which to copy the SAVf Artifacts. When this file is copied,DROPS uses the Copy From Stream File command to restore it in the target IBM ias an object.

RestorationTarget Library The directory in which to save the restored SAVf object(s).

Login &Password The connection information for the target IBM i.

The jobs librarylist The libraries to access via the online job.

Mapping Rules The rules to distribute the deployed objects. Define which libraries should receive certainobjects.

Table 50: IBM i Infrastructure Item extended configuration

IBM z/OS extended configurationTo connect to a z/OS server, select the IBM z/OS Infrastructure Item Type and enter the followingextended configuration information.

Section Description

Library Name Replacement Rules Replace strings in the name library contained in the deployed package.Table 51: IBM z/OS Infrastructure Item extended configuration

Generic JDBC Connection extended configurationTo connect to a JDBC server, select theGeneric JDBC Connection Infrastructure Item Type and enter thefollowing extended configuration information.



DROPS v2.8.1User Guide | Infrastructure Item Type Extended Configuration

Field Description

JDBC Driver The unique target JDBC driver.

Classpath The unique target JDBC classpath.

URL The target address and port in URL format.

User & Password The connection information for the target JDBC.Table 52: JDBC Infrastructure Item extended configuration

Tomcat extended configurationTo connect to a Tomcat server, select the Tomcat Server Infrastructure Item Type and enter the followingextended configuration information.

Field Description

Tomcat Home Directory The root path to the target tomcat.

Application Directory The path to the tomcat’s webapps directory.

URL The target address and port in URL format.

Login & Password The connection information for the target Tomcat.Table 53: Tomcat Infrastructure Item extended configuration



DROPS v2.8.1Environment Extension Type Configuration | User Guide

Environment Extension Type ConfigurationCertain Environment extensions require extended configuration to further define connection information.

If the type of Environment Extension chosen requires extended configuration, click the Editconfiguration... link in the Identification section to open the corresponding Extended Configurationeditor.

NoteLike any property defined in an entity, the fields in any extendedconfiguration editor can be referenced by Substitution Variables to reusethe details in the Deployment Process Diagram.

Environment Extension types

ARCAD Environment extended configurationTable 54: Environment Extension types

ARCAD Environment extended configurationTo connect to an ARCAD application and environment, select the ARCAD Environment Extension Typeand enter the following extended configuration information. These values can be used as a variables in thedeployment diagram to ensure that the correct target ARCAD environment is reached.

Field Description

Application Code The ARCAD Application to which to connect.

Environment ID The ARCAD Environment to which to connect.Table 55: ARCAD Environment extended configuration



DROPS v2.8.1User Guide | Rollback

RollbackIn order for DROPS to carry out the rollback process, certain systems and/or databases must conform tothe following administrative prerequisites.

SQL ServerSQL Server rollback has been developed with SQL Server 2014 Express Edition version 12.0. The databaseto roll back must be in FULL recovery model. To perform the rollback, DROPS connects to the SQL Serverdatabase with the same user login as the application login to roll back.

Features not supported

l Data types: hierarchyid, spatial types, text, ntext, image, varchar(max), nvarchar(max), varbinary(max), sql_variant, table, xml, cursor, udt.

l Row > 8060 bytesl Rollback of sequencesl Clustered tablel Sparse columnsl Partitioned tables

OracleOracle rollback has been developed in version 11g Release 2, more precisely 11.2.0.4. It runs both onStandard and Enterprise versions.

When rolling back LOB data, the datamust be accessible in UNDO, limiting the elapsed time the rollbackcan be performed after the end of the client SQL batches.

Configuration

l The databasemust be in ARCHIVELOGl Minimal supplemental logging must be enabled.l Archive Log Files must be accessible when Drops executes the rollback.l When rolling back LOB data, UNDOmust contain data to be rolled back.

Rights

To perform the rollback, DROPS connects to the Oracle database with a user login which must have thefollowing rights:

l GRANT CREATE SESSIONl GRANT CREATE TYPEl GRANT FLASHBACK ANY TABLEl GRANT SELECT_CATALOG_ROLEl GRANT EXECUTE_CATALOG_ROLEl GRANT EXECUTE ONDBMS_LOGMNRl GRANT EXECUTE ONDBMS_AUDIT_MGMTl GRANT EXECUTE ONDBMS_UTILITYl GRANT EXECUTE ONDBMS_LOCK



DROPS v2.8.1Rollback | User Guide

l GRANT EXECUTE ONDBMS_SESSIONl GRANT SELECT ANY TRANSACTIONl EXECUTE ONDBMS_FLASHBACKl SELECT ONV_$LOGFILEl SELECT ONV_$LOGMNR_CONTENTSl SELECT ONDBA_AUDIT_TRAILl SELECT ONDBA_AUDIT_OBJECTl SELECT ONDBA_OBJECTSl SELECT ONDBA_LOBSl SELECT ONDBA_CONSTRAINTSl SELECT ONDBA_STMT_AUDIT_OPTSl SELECT ONDBA_OBJ_AUDIT_OPTSl SELECT ONV_$SESSIONl SELECT ONDBA_TAB_COLUMNSl SELECT ONDBA_TABLESl SELECT ONDBA_CONS_COLUMNSl SELECT ONDBA_SEQUENCESl SELECT ONDBA_DEPENDENCIESl ALTER ANY TRIGGERl SELECT ANY TABLE

Features not supported

l DDL operation is not supported, except TRUNCATE when the table is empty at the start of thecapture.

l IOT tablesl BFILE datatypel Simple and nested abstract datatypes (ADTs)l Collections (nested tables and VARRAYs)l Object refs



DROPS v2.8.1User Guide | Client APIs

Client APIsDROPS comes with a set of client APIs designed to allow the creation and execution of Import andDeployment Processes. To facilitate their use in any existing build mechanism, these APIs are available asANT tasks.

The JAR file containing the Client API can be found in the directory where DROPS is installed: <DROPSServer installation directory>/clientAPI directory.

An exemplary ANT build file can also be found in this directory.

Client APIs

drops.instance task below

drops.import.release task on the facing page

drops.deploy task on page 283

Tips on page 285

Full script example on page 286Table 56: Client APIs: Configuration

ANT Task Elementsdrops.import.filter

The drops.import.filter element is an embedded element that can be used with the drops.import.releasetask. If the *filterType attribute set to *MANUAL, then this element is used to specify the external version(s) to use for each Import Strategy run by that task.

Attribute Description

*componentCode The code of the Import Strategy’s parent Component.

*strategyCode The code of the Import Strategy to run.

*externalVersion The external version used by the Import Strategy.Table 57: The drops.import.filter element’s attributes

Example<drops.import.filter componentCode="SQL" strategyCode="svn"externalVersion="head" />

drops.instance taskThis task creates a reference to a DROPS Server and saves it in an ANT property. This property can be usedlater on by the drops.import.release task and the drops.deploy task to refer to a connection automatically.


*propertyName

Create an ANT property to reference the connection to a DROPS Server that will includethe URL, user and password defined below. Enter the name of the property to call later torefer to a connection automatically.

*url The remote DROPS Server URL.Table 58: The drops.instance task attributes



DROPS v2.8.1Client APIs | User Guide


http://<server IP or network name>:<port>

*user A valid DROPS user.

*password The user's password.Table 58: The drops.instance task attributes

Example<drops.instance propertyName="drops.server"url="http://192.168.1.155:5252" user="jenkins"password="continu0us1ntegration" />

drops.import.release taskThis task creates and executes an Import Process Instance for a DROPS Application. The task supports thesame range of options as the ones found in theNew Import Process Instance dialog, as described in thetable below.

ReferenceFor more information about the parameters for an Import ProcessInstance, refer to Create new Import Process Instances on page 175.


*dropsServerProperty The Client APIs of the reference to the DROPS Server to use, defined by theClient APIs.

*applicationCode The DROPS Application that includes the Artifacts to import.

*releaseNumberThe number of the Release that will hold the imported Artifacts. This value canbe any release number that complies with the Application's Release NumberTemplate or *GEN.

releaseText The description of the Release.

incrementPart

This attribute is required if the *releaseNumber is set to *GEN.

The part of the release number that will be increased to create the Release. CanbeMAJOR,MINOR, BUILD or REV.

*filterType

The Import Strategy to use to import the Artifacts. Like in the DROPS Studio,threemethods are available:

l *NOFILTER: all Import Strategies are run using the release number as theexternal version number.

l *MANUAL: Import Strategies listed using embedded drops.import.filterelements or listed in a local file are executed.

l *FILE: Import Strategies listed in an external .properties file located on theDROPS Server are executed.

filterFilenameThe absolute path on the DROPS Server of the .properties file that contains alist of Import Strategy codes and the external version number used to run eachof them.

Table 59: The drops.import.release task's attributes





This attribute is only required if the *filterType is set to *FILE.

fromLocalFile

The absolute path of a local .properties file that contains a list of ImportStrategy codes and the external version number used to run each of them.

This attribute is only used if the *filterType is set to *MANUAL.

resetRelease

If set to true and if the Release already exists, its content is cleared beforeArtifacts are imported.

By default the value is false.

autoStart

If set to true, the Import Process Instance created by this task is immediatelyexecuted. If set to false, it will have to bemanually executed later.

By default the value is true.

waitForCompletion

If set to true and if autoStart is true as well, this task will block the executionuntil the Import Process is complete.


releaseNumberProperty

Create an ANT property to reference the release created when this task isrun. Enter the name of the property to call.

This property can be used later as the *releaseNumber in the drops.deploy taskto create and launch a deployment process for this release.

importResultProperty

The name of an ANT property that will be set with the result of the ImportProcess Instance.

Import result:

0: succeeded1: failed2: unknown

Table 59: The drops.import.release task's attributes

Supported nested elements

l drops.import.filter: if the task's *filterType attribute is set to *MANUAL, multiple elements can beused to describe the Import Strategies to be run and the external version numbers to use.

ExampleThe following example will create and execute a new import process for theDROPS_DEMO application. The Release's number will be generated byincrementing its revision digit. Every Component's Import Strategies will berun using the Release Number as their external version number. TheImport Process Instance reference will be put in the drops.release propertyand the release number will be put in the drops.import.instance property.

This Import Process Instance will be created and executed on theDROPS Server referenced by the drops.server property.

<drops.import.releasedropsServerProperty="drops.server"




applicationCode="DROPS_DEMO"releaseNumber="*GEN"releaseText="ANT task importation"incrementPart="REV"filterType="*NOFILTER"releaseNumberProperty="drops.release"instanceProperty="drops.import.instance" />

ExampleSame as above, but this time the filterType attribute is set to *MANUAL.Consequently, two nested drops.import.filter elements are used to list theImport Strategies to be run: the SQL Component’s svn Strategy, and theIBMI Component’s ARCAD strategy.

<drops.import.releasedropsServerProperty="drops.server"applicationCode="DROPS_DEMO"releaseNumber="*GEN"releaseText="ANT task importation"incrementPart="REV"filterType="*MANUAL"releaseNumberProperty="drops.release"instanceProperty="drops.import.instance"><drops.import.filter componentCode="SQL"

strategyCode="svn" externalVersion="head" /><drops.import.filter componentCode="IBMI"

strategyCode="arcad" externalVersion="10.06.00" /></drops.import.release>

ExampleStill the same as above, but the filterType attribute is set to *FILE. In thiscase, the filterFilename attribute is set to point to the location of a.properties file on the DROPS Server, that contains a list of Import Strategycodes and the external version number to use for each of them.

<drops.import.releasedropsServerProperty="drops.server"applicationCode="DROPS_DEMO"releaseNumber="*GEN"releaseText="ANT task importation"incrementPart="REV"filterType="*FILE"filterFilename="/tools/release12547856.properties"releaseNumberProperty="drops.release"instanceProperty="drops.import.instance" />

drops.deploy taskThis task creates and executes a Deployment Process Instance for a given process and release number.


*dropsServerProperty The Client APIs of the reference to the DROPS Server to use, defined bythe Client APIs.

*environmentCode The code of the Environment holding the Deployment Process to run.Table 60: The release.deploy task's attributes





*processCode The code of the Deployment Process to run.

*releaseNumberThe release number of the Release to deploy. Enter either a releasenumber or the value of the releaseNumberProperty from thedrops.import.release task.

transactionId The Transaction Id to use for this Deployment Process Instance.

autoStart

If set to true, the Deployment Process Instance created by this task isimmediately executed. If set to false, it will have to bemanually executedlater on.


waitForCompletion

If set to true and if autoStart is true as well, this task will block theexecution until the Deployment Process Instance is done.


deploymentInstanceProperty Create an ANT property to reference the Deployment Process Instancecreated by this task.

deploymentResultProperty

Create an ANT property to reference the result of the execution of theDeployment Process Instance created and executed by this task.

Deployment result:

0: succeeded1: failed2: unknown5: succeeded with warnings6: canceledTable 60: The release.deploy task's attributes

ExampleFollowing the previous example, the previously imported Release will bedeployed using the process DEPLOY_DEMO from the UAT Environment.The release number was retrieved from thereleaseNumberProperty in thedrops.import.release task and its value is now passed to the*releaseNumber attribute.

<drops.deploydropsServerProperty="drops.server"environmentCode="UAT"processCode="DEPLOY_DEMO"releaseNumber="${drops.release}"deploymentResultProperty="drops.deployment.result" />




TipsClassify your Server Credentials

As stated above, the drops.instance task element has a password attribute which is supposed to beconfidential. ANT itself doesn't offer a way to hide this kind of information. However, because thisinformation should classified and is used multiple times in an ANT script, it is advised to create an external.properties file with restricted permissions and allow the ANT script to load it using the <property>standard ANT tasks.

This method offers more flexibility and security over the credentials used to connect to the DROPS Server.

ExampleA file named drops.credentials.properties is created under the/opt/tools/scripts directory. This file contains the following set of properties:

drops.server.url=http://192.168.1.155:5252drops.port=5252drops.user=jenkinsdrops.password=justDoIt

It is then possible to load these properties in an ANT script using theloadProperties ANT task:

<propertyfile="/opt/tools/scripts/drops.credentials.properties" />

Then it is possible to use the properties retrieved from the credentials' filewith the drops.instance task:

<drops.instance propertyName="drops.server"url="${drops.server.url}" login="${drops.user}"password="${drops.password}" />



Full script exampleBellow is a sample ANT script that imports Artifacts in a newRelease and deploys it on the go.

<project default="main"><taskdef resource="com/dropssoftware/client/ant/antlib.xml"/>

<property name="in.jenkins.build.number" value="" /><property name="in.drops.application" value="" /><property name="in.drops.environment" value="" /><property name="in.drops.process" value="" /><property name="in.drops.import.filter.file" value="" /><property file="${in.drops.server.properties}" />

<property name="in.drops.increment.part" value="REV" /><property name="in.drops.release.number" value="*GEN" />

<property name="drops.server.url" value="http://${drops.server}:${drops.port}"/>

<target name="main" depends="connect, importation, deployment" />

<target name="connect"><drops.instance propertyName="drops.server" url="${drops.server.url}"

login="${drops.user}" password="${drops.password}" /></target>

<target name="importation"><drops.import.releasedropsServerProperty="drops.server"applicationCode="${in.drops.application}"releaseNumber="${in.drops.release.number}"releaseText="Automatic import from Jenkins Build

#${in.jenkins.build.number}"incrementPart="${in.drops.increment.part}"filterType="*MANUAL"fromLocalFile="${in.drops.import.filter.file}"releaseNumberProperty="drops.release"/>

<echo>Release ${drops.release} imported successfully.</echo></target>

<target name="deployment" if="drops.release"><drops.deploydropsServerProperty="drops.server"environmentCode="${in.drops.environment}"processCode="${in.drops.process}"releaseNumber="${drops.release}"/>

<echo>Deployment of release ${drops.release} of application${in.drops.application} on environment ${in.drops.environment} is done.</echo>

</target></project>

DROPS v2.8.1DROPS for z/OS | User Guide

DROPS for z/OSSYSchange provides a simple and practical solution for auditing, controlling, and managing systemsoftware or application software changes in z/OS environments. It is a tool that automates ReleaseManagement in z/OS SYSPLEX environments.

SYSchange supports all z/OS file structures, including PDS, PDSE, Physical Sequential, VSAM, DirectAccess, and zFS File Structures. All MVS operating environments and derivatives are supported includingthe OS/390 and z/OS in SYSPLEX environments.

SYSchange delivers cost effective solutions in two (2) areas:

l Compliance and Deploymentl The Developer Workspace

Compliance and DeploymentTo SYSchange, compliancemeans providing the capability to capture changes in critical protected librariesin real time, and to provide recoverability at themember-level. This component specifically manageschanges in system software environments which includes the OS, all IBM system products (IMS, DB2, CICS,…), all ISV products, production libraries – anything that runs the systems.

The deployment notions provide for ReleaseManagement. Entire library groups or selected librarymembers are intelligently packaged in a single file referred to as a SYSchange Promotion Package. ThePromotion Packages, automatically created by SYSchange can be transferred to local or remoteenvironments and then "promoted" to create or update the target libraries.

The automated "change identification", "packaging", and "promotion" capabilities of SYSchangehave made DROPS for z/OS as a "continuous" release management tool operating from a clientenvironment. DROPS for z/OS is a unique and multi-platform solution for management andautomation of Enterprise Software Deployment.

The Developer WorkspaceThis component enables application developers to compile and generate codes and move the code throughstages. This component is designed for application developers and managers to replace their traditionalhome-grown application development tools as well as the traditional changemanagement products suchas the CA-Endevor product.

Configuring SYSchange for DROPS for z/OSTo configure and activate a fully functional SYSchange, please refer to chapter 3 of the SYSchange User'sGuide.

To activate SYSchange to operate in concert with the DROPS for z/OS software, perform only thefollowing steps from the 10 steps documented in the User's Guidementioned above:

(step 1) Copy SYSchange LINKLIB to your APF authorized library.

(step 3) Edit and save the SYCPARMSmember.

(step 4) Edit and run SYCEXTND job to activate the software.

(step 5) Edit and run SYCINIT job.

Verify successful installation using SYCIVP job.



DROPS v2.8.1User Guide | DROPS for z/OS

SYSchange Commands

ReferenceFor a description of all batch commands available in SYSchange, refer tochapter 8 of the SYSchange User’s Guide.

Some of the commands used in DROPS for z/OS are explained here using working examples.

Example 1: Tokenizing a Software PackageTo establish a token representation of a software environment, the following commands may be executed:

//jobEXPL=DROPS.DEMO.DEV.INSTALLEXPL=DROPS.DEMO.DEV.LINKLIBEXPL=DROPS.DEMO.DEV.MACEXPL=DROPS.DEMO.DEV.PANEEXPL=DROPS.DEMO.DEV.PARMLIBEXPL=DROPS.DEMO.DEV.SOURCE*SHOW=LISTTOKEN=LIST//*

Using the EXPLICIT commands one or more data sets may be specified to create a LIST of libraries. Oncethe list of libraries is created, the TOKEN=LIST command will tokenize every data set in the list and storesthemember-level tokens in the SYSchange Control File (a VSAM repository).

Instead of using the EXPLICIT commands, you may also use the PATTERN commands as shown below:

//jobPATTERN=DROPS.DEMO.DEV.**SHOW=LISTTOKEN=LIST//*

Example 2: Creating a Full PackageThe following commands direct SYSchange to create a promotion package containing all library membersin the entire environment. Once the package is created, it can simply be transferred to other systems andthen promoted in order to build an identical environment as in the base. The OPTION=COPY directsSYSchange to generate a full package of the environment specified by the COMPONENT parameters ofthe CRCREATE command. The ACT=NEW indicates that the library placed in the promotion package is tobe treated as "newly allocate" when promoted at the target system.

//job*OPTIONS=COPY*CRCREATE=(BASIC=(REF='ticket 100',

DESC='a software package to replicate environment',APPROVERID=NONE),

*COMPONENT=(ACT=NEW,

MEM=*,DSN=DROPS.DEMO.DEV.INSTALL,




CHECKER=NONE),*COMPONENT=(ACT=NEW,

MEM=*,DSN=DROPS.DEMO.DEV.LINKLIB, CHECKER=NONE),*...*

NOTIFYLIST=NONE)*CRAPPROVECRBUNDLE//*

Example 3: Promoting a Full Package to build a New EnvironmentThe package created abovemay be promoted to a target system to build a new environment.

//job*DISP=SHRSTRREPL=('DEV','TST') in case of differences in nodesPROMOTE=(DSN=SYCPKG.P0000001,* RENAMEPACKAGE,

FEEDBACKCOMMENT='SUCCESSFUL BUILD’,SELECT=(DSN=*,MEM=*))

//*

The libraries stored in the promotion package have their first node as "DEV". If you intend for the replicatedenvironment to have a different first node you may indicate this intention in the STRREPLACE (orSTRREPL) command. In our example, the libraries will be newly allocated under the namesDROPS.DEMO.TST.INSTALL, etc.

Example 4: Identify and Package the Changed ComponentsThe following commands direct SYSchange to "identify and package" the changed components in the pre-tokenized environment shown in Example 1. The OPTION=MODS indicates to SYSchange that theMODSidentification is requested. The OPTION=IDENTIFY directs SYSchange to generate the packagingcommands and write those commands to a file pointed by the OUTFILE DD in the JCL. Then, theenvironment of interest is specified by a series of EXPLICIT commands. The libraries in the LIST are re-tokenized and the new tokens are compared against the old ones stored in the Control File to determinewhich library members have changed. Note that the stored tokens in the Control File remain unaffected.Only when the command TOKEN=LIST (without theMODS option) is specified the tokens will berefreshed.

//job** IDENTIFY THE INTRODUCED CHANGES IN A PREVIOUSLY TOKENIZED GROUP OF* LIBRARIES. AND, THEN PACKAGE THE CHANGED COMPONENTS INTO A* SYSCHANGE "PROMOTION PACKAGE".*COMMENT='AUTOMATIC PACKAGING OF CHANGES'OPTION=MODSOPTION=IDENTIFY Write the packaging commands to OUTFILE DD*EXPL=DROPS.DEMO.DEV.INSTALLEXPL=DROPS.DEMO.DEV.LINKLIB




EXPL=DROPS.DEMO.DEV.MACEXPL=DROPS.DEMO.DEV.PANELSEXPL=DROPS.DEMO.DEV.PARMLIBEXPL=DROPS.DEMO.DEV.SOURCE*SHOW=LISTTOKEN=(LIST,MODS)//*

Example 5: Promoting a Change Package to Update Target Environment(s)The package created abovemay be promoted at a target system in order to update the identicallyconfigured libraries. Usually, a change package contains only a few changed components. For example,theremay be a few updated members for the INSTALL library, and a few load module updates for theLINKLIB, and none for the other libraries. In this case, only those two libraries will be updated during thePROMOTE operation.

//job*OPTION=FULLROLLBACKDISP=SHSTRREPL=('DEV’,

‘TST’)PROMOTE=(DSN=SYCPKG.P0000002,* RENAMEPACKAGE

FEEDBACKCOMMENT='SUCCESSFUL RELEASE UPDATE’,SELECT=(DSN=*,MEM=*)

//*

If desired, using the STRREPL command you may direct the updates to libraries with different nodes. Forexample, if you intend to update DROPS.DEMO.TST.INSTALL and DROPS.DEMO.TST.LINKLIB at thetarget system, you may use the above STRREPL command.

Sample Tokenization JCLThe following JCL may be used to tokenize a software environment. In all JCL theremust be a //PARMLIBDD to point to the PARMmember SYCPARMSwhere the Control Files and Data Files are named. Thecommands shown in examples follow the //SYCIN DD *.

//JOB//* _____________________________________________________//* TOKENIZE A DEV GROUP AND STORE THE TOKENS IN THE CNTL//* -----------------------------------------------------//*//STEP1 EXEC PGM=SYCMAIN,REGION=0M//PARMLIB DD DISP=SHR,DSN=TGTHLQ.SYC410.PARMLIB(SYCPARMS)//STEPLIB DD DISP=SHR,DSN=TGTHLQ.SYC410.SSYCLNK//SYSUDUMP DD SYSOUT=*//SYSPRINT DD SYSOUT=*//SYCIN DD *Commands (refer to example-1)//*

Sample Packaging JCL (Creating a Full package)The following two-step JCL may be used to first identify the changed components in the pre-tokenizedsoftware environment and generate the packaging commands. Then, in the second step those commands




are executed to create a change package. The OUTFILE DDmust point to an existing file with the followingDCB: PS, FB, 80, 8000.

//JOB//* _____________________________________________________//* creating a “Full” package (all library members)//* -----------------------------------------------------//*//PARMLIB DD DISP=SHR,DSN=TGTHLQ.SYC410.PARMLIB(SYCPARMS)//STEPLIB DD DISP=SHR,DSN=TGTHLQ.SYC410.SSYCLNK//SYSUDUMP DD SYSOUT=*//SYSPRINT DD SYSOUT=*//SYCIN DD *Commands (refer to example-2)//*

Sample Packaging JCL (Creating a Change Package)The following two-step JCL may be used to first identify the changed components in the pre-tokenizedsoftware environment and generate the packaging commands. Then, in the second step those commandsare executed to create a change package. The OUTFILE DDmust point to an existing file with the followingDCB: PS, FB, 80, 8000.

//JOB//* _______________________________________________________//* Step-1 Identify the changed members in the environment//* -------------------------------------------------------//*//IDENTIFY EXEC PGM=SYCMAIN,REGION=4096K//PARMLIB DD DISP=SHR,DSN=TGTHLQ.SYC410.PARMLIB(SYCPARMS)//STEPLIB DD DISP=SHR,DSN=TGTHLQ.SYC410.SSYCLNK//SYSUDUMP DD SYSOUT=*//SYSPRINT DD SYSOUT=*//OUTFILE DD DISP=SHR,DSN=IBMUSER.SYC.CHANGES <--PS,FB,80,8000//SYCIN DD *Commands (refer to example-4)//*//* _______________________________________________________//* Step-2 Use the commands in OUTFILE to create the package//* -------------------------------------------------------//*//PACKAGE EXEC PGM=SYCMAIN,REGION=4M,COND=(4,EQ,IDENTIFY)//PARMLIB DD DISP=SHR,DSN=TGTHLQ.SYC410.PARMLIB(SYCPARMS)//STEPLIB DD DISP=SHR,DSN=TGTHLQ.SYC410.SSYCLNK//SYSUDUMP DD SYSOUT=*//SYSPRINT DD SYSOUT=*//SYCIN DD DISP=SHR,DSN=IBMUSER.SYC.CHANGES <--//*

Sample Promotion JCLThe following two-step JCL may be used to first identify changed components.

//JOB//* _______________________________________________________//* promote a package to update target environment(s)//* -------------------------------------------------------//*//PROMOTE EXEC PGM=SYCMAIN,REGION=0M//PARMLIB DD DISP=SHR,DSN=TGTHLQ.SYC410.PARMLIB(SYCPARMS)//STEPLIB DD DISP=SHR,DSN=TGTHLQ.SYC410.SSYCLNK




//SYSIN DD SPACE=(TRK,(1,1)),DISP=(,DELETE),// UNIT=SYSALLDA//SYCWORK DD SPACE=(CYL,(5,5)),DISP=(,DELETE),// UNIT=SYSALLDA//SYSUDUMP DD SYSOUT=*//SYSPRINT DD SYSOUT=*//SYCIN DD *Commands (refer to example-3)//*(end-of-document)



DROPS v2.8.1Troubleshooting | User Guide

TroubleshootingI can't find/access the entity I need to create/edit. I can access an entity, but I can't make any changes.

I can't perform a task because I don't have thecorrect Role. I can't save the Deployment Process Diagram.

My Deployment Process is suspended and I don'tknowwhy.

My Deployment Process is suspended but there areno messages in the Suspended Actions view.

My Deployment Process is suspended and awaitingapproval but there are no messages in theValidation Requests view.

My Deployment/Import Process failed.

I can't access DROPS Reports. I can access the DROPS Reports but they do notgenerate content.

My database is full. The DROPS Server is running but I can’t access it.Table 61: Troubleshooting

I can't find/access the entity I need to create/edit.If you see themessage "You are not allowed to use this feature" when trying to access an entity, verify thatyour User's profile has been granted the right(s) necessary to access the list of items and/or search forcertain items.

ReferenceFor more information about profiles and rights refer to:

l Accessing your profile and rights on page 45l The DROPS Configuration Guide

I can access an entity, but I can't make any changes.Verify that your User's profile has been granted the right(s) necessary to edit, delete, create or otherwisemodify the entity.

ReferenceFor more information about profiles and rights refer to:

l Accessing your profile and rights on page 45l TheDROPS Configuration Guide

I can't perform a task because I don't have the correct Role.If you see amessage similar to the screen shot below, verify that your User has been assigned the Rolenecessary to carry out the task.



DROPS v2.8.1User Guide | Troubleshooting

ReferenceFor more information about Roles refer to:

l Roles on page 241l Assigning entity-level Roles on page 43l TheDROPS Configuration Guide

I can't save the Deployment Process Diagram.

If there are errors in the Deployment Process Diagram and DROPS cannot save it, the Invalid Itemsview informs you of what the problem is. Any changes will be lost if you close the Process without fixing theissues listen and successfully saving.

Figure 91: The Invalid Items view

In order to save the Deployment Process Diagram, the following actionsmust be taken. If you close theDeployment Process Diagram editor without doing them, all changes will be lost.

l Deployment Activitiesmust be linked to a Component. See Edit Deployment Activity properties onpage 152.

l Deployment Activitiesmust have both a parent and a child Activity. Most commonly the parent will bean Initialization Activity and the child a Finalization Activity. See Define the order in which todeploy Activities on page 139.

l Deployment Activitiesmust have an identifier. See Edit Deployment Activity properties on page 152.

l Deployment Actionsmust define a script. See Edit Deployment Action properties on page 157.

l Deployment Actionsmust have an identifier. See Edit Deployment Action properties on page 157.




My Deployment Process is suspended and I don't know why.

If a Deployment Process Instance is suspended, check theDeployment Steps tab to see why. Often,the deployment is waiting for approval which means that a Validation Request is pending.

ReferenceFor more information about viewing the Deployment Steps tab, refer toUnderstanding Deployment Process Instance results on page 201.

For more information about resolving suspended Deployment Instances,refer to Working with Validation Requests on page 223 or Working withSuspended Actions on page 220.

My Deployment Process is suspended but there are no messages in the Suspended Actions view.

To view Suspended Actions and resolve issues, a User must have the Contributor role for theInfrastructure Item in question.

ReferenceFor more information about Roles refer to:

l Roles on page 241l Assigning entity-level Roles on page 43l TheDROPS Configuration Guide

My Deployment Process is suspended and awaiting approval but there are no messages in theValidation Requests view.

To view and approve/reject Validation Requests, a User must have the Role defined in the Validationtab in the Deployment Process Diagram's properties.

ReferenceEdit global Deployment Process properties on page 148

My Deployment/Import Process failed.Check the Process' log file to determine at which stage it failed. Common failures are:

l incorrect or missing Import Strategies (see Introduction to importing Artifacts on page 167 andWorking with Import Strategies on page 60).

l incorrectly configured Infrastructure Items (seeWorking with Infrastructure Items on page 97).

l incorrectly built Deployment Process Diagram (see Building Deployment Process Diagrams onpage 136 and Editing Deployment Process properties on page 146).



DROPS v2.8.1User Guide | Troubleshooting

I can't access DROPS Reports.

If the Reports view is empty, the DROPS Studio is not communicating with the DROPS Web Server.

ReferenceRefer to theDROPS Installation Guide for installation instructions.

Verify that the port is running correctly by testing this website (the default port is 8080):http://localhost:8080/birt/report.

Then, verify that the DROPS Studio is also connecting to the correct port by confirming the URL matchesthe port defined: http://localhost:8080/birt/

( Configuration Category view→ Administration→ HTTP Proxy Service → birt).

I can access the DROPS Reports but they do not generate content.If you are able to generate a Report in your external browser, even if it is incomplete, the default 8080 portsettings are correct.

To ensure that the DROPS Web Server is correctly communicating with your database, verify that it iscommunicating with the correct port that your DB is installed on. By default, the DB runs on 9092. If yourport is running on a different port, modify the Data Source URL value in the profileStore.xml to reach thedatabase.

The default location is: C:\Program Files\ARCAD Solutions\Jetty\webapps\birt\report

Change

<property name="odaURL" value="jdbc:h2:tcp://localhost/database/rm4os"/>

to

<property name="odaURL" value="jdbc:h2:tcp://localhost:xxxx/database/rm4os"/>

where xxxx is the DB's port defined during the installation process.

Restart the DROPS Web Server service to ensure themodification is taken into account.

My database is full.Deployment logs tend to take up a lot of room in the DROPS database.

Limit the size of your deployment logs by filtering out specific unnecessary entries. If your DB still becomestoo crowded, archive the deployment logs to createmore space.

ReferenceFor more information about filtering entries in deployment logs, refer totheDROPS Configuration Guide.

For more information about activating the auto-archive option fordeployment logs, refer to theDROPS Configuration Guide.




For more information about manually archiving logs, refer to View theLogs on page 203.

The DROPS Server is running but I can’t access it.The DROPS Server has been correctly installed and the service is up and running. However, it is not possibleto connect to it from the DROPS Studio or to call the web services.

Symptoms:

l The studio can't connect and says that the server is not responding.l Accessing the about, shell, or console web service from a web browser fails with a timeout or an"Unauthorized connection" error

l The server's service is actually running and no fatal error shows in the logs or when starting the servicefrom the command line.

Themain reason for this is that the port on which the server is listening (5252 by default) is not reachable onthe network.

This can be easily diagnosed by trying to access the server locally. Call a netstat-like command on the serverand see if it's actually listening on the aforementioned port. If it's not, proceed with one of the following:

l If a graphical environment and a web browser are available on themachine hosting the server, openthe web browser and access the "about" web service using the address http://127.0.0.1:5252/about. Itshould display the "about" page and list the server's plugins and their state.

l Use a command line tool to call the "about" web service (like wget, curl...) onhttp://127.0.0.1:5252/about and download the result.

If it appears that the DROPS Server is accessible locally, then the network's configuration should bechecked as well as the firewall rules, if any.



DROPS v2.8.1User Guide | Glossary

GlossaryAB C D E FG H I J K L MNO PQ R S T U VW X Y Z

A

ActionSee Deployment Action.

Activation KeyA variable-length string value registered in a DROPS Server to enable the creation of a given amount ofInfrastructure Items. It contains the total count of available License Units for each License Type.

An Activation Key is encrypted and only valid for one specific DROPS Server.

See License Unit.

ActivitySee Deployment Activity.

AdministratorUser: In charge of high-level configuration.

Role: In charge of assigning Roles to Users at the entity-level.

AgentThe tool that DROPS Server uses to communicate with a target system. It is a module that must beinstalled on every target system to which you intend to deploy. The DROPS Server can connect to the V2DROPS Agent on your target machine via a TCP/IP SSL connection or to the V3 DROPS Agent via HTTP.

Ant projectA valid set of Ant tasks that makes up the content of a script.

Ant taskIndividual tasks used in scripts to define the course of action for a Deployment Action. They produce thesame result(s) on every platform they run on.

DROPS provides tasks to perform calls to the DROPS Server to carry out tasks like publishing files from aDeployment Process, for example, and actions on an IBM i and/or an ARCAD instance.

Prerequisites: the remote runtimemust have the ant-drops.jar in its classpath.

ApplicationA set of Artifacts that creates a specific structure of elements that, ideally, make up and complete thesystem you deploy.



DROPS v2.8.1Glossary | User Guide

Applications house Artifacts (grouped by Components and Release) and are required to deploy a given setof functional elements to a target Environment.

See Artifact and Component.

Archived Files Storage AreaThe path to the root location where archived deployment logs should be stored. By default, this repositoryis automatically created in the DROPS Server.

ArtifactA unique element of an operational Application.

Artifacts are combined in Components to create a set of elements to be deployed.

See Component.

Artifact KeyAn Artifact's relative path starting from its parent Component. The relative path is the path defined in theDefault Component URI Template field during DROPS global configuration.

By default the relative path to an Artifact is:file://${root}/app${application}/cmp${component}/rls${release}/...

Artifact ListAn .xml file created when Artifacts are imported which can be referenced in Substitution Variables to locateArtifacts.

Artifact RepositoryA centralized directory that regroups defined Applications (Components and Artifacts) and Releases.

Loading the Artifact Repository with imported Artifacts is a process that relies on predefined strategies andANT tasks. Any type of source provider can be connected to gather Artifacts for your Components.

See Application and Release.

B

Backup DirectoryThe directory path on the target system used to stock a copy of the content that is currently defined in andactive in the Deployment Process.

C

change packageSpecific to SYSchange. A package that contains only a few changed Components created in order to updatethe identically configured libraries of a target system.




ComponentA collection of Artifacts housed in an Application grouped by Release.

Components group Artifacts based on their function and/or destination. The hierarchy respected in aready-to-deploy Component is dependent on the target Release.

Configuration Management perspectiveThe eclipse perspective that enables you to manage the artifact and infrastructure repositories.

ContributorRole: In charge of solving problems concerning the Infrastructure Item. User is notified via notificationemail when an issue arises.

D

Database AdministratorRole: Responsible for the Application's source/target database(s).

Deployment ActionSpecific to Deployment Processes. Represents one script. Each script defines a task to carry out during theDeployment Process.

Actions are added to certain activities or stages in the Deployment Process.

See Stage.

Deployment ActivitySpecific to Deployment Processes. An ensemble of Stages that defines the order in which to carry out theDeployment Process.

The three types of activities in the Deployment Process Diagram are:

1. Initialization Activity2. Infrastructure Item Activity3. Finalization Activity

Deployment Activity TemplateA pre-defined ensemble of Stages and/or Deployment Activities that can be reused in any number ofDeployment Process Diagrams.

Activity Templates must include at least one Stage or one Deployment Activity. Only Infrastructure ItemActivities can be used to create Templates.




Deployment TagA tool to mark an ensemble of Deployment Process Instances. You can use tags to quickly search forInstances.

Deployment Infrastructure RepositoryEnsemble of all the entities required to deploy.

Deployment ProcessThe ensemble of the Deployment Process Diagram and associated parameters used to define andautomate the deployment of one Application to one Environment.

The process is broken into Activities, Stages and Actions. Actions can be applied to Activities and Stages.

Step one (Initialization Activity) = all of the Actions defined are carried out.

Step two (Infrastructure Item Activity) is broken into four Stages, each of which is carried out in turn:

1. Preparation Stage2. Transfer Stage3. Receiving Stage4. Installation Stage

Step three (Finalization Activity) = all of the actions defined are carried out.

See Stage, Deployment Action, Deployment Activity and Deployment Process Diagram.

Deployment Process DiagramSpecific to Deployment Processes. An editable visual representation of the Activities, Stages and Actionsdefined to automate the Deployment Process.

Use the Deployment Process Diagram to drag and drop the Actions to carry out during the DeploymentProcess into the Activities and Stages required for all the Infrastructure Items for a single Environment.

Deployment Process InstanceAn execution instance of a Deployment Process where a particular Release has been defined.

They enable Users to:

l get feedback on the progression of the execution;l get logs on the different operations made during the execution;l access information about what has been deployed;l validate the different deployment steps;l interact, if needed, with the process to solve critical situations.

Deployment Process SchedulerAn interactive Gantt chart that displays all of the scheduled Deployment Process Instances in a time line.

The Scheduler can be used to create and modify Deployment Process Instances and their schedules.




Deployment Process Properties TemplatePre-defined process-level properties and parameters that can be reused in any number of DeploymentProcess Diagrams without affecting the diagram itself.

Deployment RuleThe combination of a RegEx and a specific path on an Infrastructure Item intended to filter deployedArtifacts. Artifacts matching the RegEx are deployed to the rule's destination path instead of thedestination defined in the Infrastructure Item.

Deployment SchemaA set of deployment rules intended to modify the destination of a filtered group of Artifacts on anInfrastructure Item at the time of deployment.

Deployment XML List Storage AreaWhen Releases are deployed, DROPS creates a Deployment List and stores it in a predefined path.By default this path leads to a relative path where the DROPS Server is installed.

DROPSA licensed software application that brings development and deployment teams together by providingcontinuous deployment of your company's technology all the way to production. Software, updates,installs, websites and much more can be automatically deployed on a scheduled basis which reducesdevelopment timewhilemaintaining team responsibility and respecting your company's security, roledistribution and source platform(s).

E

entityAny item that requires configuration and can be referred to by other items to create a chain of content inorder to either import or deploy Artifacts.

ExampleApplication, Component, Import Strategy, Release, Environment andInfrastructure Item.

EnvironmentAn ensemble of Infrastructure Items that may represent an easily identifiable location or system thatdefines where deployed content is intended to go.

Environments are linked to Applications and their Releases in order to deploy a given set of functionalelements to a target.

See Application and Infrastructure Item.




Environment GroupAn ensemble of Environments that share one or more Applications used to createmultiple DeploymentProcess Instances at the same time.

F

Finalization ActivityThe final step in the Deployment Process. Only one of these types of activities can be defined perDeployment Process Diagram. No Artifacts aremanaged during this step. Only certain actions can bedefined in these types of activities and they are always carried out on the DROPS Server. The parentActivity must be an Infrastructure Item Activity.

See Deployment Activity and Deployment Action.

full packageSpecific to SYSchange. A package that contains all of the library members from an Environment, includingthe changed and unchanged Components.

G

H

I

Import OperatorRole: In charge of executing the Import Process.

Import Root DirectoryIf an Import Strategy uses the default *AUTO as its , the path defined here will be used. By default, thispath leads to a relative tmp path where the DROPS Server is installed.

Import StrategyAn engine that communicates with an external artifact provider (source) to find and import the definedArtifacts. The imported Artifacts are classified according to the directory structure defined in the Strategyand can be filtered by version.

Import XML List Storage AreaWhen Artifacts are imported, DROPS creates an Artifact List and stores it in a predefined path. By defaultthis path leads to a relative path where the DROPS Server is installed.




Infrastructure ItemA unique entity that defines a Technical Platform target to which content is deployed. It containsconnection information and deployment instructions

Infrastructure Items are added to Environments and arematched on a one-to-one basis with Componentsin the Deployment Process Diagram.

See Environment and Component.

Infrastructure Item ActivityIntermediary steps in the Deployment Process. There can only be as many Infrastructure Item Activities in aDeployment Process Diagram as the associated Environment has Infrastructure Items. One Activity islinked to one Infrastructure Item. Stages are added to these Activities to define the deployment actions tocarry out for each Item.

Important!These activities must have both a parent and a child activity in order to savethe Deployment Process.

These activities must be linked to at least one Component in order to savethe Deployment Process.

See Deployment Activity, Stage, and Deployment Action.

Infrastructure RepositoryA centralized directory that regroups Users, Environments, Infrastructure Items, Strategy Templates,scripts, Deployment Schemas, Replacement Rules, Process Templates and Clients if applicable. The parentmenu item for this repository is the Configuration node in the Configuration Explorer.

Defining the entities included in this directory enables you to configure the entire deploymentenvironment.

Unlike the Artifact Repository, the Deployment Infrastructure Repository is only a menu in theDROPS Studio RCP, not an actual database.

Initial Import StrategyA type of Import Strategy that retrieves Artifacts to create a Release that guarantees that an entireApplication will be imported into one Release. It may be useful to ensure that the first Release importedcontains every Artifact of the Application to be able to deploy the full Application to a new system.

Contrary to "regular" Import Strategies, which may repeatably import only themost recent file(s) in aversion (partial imports), Initial Import Strategies are usually used once in the beginning to create thecomplete foundation of your Application in the Artifact Repository.

Initialization ActivityThe first step in the Deployment Process. Only one of these types of activities can be defined perDeployment Process Diagram. No Artifacts aremanaged during this step. Only certain actions can be




defined in these types of activities and they are always carried out on the DROPS Server. The client activitymust be an Infrastructure Item Activity.

See Deployment Activity and Deployment Action.

Installation PathThe root directory on the DROPS Agent that contains the Local Repository Storage Area.

Installation StageThe final phase of the Deployment Process carried out on the DROPS Agent (the target InfrastructureItem). The Actions defined for this stage are completed after the Receiving Stage or if a Transfer-Onlydeployment instance is performed.

J

JMVJava Virtual Machine

K

L

License UnitEquivalent to one Infrastructure Item, this is the price paid to use DROPS.

License Units depend on the Type of Infrastructure Item created (the License Type). DROPS provides someextensions like DROPS for IBMi or DROPS for z/OS that allow you to deploy to special targets (IBM i orz/OS). The pricing model takes the value of such a feature into account.

To view the number of permanent and temporary License Units available, click the Configuration node inthe Preferences menu (right-click on the DROPS Server→ Preferences→ Configuration).

See also: Temporary License Unit.

License Unit PackThe total number of different types of License Units purchased represented by an Activation Key that,when registered in the DROPS Server, enables you to use DROPS.

License TypeThe different kinds of License Units available for purchase that enable you to create different types ofInfrastructure Items and therefore use DROPS.

l IBM il z/OS




l Open (all the other targets)l Temporary

Local Repository Storage AreaThe path defined when a DROPS Agent is installed that contains both the default Root Directory and theBackup Directory. This path must be accessible to the DROPS Agent and is intended to regroup all of thecontent deployed to an Agent in one location. This path is used when the Backup and/or the Root Directoryis set to *AUTO in an Infrastructure Item.

This path may also be called the storage path or the storage root.

M

ManagerRole: Responsible for the correct configuration of the Infrastructure Item(s) concerned.

Monitoring ListA list of Infrastructure Items that is periodically checked by the DROPS Server to confirm that theconnection to each corresponding Agents is active.

N

O

OS FamilyTheOS on which the DROPS Agent is running. The processes required to remotely install and uninstall aDROPS Agent are defined by this value.

Operational Console Management perspectiveThe eclipse perspective that enables you to execute the Import and Deployment Processes. The actionsavailable in this perspective are also available in the DROPS Web Console.

Operational NeedA particular need that can be satisfied by the execution of a set of processes done by actors that have therequired knowledge to correctly understand how and whymultiple Applications depend on each other.

P

packageSpecific to SYSchange. An archive that contains data that comes frommultiple libraries. Its internal formatis defined by SYSchange.

See promotion package.




packagingSpecific to SYSchange. The process by which all themembers in the libraries belonging to a softwarepackage are copied into a single file referred to as a SYSchange promotion package.

ExamplePackaging of application software with library types of SRC, MAC,PANELS, MSGS, SKELS and LINKLIB involve copying all library membersinto a physical sequential file. If the software package above was pre-tokenized, optionally only the changed Components are stored in theSYSchange promotion package. Thus, only the changed Components arepackaged and then promoted to update the target system(s).

pattern library listSpecific to SYSchange.and IBM i. A string pattern that will be used by SYSchange to search for the name ofthe library that will be scanned to detect modifications.

platformAn operating system.

Platforms available are defined by a DROPS admin (high-level configuration) and used in InfrastructureItems to define the type of OS to which your Applications are deployed.

Preparation StageThe first phase of the Deployment Process carried out on the DROPS Server intended to define actions toprepare Artifacts for deployment.

profileA set of rights assigned to a User.

Project ManagerRole: Responsible for the correct configuration of the Release(s) concerned.

promotionSpecific to SYSchange. The process by which a SYSchange promotion package is used to update libraries inthe target environment. At the time of promotion, a restore packagemay be requested.

promotion packageSpecific to SYSchange. An archive that contains data that comes frommultiple libraries. Its internal formatis defined by SYSchange.

See package.

processSee Deployment Process.




Process TemplateThere are five different types of Process Templates and each one represents a different level and all of thelevels it contains.

l A Stage Templatemust include at least one Deployment Action to predefine the steps to carry outwhen the stage is executed. Templates can be created for every Stage in a Deployment Process:

o Preparation Stageo Receiving Stageo Installation Stage

l ADeployment Activity Template is only for Infrastructure Item Activities. Activity Templates mustinclude either at least one Stage (which must also include at least one Action) or at least one Actionoutside of a Stage. The same requirements for a normal, unique Deployment Activities apply toActivity Templates, including most of the properties.

l ADeployment Process Properties Template is an ensemble of pre-defined process-level properties andparameters which can be applied to a Deployment Process Diagram to automatically define thisinformation without using uneditable elements (Activity or Stage Templates) in the Diagram itself.

purgeThe two methods of permanently removing excess or outdated content fromDROPS.

Purging logs, temporary directories and import instances from the DROPS Server is performed in theDROPS Server Configuration menus.

Purging outdated or ineffective Releases is performed in the DROPS Studio.

Q

R

Receiving StageThe third phase of the Deployment Process performed on the DROPS Agent (the target InfrastructureItem). This phase is intended to allow you time to modify transferred Artifacts before installing themcompletely on the Infrastructure Item. If a Deployment Process is executed in Transfer-Only mode, thedeployment stops after this stage is complete.

ReleaseA consistent set of updated or newArtifacts created during the import process and nested underComponents and Applications in the Artifact Repository.

Releases are the packages that you deploy and can follow your specific version system.

Release ManagerRole: Responsible for the correct configuration of the Environment's Deployment Process Instance.




release numberThe unique code applied to Releases automatically when they are created.

The template for release numbers is defined in the Preferencesmenu and/or Applications.

Release OperatorRole: In charge of executing Deployment Processes

Release SetA group of Releases selected one-by-one to be deployed to the same Environment. Sets cannot be storedsince they are defined when Deployment Process Instances are created. Every Release Set Instance canhave a different combination of Releases.

repositorySee Artifact Repository.

Repository ManagerRole: In charge of the content in the Artifact Repository

Repository Storage AreaThe path to the root location of the Artifact Repository. By default, this repository is automatically createdin the DROPS Server.

restore packageSpecific to SYSchange. A package created during the promotion (deployment) process which contains acopy of the target environment's original library members prior to being replaced by the data from thepromotion package.

To UNDO the effect of a promotion (deployment) operation, the restore packagemay be used to revert thesystem to its state just prior to the last promotion (see rollback).

rightsDefine a User's access to entities and items and grant authority to create, view and modify them.

Rights are granted to profiles which are assigned to Users.

See profile.

RoleDefines a User's responsibility concerning an entity involved in the Deployment Process.

Roles are assigned for Applications, Releases, Clients, Environments and Infrastructure Items. Having aRole involving an entity means that the User can and may be required to perform certain actions during theimport and/or Deployment Process.




rollbackRestoring previous content after a deployment is considered 'unsuccessful'.

If a deployment fails or the deployed content is incorrect, reverse the deployment actions by recalling thenew content and reinstating the previous content that was saved before the copy.

Root DirectoryThe directory path where the deployed Artifacts are temporary stored before being officially copied to thetarget. It is used to temporarily store the Artifacts to be deployed before DROPS actually deploys them.

S

SCMSoftware Configuration Manager. A.K.A.: VCS

scriptA sequence of valid Ant tasks (XML tags) linked to a Deployment Action that defines what the Actionshould accomplish.

schemaSee Deployment Schema.

stepSee Deployment Activity.

StageA set of Deployment Actions in a Deployment Process that represents a functional part of the parentDeployment Activity's execution and involves different parts of the system. Each Stage runs in a differentlocation - the DROPS Server or the target Infrastructure Item.

There are four different Stages:

1. Preparation Stage2. Transfer Stage3. Receiving Stage4. Installation Stage

Stage TemplateA pre-defined set of Deployment Actions in a Deployment Process that represents a functional part of theparent Deployment Activity's execution and involves different parts of the system.

Stage Templates must include at least one Deployment Action.

There are three different Stage Templates:




1. Preparation Stage2. Receiving Stage3. Installation Stage

StrategySee Import Strategy.

T

Technical IDA unique number automatically assigned to each Import Process Instance. Also called the Internal ID.

Technical PlatformThe service to which an Infrastructure Item deploys Releases.

Temporary Infrastructure ItemAn Infrastructure Item that is only active for a fixed amount of time and that consumes one TemporaryLicense Unit.

Temporary Infrastructure Items can only be created if every License Unit in the current Activation Key's isconsumed. The number of Temporary License Units available depends on the number of purchasedLicense Units that the current Activation Key contained.

If no Activation Key has ever been registered for the current DROPS Server, only five (5) temporaryInfrastructure Items can be created and used for a limited period of time (up to onemonth). This enablesyou to use DROPS while your Activation Key is being generated.

A Temporary Infrastructure Item becomes definitive as soon as a new License Unit is available (as soon as anew License Unit Pack is registered).

Temporary License UnitAn automatically-activated License Unit that enable you to create temporary Infrastructure Items (availablefor one week). These units aremade available before you register your purchased Activation Key and afterall of the purchased License Units in your current Activation Key are consumed.

See License Unit.

tokenizationSpecific to SYSchange. A Hash Sum value representing the content of a file.

The SYSchange tokenization process is used to determine whether or not a file has changed. When alibrary is tokenized, each library member along with its token (a 4-byte hex value) is stored in theSYSchange Control file. At a later time, when the same library is re-tokenized, the current member tokensare compared against the ones stored in the Control File and themembers with different tokens aredetermine to have changed. When a file is tokenized any minute change in the file content produces adifferent token value, i.e. a change has been introduced in the file.

See change package, full package and packaging.




Transaction IDWhen a Deployment Process Instance is created this identifier is generated which facilitates the rollbackprocess by enabling DROPS to find the Actions carried out.

The Transaction ID is not necessarily unique for each Instance. If an Instance is broken into two parts(Transfer-Only and Installation-Only) the two Instances will share the same ID in order to maintain the linkbetween the two halves of the Deployment Process and ensure that if rollback is required, both halves arerolled back.

The ID's syntax follows the templatemanaged in the Preferences menu.

Transfer StageThe second phase of the Deployment Process performed behind the scenes which cannot bemodified. Artifacts are transferred to Infrastructure Items during this phase.

U

Update Repository Root PathThe path to the root location of the new repository in which the server will store files downloaded from theUpdate Server. By default, this repository is automatically created in the DROPS Server.

UserPassword protected accounts that define the access rights for the different members of your team that useDROPS. Each account is associated with one email address and has a unique login.

Users are assigned Roles to play in the Deployment Process and given rights to access certain functions.

V

Validation RequestThemessage sent to a defined User when a Deployment Process requires his or her approval beforecarrying out a specific Activity or Action.

VCSVersion Control System. a.k.a.: SCM




W

X

Y

Z

z/OS ApplicationSpecific to SYSchange. A set of libraries required to provide a given set of functional features.

z/OS ReleaseSpecific to SYSchange. The snapshot of a stable state of a z/OS Application defined by the developer of theapplication. It is defined by a Release Number that identifies the state of the system after applying therelease. It could be also understood as the set of modified elements that must be applied to the state n ofan application to promote it to the state n+1.



DROPS v2.8.1User Guide | Index


- A -Action See Deployment ActionActivation Key 107, 298Activity See Deployment ActivityAFS 22Agent 23, 97, 130, 141, 186, 217, 253, 298Ant project 298Application 24, 27, 41, 47, 76, 93, 112, 117, 131,

147, 167, 170, 173, 184, 208, 223, 229,235, 246, 255, 276-277, 281, 298

Artifact 47, 131, 189, 255Artifact Key 113, 252, 299Artifact List 179, 205, 252, 299Artifact Repository 27, 47, 49, 56, 60, 70, 76,

113, 141, 242, 254-255, 299

- C -Client 27, 38, 43, 185, 229, 280Component 27, 47, 113, 131, 155, 170, 280, 294Configuration Category view 228, 296Configuration Management perspective 29,

47, 80, 228, 300Current User Information 35, 45

- D -Deployment Action 146, 205, See also scriptDeployment Activity 137, 152, 163

Finalization Activity 143, 161Infrastructure Item Activity 137, 152Initialization Activity 153

Deployment Diagram 126, 198Deployment Files Storage Directory

Deployment XML List Storage Area 302Deployment Infrastructure Repository 80, 301Deployment Process 4, 27, 29-30, 37, 43, 56,

70, 77, 79-80, 84, 93, 97, 113, 117, 121,131, 136, 146, 161, 182, 184, 208, 217,220, 223, 234, 241, 246, 274, 277, 298

Deployment Process Instance 142, 148, 221,250, 283, 295

Deployment Process status 135Deployment Result 216Deployment Rule 302Deployment Schema 108, 141, 156, 302Deployment Tag 185, 211, 301

deployment workload 97DROPS Agent 23, 97, 130, 141, 186, 217, 253,

298DROPS for z/OS 25, 142, 270, 287DROPS Server 4, 22, 27, 32, 35, 38, 43, 45, 47,

49, 56, 60, 67, 70, 76, 81-82, 84, 93, 97,113, 117, 121, 131, 139, 152, 161, 168,170, 173, 184, 208, 217, 220, 223, 228-229, 253, 262, 280, 297-298

DROPS Studio 4, 23, 29, 32, 39, 74, 111, 121,238, 244, 257, 281, 296, 304

DROPSWeb Console 23, 29, 32, 167, 182, 306DROPSWeb Server 23, 228, 296

- E -Entity Types

Component Type 57Environment 4, 52, 93, 129, 136, 147, 184, 208,

217, 220, 223, 229, 257, 277, 283, 289, 299Environment Group 43, 187, 303External Version 172, 176, 247, 273

- G -Gantt chart 209, 301

- I -Import Strategy 25, 27, 47, 56, 60, 67, 73, 170,

175, 246, 255, 280, See also Initial ImportStrategy

Infrastructure Item 24-25, 56, 130-131, 136,146, 161, 186, 217, 220, 229, 252, 274,295

Infrastructure Repository 80, 84, 301Initial Import 25, 65, 167, 170, 176, 270, 304Initial Import Strategy 25, 171, 270, 304, See

also Import StrategyInstallation Path 110, 305

- J -Jetty 24, 296

- L -Library List 271Library Pattern 270License Unit Pack 107, 305Login storage 41


DROPS v2.8.1Index | User Guide


- M -Module 111, 262, 290, 298Monitoring List 103, 306

- O -Operational ConsoleManagement

perspective 6, 29, 167Operational Need 236, 306OSGi 22

- P -package

application package 271Package 51, 91, 112, 148, 287

release package 270Packaging Type 51, 149

Cumulative 52, 149Unitary 51, 149

Process Template 139, 152Deployment Activity Template 138, 300Deployment Process Properties

Template 302Stage 113, 117, 154, 161, 225

profile 4, 40, 45, 110, 241, 244, 293, 307

- R -Release 3-4, 21, 29-30, 49, 60, 84, 93, 111,

149, 161, 168, 170, 174, 184, 208, 217,220, 223, 244, 278, 281, 287, 299

Release Number 53, 71, 77, 174, 218, 220, 224,242, 244, 313

Release Number Template 53rights 2, 4, 28, 37-38, 45, 51, 58, 62, 67, 72, 82,

88, 95, 105, 115, 161, 168, 241, 244, 278,293, 307

Role 28, 150, 298Administrator 43, 49, 84, 93, 97, 223, 242,

244, 298Contributor 97, 217, 220, 243, 295, 300Database Administrator 223, 242, 300Import Operator 168, 170, 173, 242, 303Manager 4, 49, 76, 84, 97, 168, 170, 173,

184, 208, 217, 220, 223, 242, 244, 306Project Manager 223, 242, 307ReleaseManager 4, 84, 168, 184, 208, 243,

308

Release Operator 4, 84, 184, 217, 220, 223,242, 309

Repository Manager 49, 76, 168, 170, 173,242, 244, 309

rollback 28, 130, 206, 278

- S -Scheduler 184, 208, 301Schema See Deployment Schemascript 294, 298Stage

Installation Stage 141, 154, 161, 195Preparation Stage 141, 161Receiving Stage 142, 161, 195Transfer Stage 113, 117, 141, 154, 198

step See Deployment ActivityStorage Areas

Archived Files Storage Area 75, 299Backup Directory 108, 299Import Root Directory 303Import XML List Storage Area 303Local Repository Storage Area 108Repository Storage Area 64, 108, 175Root Directory 60, 108, 113, 141, 303Update Repository Root Path 312

Strategy See Import StrategySYSchange 5, 25, 270, 287, 299

- T -Technical Platform 21, 106, 304Template Environment 93Temporary Infrastructure Item 107, 311tokenization 311Transaction ID 130, 192, 213, 251, 312

- V -Validation Request 186, 312


help-drops.arcadsoftware.comguide.pdf · northamerica&latam emea(hq) asiapacific...

Documents