Skip to main content

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

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Integrating Agile Workbench with Jira in Pega Platform from 8.3.x to 8.4.x

Updated on September 10, 2021

In Pega Platform™, project stakeholders can use the Agile Workbench tool to capture real-time feedback about an application development project directly in the application. By using the Atlassian Jira component that is available from Pega Exchange, you can continue to use a real-time Agile methodology and integrate Agile Workbench with Jira to leverage its project management features, such as project and issue tracking, Scrum and Kanban support, backlog prioritization, and sprint planning.

As a best practice, to integrate with an external project management system such as Jira, your Pega Platform development operator ID should match your project management system user ID for Jira on premises, or account ID for Jira on Cloud. However, if your IDs for the two systems are not the same, you can provide a different, valid project management user ID for Jira on premises, or account ID for Jira on Cloud. On the Operator menu, in the Project management section, click Preferences, and then update the user ID for Jira on premises, or account ID for Jira on Cloud.

Before you begin

Before you integrate Agile Workbench with Jira, perform the following actions:

  • Disconnect any existing integration to a project management system. On the Integration & security tab of the Application rule form, in the Agile Workbench integration section, click Configure integration, and then click Disconnect integration.
  • If you use a custom workflow or a custom list of priorities in Jira, ensure that Jira workflow and priorities match the Agile Workbench configuration. For more information, see Mappings of Agile Workbench values to Jira values.

To integrate Agile Workbench with Jira:

  1. Download the Jira component from Pega Exchange.
  2. In the Dev Studio header, click the name of your current application, and click Definition to open the Application rule form.
  3. On the Definition tab, in the Enabled components section, click Manage components.
  4. Click Install new, select the file that you downloaded from Pega Exchange, and click Open.
  5. Select the Enabled check box to enable this component for your application, and click OK.
  6. In the list of enabled components, verify the Jira component and its version, and save your changes to the rule form.
  7. Update the PM_Jira_AuthProfile Authentication Profile instance with credentials that you plan to use to access your Jira system through REST authentication:
    • To configure Jira on premises, provide the user ID and password.
    • To configure Jira on Cloud, provide the user ID and the API token.

      For more information about creating an API token, refer to the Atlassian documentation.

    • To use a method of authentication other than Basic, delete and re-add the PM_Jira_AuthProfile instance by using the same name for the new version 
  8. In Dev Studio, click the operator icon, and then click Preferences.
  9. In the Project management section, in the User ID field, enter your Jira user ID, and then click Save.
  10. On the Integration & security tab of the Application rule form, in the Agile Workbench integration section, click Configure integration.
  11. Select JIRA.
  12. Provide the API URL for Jira, and click Connect.
  13. Associate your Agile Workbench work items with a project and release by selecting an existing Jira project and release, or by creating a project and release.
  14. Click Begin integration. All of the user stories and bugs that were created in Agile Workbench are exported to Jira and associated with the project and release that you specified in step 11. A confirmation message explains the results of the integration process.
  15. Click Done after the integration is complete.

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