Getting Started with Dynamic Issue Instructions
- Sales Rixter AB
Dynamic Issue Instructions is a Atlassian Forge app that provides the ability to add instructions that change dynamically when the issue changes status. The user can setup different instructions per issue type and status which makes it powerful to customize.
Installation
Install it through the Atlassian Marketplace
Project Admin Usage
Go to the project settings page (cog) and expand Apps section.
Click on Instructions menu item
Click on Create Issue Instruction button
Select Issue type and Status
In the description text box enter the instruction that you which to show on the issue for the selected status, use variables to get access to issue data in the instruction.
Click Save and the instruction is stored and will show up on the issue.
Use variables in instruction text to enrich the instruction
Variable | Description | Syntax example |
|---|---|---|
{{key}} | issue key |
|
{{id}} | issue id |
|
{{description}} | description of the issue, specially stored and accessed by the syntax to the right | {{description.content[0].content[0.text} |
{{assignee}} | assignee object, select what info from the assignee to display | {{assignee.displayName}} |
{{reporter}} | reporter object, select what info from the reporter to display | {{reporter.displayName}} |
{{creator}} | creator object, select what info from the creator to display | {{creator.displayName}} |
{{priority}} | priority object, select what info from the priority to display | {{priority.name}} |
{{fixVersions}} |
|
|
{{customfield_xxxxx}} | access any customfield value |
|
{{labels}} |
|
|
{{versions}} |
|
|
{{issuelinks}} |
|
|
{{status}} | status object, select what info from the status to display | {{status.name}} {{status.statusCategory.name}} |
{{components}} |
|
|
{{issuetype}} | issuetype object, select what info from the issuetype to display | {{issuetype.name}} |
{{project}} | project object, select what info from the project to display | {{project.name}}, {{project.key}} |
{{created}} |
|
|
{{updated}} |
|
|
{{summary}} |
|
|
{{duedate}} |
|
|
{{environment}} |
|
|
{{comment}} | comment object, select what info from the comment to display | {{comment.comments[0].author.displayName}} {{comment.comments[0].content[0].content[0.text}} |
User Usage
Click on the Instructions button on the issue. (needs to be done 1st time)
View the Instructions panel.
Transition the issue and enjoy the guidance of the instructions.