UAT Studioby Salvion
Help · Connections

Connect UAT Studio to Jira

Send issues from your UAT straight to your development team's Jira project. No more copying tickets after the triage call: one click, and the bug is in Jira with the test step, the expected result, the screenshots and a link back. When the fix is done, the tester knows it's time to retest.

Takes about 10 minutesWho a workspace adminWorks with Jira CloudPlans Team, Partner and Enterprise
Before you start

What you need

  • Jira Cloud: an address that ends in .atlassian.net.
  • A Jira account that may create issues in the project the bugs should go to.
  • Admin rights in your UAT Studio workspace.
Tip: use a service accountTickets are created in the name of the account whose token you use. Many teams create a separate Jira user such as UAT Studio for this, so tickets don't depend on one person's account and are easy to recognise.
Set up · once per workspace

Connect your Jira project

1

Create an API token in Atlassian

  1. Sign in to Atlassian with the Jira account you will use, and go to id.atlassian.com › Security › API tokens.
  2. Click Create API token.
  3. Give it a name you will recognise later, for example UAT Studio, and choose an expiry date.
  4. Click Copy. Keep the window open until you have pasted the token in step 5: Atlassian shows it only once.
Atlassian Account, Security tab, API Tokens: the Create API token button, and a token named UAT Studio that expires after a year
Use Create API token, not Create API token with scopes. Tokens expire after at most a year.
Put the expiry date in your calendarWhen the token expires, sending stops. Create a new token and paste it in UAT Studio; nothing else changes.
2

Find your Jira address and project key

Jira address: open Jira and look at the address bar. Everything up to and including .atlassian.net is your address, for example https://acme.atlassian.net.

Project key: the short code in front of every ticket number. In PORTAL-123 the key is PORTAL. Open any ticket in the project and you see it in the breadcrumb at the top. No tickets yet? Open the project and look at the address bar: the key follows /projects/.

Projects or spaces?Newer Jira calls projects spaces. It's the same thing: use the key of the space your bugs should go to.
3

Open Connections in UAT Studio

Sign in at app.uat.studio and open your workspace. Click Connections. You also find it under Setup in any project, as Manage connections.

The workspace page with the buttons Plan & billing, People & access, Connections and Audit log
4

Add Jira and fill in the settings

Under Add a connection, choose Jira and click Add.

Add a connection, with Jira selected and the Add button

A card for the new connection appears. Fill in:

FieldWhat to fill in
NameHow the button reads: Send to Jira. Change it if you connect more than one project, for example Portal Jira.
Jira addressYour address from step 2, such as https://acme.atlassian.net.
Email of the Jira accountThe email address of the account that created the token.
Project keyThe key from step 2, in capitals, such as PORTAL.
Issue typeBug. If your project has no Bug type, use the type your team uses for defects, such as Task.

Click Save settings.

The Jira connection card with the address, email, project key and issue type filled in
5

Store the token

Paste the token from step 1 in the field API token and click Store token. The field then shows only the last 4 characters, so you can see which token is stored.

The API token field with a pasted token, hidden as dots, and the Store token button
Your token stays yoursThe token is sent once over an encrypted connection and stored encrypted. Nobody can read it back: not your colleagues, not UAT Studio support.
6

Test the connection

Click Test connection. UAT Studio signs in to Jira with your token and checks the project. When all is well you see Connected as <name> to project <project>, and OK next to the last test.

The connection card after a successful test: last test OK, connected as Emma de Vries to project Customer Portal

That's it. Every project in this workspace can now send issues to this Jira project.

Every test day

Sending issues to Jira

One issue

Open the issue. Under Ticket in the development team's system, click Send to Jira.

The issue panel with the Send to Jira button

A few seconds later the ticket exists in Jira. The ticket number and a link appear on the issue, and the issue's history shows when it was sent and by whom. An issue that is already linked can't be sent twice by accident.

The issue panel after sending: linked to Jira ticket PORTAL-1, with a link Open Jira PORTAL-1

All issues after the triage call

In Issues › Triage, give each new issue a decision. When you're done, UAT Studio counts the issues to fix that have no ticket yet. Click Send 3 to Jira (or however many there are) to create all tickets at once.

Triage done: Send to the development team, with the button Send 3 to Jira and the CSV downloads

What the Jira ticket contains

  • Title: the issue number and title, such as ISS-012: Quote PDF shows the wrong VAT rate.
  • Description: what the tester wrote, the test case with the step that failed and the expected result, the environment and who found it.
  • Priority from the severity, and the labels UAT and the issue number, so you can filter on them.
  • A link back to the issue in UAT Studio, where the screenshots are.
A Bug in Jira created by UAT Studio: the title ISS-001 with the failed test step, and a description with the step, the expected and the actual result
A ticket as UAT Studio creates it. Below the description: the test case, who found it and the link Open in UAT Studio.

Screenshots go along

The screenshots and files of the issue are attached to the Jira ticket: up to 10 files of at most 10 MB each. A file that doesn't fit stays in UAT Studio, and the issue's history says which one.

Merging duplicates

When you merge two issues in UAT Studio that both have a ticket, the duplicate ticket follows: it gets a comment, the link duplicates to the other ticket, and moves to Done. If your workflow doesn't allow that, UAT Studio tells you, and you close it in Jira yourself. When only the duplicate had a ticket, the issue that stays takes it over.

Status back

When the fix is done in Jira

When the developer moves the ticket to a status in the category Done, the issue in UAT Studio becomes Ready for retest and the tester gets a mail to retest. When the ticket moves to In Progress, the issue does too. The status in Jira is shown next to the ticket link.

A failed retest is never undone: when the tester reopens the issue while the ticket is still Done, UAT Studio leaves it open. A closed issue stays closed.

By itself, or straight away

Without doing anything, UAT Studio looks up the ticket status each time an admin opens the issues, and with the button Update ticket status.

Straight away: let Jira tell UAT Studio when a ticket moves. You need to be allowed to create an automation rule in the Jira project.

  1. In UAT Studio, under Connections, in the Jira connection, click Create webhook address and copy the address. It's shown only once.
  2. In Jira, open the project and go to Project settings › Automation › Create rule.
  3. Trigger: Work item transitioned (in older Jira: Issue transitioned). Leave From and To empty.
  4. Action: Send web request. Web request URL: the address you copied. Method POST. Web request body: Issue data (Jira format).
  5. Name the rule UAT Studio status and turn it on.
Keep the address within the teamThe address works as a key for reporting ticket statuses only. Lost it, or shared it by mistake? Click New address: the old one stops working at once.
Roles

Who can do what

AdminsAdd, change, test and remove connections; send issues.
Testers, stakeholders, developersSee the ticket number and link on an issue. They can't send issues or see connection settings.
Audit logEvery change to a connection is recorded, so you always see who changed what and when.
Troubleshooting

If something goes wrong

You seeWhat to do
The token or email address is not acceptedThe email address must be the one of the Atlassian account that created the token. Check for typos, or create a new token and store it again.
The project … was not foundCheck the project key, and that the Jira account can see the project.
Sending fails on the issue typeThe project has no type with that name. Look up the types in your Jira project and fill in the right one under Issue type.
It worked before, now it doesn'tThe token has probably expired or was revoked. Create a new one and store it; the rest stays as it is.
The status doesn't come backOpen the issues as an admin, or click Update ticket status. With a webhook address: check that the automation rule is on and look at its audit log in Jira; under Connections you see when the last message arrived.
No Send to Jira buttonOnly admins see it, and only when the connection is On and has a stored token.
Connections are not part of your planConnections come with Team, Partner and Enterprise. Your admin can upgrade under Plan & billing.

Still stuck? Mail [email protected] with the message you see. Never send us the token itself.

Using Azure DevOps? See Connect UAT Studio to Azure DevOps. All guides: UAT Studio help.

Security

How we handle your token

  • The token goes from your browser to our server once, over an encrypted connection.
  • It is stored encrypted (AES-256). The key to decrypt it is kept separately from the database, so a copy of the database alone is useless.
  • Nobody can read the token back: not in the app, not through support.
  • UAT Studio uses the token only to test the connection, to create the tickets you send (with their files), to read the status of those tickets and to close a duplicate ticket after a merge. It doesn't read anything else in your Jira.
  • Remove the connection or revoke the token in Atlassian, and access ends straight away.