Task catalog
Deployment Manager supports a range of tasks to support the different application deployment scenarios for Pega powered applications. Tasks relevant to a use case are structured by environment templates and pipeline templates.
See below for the two different task structures:
- Environment template: When the environment template on a stage is configured to anything other than custom, recommended tasks are populated for the environment template. A list of available tasks for the stage provides all tasks that can be added as necessary. When the environment template for a stage is custom, no recommendation or restriction applies to a stage. Users can choose any tasks from the tasks available in the system.
- Pipeline template: Pipeline templates drive the range of tasks available though the
environment type. Adding a task to a stage requires you to decide the step on which
you want to add a stage and then follow the following steps:
- In the navigation pane of Deployment Manager, click Pipelines and then click the name of the pipeline.
- Select the pipeline name. Click .
- On the pipeline model screen, identify the position where you need to add the task.
- Click the more icon on the task and click Add task below.
- From the task menu, select the task and click Select.
- Update the required task details.
- Click Save.
- Check application compliance
Validate that your application has test rulesets, branches, and referenced rules that are missing. The checks can be enabled as required, however it is recommended to enable all the three validations.
- Generate artifact
Exports the artifact as defined in the product rule and publishes to the development repository.
- Deploy application
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.
- Check guardrail compliance
This task returns an error if guardrail compliance for this application is less than the compliance score. As a best practice, Pega recommends a compliance score of 90 for highly performing applications.
- Check branch guardrail
This task returns an error if guardrail compliance for the branch associated with the deployment is less than the compliance score. As a best practice, Pega recommends a compliance score of 90 for highly performing applications.
- Verify security checklist
Use the Verify security checklist task to ensure you complete the tasks in the Security Checklist before the system triggers a pipeline. The Security Checklist is the key feature of Pega Platform that provides Pega's leading practices for securely deploying applications and assists clients in hardening their applications and systems.
- Publish to production
Promotes the application artifacts to production repository.
- Get merge conflict
Before a merge action is performed, this provides details on the conflicts from the changes in the specified branch identified by branch ID (input parameter).
- Merge
This task merges the changes residing in the branch identified by branch ID (input parameter) to the SOR (System of Record) where the development changes are committed.
- Run pega units on branch
Executes PegaUnit tests for the pipeline application. This task returns an error if the pass percentage is less than 100%.
- Deploy branch
The task is required to make the development changes, which are managed on a rule branch, available to perform quality checks such as resolving merge conflicts and running Pega unit tests before the branch merge.
- Check branch review status
Ensures the review on the specified branch is closed.
- Perform manual step
Pauses the deployment and assigns a manual task to the user or adds an approval requirement from a stakeholder for a critical action.
- Update application on access group
Update access groups with new application version.
- Trigger deployment
Triggers a deployment of the specified application pipeline.
- Run Jenkins task
This task is executed on the Jenkins environment. Please ensure that it is properly configured on your Jenkins environment.
- Validate test coverage
Validate test coverage of rules for an application to verify that they meet a specific threshold. Use this task with , which enables the test coverage session.
- Enable test coverage
This task starts an application-level test coverage session that captures which rules are covered and uncovered while the test gates are running. It provides an intermediate input option named "Restart Test Coverage" if the test coverage session is already in progress for this application. Clicking on this option will stop the active coverage session on candidate application and starts a new one.
- Run pega unit tests
Executes PegaUnit tests for the pipeline application or the application given by the access group. If the test suite ID is configured, tests in that test suite are executed. Otherwise, all PegaUnit tests for the application are executed. This task returns an error if the pass percentage is less than 100%.
- Refresh application quality
Regenerates the application quality metrics.
- Update overlay application
This task is only used in Business change pipelines, and it works in conjunction with the NewApplication task. It updates the built-on of the pipeline's application to be the one that was created by the NewApplication task
- Run pega scenario (sauce labs)
Runs the application Pega scenario tests on Sauce Labs Testing tool. If the test suite ID is configured, this executes the tests in that test suite. Otherwise, this executes all scenario tests for the application. This task fails if the test pass rate is less than 100%.
- Run pega scenario (standalone selenium)
Runs the application Pega scenario tests in a standalone-selenium provider. If the test suite ID is configured, this executes the tests in that test suite. Otherwise, this executes all scenario tests for the application. This task fails if the test pass rate is less than 100%.
- Run pega scenario (CBT)
Runs the application Pega scenario tests on a cross-browser testing tool. If the test suite ID is configured, this executes the tests in that test suite. Otherwise, this executes all scenario tests for the application. This task fails if the test pass rate is less than 100%.
- Run pega scenario (browser stack)
Runs the application Pega scenario tests in Browser Stack. If the test suite ID is configured, this executes the tests in that test suite. Otherwise, this executes all scenario tests for the application. This task fails if the test pass rate is less than 100%.
- Create application version
Creates a new application version.
- Select deploy options and test users
Select options and users when finalizing changes in production stage.
- Activate to all or discard from testing
Task available in the production stage to select where changes should be published.
- Validate application testing
Validate that your application testing covers each case type at least once. Deployment Manager returns an error if your application does not cover every case type as part of the testing. Add the Validate application testing task to your update pipeline to check for all case types from all applications in the system.
- Validate development standards
Enforce development standards on an application and manage the applicable development standards through policies. For more information on policies, see .
- Check rule override
Use this task to ensure that no internal rules are accidentally overridden during branch merges. This is helpful in controlling maintenance issues with new platform updates.
- Review deployment health
View the health of a deployment by tracking urgent events that the system reports to Pega Predictive Diagnostic Cloud after the deployment completes on a given environment. To gain better insight about the health of the deployment, run tests before you run this task.
- Register artifact
Reuse an artifact from another deployment with the Register artifact task, which creates an artifact entry and registers the artifact with the system. This task recognizes the artifact through the artifact path and repository name deployment parameters that are provided at the start of the deployment.
Previous topic Environment templates Next topic Check application compliance