Configure Issue Tracker

Configure the Issue Tracker if you want to enable the creation of tickets in your bug tracking tool (BTT) from the Polyspace^® Access interface. Polyspace Access supports integration with the Jira Software and Redmine BTT. If you do not want to integrate your BTT with Polyspace Access, select none in the Provider field.

On the Cluster Dashboard, click Configure Apps to go to the Cluster Settings. Whenever you change the settings, click Save, return to the Cluster Dashboard, and click Restart Apps for the changes to take effect. Make sure that Validate on Save is enabled before you click Save.

Note

On Windows^® systems, all the file paths that you specify must point to local drives.

Prerequisites

Install and start the Cluster Admin. See Configure and Start the Cluster Admin.

Configure Jira Software Bug Tracking Tool

You can configure the Issue Tracker for use with Jira Server, Jira Cloud, and Jira Data Center. In the Issue Tracker section, specify these settings:

Setting	Description
Provider	Select `Jira`.
Jira deployment type	Specify whether your Jira instance is Jira Server, Jira Cloud, or Jira Data Center.
Jira URL	Specify the URL of the Jira instance for your organization, for example, `https://jira.mycompany.com`. If your Jira instance is configured using HTTPS, see Add BTT Instance Configured Using HTTPS.
Authentication method	Specify the method that Issue Tracker uses to authenticate Jira logins from Polyspace Access users. For example, you can select OAuth 1.0a or OAuth 2.0 as the authentication method for Jira Cloud.

OAuth Configuration

If you select OAuth 1.0a or OAuth 2.0 as an authentication method, your Jira administrator must first create an application link in Jira. You can use OAuth 1.0a with Jira Server, Jira Cloud, and Jira Data Center, or OAuth 2.0 for Jira Cloud and Jira Data Center.

For an OAuth 2.0 application link, the Jira administrator specifies a callback URL and permissions. For more information, see this OAuth 2.0 (3LO) apps.

For an OAuth 1.0a application link, the Jira administrator specifies an application URL (the URL for Polyspace Access) and generates an RSA public-private key pair. For more information, see step 1 of the Atlassian OAuth documentation.

OAuth 2.0 Specific Configuration

If you select the OAuth 2.0 authentication method, specify these additional settings:


OAuth2 Client ID	The OAuth2 Client ID must match the Client ID in the settings of your OAuth 2.0 application link.
OAuth2 Client Secret	The OAuth2 Client Secret must match the Secret value in the Settings of your OAuth 2.0 application link.
OAuth2 Redirect URL	Specify a link in this format: `<hostname>/issuetracker/authn/oauth2/callback` Here, `<hostname>` is your Polyspace Access URL. For example, if your Polyspace Access URL is `https://access-machine.company.com:9443`, your OAuth2 Redirect URL would be `https://access-machine.company.com:9443/issuetracker/authn/oauth2/callback`.
OAuth2 Scopes	Specify the Jira API permissions that are enabled in your application link as a comma separated list. These permissions are required: `read:jira-work` `read:jira-user` `write:jira-work` This field is available only if you select Jira Cloud as the deployment type.
OAuth2 Site URL	Specify the URL of the Jira Cloud instance for your organization, for example, `https://mycompany.altassian.net`. This field is available only if you select Jira Cloud as the deployment type.

OAuth 1.0a Specific Configuration

If you select the OAuth 1.0a authentication method, specify these additional settings:

Setting Description

Setting	Description
OAuth1 callback URL	The OAuth1 callback URL must match the application URL specified in Jira, for instance `https://access-machine.company.com:9443`.
OAuth1 consumer key	Specify the consumer key value that your Jira administrator entered when configuring the application link in Jira, for instance `OauthKey`.
OAuth1 private key file	Specify the path to the private key file that your Jira administrator generated when configuring the application link in Jira, for instance `/local/polyspace_access/jira_privatekey.pem`. Note The hostname that you specify when you create the JIRA private key must match the hostname that you use in your Polyspace Access URL. If the hostnames do not match, for instance if you use `localhost` instead of the hostname in your Polyspace Access URL, you might see a user authentication error when you attempt to create Jira tickets from Polyspace Access.

OAuth1 callback URL

The OAuth1 callback URL must match the application URL specified in Jira, for instance https://access-machine.company.com:9443.

Jira configuration of oauth.

OAuth1 consumer key

Specify the consumer key value that your Jira administrator entered when configuring the application link in Jira, for instance OauthKey.

OAuth1 private key file

Specify the path to the private key file that your Jira administrator generated when configuring the application link in Jira, for instance /local/polyspace_access/jira_privatekey.pem.

Note

The hostname that you specify when you create the JIRA private key must match the hostname that you use in your Polyspace Access URL. If the hostnames do not match, for instance if you use localhost instead of the hostname in your Polyspace Access URL, you might see a user authentication error when you attempt to create Jira tickets from Polyspace Access.

Limitations

Polyspace Access does not support the creation of BTT tickets that have custom fields if these fields are required fields, except if the fields are:
- All numeric values.
- String only values.
- Single select custom fields.
After users log into Jira from Polyspace Access and start creating Jira tickets, the users remain logged into their Jira session until the session expires.
In Jira Software version 8.4 and later, do not enable dark feature. See Enable Dark Feature in Jira.

Configure Redmine Bug Tracking Tool

Setting Description

Setting	Description
Provider	`Redmine`
Redmine URL	Specify the URL of the Redmine instance for your organization, for example, `https://redmine.mycompany.com`. If your Redmine instance is configured by using HTTPS, see Add BTT Instance Configured Using HTTPS. This field is available only if you select Redmine as a provider.
Redmine API key	Specify the API access key of a Redmine administrator. To obtain the API key, log into your instance of Redmine as an administrator, click My account in the upper-right corner, then, in the right pane, click Show under API access key. The Issue Tracker does not validate the API key. Check periodically that the API key has not expired or become invalid. This field is available only if you select Redmine as a provider.

Provider

Redmine

Redmine URL

Specify the URL of the Redmine instance for your organization, for example, https://redmine.mycompany.com.

If your Redmine instance is configured by using HTTPS, see Add BTT Instance Configured Using HTTPS.

This field is available only if you select Redmine as a provider.

Redmine API key

Specify the API access key of a Redmine administrator.

To obtain the API key, log into your instance of Redmine as an administrator, click My account in the upper-right corner, then, in the right pane, click Show under API access key.

The Issue Tracker does not validate the API key. Check periodically that the API key has not expired or become invalid.

This field is available only if you select Redmine as a provider.

Limitations

Polyspace Access does not support the creation of BTT tickets that have custom fields if these fields are required fields, except if the fields are all numeric values or string only values.
To create a redmine ticket from Polyspace Access, the username used to log into Polyspace Access must match the username of a Redmine account.
Redmine tickets that users create from Polyspace Access can be populated only with default field values. Some of the ticket field values that a user selects in Polyspace Access might not match the field values of the Redmine ticket.

Add BTT Instance Configured Using HTTPS

If your BTT instance is configured by using HTTPS, add the BTT SSL certificate to the certificate trust store file that you specify in the CA File field of the Nodes settings. To view these settings, click Configure Nodes on the Cluster Dashboard. Depending on your trust store file, the BTT SSL certificate might already be included in the trust store.

The certificate trust store file typically corresponds to the file that you provide with --ssl-ca-file when you configure the Cluster Admin with HTTPS. See Choose Between HTTP and HTTPS Configuration for Polyspace Access.

For instance, on a Linux^® Debian^® distribution, to add BTT certificate btts_cert.pem to trust store file trust_store.pem, use this command:

cat trust_store.pem btts_cert.pem > combined_cert.pem

The command combines the content of the two files and outputs file combined_cert.pem. If you use a self-signed certificate to configure HTTPS, add the BTT certificate to the self-signed certificate.

To complete the configuration, enter the path to combined_cert.pem in the CA File field of the Nodes settings, save your changes, return to the dashboard, and restart the Apps.

If you did not configure the Cluster Admin by using HTTPS, specify the path to the BTT SSL certificate in the CA File field.