Slack-Jira User Manual
This Slack-Jira Add-on User Manual is aimed to assist with operating on provided features and exploiting the functional benefits of the systems integration. Add-on setup and administration description is available in the “Slack-Jira Add-on Administration Manual”.
This is a part of Slack-Jira guides that unveil all features and related use cases for building effective workflows. Full set of documentation includes:
Slack-Jira Add-on User Manual (current guide)
Bitband Team recommends get a grasp of these manuals to shorten deployment time and smooth adoption.
Slack-Jira plugin lets you combine the best from both domains - strict, organized handling of Jira tickets and dynamic, human-centric Slack chats. Environment for software projects has never been so handy, intelligible and fun.
Try the Slack-Jira Add-on in three easy steps:
Table of Contents
1. Control Jira from Slack
Slack-Jira Add-on provides powerful feature of controlling and manipulating Jira issues and related parameters directly from a Slack chat. This chapter contains a textual description of the available commands and their syntax.
For quick introduction there is a video clip about Slack slash commands and their practical usage scenarios. Double click on video to switch it to the full screen and watch in all details.
Slash commands can be used from any Slack-Jira connected chat. Even if a chat receiving notifications from a certain project the commands from it can access any project and/or issues inside the Jira account.
All ticket types created programmatically using Slack slash commands have default Reporter field set to Jira account used for systems pairing. This can be changed by passing ";reporter" option along with a command.
1.1. Commands Brief Reference
To obtain a short help about available commands list, their names and options use next command.
To get a more detailed information on a certain command:
Commands and options are case insensitive.
1.2. Set Default Jira Project for a Chat
This command allows to define Jira project which will be manipulated by subsequent commands, (for example - jira create).
/jira project <jira-project-id>
However, target project can also be specified for each command through additional parameter.
1.3. Create Jira Issue
The command creates an issue with the specified fields.
/jira create :[option] <value>
:summary - (required) - sets the summary for an issue.
:issuetype - (optional) - specifies the type of an issue. Default value: task. Basic applicable values are: “task”, “bug”, “story”. Custom issue types are supported as well.
:desc - (optional) provides description for a Jira issue.
:priority - (optional) - issue priority. Value should match one of the following strings: “highest”, “high”, “medium”, “low”, “lowest”.
:assignee - (optional) - passes assignee Jira id. Value should match existing Jira user id.
:reporter - (optional) - indicates an account who reports the issue. Default value: current Slack user. Specified values should match one of the existing Jira accounts id.
:project - (optional) - a Jira project id. If a project value was preliminary specified with “jira project” command then it will be used by default.
1.4. Obtain Information about Jira Issue
To quickly retrieve data about Jira issue the one can use the next command.
/jira get <jira-issue-id> [detail]
detail - (optional) - next data will be obtained: project name, issue number, issue summary, issue description, assignee, issue reporter, components, and issue status.
Without the option the command retrieves next fields from a specified issue: project name, issue id, issue summary, issue description, assignee.
1.5. Manipulate Jira Issue Statuses
Slack-Jira Add-on allows to control ticket statuses directly from a chat window.
/jira transition <jira-issue-id>
Command execution will result in rendering a list of available statuses for the specified jira issue.
Select and press on a new status to finalize the transaction.
1.6. Search Jira Issues using JQL Syntax
This command provides powerful feature utilizing Jira Query Language capabilities.
/jira search <JQL request>
Command output will provide a list of jira issues which content matches query.
Full description of JQL opportunities and related parameters can be found on Attlasian web-page: https://confluence.atlassian.com/jirasoftwarecloud/advanced-searching-764478330.html
1.7. Assign a Jira Issue
Jira issue assignee field can be changed using the “assign” command.
/jira assign <jira-issue-id>
With correct Jira issue specified the output will provide a drop-down list of Jira users that can be appointed as new assignee.
Once new user was chosen a new issue status contains project name, issue and new assignee will be displayed.
2. Frequently Asked Questions
Slack-Jira Add-on delivers vast number of opportunities and fits numerous use cases. FAQ sections reveals related inquiries from our Users as well as described edge cases for faster adoption of an improved Slack-Jira based workflow.
Is there a way to disable Jira update notifications in Slack channels?
There are several ways of how to accomplish this. You can pick one of them:
Deactivate appropriate values in “Filters” menu using “Basic filter” or “Advanced JQL filter” modes (“Jira Settings” → “System” → “Slack Integration” → pick channel type → pick channel → “Filters”).
Disable events update type in the channels menu (“Jira Settings” → “System” → “Slack Integration” → pick channel type → pick channel → “Events”).
For “Issue channels” it’s possible to disallow any notifications using the appropriate control “Allow Slack notifications from individual JIRA issues” (“Jira Settings” → “System” → “Slack Integration” → “Issue channels” → deactivate a switch).
How do I reach Slack-Jira Integration Add-on menu?
Here is the short path to open appropriate settings: “Jira Settings” → “System” → “Slack Integration”.
Is Jira-Slack Integration Add-on available for standalone Jira versions?
At the moment the service is only available for Atlassian Cloud installation. Bitband explores options to release hosted version of Slack-Jira.
If you have a specific interest in this product consider contacting us: firstname.lastname@example.org
Is Jira-Slack Integration Add-on available for Jira Software Data Center?
It’s on the roadmap but not yet available for public distribution.
If you have a specific interest in this product consider contacting us: email@example.com
Is it possible to disable “Issue channels” for Jira and disable Slack channels creation from the issue?
Currently this option is not available but Bitband Team is working on providing a solution for this use case.
Here is the constantly updated list of pitfalls and known problems and how to workaround them.
What might be the issue with event notifications not being forwarded to Slack?
The following reasons are the most probable cause of the malfunctioning - insufficient permissions and incorrect configuration.
Firstly, check if a Slack account used for integration has administrative privileges. If an account with regular permissions was used then disconnect it and complete the steps described in “Slack-Jira Integration in Details” chapter.
Secondly, check that Slack channels used in the Add-on configuration are still exist.
Once Slack and Jira properly integrated the channel settings should be revised for possible misconfigurations. Validate all existing channels for “Filters”, “Events” and “Options” configurations.
If the issue is still unresolved contact Bitband Support Team: firstname.lastname@example.org.
Why every time a Slack channel is created my account is put as an originator and I’m invited to join it?
As it is recommended in “Slack-Jira Integration in Details” section systems pairing better be accomplished using separate Slack account with administrative privileges.
When customizing the Add-on I get "Error while set cookie!" error message. How can I fix it?
This is rare problem which has very simple solution - just reload the frame by pressing right mouse button on the page area and choosing appropriate option from the browser's menu. Usually, it has identical name.
As an alternative solution you can reload the whole page. Use next keyboards shortcuts:
Chrome/Chromium: on Windows OS press Ctrl+R; on macOS - Cmd+Shift+R.
Firefox: on Windows OS press Ctrl+F5; on macOS - Cmd+Shift+R.
Edge/Internet Explorer: on Windows OX press F5 or Ctrl+R.
or use appropriate option in the browser's menu.
When I try to create an issue from Slack slash command I get "500_service_error". How can I fix it?
This error appears if you try to use issue types that are not activated in Jira. Review and enable necessary issue types in project settings. You can find appropriate settings following the next path:
"Open the project - "Project Settings" - "Issue Types" - "Add Issue Type" - select (or create) issue type - press "Add" button". Now the issue type should be accessible from slash commands.