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”.

Slack-Jira plugin lets you combine the best from both domains - strict, organized handling of Jira tickets and dynamic, human-centric Slack chats. Environments for software projects have never been so handy, intelligible and fun.

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.

Commands Brief Reference

To obtain a short help about available commands list, their names and options use next command.

  • Command syntax:

/jira ?

/jira help

To get a more detailed information on a certain command:

/jira <command-name>

Commands and options are case insensitive.

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).

  • Command syntax:

/jira project <jira-project-id>

However, target project can also be specified for each command through additional parameter.

Create Jira Issue

The command creates an issue with the specified fields.

  • Command syntax:

/jira create :[option] <value>

  • Options:

: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.

Obtain Information about Jira Issue

To quickly retrieve data about Jira issue the one can use the next command.

  • Command syntax:

/jira get <jira-issue-id> [detail]

  • Options:

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.

Manipulate Jira Issue Statuses

Slack-Jira Add-on allows to control ticket statuses directly from a chat window.

  • Command syntax:

/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.

Search Jira Issues using JQL Syntax

This command provides powerful feature utilizing Jira Query Language capabilities.

  • Command syntax:

/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

Assign a Jira Issue

Jira issue assignee field can be changed using the “assign” command.

  • Command syntax:

/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.