Fields Used to Configure a Jira ALM Instance

The following table describes the fields that the System Administrator uses to create or update a Jira ALM instance for integrating with the Jira system.

ALM Tab

Group

Field

Description

Connector-level fields

The following fields configure an ALM connector (in this case, the Jira connector).

The “Integrating with Application Lifecycle Management” chapter of the Code Insight Installation & Configuration Guide provides more information about the relationship between the Jira connector and instances.

Application

To add instances to the Jira connector, select Jira from the 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 opened 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.

These are the only fields required to set up the Jira ALM instance. (All remaining fields on this tab are optional when creating the 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 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 the “Prerequisites for Configuring the Jira Connector” section in the “Code Insight Installation & Configuration Guide”.

ALM Instance Name

(Required) Enter a name for the Jira ALM instance.

The name must be unique among all other Jira ALM instances defined in your Code Insight installation.

JIRA Server URL

(Required) Enter the URL of the Jira server to connect to. 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. This is particularly important if Captcha or Single Sign-On is enabled on the server.

Note:After a successful connection, the user is automatically designated as the reporter of the 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.

Default Project Key

Provide a default value for the key that identifies the Jira project with which the Jira issues (created from this instance) will be associated. This value can be edited when a project is associated with the instance.

This field is optional when configuring the instance (but is required when a Code Insight project is associated with this instance, as described in Associating the Project with an Application Life Cycle System to Create Work Items).

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.)
• 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). Deviation from this field configuration on the Jira server can cause the creation of Jira issues from Code Insight to fail. For complete information, see the “Prerequisites for Configuring the Jira Connector” section in the “Code Insight Installation & Configuration Guide”.

Default Issue Type

Enter the type of issue created on the Jira server—Bug or Task.

 

Default Priority

Select the priority level for the Jira issue:

1—Highest

2—High

3—Medium

4—Low

5—Lowest

Important:The priority scheme for issues on the Jira server must match this priority scheme. If a different priority scheme is used on the Jira server, the creation of the Jira issue from Code Insight can fail. For complete information, see the “Prerequisites for Configuring the Jira Connector” section in the “Code Insight Installation & Configuration Guide”.

Default Assignee

Enter the email for the user on the Jira server to whom you want to assign any Jira issues created from this instance.

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 Use of Code Insight Variables in Text.

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 Use of Code Insight Variables in Text.