📋

Jira

How do I enable the Allma // Jira integration?

You can enable our Jira integration by following these steps:

image
  • You should see our Jira card, with a grey "disabled" toggle:
image
  • By clicking on the toggle, you should now be taken to our Jira Settings page, where you'll see a number of settings. The following are required in order for the Jira Integration to function:
    • API Key - The API Key to use while connecting to Jira
    • User Email - The email address of the User associated with the API Key (case sensitive)
      • Note - It's advised to make a specific user in Jira for this integration, and bind the API Key to this account. This provides two primary benefits:
        • The Allma User in Jira is not tied to an existing employee, and should not be turned off if that employee loses access to Jira for any reason
        • The name of the user who creates Tickets and Comments can be more easily customized by you, in order to not confuse users as to who is posting the updates
    • Jira URL - The URL of your jira server
      • Example: https://example.atlassian.net
      • If your Jira server is not cloud hosted, you will need to confirm with your network / system admins if it's accessible to the internet or not.
    • Project Key - The Jira Project you want your tickets to be created under (case sensitive)
      • Example: A project named "Vanguard" might have the Key "VAN"
      • This is required as at present our integration is optimized for centralizing incident tickets under a single board.
    • Ticket Type - The Jira Ticket Type you want your tickets to be created as (case sensitive)
      • Example: Task
      • You can use Custom Types here, but see the note below.
    • You can confirm the Integration is enabled by navigating back to the Integrations Page as above, where you should see that the Integration Card now displaying a green enabled status.
image

How does the Allma // Jira integration work?

The Allma // Jira integration is a low-touch way to help you manage tracking your incidents "offline" from where you manage them, which is in Slack. Many teams and organizations have requirements around tracking certain information in systems like Jira, and our integration is optimized to help you do that.

The primary way it works is to enable creating tickets based off the Incident itself when you declare one, and providing a way for interested parties who are keen to get information and updates but are not required / whose presence might be a distraction in the incident channel itself.

Using the existing notification and subscription functionality available to all Jira users, a process where you make tickets for each incident, and allow interested parties to watch and subscribe to those tickets is an efficient way to ensure all parties stay up to date.

When an incident is created, you should expect a ticket like so to be create:

image

This will provide a brief summary based on incident data, and link to the incident itself in Allma as well as to the incident channel itself in Slack.

If you've configured it to push Timeline updates to the ticket, you'll receive comments from the user who you've configured the Integration to run as that look like so:

image

What can I customize with the Allma // Jira integration?

You can customize the following things:

  • The Project the ticket is assigned to
  • The Type of ticket which is created
  • Ticket Creation - Automatically create a ticket for each new incident?
    • Selecting No will still allow you to optionally create a ticket when declaring an incident
    • Selecting Yes will enforce all incidents get tickets, and will not provide the ability to override the setting at incident time.
  • Ticket Updating - Automatically add a comment to the associated ticket when an incident has a timeline update?
    • Selecting No will prevent timeline entries from being automatically appended to the ticket via comments
    • Selecting Yes will ensure all timeline entries, from slack or the UI, are appended to the ticket via comments

Can I alter how I have Jira configured after the fact?

Yes!

  • Navigate to our Settings Page:
image
  • Click on "Jira" under the Integrations section on the left sidebar:
image

From here, you can change any of your settings at any time.

Understand that if you make a change, those settings will begin to reflect nearly immediately - so be careful about updating the settings if you're not sure about the changes you're making.

Can I use Custom Ticket Types with Jira?

Yes!

Depending on what type of Project you use (scrum vs kanban) or possibly the age of your Jira instance, there can be multiple ways to configure a custom ticket type. Please see the relevant Jira documentation for your project type and server.

A good litmus test is "When creating a new ticket from the UI, do I see the option to use this ticket type?"

  • If yes, Allma should be able to use it for you, provided you give us the type correctly spelled and cased
  • If no, you likely need to look into your jira configuration and ensure that the type is properly available to that Project and potentially any relevant Screens and Schemas (again, depending on Project Type and Jira version)

Can I create Epics with Jira?

Yes!

Just enter the "Epic" ticket type during configuration.

Remember that Jira organizes Epics differently from other tickets, and they may not appear directly in your backlog. However the Epic will contain all the same information as other tickets, and can receive updates via comments as well.

What permissions does the Jira user need?

At minimum, a Jira User needs the following in order to use all of our functionality

  • Browse Projects
  • Create Issues
  • Add Comments