Deployment process instances
Required Roles | Environment Release Manager and/or Release Operator |
Required Rights (by category) |
Deployment process Instances |
Perspective | Operational Console Management |
Access | DROPS Server → Deployment Process → Deployment Process Instances |
Deployment process instances enable you to deploy one application to one target environment. Instances can be created from the Deployment Process Instances search view and either executed manually or scheduled in order to execute them at a later date or even to execute them regularly.
If the DROPS Server is stopped during a deployment, the deployment process instance is canceled. You cannot continue the deployment once the server is started again. In order to finish deploying, duplicate the instance and execute again.
Jenkins can also create deployment process instances if they are launched outside of the DROPS Studio.
For more information about deploying with Jenkins, refer to DROPS for Jenkins.
Follow the subsequent steps to search for deployment process instances in the instances view.
Step 1 Select Deployment Process Instances from the Deployment Process node in the Console Explorer.
Step 2 When the search view is opened, the list of instances is empty. Use the search criteria sections to filter the search.
- To search for an existing instance by the deployment process it uses to deploy, expand the Deployment Process section.
Click the corresponding browse button to select the associated client, environment and/or deployment process.
Important!If the Not completed checkbox is ticked [default], only deployment instances that are not completed or not canceled are displayed in the search results.
Important!If the Not linked to a plan checkbox is ticked [default], only deployment instances created manually are displayed in the search results.
- To search for an existing instance by the release it deploys, expand the Release section. Click the corresponding browse button to select the associated application and/or release.
- To search for an existing instance by the description of either its environment or release, expand the Description section then enter part of the corresponding description.
- To search for an existing instance by its deployment or release status, expand the Deployment Status section then select a predefined status.
-
To search for an existing instance by the deployment instance tag it belongs to, expand the Deployment Tag section then select the tag from the drop-down list.
ReferenceFor more information about tags, refer to Managing deployment tags
- To search for an existing instance by the date it was or should be executed, expand the Deployment Execution Date section. Tick the Start and/or End Date, then select the range using the calendar.
- To search for an existing instance by the date it finished, expand the Completion Date section. Tick the Start and/or End Date, then select the range using the calendar.
- To search for an existing instance by its scheduled deployment date, expand the Schedule Date section. Tick the Start and/or End Date, then select the range using the calendar.
Enter any combination of the above search criteria, then click the Search button to display the results. 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 auto search icon.
Result The Deployment Process Instances search view displays all of the finished and scheduled instances that meet the search criteria.
The Application column displays the name of the application deployed as well as one of the following icons which describes the mode in which the instance is set to deploy.
Full-transfer | Defining an instance's deployment mode |
Transfer-only | |
Installation-only | |
Rolled back | Rolling back a deployed deployment process instance |
Re-execute | Re-executing failed deployments |
The Release 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 and change while the instance is being processed.
The Scheduling Info. column displays the date and time the instance is scheduled to deploy, if configured.
If an installation-only instance has been auto-scheduled, the label will be in one of the following formats:
- *AUTO [+<delay_value>] if no fixed time has been chosen
- *AUTO [+<delay_value>] [<hour>:<minute>] if a fixed time has been chosen
There are multiple ways to create deployment process instances in the instances view:
- Create a deployment process instance using the Create a new deployment process instance wizard.
- Create one instance to use to deploy a set of releases to the same environment using the Create a new deployment process instance for a Release Set wizard.
- Create multiple instances to deploy one release to a set of environments using the Create a new deployment process instance from environment group wizard.
- 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 be modified.
By default, new instances are always marked to be deployed in full-transfer mode, however they are not executed automatically and must be executed manually or scheduled to execute automatically.
For more information about changing the mode in which to deploy an instance, refer toDefining an instance's deployment mode.
For more information about executing instances, refer toExecuting deployment process instances manually.
A single deployment process instance allows you to deploy one release to a single environment.
Creating a new single instance enables you to duplicate it later.
Follow the subsequent steps to create a new deployment process instance in the instances view.
Be careful selecting the properties of a deployment instance! Most of them cannot be changed once the instance is created.
Step 1 To open the Create a new deployment process instance wizard, either click the create icon in the Deployment Process Instances search view or right-click anywhere in the view and select Create a new deployment process instance.
Step 2 Define the instance by clicking the browse button for each of the following entities.
- If multiple clients are available, select the client to which to deploy the release. Changing the client alters the options available throughout the wizard. Only the entities available for the selected client will be accessible.
- Select the environment to which to deploy the release. The list is prepopulated with the environments available for the selected client. Changing the environment alters the options available throughout the wizard. Only the entities available for the selected environment will be accessible.
- Select the deployment process to use. The list is prepopulated with the processes available for the selected environment.
- Select the Release to deploy. The list is prepopulated with the releases available for the selected client.
-
Modify the template for the Transaction ID, if required.
The ID's syntax follows the template managed in the Preferences menu.
ReferenceFor more information about the default Transaction ID template, refer to Defining deployment process instance parameters.
Click Next > to continue.
Step 3 If required, or useful, select an existing deployment tag to regroup the instance with other similar instances.
Tags can be managed here or in the Preferences menu.
Deleting tags removes them from all of the instances to which they were linked.
For more information about deployment tags, refer to Managing deployment tags.
Step 4 To associate the instance with a workitem, select the provider then the pre-defined workitem.
For more information about JIRA issues and workitems in DROPS, refer to Workitems.
Click Finish.
Result The new deployment process instance is available in the Deployment Process Instances search view.
This option creates a single deployment process instance that includes multiple releases to be deployed to a single environment.
During the deployment, the release set is processed just like a CUMULATIVE deployment: DROPS will first go 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 the most recent version of an artifact, if the same artifact is included in multiple releases. The release with the most recent version of the artifact will include it during deployment 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.
Be careful selecting the properties of a deployment instance! Most of them cannot be changed once the instance is created.
Step 1 To open the Create a new deployment process instance for a release set wizard, either click the 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 the main properties of all the instances by clicking the browse button for each of the following entities.
- If multiple clients are available, select the client to which to deploy the releases. Changing the client alters the options available throughout the wizard. Only the entities available for the selected client will be accessible.
- Select the environment to which to deploy the releases. The list is prepopulated with the environments available for the selected client. Changing the environment alters the options available throughout the wizard. Only the entities available for the selected environment will be accessible.
- Select the deployment process to use. The list is prepopulated with the processes available for the selected environment.
-
Modify the template for the Transaction ID, if required.
The ID's syntax follows the template managed in the Preferences menu.
ReferenceFor more information about the default Transaction ID template, refer to Defining deployment process instance parameters.
Click Next > to continue.
Step 3 Ctrl+click
to select multiple releases to deploy. The list is prepopulated with the releases available for the selected client.
Click Next > to continue.
Step 4 If required, or useful, select an existing deployment tag to regroup the instance with other similar instances.
Tags can be managed here or in the Preferences menu.
Deleting tags removes them from all of the instances to which they were linked.
For more information about deployment tags, refer to Managing deployment tags.
Step 5 To associate the instance with a workitem, select the provider then the pre-defined workitem.
For more information about JIRA issues and workitems in DROPS, refer to Workitems.
Click Finish.
Result The new deployment process instance is available in the Deployment Process Instances search view. Instances created for release sets are indicated by a plus sign in the Release column indicating that more than one release is to be included in the deployment.
Contrary to the release set option above, this option creates multiple individual deployment process instances that each deploy the same release to multiple environments that are defined in an environment group.
Follow the subsequent steps to create multiple instances using an environment group.
Be careful selecting the properties of a deployment instance! Most of them cannot be changed once the instance is created.
Step 1 To open the Create a new deployment process instance from environment group wizard, 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 the main properties of all the instances by clicking the browse button for each of the following entities.
- If multiple clients are available, select the client to which to deploy the release. Changing the client alters the options available throughout the wizard. Only the entities available for the selected client will be accessible.
- Select the environment group that includes the environments to which to deploy the release. The list is prepopulated with the environment groups available for the selected client. Changing the environment group alters the options available throughout the wizard. Only the entities available for the selected group will be accessible.
-
Select the application to deploy. This list is prepopulated with all of the applications that the environments in the group share.
NoteThe deployment processes used to generate multiple instances are the process(es) that concern the selected application/release defined as default for the environment(s) in the environment group. If no default process is defined for the environment/application pair, the option to choose the deployment process to use is displayed.
The list of processes to select is prepopulated with the processes available for each environment/application pair in the Group.
- Select the Release to deploy. The list is prepopulated with the releases available for the selected client.
-
Modify the template for the Transaction ID, if required.
The ID's syntax follows the template managed in the Preferences menu.
ReferenceFor more information about the default Transaction ID template, refer to Defining deployment process instance parameters.
Click Next > to continue.
Step 3 To Generate transfer-only and installation-only instances, leave the corresponding checkbox ticked [default]. If the check box is not selected, full-transfer instances are created.
If both transfer- and installation-only instances are created, the installation-only instance can be automatically scheduled to deploy
Step 4 If required, or useful, select an existing deployment tag to regroup the instance with other similar instances.
Tags can be managed here or in the Preferences menu.
Deleting tags removes them from all of the instances to which they were linked.
For more information about deployment tags, refer to Managing deployment tags.
Click Finish.
Step 5 If no default deployment process is defined for an environment included in the environment group selected, the Process Selection dialog is displayed. Select the deployment process to use to deploy the selected release. The list is prepopulated with the deployment processes available for the selected environment/application pair(s).
For more information about default processes, refer toDefining default deployment processes.
Step 6 To associate the instance with a workitem, select the provider then the pre-defined workitem.
For more information about JIRA issues and workitems in DROPS, refer to Workitems.
Result The new deployment process instances are available in the Deployment Process Instances search view.
Duplicating an instance is a quick way to create an identical instance, with the same tags, that can later be scheduled differently or to which you can add different attachments.
To duplicate an existing deployment process instance, select it then either click the duplicate icon, or right-click on it and select Duplicate a deployment process instance. The duplicated instance is automatically available in the Deployment process Instances search view and has its own Transaction ID.
Duplicating a transfer-only or an installation-only instance creates a full-transfer instance.
Scheduling future deployments is often very important but the exact release to deploy at a scheduled time isn't always defined until shortly before the deployment is to be executed. Defining an arbitrary release in order to schedule a deployment instance, then changing the release before deployment can be helpful to schedule multiple future releases well in advance.
Changing the release that a deployment instance deploys is only possible if 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 also carried 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 process Instances search view then either click the change release icon, or right-click on it and select Change release.
Step 2 Select the new release to deploy then click OK or double-click it.
Result The Release column in the Deployment Process Instances search view is updated with the new release to deploy.
Deployment tags are intended to regroup similar deployment process instances and search for these instances by their tag. If an instance is duplicated, its tag(s) are carried over to the new instance, too.
Tags may be required for every deployment instance, or optional. If they are required, deployment process instances must be tagged when they are created. If they are optional, instances can be tagged when they are created or afterwords.
Tags can always be removed after an instance is created.
The Deployment Tags dialog is used to tag one or more instances and manage the tags themselves after instances are created. Tags can be edited at any time. To access the Deployment Tags dialog, select one or more deployment process instance(s) in the search view then either click the deployment tags icon or right-click then select Manage Deployment Tags.
To tag the selected instance(s), select the tag(s) from the list and click OK. When an instance is tagged, that tag is highlighted.
To remove a tag from the selected instance(s), unselect the highlighted tag(s) [Ctrl+click
], then click OK.
Tags can be managed in the Preference menu and in each tag selection dialog when working with deployment process instances.
For more information about managing tags from the Preferences menu refer to Defining deployment tags.
For more information about making tags required, refer to Deployment instance settings.
To create a new tag click the Create button. Enter the name of the new tag then click OK.
To edit the name of an existing tag, double-click on it or select it then click the Edit button. Modify the name of the tag, then click OK.
To delete an existing tag, select it then click the Delete button.
Deleted deployment tags cannot be accessed or recovered.
Deleting a tag does not delete any of the instances that may be linked to it. The link between the tag and the instance is broken but the instance’s content is not modified.
Deployment instances can be carried out in one of three modes: full-transfer, transfer-only or installation-only mode. If an instance has not been executed, you can change the mode to deploy it in at any time.
Deployment process instances that are marked to be deployed in full-transfer mode deploy all of the stages included in the deployment process diagram.
By default, all new deployment process instances are set to deploy in full-transfer mode.
If a transfer-only instance already has an installation-only child instance, the child instance is not deleted. It is recommended to delete the child instance so that the installation does not run twice.
To mark a transfer-only or installation-only deployment process instance to run in full-transfer mode, either right-click on the instance in the Deployment process Instances search view then select Mark as full-transfer or select it, then click the full-transfer icon.
Result The instance's icon changes to in the Application column.
For more information about the different Stages of the deployment process, refer to Manage deployment process stages.
For more information about executing a full-transfer deployment, refer to Executing deployment process instances manually or Scheduling deployment process instances.
Deployment process instances that are marked to be deployed in transfer-only mode stop deploying after the receiving stage is complete. If an installation stage is included in the deployment process it is not carried out.
To mark a deployment process instance to run in transfer-only mode, either right-click on the instance in the Deployment process Instances search view then select Mark as transfer-only or select it, then click the transfer-only icon.
Result The instance's icon changes to in the Application column.
For more information about the different Stages of the deployment process, refer to Manage deployment process stages.
For more information about executing a transfer-only deployment, refer to Executing deployment process instances manually or Scheduling deployment process 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 parent and has the exact same Transaction ID.
If the first stages in a deployment process have already been carried out in transfer-only mode and any actions required for the transferred artifacts are complete, the deployment is ready to be finalized manually which can only be done by creating an installation-only instance.
For more information about the different Stages of the deployment process, refer to Manage deployment process stages.
There are two ways to manually create installation-only instances:
- To create and immediately execute an installation-only instance, refer to Executing deployment process instances manually.
- To create and schedule an installation-only instance to execute later, refer to Scheduling deployment process instances.
Deployment process instances can either be executed manually or scheduled to be executed automatically in the future. If an instance is scheduled, override the schedule by executing the instance manually.
To view what happens during the execution in real-time, open the deployment instance’s Results view and watch the deployment actions take place from the Console tab.
The Console tab is only available in Prepared instances or those which are currently In Progress. If an instance has finished executing the Console is no longer available but the log can be accessed in the Logs tab.
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 in the Deployment process Instances search view then either click the Execute icon or right-click then select Execute. The deployment begins right away and any scheduling information for the instance is overridden.
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 instance immediately 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 execute installation-only icon, or right-click then select Execute installation-only.
Step 3 Click OK in the dialog to confirm.
If the transfer-only stage of the deployment process has not been executed yet or was unsuccessful, a second dialog is displayed. You can either cancel the installation or proceed anyway and the actions in the deployment diagram's installation stage(s) will begin.
A transfer stage can "fail" when any action in the stage cannot be carried out. This means that the stage can "fail" after content is transferred by one action if the following action cannot be completed. If an action post-transfer fails, the transferred files can still be installed.
If your transfer stage includes an action to send an email after a transfer is complete and the email cannot be sent (the final Action fails) the whole transfer stage will have a failed status even though the transfer action completed successfully.
To define when an action should be considered as complete or failed, 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.
Deployment process instances can either be executed manually or scheduled to be executed by DROPS in the future.
All instances in any mode can be scheduled but they must have a Prepared status. Instances that have already been executed once cannot be scheduled to deploy again.
Full-transfer and transfer-only instances are not executed immediately when they are created. Any deployment process instance's schedule can be modified up until the moment it executes.
Follow the subsequent steps to schedule a deployment process instance to execute in the future from the Deployment 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 Change the scheduling information icon or right-click, then select Change the scheduling information.
Step 2 Tick the Scheduled checkbox to activate the schedule for the current instance.
Step 3 Select the Date, Hour and Minute that the instance should be executed.
Step 4 If the deployment should be carried out in transfer-only mode, tick the transfer-only checkbox. If this checkbox is not ticked, the deployment process instance will be carried out in full-transfer mode.
If a full-transfer instance is changed to a transfer-only, the transfer-only's child installation-only instance is automatically created and scheduled to deploy at the same time as its parent transfer-only instance.
If a transfer-only instance is changed to a full-transfer, the transfer-only's child installation-only instance is deleted.
Click OK.
Result The Scheduling Info column for the selected instance is filled in with the date and time of the scheduled execution.
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 instance from the Deployment process Instances search view.
Only transfer-only instances can be used to schedule installation-only instances.
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 the Date, Hour and Minute that the installation-only instance should be executed.
The Install Only checkbox is not available because the parent instance is transfer-only by default.
Click OK.
Result The installation-only instance is created and the installation stage of the deployment process diagram will begin at the time defined (displayed in the Scheduling Info column).
If an installation-only instance was automatically scheduled but needs to be modified, toggle between automatic schedule and manual schedule (or no schedule at all - N/A) to deactivate or modify it as needed.
If an installation-only instance has been auto-scheduled, the label will be in one of the following formats:
- *AUTO [+<delay_value>] if no fixed time has been chosen
- *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 schedule follow the steps inModify any instance's schedule. Changing the schedule from *AUTO to the schedule 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-click on an instance and either select Auto-Schedule (to apply the auto-schedule) or Remove Auto-Scheduling Mode (to remove any schedule).
The auto-schedule for installation-only instances can only be toggled on/off if the instance has a Prepared status and its transfer-only parent instance is not Completed.
Installation-only instances must always have a scheduled time to deploy. An installation-only instance with N/A in the Scheduling Info column will never execute. You cannot manually execute this kind of instance after it is created and if its schedule is toggled off.
Follow 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 the Date, Hour and Minute that the instance should be executed.
Click OK.
Result The Scheduling Info column for the selected instance is filled in with the date and time of the scheduled execution.
Remote deployments are similar to deployments done in a simple single server configuration. The only difference is that you select a node server to execute the deployment instead of the main server.
A remote execution is an import and deploy action of the server. When executing the remote deployment instance, the node server executes an import instance to provision the node server's artifact repository, and then execute the deployment instance.
To delegate the execution of the import and deployment activities to node servers, a specific right must be enabled for the user role in charge of deployment: Substitute another user when accessing web-services in the Server general administrative rights.
For more information about the main and node server configuration, refer to About main / node servers configuration.
Main and node servers can be synchronized automatically prior the execution of the deployment process instance.
To configure the automatic synchronization of the main and node servers before the execution of a deployment instance, refer to
The Deployment process Instances search view provides some details of processed deployment process instances. Access more information by either double-clicking on an instance in the list, selecting it then 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.
The Overview tab displays the uneditable general information about the instance. The End Date and Executed by fields are blank until the instance is executed.
All of the activities and stages included in the deployment process, along with their current Execution Status and Result, are displayed in the Deployment Steps tab.
If a deployment process instance is suspended, check this tab to see why. Often, the deployment is waiting for approval which means that a validation request is pending.
For more information about resolving suspended deployment instances, refer to Validation requests or Suspended actions.
If a file transfer fails, DROPS will retry the transfer a number of times. This number of attempts is defined in the server configuration (the default value is 3). If all attempts fail, the process is aborted and the Execution Result is set to Failed.
Before trying to re-transfer the file, DROPS will check if the remote agent is reachable. If not, it will retry to reconnect a number of times, this number of attempts 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.
For more information about defining the defaults mentioned above, refer to
All of the activity from the deployment is displayed in the Logs tab. Every action carried out during a deployment is logged.
To filter the records at the source and exclude specific entries that are unnecessary, create a regex and enter it in the ANT Message Filter field found in the Local Execution settings of the DROPS Server. If no regex is defined, all entries are logged in the deployment log. .
Filter results by Message Code, Message Text, Activity ID, Stage ID or Action ID. Enter any combination of search criteria then click the search icon to display the results. To display the complete log, click search without entering any criteria.
Filter the severity of the results displayed by selecting one or more of the Severity icons
- Fatal: only fatal errors are displayed.
- Warning: only Warnings errors are displayed.
- Info: only Important information is displayed.
- Verbose: only details are displayed.
Use the Show Previous and Next icons to quickly move through a long list of entries to find and jump to the fatal errors.
Click the export icon to open the selected log(s) in an external text editor. By default, the editor will open automatically.
Click the export to JSON file icon to open the selected log(s) in .json format. You will be prompted to select where to save the file.
If no log entries are displayed, the log may be archived. Logs can be automatically or manually archived to create space in the database. If no logs are available in this view, check the Attachments tab to access the archived .txt log file.
While only successfully deployed instance’s logs can be automatically archived, both successful and unsuccessful deployment logs can be manually archived. To manually archive a deployment process instance’s log, search for it in the Deployment process Instances search view. Either right-click on it then select Archive Log or select it, then click the archive log icon. When archived, logs are removed from the database which liberates space.
For more information about activating the auto-archive option for deployment logs and how to define the location to store archived logs, refer to
Execution instances’ logs are stored in separate databases so they do not share a common base. 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 and record the results.
The steps carried out during deployment are displayed on the left in the new logs, just as they are in the Deployment Steps tab. Each step’s individual result (failed or successful) are displayed in order to quickly address the step that may be causing problems in your deployment. To view the log information for any part 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.
To 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, click on the step to filter the log as much as required to find the exact action in the process that failed.
In the example below, the deployment to the Apache infrastructure item failed in general but we can see that only one stage in that item’s process failed. Furthermore we can see that only one action in the installation stage failed but not all of them. If we click on the action that failed, we can see its unique log and quickly find the problem.
For more information about changing the syntax displayed for each line in the log, refer to Defining import & deployment log formats.
Attachments 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 as a .txt file.
View any attachments published during the deployment action in the attachments tab.
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.
If, for any reason, a deployment failed this option allows you to resume where it left off after fixing the issue(s) that caused the failure. All of the actions performed correctly before the failure was encountered are still valid and will not be affected by re-executing the deployment. Any transfers already made will not be made again since the process only restarts from the first action after the failure. A process can fail, be corrected and resumed as many time as needed to correct all the issues it may encounter. A log is created each time a deployment is resumed.
Follow the subsequent steps to re-execute a failed deployment.
Step 1 Select the failed instance to re-execute in the Deployment process Instances search view then either click the Re-execute icon or right-click, then select Re-execute.
Step 2 Click OK in the dialog to confirm that the instance should be re-executed.
Result All of the stages and actions in the deployment process not yet executed by the instance are launched.
Any deployment process instance can be rolled back in order to reinstate the previously deployed content that the current deployment overrode. Rollback for deployment process instances can either be executed manually or scheduled to be executed automatically in the future.
Follow the subsequent steps to create and execute a rollback instance immediately from the Deployment process Instances search view.
Step 1 Select the instance to roll back in the Deployment process Instances search view then either click the Rollback icon or right-click, then select Rollback.
Step 2 Click OK in the dialog to confirm that the instance should be rolled back.
Step 3 Click No 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 in reverse order and the new rollback instance is available in the Deployment process Instances search view.
Follow the subsequent steps to schedule a rollback instance from the Deployment process Instances search view.
Step 1 Select the instance to roll back in the Deployment process Instances search view then either click the rollback icon or right-click, then select Rollback.
Step 2 Click OK 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 the Date, Hour and Minute when the rollback should be executed.
If the instance to roll back is already Completed, the scheduled date/time to roll back must be after the source's Completion Date.
If the instance to roll back is scheduled, the scheduled date/time to roll back must be after the source's Scheduled Date.
If the instance to roll back is not completed and not scheduled, the date/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 the scheduler are carried over to the Deployment process Instances search view.
Canceled deployment process instances cannot be restarted.
To cancel a deployment process instance search for it in the Deployment process Instances search view. Either right-click on it, then select Cancel Execution or select it, then click the cancel icon. Click OK to confirm or click Cancel to keep the instance.
Instances that are In Progress cannot be deleted. To delete an instance that is stuck in progress, cancel it first, then delete it.
Deleted deployment process instances cannot be accessed or recovered. Deleting an instance removes the trace of the deployment.
To delete a deployment process instance search for it in the Deployment process Instances search view. Either right-click on it, then select Delete or select it, then click the delete icon. Click OK to confirm or click Cancel to keep the instance.