Overview
Overview
You can work on the Jira library as it allows users to work with Jira Server to perform tasks such as ConnectJira, CreateIssue, UpdateIssue, DeleteIssue, AssignIssue, QueryIssues, AddComment, DeleteComment, and GetComments.
The features provided by the Jira library are as follows:
Jira Features: ConnectJira
Issue Management: CreateIssue, UpdateIssue, DeleteIssue, AssignIssue, QueryIssues
Comment management: AddComment, DeleteComment, GetComments
Common properties
Common properties
More Options
Properties | Type | Required | Unit | Auto-setting | Description |
|---|---|---|---|---|---|
On Error | Combination box | N | - | N | Specify an action to carry out when an error occurs at the time of execution. - If not specified: Output errors and exit the task. - --Ignore--: Ignore the error. - --Retry--: Try the activity one more time. - --Goto--: Try the scenario for the specified time if the activity fails. - _Event: Select an event created within the project. If a handler is specified: Call the specified handler. |
DESCRIPTION
Properties | Type | Required | Unit | Auto-setting | Description |
|---|---|---|---|---|---|
DESCRIPTION | Text | N | - | N | Enter the description for the activity card. The description entered in the DESCRIPTION field is used as the description of the activity. A representative value will be displayed in the absence of the DESCRIPTION input. |
ConnectJira
ConnectJira
Overview
This activity card starts authenticating to the Jira you want to connect to.
Application procedures
In the [Output] field, enter the variable to which the connection information will be assigned to Connection.
Select an authentication type in Authentication Type .
In the Server URL field, enter the Jira project URL.
Card properties
Common | Properties | Type | Required | Unit | Auto - setting | Description |
|---|---|---|---|---|---|---|
N | [Output] Connection | Variable | Y | - | N | Enter the variable to which connection information will be assigned. |
N | Authentication Type | Combination box | Y | - | N | Select the authentication type to use to access the Jira service. The below options are displayed: - API Token - OAuth 2.0 |
N | Server URL | String | Y if Authentication Type is API Token, otherwise N | - | N | Enter the Jira project url. |
N | API Token | String | Y if Authentication Type is API Token, otherwise N | - | N | Enter the API Token. |
N | User email | String | Y if Authentication Type is API Token, otherwise N | - | N | Enter User email. |
N | Client ID | String | Y if Authentication Type is OAuth 2.0, N otherwise | - | N | Enter the Client ID. |
N | Client Secret | String | Y if Authentication Type is OAuth 2.0, N otherwise | - | N | Enter the Client Secret. |
Y | - | - | - | - | Common property of Jira library. | |
Y | - | - | - | - | Common property of Jira library. |
Example of utilization
Connect to Jira using ConnectJira.
ConnectJira
Sample file
Menu > Help > Samples > Sample > Jira
Used variables
this.connection = variable to which connection information will be assigned this.serverUrl = Jira Project url this.apiToken = User API Token this.userEmail = userEmail this.clientId = User ID of your Jira account this.clientSecret = User Secret of the Jira account
Used properties
[Output] Connection = this.connection
Server URL = this.serverUrl
API Token = this.apiToken
User email = this.userEmail
Client ID = this.clientId
Client Secret = this.clientSecret
Related/Similar Activities
CreateIssue
CreateIssue
Overview
This activity card is used in Creating a Jira issue.
Application procedures
In the [Output] field, enter a variable to store the result in Issue.
In the [Input] field, enter connection information variables in Connection.
In the Project Key field, enter the project key.
It is possible to create an issue with the default schema based on the Jira Cloud platform REST API, version 3.
For Components, enter the values created in advance in the Jira Project.
(ex> [https://testrpa.atlassian.net/jira/software/c/projects/RPATEST/components)]
Additional Fields are entered after adding Fields in Jira Project Settings.
Card properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
|---|---|---|---|---|---|---|
N | [Output] Issue | Variable | Y | - | N | Enter a variable to store the generated issue results. |
N | [Input] Connection | Variable | Y | - | N | Enter the connection information variables. |
N | Project Key | String | Y | - | N | Enter the Project Key. |
N | Summary | String | Y | - | N | Enter Summary. |
N | Type | Combo box | Y | - | N | Enter the Type. - Epic- Story - Bug- Task |
N | Additional Fields | String | N | - | N | Enter Additional Fields.
|
N | Components | String | N | - | N | Enter Components.
|
N | Description | String | N | - | N | Enter a Description. |
N | Attachment | String | N | - | N | Enter the attachment path. |
N | Parent Issue Key | String | N | - | N | Enter the Parent Issue Key. |
Y | - | - | - | - | Common property of the Jira library. | |
Y | - | - | - | - | Common property of the Jira library. |
Example of utilization
Create a Jira issue using CreateIssue.
CreateIssue
Sample file
Menu > Help > Samples > Sample > Jira
Used variables
RESULT = variable to which generated issue information will be assigned this.connection = connection information variable this.projectKey = Project Key this.summary = Summary this.description = Description
Used properties
[Output] Issue = RESULT
[Input] Connection = this.connection
Project Key = this.projectKey
Summary = this.summary
Description = this.description
Related/Similar Activities
UpdateIssue, DeleteIssue, AssignIssue, QueryIssues
UpdateIssue
UpdateIssue
Overview
This activity card edits the Jira issue.
Application procedures
In the [Output] field, enter a variable to store the result in Issue.
In the [Input] field, enter connection information variables in Connection.
In the Issue Key field, enter the issue key.
For Components, enter the values created in advance in the Jira Project.
(ex> [https://testrpa.atlassian.net/jira/software/c/projects/RPATEST/components)]
Additional Fields are entered after adding Fields in Jira Project Settings.
Card properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
|---|---|---|---|---|---|---|
N | [Output] Issue | Variable | Y | - | N | Enter a variable to store the modified issue result. |
N | [Input] Connection | Variable | Y | - | N | Enter the connection information variables. |
N | Issue Key | String | Y | - | N | Enter the Issue Key. |
N | UpdateSummary | Toggle button | N | - | N | Specifies whether or not to modify the summary. |
N | Summary | String | Y if UpdateSummary is On, N otherwise | - | N | Enter Summary. |
N | Additional Fields | String | N | - | N | Enter Additional Fields.
|
N | UpdateComponents | Toggle button | N | - | N | Specifies whether to modify Components. |
N | Components | String | Y if UpdateComponents is On, N otherwise | - | N | Enter Components.
|
N | UpdateDescription | Toggle button | N | - | N | Specifies whether to modify Description. |
N | Description | String | Y if UpdateDescription is On, N otherwise | - | N | Enter a Description. |
Y | - | - | - | - | Common property of the Jira library. | |
Y | - | - | - | - | Common property of the Jira library. |
Example of utilization
Fix Jira issues using UpdateIssue.
UpdateIssue
Sample file
Menu > Help > Samples > Sample > Jira
Used variables
RESULT = variable to which the modified issue information will be assigned this.connection = connection information variable this.issueKey = IssueKey
Used properties
[Output] Issue = RESULT
[Input] Connection = this.connection
Issue Key = this.issueKey
Summary = 'Update Summary'
Components = 'component1;component2'
Description = 'Update Description'
Related/Similar Activities
CreateIssue, DeleteIssue, AssignIssue, QueryIssues
DeleteIssue
DeleteIssue
Overview
This activity card deletes the Jira issue.
Application procedures
In the [Input] field, enter connection information variables in Connection.
In the Issue Key field, enter the issue key.
Card properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
|---|---|---|---|---|---|---|
N | [Input] Connection | Variable | Y | - | N | Enter the connection information variables. |
N | Issue Key | String | Y | - | N | Enter the Issue Key. |
Y | - | - | - | - | Common property of the Jira library. | |
Y | - | - | - | - | Common property of the Jira library. |
Example of utilization
Delete the Jira issue using DeleteIssue.
Sample file
Menu > Help > Samples > Sample > Jira
Used variables
this.connection = connection information variable this.issueKey = IssueKey
Used properties
[Input] Connection = this.connection
Issue Key = this.issueKey
Related/Similar Activities
CreateIssue, UpdateIssue, AssignIssue, QueryIssues
AssignIssue
AssignIssue
Overview
This activity card assigns a Jira Issue Assignee.
Application procedures
In the [Output] field, enter a variable to store the result in Issue.
In the [Input] field, enter connection information variables in Connection.
In the Issue Key field, enter the issue key.
Card properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
|---|---|---|---|---|---|---|
N | [Output] Issue | Variable | Y | - | N | Enter a variable to store the results of assigned issues. |
N | [Input] Connection | Variable | Y | - | N | Enter the connection information variables. |
N | Issue Key | String | Y | - | N | Enter the Issue Key. |
N | Assignee | String | Y | - | N | Enter Assignee. |
Y | - | - | - | - | Common property of the Jira library. | |
Y | - | - | - | - | Common property of the Jira library. |
Example of utilization
Assign a Jira Issue Assignee using AssignIssue.
AssignIssue
Sample file
Menu > Help > Samples > Sample > Jira
Used variables
this.connection = connection information variable this.issueKey = IssueKey this.assignee = Assignee
Used properties
[Output] Issue = RESULT
[Input] Connection = this.connection
Issue Key = this.issueKey
Assignee = this.assignee
Related/Similar Activities
CreateIssue, UpdateIssue, DeleteIssue, QueryIssues
QueryIssues
QueryIssues
Overview
This activity card Leveraged JQL to query Jira issues.
Application procedures
In the [Output] field, enter a variable to store the result in Issue.
In the [Input] field, enter connection information variables in Connection.
In the JQL field, enter the jql query.
Issues in Output are checked in the form of a one-dimensional array.
issues[0]
Card properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
|---|---|---|---|---|---|---|
N | [Output] Issue | Variable | Y | - | N | Enter a variable to store the results of assigned issues. |
N | [Input] Connection | Variable | Y | - | N | Enter the connection information variables. |
N | JQL | String | Y | - | N | Enter JQL. |
N | Max Results | Number | Y | - | N | Enter Max Results. |
Y | - | - | - | - | Common property of the Jira library. | |
Y | - | - | - | - | Common property of the Jira library. |
Example of utilization
Query Jira issues using QueryIssues.
QueryIssue
Sample file
Menu > Help > Samples > Sample > Jira
Used variables
this.connection = connection information variable
Used properties
[Output] Issue = RESULT
[Input] Connection = this.connection
JQL = 'project = "RPATEST"'
Max Results = 50
Related/Similar Activities
CreateIssue, UpdateIssue, DeleteIssue, AssignIssue
AddComment
AddComment
Overview
Add a comment to the Jira issue.
Application procedures
Enter a variable to store the result in [Output] Comment.
In the [Input] field, enter connection information variables in Connection.
In the Issue Key field, enter the issue key.
Formatted comments are entered in the following format.
Bold: *comment*
Italic: _comment_
Underline: +comment+
Strikethrough: -comment-
Card properties
CommonCommon | Properties | Type | Required | Unit | Auto-setting | Description |
|---|---|---|---|---|---|---|
N | [Output] Comment | Variable | Y | - | N | Enter a variable to store the entered Comment result. |
N | [Input] Connection | Variable | Y | - | N | Enter the connection information variables. |
N | Issue Key | String | Y | - | N | Enter the Issue Key. |
N | Comment | String | Y | - | N | Enter Comment. |
Y | - | - | - | - | Common property of the Jira library. | |
Y | - | - | - | - | Common property of the Jira library. |
Example of utilization
Enter Jira comments using AddComment.
Addcomment
Sample file
Menu > Help > Samples > Sample > Jira
Used variables
this.connection = connection information variable this.issuekey = Issue Key
Used properties
[Output] comment = RESULT
[Input] Connection = this.connection
Issue Key = this.issueKey
Comment = 'sample comment'
Related/Similar Activities
DeleteComment
DeleteComment
Overview
This activity card deletes the Jira issue's comment.
Application procedures
In the [Input] field, enter connection information variables in Connection.
In the Issue Key field, enter the issue key.
Enter the comment ID you want to delete in Comment ID.
Get the Comment Id through the 'Copy link to comment' of the comment you want to delete.
Card properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
|---|---|---|---|---|---|---|
N | [Input] Connection | Variable | Y | - | N | Enter the connection information variables. |
N | Issue Key | String | Y | - | N | Enter the Issue Key. |
N | Comment ID | string | Y | - | N | Enter the Comment ID you want to delete. |
Y | - | - | - | - | Common property of the Jira library. | |
Y | - | - | - | - | Common property of the Jira library. |
Example of utilization
Delete Jira comments using DeleteComment.
DeleteComment
Sample file
Menu > Help > Samples > Sample > Jira
Used variables
this.connection = connection information variable this.issuekey = Issue Key this.commentID = Comment ID
Used properties
[Output] Issue = RESULT
[Input] Connection = this.connection
Issue Key = this.issueKey
Comment ID = this.commentID
Related/Similar Activities
GetComments
GetComments
Overview
This activity card retrieves comments from Jira issues.
Application procedures
In the [Output] Comments field, enter a variable to store the results.
In the [Input] field, enter connection information variables in Connection.
In the Issue Key field, enter the issue key.
Check Comments in Output in the form of a one-dimensional array.
comments[0]
Formatted comments are displayed in the format shown below.
Bold: *comment*
Italic: _comment_
Underline: +comment+
Strikethrough: -comment-
Card properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
|---|---|---|---|---|---|---|
N | [Output] Comments | Variable | Y | - | N | Enter a variable to store the retrieved Comment result. |
N | [Input] Connection | Variable | Y | - | N | Enter the connection information variables. |
N | Issue Key | String | Y | - | N | Enter the issue key to search comments. |
Y | - | - | - | - | Common property of the Jira library. | |
Y | - | - | - | - | Common property of the Jira library. |
Example of utilization
Retrieve Jira comments using GetComments.
GetComments
Sample file
Menu > Help > Samples > Sample > Jira
Used variables
this.connection = connection information variable this.issuekey = Issue Key
Used properties
[Output] comments = RESULT
[Input] Connection = this.connection
Issue Key = this.issueKey
Related/Similar Activities