Configuring the Perforce ALM for Jira app

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

Keep the following in mind:

  • To install the app, search for 'Perforce ALM for Jira' in the Atlassian Marketplace and install it. See the Atlassian documentation for information.
  • To view ALM information in Jira, users must have access to log in the ALM web client. ALM security permissions are applied when working with issues 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: Select the app

1. In Jira Cloud, click and choose Apps.

In Jira Data Center, click and choose Manage apps.

2. Click the Manage apps tab.

3. Expand Perforce ALM for Jira in the User-installed apps area.

4. Click Configure.

The Perforce ALM Configuration page opens.

Step 2: Configure the connection settings and authenticate with Perforce ALM

1. In the Connection Settings section, provide the following information:

  • Perforce ALM Web URL: Enter the URL for the ALM web client. The URL must start with https://. 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.
  • Server name: Select the server to connect to if the ALM Web CGI is configured to connect to more than one server. The list of available servers configured for the CGI is available. Most web installations only have one available server. Click the Refresh button to refresh the list.

2. If you are not already logged in to the ALM web client, click Open Perforce ALM Web.

If you are already logged in or if you see the Verify Login button, skip to step 5 in this section.

3. Log in and select a project.

4. Go back to the Perforce ALM for Jira page.

5. Click Verify Login. This sends a request to the browser for third-party cookie access, which is required to configure the app.

Depending on the browser, you may be prompted to allow cookies.

For additional security, you may want to configure how often to expire ALM logins and authorization to Jira. See the registry utility documentation for information about security options.

Step 3: Configure the Perforce ALM settings

1. In the Connection Settings section, enter the Jira integration key or click Get Key to generate one.

The key provides security between Jira and the Perforce 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, go back to Jira, and paste the key in the 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. Only the selected projects are available in Jira.

Ctrl+click the projects to include or select All to include all projects. You must select at least one project. Click the Refresh button to refresh the list.

Step 4: Configure the Jira settings

1. In the Jira Settings section, select the Jira projects to display in the Perforce ALM section. The Perforce ALM items panel is only available for Jira issues in the selected projects. You must select at least one project.

2. Click Save.

The app is configured and ready to use. See Working with Perforce ALM items in Jira.

Editing an existing app configuration

When editing an existing app configuration, you must be logged in the ALM web client. If you are not logged in, the Jira integration key field is not displayed and refresh button next to the Perforce ALM projects to display in Jira field is not available. Click Open Perforce ALM Web to open the web client, log in, and then click Verify Login to continue the configuration.