Jira

Jira



Jira 

This plugin is designed to perform various tasks on a JIRA instance.  These tasks are handled by the plugin steps as discussed below. 

This plugin has been tested with JIRA-8.6.1, JIRA -8.0.2, JIRA-7.13.0 (On-Premise) and JIRA- (On-Cloud).

Prerequisites:

  1. JIRA instance and access details with appropriate permissions.
  2. json-20180130.jar must be present in lib folder of Process Studio as well as AE.
  3. Get an API Key in case of on cloud instance.

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html


Jira: Add Comment

Description

JIRA Add Comment plugin step adds a new comment to an issue in On-premise and On-cloud version of a Jira instance.

Configurations 

No.

Field Name

Description

1

Step Name

Name of the step. This name has to be unique in a single workflow.


Connection:


2

Base URL  

For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration.

In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/).

3

Username

A username with appropriate permissions to authenticate to JIRA instance and add a comment. This field is mandatory.


Password:


4

Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

5

Password/API Key

Password can be entered as Text (for static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Provide an API Key in case of on cloud instance.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

6

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Issue Key

Issue key of the issue for which comment is to be added. This field is mandatory.

2

Button: Get

Clicking on this button brings up the issue keys available as per the access permission of Username provided in Connection.

Note Limitation: It will return maximum 1000 or 100 issues for on-premise and on-cloud instances respectively. This is an intentional limitation on JIRA applications to avoid performance-related issues such as an OutOfMemoryException.

3

Comment

Specify a Comment for the specific issue. This field is mandatory.


Result:

There is no explicit output Result field in this plugin. Plugin results weather success or error can be captured using Set Workflow Result. Errors can be captured in error handling as discussed in Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.




Jira: Add Label

Description

This plugin adds a label to an issue in on-premise or on-cloud version of a JIRA instance.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Base URL  

For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration.

In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/).

3

Username

A username with appropriate permissions to authenticate to JIRA instance and add a labelThis field is mandatory.


Password:


4

Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

5

Password/API Key

Password can be entered as Text (for static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Provide an API Key in case of on cloud instance.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

6

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Issue Key

Issue key of the issue for which label is to be added. This field is mandatory.


Note Limitation: REST API can get maximum of 1000 and 100 issues for on-premise and on-cloud instances respectively. This is an intentional limitation on JIRA applications to avoid performance-related issues such as an OutOfMemoryException.

2

Button: Get

Clicking on this button brings up the issue keys available as per the access permission of Username provided in Connection.

3

Label

Specify a label value to be added to an issue. This field is mandatory.


Result:

There is no explicit output Result field in this plugin. Plugin results weather success or error can be captured using Set Workflow Result. Errors can be captured in error handling as discussed in Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.



Jira: Create Issue

Description

“Jira Create Issue” plugin step creates an issue in an on-premise or on-cloud version of a JIRA instance.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Base URL  

For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration.

In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/).

3

Username

A username with appropriate permissions to authenticate to JIRA instance and create issueThis field is mandatory.


Password:


4

Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

5

Password /API Key

Password can be entered as Text (for static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Provide an API Key in case of on cloud instance.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

6

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Accept Update fields as JSON

Enable checkbox to accept the fields to be updated in JSON format.

2

Update fields JSON

Select the field in the stream containing the JSON text.

Sample JSON is shown below: {"Summary":"sumaryfromAE","Project":"SP","Priority":"Medium","description":"Dec from AE","Issue Type":"Bug"}

The JSON field can be any field in the stream or can be created using any step such as Generate Rows, Modified Java Script, Set field value to a constant etc.


Tabular Fields:

Choose fields and provide field values to create a Jira issue.

3

Variable Field Name

This is an optional field. Choose a field in input stream from drop down list or provide a user or system defined variable.

4

Static Field Name

Clicking on this column field brings a dialog with the list of available fields to create an issue.

5

Field Value

Specify a Field value to hold the value of field name selected in Field Name column above.


All the mandatory fields for creating an issue for a particular instance must be selected and the field values should be provided else the workflows throws error mentioning the mandatory field that is missing


Output Tab:

No.

Field Name

Description


Output Fields:


1

ID

Output field to hold the ID of the issue created on successful plugin execution. The mandatory fields depend on the particular instance configurations.

2

Key

Output field to hold the key of the issue created on successful plugin execution


Errors can be captured in error handling as discussed Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.



Result:

There is no explicit output Result field in this plugin. Plugin results weather success or error can be captured using Set Workflow Result. Errors can be captured in error handling as discussed in Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.


Jira: Attach File to Issue

Description

This plugin attaches a file to an issue in on premise or on-cloud version of JIRA Software.


Prerequisites:

  1. JIRA instance (JIRA-8.0.2 (On-Premise) and JIRA  (On-Cloud)) and access details 
  2. json-20180130.jar must be present in lib folder of Process Studio as well as AE.

Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


1

Base URL

For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration.

In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/).

2

Username

A username with appropriate permissions to authenticate to JIRA instance and attach file to an issueThis field is mandatory.


Password:


3

Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

4

Password/API Key

Password can be entered as Text (for static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Provide an API Key in case of on cloud instance.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

5

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Issue Key

Issue Key of the issue to be deleted.


Note Limitation: REST API can get maximum of 1000 and 100 issues for on-premise and on-cloud instances respectively. This is an intentional limitation on JIRA applications to avoid performance-related issues such as an OutOfMemoryException.

2

Button: Get

Clicking on this button brings up the issue keys available as per the access permission of Username provided in Connection.

3

File

File path of the file to be attached to the issue.

4

Button: Browse File…

Clicking on this button brings up the dialog to browse the file which is to be attached to the issue.



Jira: Delete Issue 

Jira Delete Issue Plugin step deletes an issue in an instance of JIRA software.


Prerequisites:

  1. JIRA instance and access details 
  2. json-20180130.jar must be present in lib folder of Process Studio as well as AE.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Base URL

For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration.

In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/).

3

Username

A username with appropriate permissions to authenticate to JIRA instance and delete projectThis field is mandatory.

4

Password:



Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

5

Password/API

Provide password of the username to authenticate in case of on premise instance and API Key in case of on cloud instance 

Password/API is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password/API field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

6

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Issue Key

Specify an Issue Key of the issue to be deleted.

2

Button: Get

Clicking on this button brings up the issue keys available as per the access permission of Username provided in Connection.



Jira: Download Attachments

Description

This plugin step downloads all the attachments associated with a JIRA issue in an on premise or on-cloud version of JIRA instance.


Prerequisites:

  1. JIRA instance (JIRA-8.0.2 (On-Premise) and JIRA  (On-Cloud)) and access details 
  2. json-20180130.jar must be present in lib folder of Process Studio as well as AE.

Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


1

Base URL

For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration.

In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/).

2

Username

A username with appropriate permissions to authenticate to JIRA instance and attach file to an issueThis field is mandatory.

3

Password:


4

Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

5

Password/API Key

Password can be entered as Text (for static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Provide an API Key in case of on cloud instance.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

7

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Issue Key

Issue Key of the issue to be deleted.

Note Limitation: REST API can get maximum of 1000 and 100 issues for on-premise and on-cloud instance respectively. This is an intentional limitation on JIRA applications to avoid performance-related issues such as an OutOfMemoryException.

2

Button: Get

Clicking on this button brings up the issue keys available as per the access permission of Username provided in Connection.

3

Output Folder Path

File path of the file to be attached to the issue.

4

Button: Browse Folder

Clicking on this button brings up the dialog to browse the path of an output folder to download attachments for the issue key specified.

5

Delete Output Folder Contents before

Mouse hover to see the allowed values “Yes”, “No”. Type Yes to delete output folder contents before downloading new files, otherwise type No

6

Add DataTimeStamp for Duplicate Files

Mouse hover on this field to see that the allowed values are “Yes” or “No”. Type Yes to Download files and add DataTimeStamp. This is useful in case of duplicate files. 

7

Add File to Result

Allowed values: ‘Yes’ or ‘No’

Provide ‘Yes’ if you wish to provide a link to download the attachment on AutomationEdge else provide ‘No’.


Output Tab:

No.

Field Name

Description


Output Fields:


1

Total Files

Specify a field name to hold the total files upon successful plugin execution. Default field name is “Total Files”. This field is mandatory.

2

Downloaded Files

Specify a field name to hold the number of the Downloaded Files.

3

Overwritten Files

Specify a field name to hold the total number of the Overwritten Files.


Errors can be captured in error handling as discussed in Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.



Jira: Get Transition

Description

This plugin gets a list of the transitions possible for a provided issue (issue key) in an on premise or on-cloud version of JIRA instance.


Prerequisites:

  1. JIRA instance (JIRA-8.0.2 (On-Premise) and JIRA  (On-Cloud)) and access details 
  2. json-20180130.jar must be present in lib folder of Process Studio as well as AE.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


1

Base URL

For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration.

In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/).

4

Username

A username with appropriate permissions to authenticate to JIRA instance and get TransitionsThis field is mandatory.


Password:


5

Password/API Key

Password can be entered as Text (for static value or environment variable). This field is mandatory.


Provide an API Key in case of on cloud instance.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

7

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Issue Key

Specify an Issue Key whose transition status is to be retrieved. Clicking the Get button next to it retrieves the available issue keys as described below.


Note Limitation: REST API can get maximum of 1000 and 100 issues for on-premise and on-cloud instances respectively. This is an intentional limitation on JIRA applications to avoid performance-related issues such as an OutOfMemoryException.

2

Button: Get 

Click the Get button to retrieve the available issue keys as per the access permission of Username provided in Connection.


Output Tab:

No.

Field Name

Description


Output Fields:


1

Transition Name

Output field to hold the Transition Name as a result of the step execution.

2

Transition ID

Output field to hold the Transition ID as a result of successful plugin execution. Default field name is “Result”. This field is mandatory.

Note: Errors can be captured in error handling as discussed in Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.


Jira: Link Issues 

Description

Jira Link Issues Plugin step creates a link between two issues in an instance of JIRA software.


Prerequisites:

  1. JIRA instance and access details 
  2. json-20180130.jar must be present in lib folder of Process Studio as well as AE.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Base URL

For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration.

In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/).

3

Username

A username with appropriate permissions to authenticate to JIRA instance and get issueThis field is mandatory.

4

Password:



Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

5

Password/API

Provide password of the username to authenticate in case of on premise instance and API Key in case of on cloud instance 

Password/API is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password/API field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

6

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Issue Key

The Key of the inward issue for which link is to be created. The issue key can be chosen from a pop-up obtained by clicking the Get button next to it as described below.


REST API returns maximum of 1000 and 100 issues for on-premise and on-cloud instance respectively. This is an intentional limitation on JIRA applications to avoid performance-related issues such as an OutOfMemoryException.

2

Get

Clicking on this button brings up the issue keys available as per the access permission of Username provided in Connection.

3

Issue Link Type

Type of the link to be created between the two issues. Following are the issue link types,

  1. is duplicated by
  2. duplicates
  3. clones
  4. relates to
  5. blocks
  6. is cloned by
  7. is blocked by

The issue link type can be chosen from a pop-up obtained by clicking the Get button next to it as described below.

4

Get

Clicking on this button brings up the available Issue Link Types.

5

Issue Key to be linked

The Key of the outward issue with which the link is to be created.

6

Get

Clicking on this button brings up the issue keys available as per the access permission of Username provided in Connection.



Jira: Perform Transition

Description

JIRA perform transition plugin step performs a transition of an issue in a JIRA instance.


Prerequisites:

  1. JIRA instance and access details
  2. json-20180130.jar must be present in lib folder of Process Studio as well as AE.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


1

Base URL

For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration.

In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/).

4

Username

A username with appropriate permissions to authenticate to JIRA instance and perform a transitionThis field is mandatory.


Password:


5

Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password/API Key

Password can be entered as Text (for static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Provide an API Key in case of on cloud instance.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

7

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Issue Key

Specify the Key of the issue on which transition is to be performed.


Note Limitation: REST API can get maximum of 1000 and 100 issues for on-premise and on-cloud instances respectively. This is an intentional limitation on JIRA applications to avoid performance-related issues such as an OutOfMemoryException.

2

Button: Get 

Click this button to get all Issue Keys available in the JIRA instance as per the access permission of Username provided in Connection. 

3

Transition Name/ID

Specify the Name or ID of the transition to be performed.  You may get the Name of the transition by clicking the Get button as described below.

4

Button: Get

Clicking on this button brings a dialog for all the Transitions Names possible for the provided issue. 

Errors can be captured in error handling as discussed in Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.



Jira: Remove Label

Jira Remove Label Plugin step removes a label value in an instance of JIRA software.


Prerequisites:

  1. JIRA instance and access details 
  2. json-20180130.jar must be present in lib folder of Process Studio as well as AE.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Base URL

For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration.

In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/).

3

Username

A username with appropriate permissions to authenticate to JIRA instance and delete projectThis field is mandatory.

4

Password:



Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

5

Password/API

Provide password of the username to authenticate in case of on premise instance and API Key in case of on cloud instance 

Password/API is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password/API field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

6

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Issue Key

Specify an Issue Key of the issue to be deleted.

2

Button: Get

Clicking on this button brings up the issue keys available as per the access permission of Username provided in Connection.

3

Label

Specify a label value to be removed from an issue.



Jira: Update Issue

This plugin step updates a JIRA issue on on-premise or on-cloud versions of a JIRA instance.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Base URL  

For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration.

In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/).

3

Username

A username with appropriate permissions to authenticate to JIRA instance and update issueThis field is mandatory.


Password:


4

Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

5

Password/API Key

Password can be entered as Text (for static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Provide an API Key in case of on cloud instance.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

6

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Issue Key

The key of an issue to be updated. This field is mandatory.

2

Button: Get

Clicking on this button brings up the issue keys available as per the access permission of Username provided in Connection.

3

Accept Update fields as JSON

Enable checkbox to accept the fields to be updated in JSON format.

4

Update fields JSON

Select the field in the stream containing the JSON text.

Sample JSON is shown below: {"Summary":"sumaryfromAE","Project":"SP","Priority":"Medium","description":"Dec from AE","Issue Type":"Bug"}

The JSON field can be any field in the stream or can be created using any step such as Generate Rows, Modified Java Script, Set field value to a constant etc.


Tabular Fields:

Choose fields and provide field values to create a Jira issue.

5

Variable Field Name

This is an optional field. Choose a field in input stream from drop down list or provide a user or system defined variable.

6

Field Name

Clicking on this column field brings a dialog with the list of available fields that can be updated in the issue and as per the access permission of Username provided in Connection.

7

Field Value

Provide an updated value for the field name selected in Field Name column above.


Result:

There is no explicit output Result field in this plugin. Plugin results weather success or error can be captured using Set Workflow Result. Errors can be captured in error handling as discussed in Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.



Jira: Add User to Group 

Description

Jira: Add User To Group plugin step adds a user to a group on on-premise or on-cloud versions of a JIRA software instance.


Prerequisites:

  1. JIRA instance and access details 
  2. json-20180130.jar must be present in lib folder of Process Studio as well as AE.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Base URL

For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration.

In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/).

3

Username

A username with appropriate permissions to authenticate to JIRA instance and change user passwordThis field is mandatory.


Password:


4

Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

5

Password/API Key

Provide password of the username to authenticate in case of on premise instance and API Key in case of on cloud instance 

Password/API is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password/API field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

6

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Username/Account ID

Username of the user to be added to a specific Group. 

The data type is String. This field is mandatory.


Note:

Account ID can be found in the URL of the cloud instance when you open user profile. (e.g. https://admin.atlassian.com/s/68f0ebf6b0dded/users/5e4d195e9706)

2

Group Name

Specify the Group name in which the user is to be added.

Groups displayed on Get button is set to max limit of 100.

The data type is String. This field is mandatory.

3

Button: Get 

Clicking on this button brings up the list of Group Names.

Groups displayed on the Get button are set to a max limit of 100.



Jira Remove User from Group 

Jira Remove User from Group Plugin Step removes a specified user from a group on on-premise or on-cloud versions of a JIRA software instance.


Prerequisites:

  1. JIRA instance and access details 
  2. json-20180130.jar must be present in lib folder of Process Studio as well as AE.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Server Name  

The JIRA instance name/IP/hostname should be provided.

3

Port

The port number of the JIRA instance should be provided.

4

Username

A username with appropriate permissions to authenticate to JIRA instance and remove a user from a groupThis field is mandatory.


Password:


5

Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password/API

Provide password of the username to authenticate in case of on premise instance and API Key in case of on cloud instance 

Password/API is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password/API field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

7

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Username/Account ID

Username/key of the user to be removed from a specific group.

The Username in case of server instance and Account ID in case of a cloud instance. The data type is string. This field is mandatory.


Note:

Account ID can be found in the URL of the cloud instance when you open user profile. (e.g. https://admin.atlassian.com/s/68f0ebf6b0dded/users/5e4d195e9706)

2

Button: Get Username

Clicking on this button brings up the list of the usernames as per the access permissions of Username provided in Connection.

3

Group Name

Specify the group name from which the user is to be removed.

Note: Groups displayed on the Get button are set to a max limit of 100.

4

Button: Get

Clicking on this button brings up a list of the groups as per the access permissions of the Username provided in Connection.



Jira Create Project

Description

Jira Create Project plugin step is designed to create a software or business project in an instance of JIRA software.

The project types seen in the screenshot below can also be chosen in the plugin options as described in the Input Tab table below.




Prerequisites:

  1. JIRA instance and access details 
  2. json-20180130.jar must be present in lib folder of Process Studio as well as AE.



Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Server Name  

The JIRA instance name/IP/hostname should be provided.

3

Port

The port number of the JIRA instance should be provided.

4

Username

A username with appropriate permissions to authenticate to JIRA instance and create projectThis field is mandatory.


Password:


5

Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password/API

Provide password of the username to authenticate in case of on premise instance and API Key in case of on cloud instance 

Password/API is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password/API field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

7

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Project Key

Provide a project key for the new project.

2

Project name

Provide the name of the new project to be created.

3

Project type

Provide a project type. The list of project types can be populated using the Get button described below. 

4

Button: Get

Clicking on this button brings up a list of project types (viz. software, ops, service_desk, business).

5

Project Template Key

Select a valid project Template Key based on the type of project selected. The list of Project Template Keys can be populated using the Get button described below.

6

Button: Get

Clicking on this button brings up a list of project Template Keys as below,


  1. com.pyxis.greenhopper.jira:gh-scrum-template
  2. com.pyxis.greenhopper.jira:gh-kanban-template
  3. com.pyxis.greenhopper.jira:basic-software-development-template
  4. com.atlassian.jira-core-project-templates:jira-core-project-management
  5. com.atlassian.jira-core-project-templates:jira-core-task-management
  6. com.atlassian.jira-core-project-templates:jira-core-process-management

7

Project description

Provide the description of the new project to be created

8

Project lead(Username/Account ID)

Mention the Username(/Account ID) who  will be set as the lead for the new project.(This will accept only valid users on JIRA)

9

Button: Get Username

Clicking on this button brings up the list of JIRA usernames.

10

URL

Provide a URL for online help



Jira Delete Project 

Description

Jira Delete Project Plugin step deletes a JIRA project in an instance of JIRA software.


Prerequisites:

  1. JIRA instance and access details 
  2. json-20180130.jar must be present in lib folder of Process Studio as well as AE.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Server Name  

The JIRA instance name/IP/hostname should be provided.

3

Port

The port number of the JIRA instance should be provided.

4

Username

A username with appropriate permissions to authenticate to JIRA instance and delete projectThis field is mandatory.


Password:


5

Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password/API

Provide password of the username to authenticate in case of on premise instance and API Key in case of on cloud instance 

Password/API is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password/API field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

7

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


2

Project Key/Id

Provide Project key or id of the project to be deleted.


Jira Delete User


Description

Jira Delete User Plugin step is designed to delete a user in an instance of JIRA software. 


Prerequisites:

  1. JIRA instance and access details 
  2. json-20180130.jar must be present in lib folder of Process Studio as well as AE.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Server Name  

The JIRA instance name/IP/hostname should be provided.

3

Port

The port number of the JIRA instance should be provided.

4

Username

A username with appropriate permissions to authenticate to JIRA instance and create userThis field is mandatory.


Password:


5

Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password/API

Provide password of the username to authenticate in case of on premise instance and API Key in case of on cloud instance 

Password/API is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password/API field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

7

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Username/Account ID

Provide the Username/Account ID of the user to be deleted.

The Username in case of server instance and Account ID in case of a cloud instance. The data type is string. This field is mandatory.


Note:

Account ID can be found in the URL of the cloud instance when you open user profile. (e.g. https://admin.atlassian.com/s/68f0ebf6b0dded/users/5e4d195e9706)

2

Button: Get Users

Click Get Users button to get the list of all available JIRA users.



Jira: Create Group 

Jira Create Group plugin step creates a group in an instance of Jira Software.



Prerequisites:

  1. JIRA instance and access details 
  2. json-20180130.jar must be present in lib folder of Process Studio as well as AE.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Base URL

For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration.

In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/).

3

Username

A username with appropriate permissions to authenticate to JIRA instance and create groupThis field is mandatory.


Password:


4

Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

5

Password/API Key

Provide password of the username to authenticate in case of on premise instance and API Key in case of on cloud instance 

Password/API is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password/API field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

6

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Group Name

Name of the new Jira Group to be created.

The data type is String. This field is mandatory.


Known Issue: For cloud instance, if multiple groups are created within a short time span (say through Excel input or using a loop), it may give “Internal server error”. This issue can be minimized by adding an appropriate delay before this step.




Jira: Remove Group 

Description

Jira Remove Group Plugin step removes a specified group in an instance of JIRA software.


Prerequisites:

  1. JIRA instance and access details 
  2. json-20180130.jar must be present in lib folder of Process Studio as well as AE.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Base URL

For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration.

In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/).

3

Username

A username with appropriate permissions to authenticate to JIRA instance and remove a user from a groupThis field is mandatory.


Password:


4

Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

5

Password/API Key

Provide password of the username to authenticate in case of on premise instance and API Key in case of on cloud instance 

Password/API is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password/API field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

6

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Group Name

Name of the group to be removed. 

The data type is String. This field is mandatory.

2

Button: Get

Clicking on this button brings up the list of groups.

Note: Groups displayed on Get button is set to max limit of 100.



Jira: Change User Password (Server) 

Description

Jira Change User Password plugin step changes the user password in an instance of Jira Software.


Prerequisites:

  1. JIRA instance and access details 
  2. json-20180130.jar must be present in lib folder of Process Studio as well as AE.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Base URL

For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration.

In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/).

3

Username

A username with appropriate permissions to authenticate to JIRA instance and change user passwordThis field is mandatory.


Password:


4

Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

5

Password

Provide password of the username to authenticate to an on premise instance 

Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

6

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Username

Username of the user who’s password is to be changed. 

The data type is String. This field is mandatory.

3

New Password

New password to be set for the specific user. 

The data type is String. This field is mandatory.



Jira Get Issue 

Description

Jira Get Issue Plugin step gets an issue from an instance of JIRA software.


Prerequisites:

  1. JIRA instance and access details 
  2. json-20180130.jar must be present in lib folder of Process Studio as well as AE.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Base URL  

For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration.

In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/).

4

Username

A username with appropriate permissions to authenticate to JIRA instance and get issueThis field is mandatory.


Password/AP Key:


5

Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password/API Key

Provide Password of the username to authenticate in case of on premise instance and API Key in case of on cloud instance 

Password/API is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory. If checkbox above is enabled Password/API field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Note: 

Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

7

Test Connection

Verifies whether the connection is established or not.

Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Issue Key

Specify the issue key of an issue to get. The issue key can be chosen from a pop-up obtained by clicking the Get button next to it as described below.


Note Limitation: REST API can get maximum of 1000 and 100 issues for on-premise and on-cloud instances respectively. This is an intentional limitation on JIRA applications to avoid performance-related issues such as an OutOfMemoryException.

2

Get

Clicking on this button brings up the issue keys available as per the access permission of Username provided in the Connection.


Note:  The latest 50 issues are displayed which is the default outcome of the REST call.


Output Tab:

No.

Field Name

Description


Output Fields:

Either JSON Output or Table Fields should be selected in the Output tab.

1

JSON Output

Enable checkbox to Get Issue fields as JSON text.

2

JSON Output Field

If ‘JSON Out’ checkbox is enabled this field is activated. Provide a field to capture the JSON text. 

JSON text contains key-value pairs enclosed by double quotes (“) enclosure with a colon separating them. Key-value pairs denote field Ids and their values. 


Sample output JSON for field Id status in Issues is shown below

"status": {

           "self": "http://localhost:8003/rest/api/2/status/10000",

           "description": "",

           "iconUrl": "http://localhost:8003/images/icons/status_generic.gif",

           "name": "To Do",

           "id": "10000",

           "statusCategory": {

               "self": "http://localhost:8003/rest/api/2/statuscategory/2",

               "id": 2,

               "key": "new",

               "colorName": "blue-gray",

               "name": "To Do"

           }


Note: 

  1. At least one output field must be provided. Either using JSON or Table Fields.
  2. The  Field names and  their respective   Ids can be found using below REST call GET {Instance URL }/rest/api/2/field


Table Fields:


3

Field Name

On the click of this cell, field explorer appears with Issue Field Names (Display names). Select the fields whose values are to be fetched.

4

Output Field

Specify an output field to hold the field values.





      Links to better reach 

            Bot Store

             EPD