Updated on 2024-04-23 GMT+08:00

Jira Software

Jira is a popular and powerful project and issue tracking tool widely used in teams and organizations, including IT, operations, sales, marketing, and human resources. The main functions of Jira are as follows: project management, issue tracking, workflow management, reporting and analysis, and integration and expansion. Jira facilitates team management and collaboration and improves work efficiency and quality.

Creating a Jira Connection

  1. Log in to the new ROMA Connect console.
  2. In the navigation pane on the left, choose Connector. On the page displayed, click New Connection.
  3. Select the Jira Software connector.
  4. In the dialog box displayed, configure the connector and click OK.

    Parameter

    Description

    Name

    Enter the connector instance name.

    Type

    Select the type of the Jira connector.

    • Cloud: The Jira instance is deployed on the cloud. Users can use a browser to access it from anywhere.
    • On-Premise: The Jira instance is installed locally. Jira is installed and configured on your own server or local PC.

    Connection Address

    Enter the connection address of Jira.

    • When Type is set to Cloud, the format of the address is https://your-domain.atlassian.net.

      your-domain indicates the domain name of an organization or team. A valid Jira Cloud subscription is required to access the address. If you are not sure about your Jira Cloud address, obtain it from your Atlassian account or administrator.

    • When Type is set to On-Premise, enter the IP address or host name of the server where Jira is located. Example: http://192.168.0.1:8080 or http://Jira.example.com:8080

    Authentication

    Select the Jira authentication type. The options are Basic and API Token.

    Username

    Required only when Authentication is set to Basic

    Username for connecting to Jira

    Password

    Required only when Authentication is set to Basic

    Password for connecting to Jira

    Email

    Required only when Authentication is set to API Token

    Jira email address

    API Token

    Required only when Authentication is set to API Token

    Generate an API token in the personal settings in Jira. The API token is used for identity authentication and allows Jira users to access their accounts and related data via APIs.

    Description

    Enter the description of the connector to identify it.

Action

  • Creating a project
  • Updating a project
  • Querying project details
  • Deleting a project
  • Creating an issue
  • Modifying an issue
  • Changing issue status
  • Querying issues
  • Querying issue details
  • Searching for available users to assign issues
  • Adding a comment
  • Modifying a comment
  • Querying comments

Configuration Parameters

Table 1 Creating a project

Parameter

Description

Project Name

Name of the project.

Project Key

Unique ID of the project.

ProjectTemplateType

Project template.

Project description

Description of the project.

Table 2 Updating a project

Parameter

Description

update by Project Key

Unique ID of the project.

Project Name

Name of the project.

Project description

Description of the project.

Table 3 Querying project details

Parameter

Description

Project Key

Unique ID of the project.

Table 4 Deleting a project

Parameter

Description

delete by Project Key

Unique ID of the project.

Table 5 Creating an issue

Parameter

Description

Project Type

Project type.

Project Key

Unique ID of the project.

Issue Type

Issue type.

Priority

Issue priority.

Summary

Issue summary.

Raised By

Enter a username.

Assign To

Enter a username.

Description

Description of the issue.

Table 6 Modifying an issue

Parameter

Description

Project Type

Project type.

Project Key

Unique ID of the project.

Name

Issue name or ID.

Issue Type

Issue type.

Priority

Issue priority.

Summary

Issue summary.

Raised By

Enter a username.

Assign To

Enter a username.

Description

Description of the issue.

Table 7 Changing issue status

Parameter

Description

Issue Name/ID

Issue name or ID.

Target Status

Select a status supported by the issue.

Table 8 Querying issues

Parameter

Description

Jql

Jira Query Language (JQL) expression.

Offset

Pagination offset. The default value is 0.

Max. Records Returned

Pagination limit.

Table 9 Querying issue details

Parameter

Description

Issue Name/ID

Enter an issue name or ID.

Table 10 Searching for available users to assign issues

Parameter

Description

Project Key

Unique ID of the project (mandatory for new issues).

Issue Name/ID

Enter an issue name or ID (mandatory when Project Key is not specified).

Jira Username

Used for exact search.

Table 11 Adding a comment

Parameter

Description

Issue Name/ID

Enter an issue name or ID.

Visibility

Select a visible scope.

Description

Comment content.

Table 12 Modifying a comment

Parameter

Description

Issue Name/ID

Enter an issue name or ID.

Comment ID

ID of the comment.

Description

Comment content.

Visibility

Select a visible scope.

Table 13 Querying comments

Parameter

Description

Issue Name/ID

Enter an issue name or ID.

Offset

Pagination offset. The default value is 0.

Max. Records Returned

Pagination limit.