Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Deploy application

Updated on December 13, 2021

Reads an application or test artifact from a repository and deploys the application on an environment. This task is available for deployment, update, and business change pipelines.

The Deploy application task performs the following actions:

  • Exports the artifact from a repository.
  • Creates an application restore point.
  • Deploys dependent, test, and application artifacts.

Types and sources of artifacts

The Deploy application task can deploy three types of artifacts:

  • Application artifact: Created from the product rule for a defined application on a deployment pipeline.
  • Test artifact: Created from the product rule defined for a test application on a deployment pipeline.
  • Dependent artifact: Extracted from a specified deployment in a deployment pipeline. The configuration is added to the Dependencies section under Application details.

A test artifact is deployed only when you select the Deploy test artifact check box on the Deploy application task in a stage. For more information on deploying a test artifact on the required stage, seeconfigure test cases on a pipeline.

Source repository

You configure a pipeline with a development and production repository. The Deploy application task exports the application artifact from a development repository. This task is required to export a production-ready or ready-to-ship artifact, and you must configure it to read the artifact from the production repository.

To configure the Deploy application task to read an application artifact from a production repository, you click the Deploy production ready artifacts? check box on the task. You also configure the production environment to use production-ready artifacts.

Deployment exceptions

The Deploy application task can generate a warning or request user input. When the task requests user input, the course of the task depends on the user's action.

The Deploy application task manages the following scenarios:

  • When an artifact has draft flows, the Deploy application task generates a warning after the pipeline deployment. The deployments with draft flows fail in a production environment.
  • When a deployment encounters an aged update, you decide whether the aged update is skipped, overwritten, or handled manually.
  • If an artifact has schema changes, you can deploy the schema changes manually.


In Pega Platform version 8.4 and later, the Deploy application task creates an application restore point. The application restore point can be accessed through the Deploy application task’s output parameter Restore point.

You can perform a rollback on any deployment that encounters an error or fails. A rollback uses restore points, which the system automatically generates when there is an import. Any change you make after the import but before the system creates the next restore point will be lost when the rollback action is triggered.

For more information about rolling back a deployment, see Rolling back a deployment.


Input parameters

Input parameters

Deploy test artifact?
Select to deploy the test application configured in the pipeline
Deploy production ready artifacts?
Select to deploy the production ready artifacts
Default action on aged update?
Sets the default method for handling aged updates. If 'override' is specified, any aged update reported during deployment refreshes with the rules in artifact. If 'skip' is specified, the aged updates are not refreshed with the rules in artifact. Blank or any other value defaults to a manual interaction if a deployment encounters aged updates.

Output parameters

Output parameters

Restore point
Restore point created as part of the deploy task
Application Records Moved Count
Records moved for the application
Application New Instances
New instances deployed for the application
Application Updated Instances
List of instances updated part of deploy task
Application Draft Flows
List of draft flows in the RAP
Test Application Records Moved Count
Records moved for the test application
Test Application New Instances
New instances deployed for the test application
Test Application Updated Instances
List of instances updated part of deploy task
Application aged updates
Returns a list of aged updates identified during the deployment on a target candidate system

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us