Skip to main content

Adding a Jira ALM Instance

To enable the Jira connector that is available with Code Insight, the Code Insight System Administrator must add one or more Jira ALM instances to the connector. Once the instances are added, they are available to all Code Insight projects on their Manage Project > Edit Project window, enabling the Code Insight Project Administrator to configure a project with one of the instances.

Important: The Jira ALM configuration is now completely dynamic. The ALM instance should be configured using a Jira user who has permissions to retrieve project types and fields of any issue type from the Jira Server.

To add a Jira ALM instance, do the following:

  1. As System Administrator, use either of these steps to open the Administration page:

    • From the Code Insight dashboard that is displayed when you open Code Insight, click administration.
    • From the Code Insight web page, click in the upper right corner, and select ADMINISTRATION from the menu.

  2. Select the ALM tile on the left to open the ALM tab.

  3. Select Jira from the Application dropdown list.

  4. Click Add Instance. A new Instance # x - Jira tab is displayed (where x is an automatically assigned sequential tab number).

  5. Enter values for the fields that define the new Jira ALM instance. For important details about these fields, refer to Jira ALM instance Fields. Note the following:

    • The fields required to set up the instance are those that identify the instance and define the connection to the Jira Server:

      • ALM Instance Name
      • JIRA Server URL
      • Authentication Type
      • JIRA Username (required only for On Premise Jira: Basic Auth and Cloud Jira: Basic HTTP authentication types)
      • JIRA Password/API Token
      • Project Key (required, select from the dropdown list of available Jira projects. The Project Key must be unique across all ALM instances. If you attempt to save an instance with a project key that is already in use by another instance, an error message will be displayed and the save operation will not be allowed.)

    • Additional fields are available for configuration:

      • Default Issue Type — Select from all issue types available in the selected Jira project.
      • Default Assignee — Search for an assignee by username or email (minimum 1 character).
      • Mandatory fields — When you select a Project Key and Default Issue Type, the system automatically displays any mandatory fields required to create that specific issue type in that project. These mandatory fields are not required during ALM instance configuration; they can be provided later in the Project ALM settings or when creating the issue from the Create Work Item window.

    • After you complete the required fields for the connection and project, you can click the Test Connection button to see whether a successful connection is established with the Jira Server. However, clicking Save after you completed the required and any optional fields will also test the connection.

  6. Click Save to save the instance and test the connection to the Jira ALM instance.

    If the connection with the Jira Server is successful, a "Connection successful" message is displayed.

    If an error occurs, check that the required fields contain valid information.

Field Value Inheritance​

When you update the value of any field in the Admin ALM settings, the change automatically reflects in the Project ALM settings for all projects using that instance, provided the value has not been overridden by the user in the project settings. For example, if you update the Default Assignee from 'john' to 'jacob' in the Admin ALM settings, all projects using this instance will automatically inherit the new value 'jacob' unless a user has explicitly overridden it in the project settings.

Supported Jira Fields and Applications​

For complete information about all available fields and configuration options, see Jira ALM instance Fields.

Code Insight does not currently support the following Jira fields. If these fields are mandatory in your Jira configuration, issues cannot be created from Code Insight:

  • Attachments
  • Worklog
  • IssueLinks
  • Teams

Code Insight does not currently support Jira Service Management (JSM) application type.