Jira ALM instance Fields
The ALM tab allows you to configure Jira ALM instances that enable integration between Code Insight and your site’s Jira system for the purpose of creating Jira issues in that system from Code Insight. The following table describes the fields on this tab.
| Group | Field | Description |
|---|---|---|
| Connector-level fields | The following fields configure an ALM connector (in this case, the Jira connector). | |
| Application | To add instances to the Jira connector, select Jira from the Application dropdown. Your selection is displayed in the non-editable Application field in the body of the instance definition. The field is required. | |
| Add Instance | Click this button to open a new Instance # n - Jira tab (within the ALM tab) to create a new Jira ALM instance. | |
| Existing Issues Sync Frequency | Click the to the right of this field to select the synchronization frequency that will apply to all the instances configured on the ALM tab. The synchronization process keeps Code Insight up to date with the status of the Jira issues created from Code Insight through the Jira ALM instances. Synchronization options include: - Never—Never run a synchronization. (Default) - Hourly—Run a synchronization every x number of hours. For example, enter 2 to run a synchronization every 2 hours. - Daily—Run a synchronization daily at x clock time. For example, select 1:15 AM from the associated list to run a synchronization at 1:15 am every day. (You can also enter a custom time.) - Weekly—Run a synchronization on x weekday at x clock time every week. For example, select Monday and 11:00 PM from the associated lists to run a synchronization every Monday at 11 pm. (You can also enter a custom clock time.) Click to accept the updated synchronization frequency or to restore the previous frequency. | |
| Functions available for the currently open instance tab | The following buttons apply to the currently open Jira ALM instance tab. | |
| Test Connection | Click this button to validate that the supplied ALM Instance Name, JIRA Server URL, Authentication Type, JIRA Username, and JIRA Password/API Token for the current Jira ALM instance enables Code Insight to successfully connect to the Jira Server. If the connection fails, check that these fields contain valid information. See a description of these fields later in this table. | |
| Delete Instance | Click this button to delete the current Jira ALM instance. If one or more projects are currently associated this instance, an error message is displayed, stating that you cannot delete the project due to project "references". You must disassociate all projects from the instance before you can delete it. | |
| Fields required to connect to the Jira system | The fields described in this section provide the information necessary for this Jira ALM instance to connect to the Jira Server and select a Jira project. These fields are required to set up the Jira ALM instance. Once you have supplied values for these fields, you can use the Test Connection to determine whether your configuration successfully connects to the Jira Server. If not, ensure that you have entered a valid value for each field. The connection is also tested when you attempt to save the instance. Important: For a description of the prerequisites needed to help ensure a successful connection, see Prerequisites for Configuring the Jira Connector. The ALM user specified in these credentials must have permissions to retrieve project types and fields of any issue type from the Jira Server. | |
| ALM Instance Name | (Required) Enter a name for the Jira ALM instance. The name must be unique among all other Jira ALM instances defined for your Code Insight installation. | |
| JIRA Server URL | (Required) Enter the URL of the Jira Server to which Code Insight will connect. Provide the URL in the format http(s):<serverName\_or\_ipAddress> . | |
| Authentication Type | (Required) Select the type of Jira deployment at your site: - Jira (On Cloud): Basic HTTP—Jira is deployed on the Cloud Jira Server. You must provide a Jira user name and API token in the Jira Username and Jira Password/API Token fields, respectively. - On Premise: Basic Auth—Your site uses an on-premise Jira Server and Data Center that requires a Jira user name and password in the Jira Username and Jira Password/API Token fields, respectively, as credentials. - On Premise Jira: Bearer Token—Your site uses an on-premise Jira Server and Data Center that requires a personal access token (PAT) in the Jira Password/API Token field as credentials. (No Jira Username value is required.) | |
| Use the following fields to provide the credentials needed for the selected Authentication Type. For a successful connection, ensure that the specified user is a valid user on the Jira Server. Additionally, make sure that the user has full access to the URL instance specified for the Jira Server and has permissions to retrieve project types and fields of any issue type. This is particularly important if Captcha or Single Sign-On is enabled on the server. After a successful connection, the user is automatically designated as the reporter of each Jira issue created from this instance. | ||
| JIRA Username | (Required for Jira (On Cloud): Basic HTTP and On Premise: Basic Auth ) Enter the user name for the Jira user. | |
| JIRA Password/API Token | (Required) Enter the appropriate value based on the Authentication Type selection: - For "Jira (On Cloud): Basic HTTP"—Enter the API token associated with the user name. - For "On Premise: Basic Auth" —Enter the password associated with the user name. - For "On Premise: Bearer Token"—Enter the user’s personal access token (PAT). | |
| Jira project for the instance | The following field identifies the Jira project (on the Jira Server) with which any Jira issue created from this instance will be associated. | |
| Project Key | (Required) Select the key that identifies the Jira project with which the Jira issues created from this instance will be associated. The dropdown list displays all available project keys from the configured Jira Server. This field is required when configuring the instance. Important: The Project Key must be unique across all ALM instances. If you attempt to save or update an ALM instance configuration with a project key that is already in use by another instance, an error message will be displayed and the save or update operation will not be allowed. Note: Once a Project Key is selected and saved, it becomes non-editable in both the Project ALM settings and the Create Work Item window. | |
| Fields used to define a Jira issue | The fields described in this section are used to define the Jira issue. Note the following: - These fields are optional when setting up an instance. - A value entered for any of these fields serves as the field’s default. However, it can be overwritten by a Project Manager when associating a project with this instance or by a project user when creating a Jira issue. (For more information, see "Associating the Project with an Application Life Cycle System to Create Work Items" and "Creating and Viewing External Work Items for a Project Inventory Task" in the Code Insight User Guide.) - If you enter a default value, ensure that it is valid. Validation of these field values takes place during the creation of a Jira issue. At that time, if information entered for these fields is invalid (for example, the Assignee value does not exist in the Jira system), the information will still be saved, but the user will not be able to create the issue on the Jira Server. Important: A Jira issue on the Jira Server must include the Issue Type, Priority, Assignee, Summary Text, and Description Text fields because these are the fields used to define the Jira issue in Code Insight. Any other field used to define a Jira issue on the Jira Server must be configured as optional (that is, as not requiring a value). For complete information, see the Prerequisites for Configuring the Jira Connector. | |
| Default Issue Type | Enter the type of issue created on the Jira Server. | |
| Default Priority | The Priority field is no longer displayed by default in the Admin ALM configuration. It will only appear if it is configured as a mandatory field for the selected Issue Type in the Jira Server. If displayed, select the appropriate priority level for the Jira issue based on your Jira Server's priority scheme. | |
| Default Assignee | Enter the username or email for the user on the Jira Server to whom you want to assign any Jira issues created from this instance. This is a searchable field—you can search for an assignee by entering a minimum of 1 character. | |
| Default Summary Text | Enter the text that will display as the summary for the issue on the Jira Server. This field supports the use of Code Insight variables, as described in Using Code Insight Variables. | |
| Default Description Text | Enter the text that will display as the description for the issue on the Jira Server. This field supports the use of Code Insight variables, as described in Using Code Insight Variables. | |
| Configuration scope and inheritance | The following describes how field values are inherited from Admin ALM settings to Project ALM settings. | |
| Global and Project Scope | When you update a field value in the Admin ALM settings, that change automatically propagates to any Project ALM settings that use this instance—provided the field value was not previously overridden at the project level. For example, if the Default Assignee is set to 'john' in the Admin ALM settings and a project uses this instance with the assignee still showing 'john', updating the Admin setting to 'jacob' will automatically update the project's assignee to 'jacob'. However, if a user has explicitly changed the project's assignee value, that project-specific override will be preserved and not automatically updated. | |
| Unsupported Jira features | The following Jira fields and application types are not currently supported by Code Insight. | |
| Unsupported Fields | The following Jira fields are not supported: - Attachments - Worklog - IssueLinks - Teams Important: If any of these fields are configured as mandatory in your Jira configuration for a particular issue type, you will not be able to create issues of that type from Code Insight. | |
| Unsupported Application Types | Code Insight does not currently support Jira Service Management (JSM). Only standard Jira and Jira Software applications are supported. |