Deployments View

Overview

This page covers all the features in the Deployments View of Appian Designer.

The deployments view contains two tabs that provide information about your environment’s incoming and outgoing deployment history. You can filter deployment history by application, status, type, or date. The deployments view is also available within applications.

By default, system administrators and users in the reviewer group can see all requests in the incoming and outgoing tabs. Application administrators, editors, and viewers will be able to see requests in both tabs for specific applications if they have the appropriate permissions.

Incoming and Outgoing Deployments

The Incoming tab displays all deployment requests that have come into your current environment. The Outgoing tab displays all the packages that have been deployed from your current environment to a different target environment.

Packages deployed using the following methods are included in this history:

Imports of Administration Console settings, such as environment branding, continue to be tracked in the Import History page of the Administration Console.

The following annontated image and descriptions define the features displayed in both the Incoming and Outgoing tabs in the deployments view.

A. Icon status of the deployment

Statuses for Direct Deployments:

  • Completed: The package has been deployed successfully.
  • Completed with Errors: The package has been deployed, but some objects had errors.
  • Failed: Objects in the package were not deployed because database scripts failed or did not fully execute.
  • In Progress: The package is currently being deployed.
  • Pending: The package has not been deployed yet and is waiting for review. This status will only appear when you enable approvals in the Administration Console.
  • Rejected: The package has been rejected by the reviewer. This status will only appear when you enable approvals in the Administration Console.
  • Unavailable: Information is not available because the target environment is on a different version of Appian.

Statuses for Manual Deployments:

  • Completed: The packaged was imported/exported successfully.
  • Completed with Errors: The package was imported/exported, but some objects had errors.
  • Failed: No objects in the package were imported/exported due to errors. Check your deployment log.
  • In Progress: The package is currently being imported/exported.

B. Name: The name of the deployment.

C. Type: The type of deployment (Direct or Manual).

D. Application: The name of the application(s) involved in the deployment.

E. Requested By/Submitted By: The user who sent the deployment.

F. Requested On/Submitted On: The date the package was deployed or sent for review.

G. Refresh: Click the refresh button to see the most up-to-date status.

Review Deployment Requests

If you want to approve deployments to higher environments before they’re applied, select the Require Review option in the Administration Console. This option requires an Appian developer to approve each incoming deployment request in the environment and it also allows you to set up a reviewer group. Appian recommends creating a reviewer group to ensure that the appropriate developers have permission to approve all incoming deployments (including new applications).

System administrators, application administrators, or the specified reviewer group can approve or reject incoming deployments. When a deployment is requested and approval is required, an email is sent to the application administrators and members of the reviewer group.

Application security and reviewer group membership determine who can see and review packages in the deployments view. The following table displays the available deployment activities and their permissions:

Activity System Administrators Reviewer Group Application Administrator Application Viewers and Editors
View deployment history Yes Yes Yes, for specific apps Yes, for specific apps
View deployment request details (object names, database scripts, import customization file) Yes Yes Yes, for specific apps No
Approve updates to existing applications Yes Yes Yes, for specific apps No
Approve deployment of a new application Yes Yes No No
Deploy existing packages Yes No Yes, for specific apps No

Developers with the appropriate permissions can view package details by clicking on the deployment name in the Incoming tab of the target environment. They can also inspect objects and leave comments about the package before approving or rejecting the deployment request.

The following image and descriptions define the features displayed when you click on a deployment name to view the deployment details. Some sections in the deployment details, such as DATABASE SCRIPTS or DECISION, may not appear if they do not apply to your package or environment.

A. Package Details: Lists the name, description, application(s), requested/submitted time, source or target environment, requester, deployment log link, and deployment status.

B. Objects: The list of objects in the package, and their status when comparing them to the current environment at the time of the deployment request. You can filter the list by object type and status.

C. Plug-ins: The list of plug-ins in the package. You can filter the list by status.

D. Database Scripts: The links to database scripts.

E. Import Customization File: Displays a link to the file or an option to upload a new file.

F. Inspection Results: Displays any missing precedents and warnings detected in the package from the most recent inspection. Inspection results are only available for direct deployments. The status will update if you click Inspect Again.

G. Decision: A reviewer can approve or reject a package in this section. After a decision has been confirmed, this section displays the review decision and comments. This section only appears when you enable approvals in the Administration Console.

Deploy Existing Packages

Once a package has been successfully deployed, you can reuse it for another environment. This is helpful for deploying packages to higher environments after testing your changes in a lower environment. The same set of changes will be applied to ensure that you are making consistent updates across all of your environments.

This option is available to system administrators and application administrators for any completed incoming deployments. The same objects and database scripts (in the same order) that were originally deployed will be used for the new deployment, but you can update the import customization file.

To reuse a package, click the deployment name and click Deploy To Another Environment. You will then be able to compare and deploy your package to another environment.

reuse deployment

Archived Deployments

Deployment packages are cleaned up periodically, which is configured from the Data Retention page in the Administration Console. Once a package is deleted, the corresponding deployment still appears in the history, but the deployment is archived and has limited functionality.

The details of archived direct deployments can be viewed by clicking on the deployment name. The objects list, package download, and inspection results are not available. Archived direct deployments also cannot be reviewed or deployed to another environment.

The details of archived manual deployments are not available.

Open in Github

On This Page

FEEDBACK