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.
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 issue. This 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 |
| 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 Fields | ||
| 1 | Issue Key | Issue Key of the issue to be deleted. Note: 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 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 the step error handling (right-click step and select error handling) to make the error message visible on AutomationEdge Requests. |