How to add the "Add comment" post function
The Add comment post function adds a comment to your issue after a transition. Use this post function to document the current state of your issue fields and transport data when needed.
It may be added to any transition in your workflow. You can use variables to display data from the issue, including the list of transports linked in the SAP Transport Panel.
Step-by-Step Guide
Step | Procedure | Example |
---|---|---|
1 | In Jira, navigate to Admin Menu (cog wheel) → Issues → Workflows → SAP Transport Panel: Original transport management workflow → Edit → Diagram View | |
2 | Select any transition from the workflow and click on Post Functions. | |
3 | Under the tab Post Functions, click on Add post function and select SAP Transport Panel: Add Comment. → Click on Add. | |
4 | Add your text to the Comment field presented in the next screen. Use the placeholder variables listed below to add information from your issue to your text. For example, if you type $issue.transports, SAP Transport Panel will replace this variable with a table listing the transport links as currently presented in your Transport Panel. You may enter up to 32767 characters, the Jira limit for comments. | |
5 | You can mail the contents of this comment to selected user groups. Add a subject line to the Subject field. Choose the user groups that should receive the email from the Recipients field. Members of the chosen groups will be notified whenever the post function executes. Leave the field blank if you do not want to make use of this feature. An SMTP mail server must be configured in Jira for this to work. | |
6 | Click on Add to finish the configuration. If a change to the issue is added in a transition screen, the Add comment post function should also be listed at the bottom so that the changes are carried over. | |
7 | The final sequence should look like the example on the right. Don't forget to publish your workflow to persist the changes made. |
Issue Variables
Add variables by typing $ followed by the variable you need. For example, to add the issue key, type $issue.key.
Field | Variable | Description | Example |
---|---|---|---|
Transport Panel List | $issue.transports | Transport Link List as found in the SAP Transport Panel, data included | |
Jira Project key | $issue.project.key | Key of the project that your issue is included in | SAP Transport Panel |
Issue key | $issue.key | Key of the issue the comment is posted on | SAPTP-17 |
Priority | $issue.priority | Priority text | Medium |
Status | $issue.status | Status text | In Progress |
Resolution | $issue.resolution | Specifies how the issue was resolved | |
Summary | $issue.summary | The issue headline | |
Reporter | $issue.reporter | Name of the user who created the issue | |
Assignee | $issue.assignee | Name of the user assigned to the issue or "Unassigned" | |
Created | $issue.created | Date on which the issue was created | |
Updated | $issue.updated | Date of last update to the issue | |
Due date | $issue.duedate | Date when the issue should be completed | |
Resolved | $issue.resolved | Date when the issue got resolved | |
Labels | $issue.labels | Comma separated list of labels |
Using the standard custom fields
You can also address custom fields by typing in the custom field ID, for example $issue.customfield_10100.
Further information → Atlassian Documentation: Locating the ID of the custom field you need.
The following types of fields are supported:
Field type | Description |
---|---|
Date Picker | Possibility to choose date |
Date Time Picker | Possibility to choose date and time |
Number Field | Possibility to enter only numbers (whole numbers or with decimal places) |
Textfield (multi-Line) | Possibility to enter longer texts |
Textarea (single Line) | Possibility to enter simple text (max 255. characters) |
URL Field | Possibility to enter an URL |
Labels | Possibility to add any Label |
Select List (cascading) | Possibility to choose from two lists. The second list depends on the value in the first list |
Select List (multiple choices) | Possibility to select several options from a defined list |
Select List (single choice) | Possibility to select an option from a defined list |
Radio buttons | List of options, shown as radio buttons - only one can be selected |
Checkboxes | Several options can be ticked in boxes |