Add Comment
AutomatR.Jira.Activities.AddComment
The "Add Comment" activity in AutomatR's Jira package utilizes the Jira API to add a comment to a specific JIRA issue. This activity streamlines the process of updating issue comments, enhancing automation capabilities for issue tracking and collaboration.
Properties
| Name | Description |
|---|---|
| Input | |
| Comment | Specifies the text of the comment to be added to the JIRA issue. String variables containing the comment text. |
| Ticket ID | Specifies the Ticket ID of the JIRA issue to which a comment should be added. Either the "Ticket ID" or "Ticket Key" must be provided. String variables containing the Ticket ID. |
| Ticket Key | Specifies the Ticket Key of the JIRA issue to which a comment should be added. Either the "Ticket ID" or "Ticket Key" must be provided. String variables containing the Ticket Key. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Add Comment" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Result | Outputs an object when the comment is added successfully. Variables of relevant types (e.g., dynamic variables) to store the result. |
Validation:
- The activity validates whether either the "Ticket ID" or "Ticket Key" is provided. If neither is provided, a validation error is raised.
How to use:
- Drag and drop the "Add Comment" activity onto the workflow.
- Configure the properties by specifying the Ticket ID or Ticket Key and providing the text of the comment to be added.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to add the comment to the specified JIRA issue.
Example: Consider an example where the "Add Comment" activity is used to add a comment to a JIRA issue with the Ticket Key "PROJ-123":
Add Comment:
Delay: 2
Ticket Key: "PROJ-123"
Comment: "This is a sample comment."
Result: commentResult
In this example, the activity waits for 2 seconds before executing, adds the comment "This is a sample comment" to the JIRA issue with the Ticket Key "PROJ-123." The result of the operation is stored in the dynamic variable "commentResult" for further handling in the workflow.