Skip to main content

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

Configuring App Studio for publishing

Updated on March 30, 2021

Publish application updates in App Studio using an existing deployment pipeline to seamlessly create patch versions of an application and start a deployment.

Before you begin: Validate the following:
  • Pega Platform is on version 8.5.2 or higher.
  • Deployment Manager is on 5.2 or higher.
This publishing capability requires your candidate environments communicate with Deployment Manager. therefore you must follow the configuration steps below before proceeding.

Enable Deployment Manager integration

You must properly configure and integrate Deployment Manager with App Studio before you can publish changes. These integration steps enable communication between the candidate environments and the orchestrator for seamless publishing of deployment pipelines.

To enable Deployment Manager integration on the App Studio environment, follow the steps below:
  1. Navigate to the Deployment Manager Pega Marketplace page and download the latest version of Deployment Manager.
  2. Extract the contents of the downloaded file.
  3. Use the Import wizard to import files into the appropriate systems. For more information on using the Import wizard, see Importing rules and data by using the Import wizard.
  4. On the development environment, switch to Dev Studio and click Configure Application Distribution Import and import the file.
    Importing PegaDevOpsFoundation using the Import wizard
  5. Next, configure the authentication profile. Deployment Manager cannot automatically populate the client secret to candidate environments, as it is not recommended to share this information across systems. To manually update the client secret information on your candidate environment:
    1. In Dev Studio, click Records Explorer Security Authentication Profile to receive a list of profile names available on the candidate environment.
    2. Select the DMReleaseAdmin_OAuth2 authentication profile.
    3. Update the client secret on the authentication profile. On the OAuth 2.0 tab, under the Client configuration section, enter the client secret in the Client secret field.
      Update client secret on the DMReleaseAdmin_OAuth2 authentication profile.
      Note: The client secret is downloaded while setting up the orchestrator instance of Deployment Manager. Contact your Deployment Manager administrator to obtain the client secret.
  6. Enter the Access token endpoint and the Revoke token endpoint in the Endpoint configuration section.
    Update access token and revoke token endpoints on the DMReleaseAdmin_OAuth2 authentication profile.
  7. Confirm the changes by clicking Save.
  8. To update the orchestrator server to manage this application deployment, you must update the OrchestratorURL on the environment.
    1. In the PegaDevopsShared ruleset, search OrchestratorURL Dynamic System Setting.
    2. Update the Value field to point to the orchestrator URL. Use this setting for Dev Studio and App Studio integration.
    3. Confirm the changes by clicking Save.

Configure a deployment pipeline

Create a deployment pipeline to model the release process set for your application or team. For more information on creating a deployment pipeline, see Creating a deployment pipeline.

Ensure your pipeline has at least one quality assurance or staging stage with a manual task so that you do not deploy changes to production that have not been approved by stakeholders.

Configure an application to enable publishing

You must properly configure an application before you can publish updates using deployment pipelines.

To enable publishing on an application, follow the list below:

  1. A product rule exists with the same name and version as the application being deployed. For more information see Creating a product rule that does not include associated data.
  2. A pipeline has been created in Deployment Manager for the application being deployed.
  3. There is at least one unlocked ruleset in the application.
  4. The application is built on PegaDevOpsFoundation. Switch to Dev Studio, navigate from the Application drop down to definition. Add built-on application and enter PegaDevOpsFoundation under name field and update the major version used under version.
    Update the application record to add built-on application.

Configure user access

As an App Studio user, log in to the application you are deploying on the development system.

To enable access to deploy the changes, a user must have deployment-level access. Follow the steps below to enable accesses.
  1. Switch to Deployment Manager from Dev Studio.
  2. In the navigation pane of Deployment Manager, click Users People.
  3. On the People page, click Add user.
  4. In the Add user dialog box, click the User field and do one of the following actions:
    1. Select the user that you want to add.
    2. Enter an email address.
  5. Click Add.
  6. From the role list, select PipelineUser.
  7. If you selected the App admin role or a custom role in the Applications field, enter the application name that the user can access.
  8. Click Send invite to send an email containing the user name and a randomly generated password for Deployment Manager log in credentials.

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