Install and configure the Perforce ALM for Jira app for Jira Cloud

Before users can work with Perforce ALM items in Jira Cloud, the administrator must configure the Perforce ALM for Jira app.

These instructions only apply to Jira Cloud. If your team uses Jira Data Center, follow the instructions in Install and configure the Perforce ALM for Jira app for Jira Data Center.

Before you begin

  • You must be a Jira site administrator.
  • The Perforce ALM Server must be version 2026.2 or later.
  • The ALM web client must be accessible over HTTPS.
  • Users who need to work with ALM information in Jira must have access to log in the ALM web client. ALM security permissions are applied when working with items in Jira.
  • As a best practice, the web server that hosts the ALM Web CGI should use response headers to prevent clickjacking attempts in web clients. The app does not work when using these headers because they prevent ALM data from loading in Jira. Before configuring the app, an administrative user must remove the headers from the Jira integration components on the web server. See Preventing Clickjacking Attempts on Perforce ALM Web Clients.

Step 1: Install the app

In the Atlassian Marketplace, search for 'Perforce ALM for Jira' and install the app. See the Atlassian documentation for information.

Step 2: Configure the ALM connection settings and authenticate

1. In the Jira administration area, go to Connected apps.

2. On the Connected apps page, find Perforce ALM for Jira.

3. Click ... and select Configure.

4. On the Perforce ALM for Jira Configuration page, in the Connection settings area, enter the Perforce ALM Web URL. This is the URL you use to access the ALM web client. The URL must start with https://. Click the checkmark to confirm the value. Jira checks the ALM connection.

If you are using a self-signed certificate, if you have not already, you must go to the web client and accept the certificate before you can continue. To learn more, see Cannot Configure or Use ALM for Jira App with Self-Signed SSL Certificates.

5. Select a Server name if the ALM Web CGI is configured to connect to more than one server. Most web installations only have one available server. Click Refresh to refresh the list.

6. Click Log in and authenticate in the browser tab that opens.

You are authenticated and more fields are displayed on the page.

Step 3: Configure the Perforce ALM settings

1. In the Perforce ALM settings section, enter the Jira integration key for the selected ALM Server or click Get key to generate one.

The key provides security between Jira and the ALM Server. If you are generating a new key, the Jira Integration Key page opens in the ALM web client. You may need to log in. Click Copy to copy the key, go back to Jira, and then paste the key in the Jira integration key field. If you need to access the key or regenerate it at any point, you can work with it in the Perforce ALM Server Admin Utility. See the server admin utility documentation for information about integration options.

2. Click Test to verify that the key is correct.

Errors are displayed if the test fails. Correct any errors and test the connection again.

3. Select the Perforce ALM projects to display in Jira.

  • All projects displays information from all ALM projects on the selected ALM Server.
  • Specific projects lets you choose the specific projects to display. Click Refresh to refresh the list of available projects.

Step 4: Configure the Jira settings

1. In the Jira settings section, select Display the Perforce ALM items section for all Jira spaces to display the Perforce ALM items section in items for all Jira spaces on the site.

2. To configure visibility of the Perforce ALM items section for a space separately from the global setting (Display the Perforce ALM items section for all Jira spaces), click Override for specific spaces.

3. In the Override Perforce ALM Items Section Visibility dialog, enter a the space name or key for the space to override the global setting and click Search.

4. Select the space.

5. In the Perforce ALM items section display area, select an option to control the ALM items section visibility for the space.

  • Use app setting always uses the setting of the Display the Perforce ALM items section for all Jira spaces option. If the option is selected, the ALM items section is displayed in the space. If the option is not selected, the section is not displayed.
  • Always show for this space always shows the ALM items section in the space, even if Display the Perforce ALM items section for all Jira spaces is not selected.
  • Always hide for this space always hides the ALM items section in the space, even if Display the Perforce ALM items section for all Jira spaces is selected.

6. Click Save to save the settings.

Step 5: Save the configuration

1. On the Perforce ALM for Jira Configuration page, click Save.

The app is configured and ready to use. To learn about working with ALM items in Jira, see Work with ALM items in Jira Cloud.