Campaigns

Required Roles	Environment Release Manager and/or Release Operator Application Repository Manager
Required Rights (by category)	Import Process Instances Deployment Plan Execution Instance
Perspective	Operational Console Management
Access	DROPS Server → Campaigns

A campaign is an identified execution unit that allows to put the following processes together:

The import of a release,
The execution of deployment process instances on the newly created release.

Campaigns allow you to execute all these operations at once, in a "One Click" deployment.

The Campaigns search view is accessed from the Campaigns node in the Console Explorer.

Creating campaigns

The creation of a campaign in DROPS consists in defining the Import Process options for a given application and the list of deployment instances that are executed to deploy the release created.

Follow the subsequent steps to create a new campaign.

Step 1 To access the Create a new Campaign wizard, either click the Create a new campaign button in the Campaign search view or right-click anywhere in the view and select Create a new campaign.

Step 2 Define the campaign main properties by setting a Name for the campaign. Tick the Execute the campaign immediately checkbox to launch the campaign right after its creation.

Important!

Set the campaign main properties carefully. They cannot be changed once the campaign is created.

Click Next > to continue.

Step 3 Select the application(s) containing the artifacts to import. At least one application must be selected and it is possible to select multiple applications.

Step 4 Select the release in which to save the artifacts that will be imported.

If Current Release is selected, the release defined in the Current Release field in the application is used to import (displayed in parentheses).
If Create a New Release is selected, a new release will be created using the Release Number Template defined in the application.

If this option is selected, define the part of a release’s version number to increment from the Increment Part drop-down menu. Keep in mind that the algorithm will update the other parts automatically. By default, the part is set to the value defined in the Default Release Increment Part.
Selecting an existing, active release from the prepopulated list will import the artifacts to that release.

Click Next > to continue.

Step 5 Define the Pipeline selection, which is a list of pipeline instances that are executed in the current campaign.

Enter a Pipeline Instance Name.
Select a Pipeline in the ones available in the drop-down list.

Note

The content of the Pipeline drop-down list is conditioned by the selected Application. The available pipelines are linked to the related client, they have only one environment group and this group contains only the selected application.

[Optional] Select a target Execution Node in the ones available in the drop-down-list.
Click the Add button to include the defined pipeline in the Pipeline Instance list.

Note

To remove pipelines from the ones added in the list, select the pipeline(s) and click the Remove button.

Click Next > to continue.

Step 6 [Optional] Enter a description in the Release Description field. Tick the Reset release before importing checkbox to force the Import Process to clean the content of the release before importing any new artifacts.

Click Next > to continue.

Step 7 To associate the instance with a workitem, select the provider then the pre-defined workitem.

Reference

For more information about JIRA issues and workitems in DROPS, refer to Workitems.

Click Next > to continue.

Step 8 Select the import strategies to add to populate the selected release.

Filtering the import strategies of the components in the application enables you to select different combinations of artifacts for this release.

Ticking No Filter will automatically import all of the application's artifacts.
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 the Application editor in the Default Imported Version file name field.
Select which import strategies to use or not by adding or removing them from the User-Defined Filter section.

Click the Edit button to edit an import strategy already in the list.

The list displays the import strategies used and their corresponding components as well as the version to import. The External Version refers by default to the ${import.version} substitution variable (*RELEASE).

Important!
The import strategies selected in this section define the components that will be deployed when this release is launched.

Only "normal" import strategies are available in this list. Initial import strategies can only be launched by selecting to import Initial Import Strategies.

Reference
For more information about strategies, refer to Import strategies and Import strategy type configuration.

Click Finish.

Result A dialog appears to display the result details of the creation of the campaign and the import, click OK. If the campaign was defined to be executed immediately after the creation, the execution starts when you close the dialog. The Status and Results columns are updated according to the process of the execution.

Executing campaigns

If the campaign was defined to not be automatically executed after the creation, it appears in the Campaigns search view and has to be executed manually.

Executing an existing campaign process instance creates a new instance in the Import Process Instances and Deployment Plan Instances views.

To execute a campaign, either right-click on a campaign in the Campaigns view and select Execute, or select a campaign and click the Execute button from the toolbar.

Note

To view the details of the execution while it happens, right-click on a campaign and select Show Result, or click the Show Result button to open the campaign results view and watch the steps as they are performed from the Log tab.

The current Status of campaigns changes while the campaign is being processed.

Campaign execution statuses
Status	Description
Prepared	The campaign was successfully prepared.
Initialization in Progress	The execution started and the initialization stage is in progress.
Release creation in progress	The initialization stage was successfully completed, the Import Process started ans is in progress.
Deployment in progress	The Import Process stage was successfully completed, the Deployment Process started and is in progress.
Completed	The campaign execution is completed.

The current Result of campaigns changes while the campaign is being processed.

Campaign execution results
Result	Description
Not Available	The campaign execution has not started yet or was just launched.
Initialization Failed	The campaign initialization process failed.
Release Creation Failed	The campaign Import Process failed.
Deployment Failed	The Deployment Instance execution failed.
Succeeded	All operations of the campaign execution succeeded.

Understanding campaign execution results

The Campaign Results view contains two tabs that each contain different elements and details of the campaign.

The Overview tab displays the uneditable general information about the instance. This tab contains several sub-tabs:
- The Campaign Properties section displays the name of the campaign as defined during its creation.
- The Execution Result section displays the details of the campaign execution, such as the Status, the Result and the Start/End date.
- The Release Creation/Update section displays the details of the release process, weather it was just created or updated. Click on the Release Creation/Update Process link to open the campaign Import Results view.
- The Pipeline Instance List section displays the list of deployment instances that were created for this campaign. For each deployment in the list, you can right-click and select Edit to open the pipeline instance diagram, or Show deployment plan results to open the pipeline Instance Result view.
The Log tab displays the Campaign execution log entries.

Submit Search

go back to top