Table of Contents

Deployment Manager release notes

These release notes provide information about enhancements, known issues, issues related to updating from a previous release, and issues that were resolved in each release of Deployment Manager.

See the following topics for more information:

For questions or issues, send an email to DeploymentManagerSupport@pega.com.

Deployment Manager 4.5.1

See the following topics for more information:

Enhancements

The following enhancements are provided in this release:

  • Ability to add tasks before Deploy and Publish tasks

For additional validation or environment provisioning, you can now add any task before the Deploy and Publish tasks, which are automatically added to the pipeline. You can add tasks before the Deploy task in any stage of the pipeline or before the Publish task in the development stage.

  • Ability to associate bugs and user stories to branch merges

When you start a deployment by submitting a branch into the Merge Branches wizard, you can now associate user stories and bugs from Agile Workbench so that you can track branch merges.

  • New REST API to deploy existing artifacts

Deployment Manager now provides a REST API to deploy existing artifacts so that you can start a production pipeline with the output of the development pipeline for the same application. You can view the Documentation/readme-for-swagger.md file for more information on using the API.

  • Ability to access and pass all relevant parameters of the current deployment for Jenkins tasks

For Jenkins tasks, you can now access and pass all the relevant Jenkins parameters for the current deployment, which include PipelineName, DeploymentID, RespositoryName, and ArtifactPath. When you configure the Jenkins task in a pipeline, the values of the parameters are automatically populated.

  • More diagnostics to troubleshoot pipelines

You can now automatically diagnose more issues with your pipeline so that you spend less time manually troubleshooting. For example, you can now verify that Jenkins steps are properly configured, and you can also obtain more information about repository connections with enhanced troubleshooting tips.

  • Elimination of post-upgrade steps when upgrading from Deployment Manager versions 3.2.1 and later

For upgrades from Deployment Manager 3.2.1 or later to version 4.5.1, you no longer need to run activities or do any other post-upgrade steps. After the upgrade completes, Deployment Manager performs health checks before running post-upgrade steps for both on-premises and Pega Cloud Services environments.

Resolved issues

The following issue is resolved in Deployment Manager 4.5.1:

  • Unable to configure keystores in Pega Cloud Services environments

If your target environment is SSL-enabled with private certificates, you can now set the keystore for Deployment Manager connectors so that they can receive and process tokens. You first configure a keystore and then update a dynamic system setting to reference the keystore ID. For more information, see "Step 3a: Configuring authentication profiles on the orchestration server and candidate systems" for your version of Installing, upgrading, and configuring Deployment Manager.

Deployment Manager 4.4.2

See the following topics for more information:

Resolved issues

The following issues were resolved in this release:

  • Incorrect status displayed for the Run Pega unit test task

If you refreshed a merge request quickly, the status of the Run Pega unit tests task might have been incorrectly displayed as the status of the merge. The correct status for the task is now displayed.

  • Duplicate operator IDs displayed for the Manual task

When you assigned manual tasks to an operator ID, the Manual task auto-complete displayed duplicate entries for the same operator ID if the operator ID was added as an administrator or user for multiple applications. The Manual task no longer displays duplicate entries.

  • Pipeline deployments sometimes froze

Sometimes, a pipeline deployment might freeze if it could not update the task with the status that it received from the task. The pipeline no longer freezes.

  • No error messages displayed for issues with artifacts and repositories

The Deploy existing artifact dialog box now validates the repository that you select. Error messages are also displayed when the repository does not list available artifacts or if the repository does not have any artifacts in it. .

  • Verify security checklist task failed and displayed a Pega Diagnostic Cloud (PDC) error

The Verify security checklist failed when a pipeline had only one stage (development) and the Production ready check box was selected on the pipeline configuration. A PDC error message was displayed. The task no longer fails for pipelines with such a configuration.

  • 32 character token limit for Jenkins tasks

For the Jenkins task, you could only enter a 32 character token to remotely start a Jenkins job. You can now enter a token with more than 32 characters.

  • Dependent applications were not deployed

On pipelines on which dependent applications were configured, they were not deployed. They are now deployed correctly.

Deployment Manager 4.4.1

See the following topics for more information:

Enhancements

The following enhancements are provided in this release:

  • Simplified configuration and workflow when merging branches in a distributed branch-based environment

The process for merging branches in distributed branch-based environments has been simplified. On the remote development system, you can now merge branches and start a deployment by using the Merge Branches wizard to merge branches onto the main development system without having to use a Pega repository type.

  • Ability to submit locked branches to the Merge Branches wizard

You can now submit locked branches to the Merge Branches wizard so that you can follow best practices when working with branches. Best practices include locking branches to prevent changes from being made to them.

  • Using the Merge Branches wizard to make merge requests now stores the branch in the development repository

When you use the Merge Branches wizard to merge branches and start a deployment, the wizard now stores the branch in the development repository. Also, after the merge is completed, Deployment Manager deletes the branch from the development system. By storing branches in the development repository, Deployment Manager keeps a history, which you can view, of the branches in a centralized location.

  • Ability to create separate product rules for test cases

You can now separately manage both application changes and test cases in the same pipeline by using a separate product rule that contains only test cases. You can also choose a stage until which test cases are deployed to ensure that test cases are not deployed on environments such as staging and production, where they might not be needed. When you create test and production applications in Deployment Manager on your development system by using the New Application wizard, the wizard automatically creates separate product rules for your production and test applications.

  • API documentation now available

Documentation for Deployment Manager APIs is now included in the Documentation/readme-for-swagger.md file. This file is included in the DeploymentManager04_04_0x.zip file, which you can download from Pega Exchange. For example, you can quickly create pipelines without using the Deployment Manager interface.

  • Usability enhancements

Several enhancements to Deployment Manager features improve usability, including the following:

  • For the Check guardrail compliance task, the default guardrail compliance score has been increased to 97.
  • Email notifications for Jenkins jobs now include a link to the Jenkins job.
  • You can now start a Jenkins job when Jenkins has cross-site request forgery (CSRF) protection enabled.
  • For pipelines that have Jenkins tasks, job history details for successful deployments have a link to the Jenkins job.
  • The Pipeline list in the Merge Branches wizard no longer displays pipelines that are not configured to support branches; previously, you received an error after submitting pipelines that did not support branches.
  • If you are using the Merge Branches Wizard but do not have pipelines configured for an application, you can use still use the wizard to merge branches into target applications.

Known issues

The following are known issues in this release:

  • The Pega Platform™ 8.1 and 8.2 versions of the Rule rebasing and Rebasing rules to obtain latest versions help topics should state that rule rebasing is supported in Deployment Manager.
  • The Publishing a branch to a repository help topic should state that you can use Deployment Manager to start a deployment by publishing a branch to the main development system even if you have multiple pipelines per application version. Also, the note in this help topic no longer applies.

Deployment Manager 4.3.2

See the following topics for more information:

Resolved issues

The following issue has been resolved:

  • Pipelines not visible on the Deployment Manager landing page

On systems running Pega CRM applications, pipelines were not visible on the Deployment Manager landing page when the datapage/newgenpages dynamic system setting was set to false. This setting disabled the new clipboard implementation for optimized read-only data pages. Pipelines are now visible regardless of the dynamic system setting value.

Deployment Manager 4.3.1

See the following topics for more information:

Enhancements

The following enhancements are provided in this release:

  • Ability to configure notifications in Deployment Manager

You can now configure notifications in Deployment Manager without having to configure an email account and listener in Dev Studio. You can also choose which notifications to receive such as whether Pega unit test tasks succeeded or failed. You can receive notifications through email, in the notification gadget, or both, and you can create custom notification channels to receive notifications through other means such as text messages or mobile push notifications.

To use notifications, you must install or upgrade to Pega Platform™ 8.1.3 on the orchestration server.
  • Publishing application changes has been consolidated with viewing application versions in App Studio

You can now publish application changes in App Studio and view information about your Deployment Manager application versions on one page. By accessing publishing features and viewing information in one place, you can more intuitively use Deployment Manager with App Studio.

Deployment Manager 4.2.1

See the following topics for more information:

Enhancements

The following enhancements are provided in this release:

  • Ability to add and manage roles, privileges, and users

Deployment Manager now provides default roles that specify privileges for super administrators and application administrators. Super administrators can add roles and specify their privileges, and both super administrators and application administrators can add users and assign them roles for specified applications. By specifying roles and privileges for Deployment Manager users, you can manage your users more effectively by controlling access to features for each type of user.

  • New Deployment Manager portal

Deployment Manager now provides a dedicated Deployment Manager portal that does not require access to the Dev Studio portal to access Deployment Manager features. The portal also provides enhancements such as a navigation panel from which you can easily access features such as reports, without having to open specific pipelines. Additionally, when you add a pipeline or modify pipeline settings, you can now open the rule forms for repositories and authentication profiles in Dev Studio from within Deployment Manager.

  • Ability to merge branches that span multiple application layers

You can now merge a branch that has rulesets that are in multiple applications if all the rulesets are in the application stack for the pipeline application. By doing so, you can, for example, merge changes that affect both a framework and an application layer. You can also merge test assets with the rules that you are testing without the test assets and rules being in the same application.

Deployment Manager 4.1.1

See the following topics for more information:

Enhancements

The following enhancements are provided in this release:

  • Redesigned, more intuitive landing page and user interface

Deployment Manager has been redesigned to have a more intuitive interface so that you can quickly access features as you interact with your pipeline. The Deployment Manager landing page now displays a snapshot of your pipeline configuration, which provides status information such as whether a deployment failed and on what stage the failure occurred. Additionally, when you click a pipeline to open it, Deployment Manager now displays important information about your pipeline such as the number of branches that are queued for merging on the development system.

  • Manage aged updates

You can now manage rules and data types, which are in an application package, that are older than the instances that are on a system. By importing aged updates, skipping the import, or manually deploying application packages on a system, you have more flexibility in determining the application contents that you want to deploy.

  • New testing tasks, which include running Pega scenario tests

Several new test tasks have been added so that you deliver higher quality software by ensuring that your application meets the test criteria that you specify.

On the candidate systems in your pipeline, you can now perform the following actions:

  • Run Pega scenario tests, which are end-to-end, UI-based tests that you create within Pega Platform.
  • Start and stop test coverage at the application level to generate a report that identifies the executable rules in your application that are covered or not covered by tests.
  • Refresh the Application Quality dashboard with the latest information so that you can see the health of your application and identify areas that need improvement before you deploy your application.
  • Enhancements to publishing application changes to a pipeline in App Studio

You can submit application changes to a pipeline in App Studio to start a deployment in Deployment Manager. The following enhancements have been made:

  • When you submit application changes into a pipeline, patch versions of the main application are now created.
  • You can now add comments, which will be published with your application.
  • You can now associate user stories and bugs with an application.
  • You can now view information such as who published the application and when for the application versions that you have submitted
  • Run Pega unit tests on branches before merging

You can now run Pega unit tests on branches before they are merged in the pipeline for either the pipeline application or an application that is associated with an access group. By validating your data against Pega unit tests, you can deploy higher quality applications.

Deployment Manager 03.04.01

See the following topics for more information:

Enhancements

The following enhancements are provided in this release:

  • Manage aged updates

You can now manage rules and data types, which are in an application package, that are older than the instances that are on a system. By importing aged updates, skipping the import, or manually deploying application packages on a system, you have more flexibility in determining the application contents that you want to deploy.

  • Ability to merge branches that span multiple application layers

You can now merge a branch that has rulesets that are in multiple applications if all the rulesets are in the application stack for the pipeline application. By doing so, you can, for example, merge changes that affect both a framework and an application layer. You can also merge test assets with the rules that you are testing without the test assets and rules being in the same application.

Deployment Manager 3.3.1

See the following topics for more information:

Enhancements

The following enhancements are provided in this release:

  • New Verify security checklist task

You can now use the Verify security checklist task to ensure that your pipeline complies with security best practices. It is automatically added to the stage before production when you create a pipeline.

  • Ability to diagnose pipelines

You can now diagnose your pipeline to verify information such as whether the target application and product rule are on the development environment, connectivity between systems and repositories is working, and premerge settings are correctly configured. You can also view troubleshooting tips and download logs.

Known issues

The following known issue exists in this release:

  • Rollback does not work for Pega CRM applications

If you are using a CRM application, you cannot roll back a deployment to a previous deployment.

Deployment Manager 3.2.1

See the following topics for more information:

Enhancements

The following enhancements are provided in this release:

  • Simplified pipeline setup

Pipeline setup has been simplified when you install Deployment Manager and when you configure pipelines. The following enhancements have been made:

  • Deployment Manager now provides the Pega Deployment Manager application with default operators and authentication profiles when you install it. You do not need to create authentication profiles for communication between candidate systems and the orchestration server.
  • If you are using Pega Cloud, Deployment Manager is automatically populated with the URLs of all the systems in your pipeline so that you do not need to configure them.
  • New Check guardrail compliance task.

You can now use the Check guardrail compliance task to ensure that the deployment does not proceed if the application does not comply with best practices for building applications in Pega Platform. This task is automatically added to all the stages in your pipeline.

  • New Approve for production task

Deployment Manager now provides an Approve for production task, which is automatically added to the stage before production when you create a pipeline. You can assign this task to a user who approves the application changes before the changes are deployed to production.

  • Ability to specify the test suite ID and access group for Pega unit testing tasks

For Pega unit testing tasks, you can now run all the Pega unit tests that are defined in a test suite for the application pipeline. By using a test suite ID, you can run a subset of Pega unit tests instead of all Pega unit tests for a pipeline application. You can also run all the Pega unit tests for an application that is associated with an access group so that you can run Pega unit tests for an application other than the pipeline application.

  • Deployment Manager now supports first time deployments

Deployment Manager now supports first-time deployments, so you do not have to import your application into each Pega Platform server on your candidate systems the first time that you configure Deployment Manager.

Deployment Manager 3.1.1

See the following topics for more information:

Enhancements

The following enhancements are provided in this release:

  • Ability to create custom repository types

You can now create custom repository types and manage your artifacts with them when you use Deployment Manager. For example, you can create a Nexus repository type and use it to move your application package between candidate systems in a pipeline. By creating custom repository types, you can use a wider variety of repository types with your artifacts to extend the functionality of Deployment Manager.

  • Use the Merge Branches wizard to submit branches into a continuous integration and delivery pipeline.

You can now submit branches into a continuous integration and delivery (CI/CD) pipeline by using the Merge Branches wizard in Designer Studio. Deployment Manager can then run premerge criteria on branches on one system so that you do not need to configure additional systems for both branch development and merging.

  • Support for Pega Cloud.

Beginning with Pega 7.4, all current and new Pega Cloud customers have a free dedicated sandbox to run Deployment Manager, which provides the following features:

  • Default repositories that store and move your application package between systems in the pipeline.
  • Ability to view, download, and remove application packages from repositories so that you can manage your cloud storage space.
  • Ability to deploy an existing application package.
  • Ability to create multiple pipelines for one version of an application.
  • Ability to create multiple pipelines for one version of an application. For example, you can create a pipeline with only a production stage if you want to deploy a build to production separately from the rest of the pipeline.
  • Ability to manage application package artifacts.

You can now browse, download, and delete application package artifacts from the orchestration server. You do not have to log in to repositories to delete artifacts from them.

  • Ability to move existing artifacts through pipelines.

You can move existing artifacts through your pipelines. Existing artifacts are maintained in repositories, and you can move them through progressive stages in the pipeline.

Deployment Manager 2.1.4

See the following topics for more information:

Issues addressed in this release

The following issues were addressed in this release:

  • Publishing application packages to the production repository sometimes fails in multinode environments

In multinode staging environments, a node retrieves an application package from the development repository and places it into its service export folder to be published to the production repository. However, Deployment Manager sometimes cannot publish it to the production repository, because the request might be sent to a different node. This issue has been fixed so that if Deployment Manager sends a request to a node that does not have the application package, that node retrieves the package from the development repository and publishes it to the production repository.

Deployment Manager 2.1.3

Enhancements

The following enhancement is provided in this release:

  • Improved structure and content of email notifications.

Improvements have been made to email notifications that are sent to users when an event has occurred. For example, the email that is sent when a step on which PegaUnit test task fails now includes an attached log file that provides details of each failed PegaUnit test case.

Deployment Manager 2.1.2

Known issues

The following issue exists in this release:

  • The PegaDevOps-ReleaseManager agent points to the wrong access group.

    Because this agent is not associated with the correct access group, it cannot process Deployment Manager activities in the background.

    To resolve the issue, after you import and install Deployment Manager 02.01.02, perform the following steps on the orchestration server:

    1. Update your Pega Platform application so that it is built on PegaDeploymentManager 02.01.02:
      1. In the Designer Studio header, click the name of your application, and then click Definition.
      2. In the Built on application section, in the Version field, press the Down Arrow key and select 02.01.02.
      3. Click Save.
    2. Update the agent schedule for the Pega-DevOps-ReleaseManager agent to use the PegaDeploymentManager:Administrators access group.
      1. In Designer Studio, click Records > SysAdmin > Agent Schedule.
      2. Click the Pega-DevOps-ReleaseManager agent.
      3. Click Security.
      4. In the Access Group field, press the Down Arrow key and select PegaDeploymentManager:Administrators.
      5. Click Save.

Deployment Manager 1.1.3

Enhancements

The following enhancement is provided in this release:

  • Improved structure and content of email notifications.

Improvements have been made to email notifications that are sent to users when an event has occurred. For example, the email that is sent when a step on which PegaUnit test task fails now includes an attached log file that provides details of each failed PegaUnit test case.

Deployment Manager 1.1.2

See the following topics for more information:

Known issues

The following issue exists in this release:

  • The PegaDevOps-ReleaseManager agent points to the wrong access group.

    Because this agent is not associated with the correct access group, it cannot process Deployment Manager activities in the background.

    To resolve the issue, after you import and install Deployment Manager 01.01.02, perform the following steps on the orchestration server:

    1. Update your Pega Platform application so that it is built on PegaDeploymentManager 01.01.02:
      1. In the Designer Studio header, click the name of your application, and then click Definition.
      2. In the Built on application section, in the Version field, press the Down Arrow key and select 01.01.02.
      3. Click Save.
    2. Update the agent schedule for the Pega-DevOps-ReleaseManager agent to use the PegaDeploymentManager:Administrators access group.
      1. In Designer Studio, click Records > SysAdmin > Agent Schedule.
      2. Click the Pega-DevOps-ReleaseManager agent.
      3. Click Security.
      4. In the Access Group field, press the Down Arrow key and select PegaDeploymentManager:Administrators.
      5. Click Save.

Resolved issues

The following issue was resolved in this release:

  • Selections that were made to the Start build on merge check box were not applied when editing a pipeline.

    When you edit a pipeline and either select or clear the Start build on merge check box, your changes are now applied. Additionally, the check box is cleared by default.

Have a question? Get answers now.

Visit the Pega Support Community to ask questions, engage in discussions, and help others.