Jira Service Desk Permission (Cloud) Access Requirements

Why do we need access to your Jira ServiceDesk?

The bot will directly perform actions in Jira to create, update, and query information about tickets.

NOTE: All end users are required to exist as "Customers" in the Jira Service Desk project in order to create/update/query tickets through the bot.

Production Environment

In your Production Jira environment, the following accounts are needed (set to America/Danmarkshavn timezone):

  • A dedicated service account for the bot in Jira to read/update tickets and read users/KB articles.
    • In the Atlassian Admin page, assign the jira-servicedesk-users role
    • In the Jira Service Desk Project Settings, assign the Service Desk Team role
  • 1 agent account (for testing & end-to-end validation) with Service Desk Team role
  • 1 user account (for testing & end-to-end validation) with Service Desk Customers role

Along with the service account, please provide an XML export of your Jira Service Desk workflow. See instructions here on how to export your workflow: https://support.atlassian.com/jira-cloud-administration/docs/import-and-export-issue-workflows/

What is this account used for:

The Moveworks service interacts with your Jira platform so that the bot can:

  • monitor tickets for autonomous resolution
  • reach out to an employee when a Jira ticket needs the employee's attention
  • create tickets to log issues the bot has resolved autonomously
  • create tickets for issues that require an agent's attention
  • read the Jira user roster so that the bot can log and assign issues appropriately
  • read Jira forms from your portal to it can serve them to end users when applicable

Jira API Token

Create a dedicated service account as above. API access for Jira Cloud is done through a username and API token. Here are the steps to create an API token for a Service Account:

  1. Log in to https://id.atlassian.com/manage/api-tokens using the Service Account user credentials.
  2. Click Create API token.
  3. From the dialog that appears, enter a label for the token (Moveworks) and click Create.
  4. Click Copy to clipboard, then share the token along with account username with your Moveworks Customer Success team.

Jira Identity Application

Due to Atlassian GDPR requirements, ingesting user information such as Jira ID, email, and name cannot be done with a service account and requires Atlassian approved application. The Moveworks Jira Identity Application is an Atlassian approved application used to integrate Jira Cloud as an identity source in Moveworks.

Testing Environment

For testing, please clone the production project to a separate test project in the same production Jira environment, utilizing the same workflows and ticket types. (Note: tickets from the production project do not need to be cloned to the test project). Also, provide the above accounts same level of access to this project as they have in the production project. This project will be used for testing purposes and during the IT Testing phase, before switching over to production and rolling out the bot to all users.

What is this account used for:

  • The account in your test Jira project is used by Moveworks to validate integration changes before they are deployed to production

Appendix - Required Jira Settings

States

Moveworks categorizes your states into the following buckets. If there is no corresponding state, your Moveworks team may recommend an additional state.

  • New / Reopened
  • In Progress
  • Waiting for User
  • Resolved / Closed

Transitions

Moveworks requires the following workflow transitions to function as expected:

  • All → Resolved (or similar state)
  • All → In Progress (or similar state)
  • All → Re-Opened (or similar state)

Example of All → Resolved transition:

Setting Fields Upon Resolution

Moveworks requires the Assignee field to be on the Resolved screen, so it can be set as the Assignee when an issue is resolved by the bot. Any other fields that must be set upon Resolution should also be present on this screen, so Moveworks can set the appropriate value. This is required even if the transition is restricted to API access only.

This article will walk through the steps of how to add a screen to a workflow transition and map it to the resolve transition. In this case, instead of the custom field called out in the document linked above, you can add the Assignee field. The field needs to be on the transition screen in order to be available to update during the transition.

Restricting Transitions (optional)

Transitions may be locked down to API-only use so agents can continue to follow their existing workflows without confusion:

Enhancing Bot Transitions (optional)

Bot-specific transitions also allow JIRA admins to control static values. Here are some common use cases:

  1. Set Resolution to Done
  2. Reopen set assignee to Unassigned
  3. Navigate to Workflows, select the transition, and click Post Functions from the pop-up.
  4. Select the Post Functions tab and click Add post function
  5. Select Update Issue Field
  6. Select the appropriate Issue Field and Field Value
  7. Additional values will require additional Post Functions