Skip to main content


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

Creating a business change pipeline

Updated on July 14, 2022

Business change pipelines are used to support everyday, business-as-usual changes to your application. This pipeline type allows users to respond to changing requirements by modifying and deploying application rules in a controlled manner. When you add a pipeline, you define all the stages and tasks that you want to do on each system. Pipelines are the first step in getting started with setting up a process for deploying a business change outside of an enterprise release.

Important: The enterprise application specified in the Create application version task must have a major, minor, and patch version defined to use a business change pipeline. See Application versioning in Pega for more information.
Note: Overlay ruleset versions managed by business change pipeline cannot be automatically rolled over after V99. For more details on how to resolve this issue, see Resolving revision deployment issues when revisions approach patch version 99.

Add a new business change pipeline

To add a new pipeline, follow the steps below:

  1. Click Pipelines.
  2. Click New on the top right.
  3. Select the business change pipeline template. Pipeline templates drive the required information needed to complete the creation of a pipeline. For more information, see Pipeline templates.
Note: Remember to save your configuration if you choose to navigate away from any of the pipeline creation screens. Progress will be lost if configurations are not saved.

Configuring a new pipeline - Application Details

Application Packaging Environment

  1. Specify the environment URL from which the business changes will be merged and progressed in the Application packaging environment field and select or enter the Authentication profile to be used for connection to the application packaging environment.
Setting up application packaging environment
Specifying the source environment by entering URL and authentication profile name.

Application Details

Application details specify the application that this pipeline progresses through.

  1. In the Application field, select the name of the overlay application.
  2. In the Version field, select the application version.
  3. In the Access group field, select the access group for which pipeline tasks are run.
    • This access group must be present on all candidate systems and have at least the sysadmin4 role.
  4. In the Product rule field, enter the name of the product rule that defines the contents of the application.
    Note: Before creating the product rule, override the following report definitions in personal ruleset (rulset of the enterprise application) to package only new created application and test the created or updated access group:
    • In pyRevisionAppFilterTemplate ruleset, in filter condition F1, set column source .pyProductName as equal to <EnterpriseApplicationName>, which is same as input parameter for the Create application version task. EnterpriseApplication is the application on which the overlay application is built on.
      Overriding report definition for pyRevisionAppFilterTemplate
      Filter conditions
    • In pyRevisionTestAccessGroupTemplate ruleset, in filter condition F1, set column source .pyAccessGroup as equal to <EnterpriseApplicationName>:RevisionTestAdmin".
      Overriding report definition for pyRevisionTestAccessGroupTemplate
      Filter conditions

    Select application in global exclusions and add the created report definitions (as shown above) to package the new enterprise application and test access group.

    Creating a product in personal ruleset
    Contents tab of a Product in personal ruleset

    For more information, see Configuring a product rule.

  5. In the Version field, enter the product rule version.
  6. In the Pipeline name field, enter a unique name for the pipeline.
Filling in application details
Application details tab highlighting the pipeline name field.

Deploy Application Test Cases

Complete the following steps to generate the artifact consisting of the test cases to run on a target environment:

  1. If you are using a separate product rule to manage your test cases, enable Configure application test cases in the Application test cases section to deploy your test case.
  2. In the Application field, select the name of the application.
  3. In the Version field, select the application version.
  4. In the Access group field, select the access group for which pipeline tasks are run.
    • This access group must be present on all candidate systems and have at least the sysadmin4 role.
  5. In the Product rule field, enter the name of the product rule that defines the contents of the application.
  6. In the Version field, enter the product rule version.

Dependencies

To configure dependent applications:

  1. Click Add in the Dependencies section.
  2. In the Application field, select the application name.
  3. In the Application version field, select the application version.
  4. In the Pipeline field, select the pipeline.
  5. In the Deployment field, select the deployment that contains the production-ready artifact of the dependent application. If you want the latest artifact of the dependent application to be automatically populated, select latest.

Merge Policy

To configure the target ruleset version used when merging branches:

  1. In the Choose the target ruleset, field, input your ruleset using the New ruleset version field.
  2. Enter the password to lock the ruleset version.

Configuring a new pipeline - Environment Details

Environments

  1. The default stages are populated based on the pipeline template created. See Pipeline templates for more information.
  2. In the Environment URL field for the system, press the Down arrow key and select the URL of the system.
  3. If you are using your own authentication profiles, in the Authentication Profile field for the system, press the Down arrow key and select the authentication profile that you want to communicate from the orchestration server to the system.
    • By default, the fields are populated with the DMAppAdmin authentication profile.
Note: The pipeline model screen will support the addition of more than four stages.

Repositories

  1. In the Artifact management section, specify the development and production repositories through which the product rule that contains application contents moves through the pipeline.
  2. In the Development repository field, select the development repository.
  3. In the Production repository field, select the production repository.
  4. Click Next.

Configuring a new pipeline - Model Pipeline

From the model pipeline screen, you can tailor your stages and tasks to replicate the quality standard of the release process defined by your organization. You can modify the deployment process here by configuring tasks and modifying stages.

Business change pipelines offer a specific default use case, however this can be customized using the model pipeline screen.

Note: Make sure that last stage is using BusinessChange_Production environment template.

For more information on adding, editing, or deleting a stage, see .

  1. Stages can be modified here by clicking the More icon on each stage.
  2. To add a stage, click the +Stage button. You can apply an environment template to each new stage. See Environment templates.
  3. To add a task to a stage, click the +Task button within a stage. The available tasks that you can add depend on the associated stage and the environment template assigned to that stage. For a list of task related information, see the Task catalog.
    Note: You cannot delete mandatory tasks.
  4. Optional: At the end of each stage, click the +Task button and select Perform manual step to add a manual task. For more information, see Perform manual step.
    Note: Do not add any other task apart from the manual step at the end of a stage in a business change pipeline.
    Adding a manual task at the end of a stage
  5. Input the enterprise application name for the input parameter of the Create application version task. See Create application version task for more information.
    Create application version task

Update impact

Updating Deployment Manager can potentially impact the status of your business change pipeline. See the table below for any update impact and how to resolve potential issues.

Created in versionUpdated to 5.1Updated to 5.2Updated to 5.3
4.xRecreate a new pipelineRecreate a new pipelineRecreate a new pipeline
5.1Not applicableRecreate a new pipelineRecreate a new pipeline
5.2Not applicableNot applicableReuse the existing pipeline

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.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us