Skip to main content

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


Updated on December 3, 2021

Are schema changes supported through a pipeline?

Deployment Manager relies on the platform import and export capabilities to deploy applications and can handle schema management through the same process. Our recommendation is to let the platform import process, and by extension Deployment Manager, handle schema management (example introducing new classes/tables, column population for exposed properties). Pega only generates and applies additive schema and does not do any type of destructive schema, so it is safe to stick with this process. For more information on configuring Deployment Manager to manage schema, please follow the instructions on Configuring settings to automatically apply schema changes.

How do rollback features work and when should I use them?

Rollback in Deployment Manager relies on the restore points feature in Pega Platform. The rollback option is presented to the user only when a step errors out in a deployment. A restore point is automatically generated every time an import happens, only if a deploy task is present in a stage.

Any application changes that happen after the import and before the next restore point rolls back when you trigger the rollback action. Consider this as an alternative to database level restore and rollback for every import,

  • For Pega Platform versions 8.3 and earlier the rollback execution impacts the entire system and is not scoped to the application.
  • For Pega Platform 8.4 and later with PegaDevOpsFoundation 4.8 and later, this is an application-level rollback with no impact to other applications.

How do I rollback a successful deployment?

The rollback deployment feature is currently only available for deployment tasks that have failed in some way. When a task fails, the deployment pipelines pauses and an authorized user is able to skip the task, retry the task, abort the task, or rollback the current deployment.

If you want the rollback option to be available when a deployment is successful, perform the following:
  1. Insert a manual step as the final task in the stage where you want to have the rollback ability. For more information, see Perform manual step.
  2. Assign the manual task to the authorized user to approve or reject the deployment.
  3. Reject the deployment via email or directly in Deployment Manager.
  4. This presents you with the options to abort or rollback the deployment.
Result: You can now successfully rollback the deployment.

What can I do with the Deployment Manager REST API?

Deployment Manager provides a REST API to help automate the actions you perform in the Deployment Manager studio.

Deployment Manager 5.x and later provides API documentation in the download archive from Pega Marketplace. You can view the Documentation/ file for more information on using the API.

Tip: When creating pipelines using the POST /pipelines endpoint, it is helpful to copy an existing pipeline from the GET /pipelines/{id} endpoint and make any necessary changes to the response JSON.

  • Previous topic Why is the migration of selected pipelines in Deployment Manager 5 not working?
  • Next topic How to articles

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