Versions Compared

Old Version 9

changes.mady.by.user Space Sync for Confluence

Saved on

compared with

New Version Current

changes.mady.by.user Chris Combe

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
stylenone

Why use the TeamForm for Jira app

With TeamForm’s Jira App, an organisation’s Jira Admin(s) can link their Jira Projects to relevant TeamForm Teams. This allows a Jira user to click through from Jira to TeamForm to view the team and team members who deliver this project.

...

We also offer a TeamForm integration, that combines with the TeamForm Jira app, to import Issues from Jira into TeamForm - displaying this team’s work items as Objectives.

...

Prerequisites

  • You have Jira Admin access where the plugin is to be installed.

  • You have configured IP whitelisting correctly, for Atlassian to connect to TeamForm, and for TeamForm to connect to Atlassian.

Getting started

  1. From within Jira, install the TeamForm for Jira from the Atlassian Marketplace.

    1. make sure you are logged into Jira, as a Jira Admin, to do this.

  2. Navigate to , on the top toolbar of Jira.

  3. Navigate to

  4. Navigate to , on the sidebar, on the left-hand side of the page.

    1. You may need to scroll the sidebar downwards to see this option, in the section.

  5. The TeamForm for Jira Admin Page will be displayed.

  6. You now need to fill out the Authentication Section of this page - details of how to do this can be found below.

Admin Page within Jira (Authentication Section)

Tenant ID and Workspace ID can be found in the TeamForm app:

...

Client ID and Client Secret are obtained by contacting TeamForm Support.

Please use the following template in your support request:

Code Block
Hi TeamForm Support,

Please supply Client Credentials (ID and Secret) to connect the TeamForm for Jira App.

Access Level: <production, staging, test etc>
Tenant ID: <tenant id (as found above)>
Workspace ID: <workspace id>
Security Contact: <your email, or the email of the person responsible for the secure storage of the Client Credentials>
Atlassian Jira URL: <xyz.atlassian.net>

Thank you,

...

Custom TeamForm URL: this is the URL of TeamForm, e.g xyz.teamform.co

  • Click Image Modified (change) on each field

...

  • , and fill out the relevant details.

...

  • Click Image Added (update) and continue to the next one.

Tip

Congratulations! You can now start to link TeamForm Teams to Jira Projects!

Linking Projects in Jira to TeamForm Teams

Visit one of your Projects in Jira and look for the TeamForm icon on the left sidebar, as shown here:

...

Tip

That’s it! You have made a link between your project and a TeamForm Team. The Team will appear in a side panel for any issue owned by this Team. You can now jump straight to the Team in TeamForm, by clicking its name.

Importing Issues into TeamForm

The TeamForm integration with Jira allows you to import a linked Project’s Issues (e.g. Epics, initiatives, stories…) into TeamForm!

Info

Only Issues under a linked Project will be imported, and only those Issues that match the following criteria:

  • their Project is linked, using the process above

  • their Issue Type is marked as as defined below

  • you have to set up the TeamForm Jira Integration in TeamForm is setup

  • issues Issues are open Open (by default, TeamForm will exclude issues which are closed excludes closed issues prior to the current TeamForm planning allocation window or “project”“allocation project”)

Setting up which issues are to be included in the import

Info

You will likely want to import only a subset of issue types into TeamForm. This section details how to include or exclude Jira issue types.

...

Note

Remember, even though an Issue Type is selected, only some of the Issues with that Issue Type will be imported: e.g only those whose Project is linked to a TeamForm Team, using the process described here.. as described above

...

Setting up your Jira integration from within TeamForm

Once the TeamForm for Jira App is in place in your Jira instance, you can install the TeamForm Jira Integration on the TeamForm side.

This Integration copies over linked Projects, and associated Child Issues (see above), into TeamForm.

To get started, find the Image Added page in TeamForm. It is on the left-hand Settings sidebar, as shown below:

Once there, create a New Integration:

...

And select Atlassian Jira:

...

You will be asked for a name and a description for the plugin. You can customise these, or it is also OK to leave them as the defaults, and click Create.

Once setup is completed, you’ll be presented with your TeamForm → Jira integration, as shown below:

...

To fill this out:

  1. Navigate back to the Admin Page of the Jira TeamForm Plugin

  2. Look for the Webtrigger section:

...

  1. Click Reveal .

    1. These are the credentials to be put into the Integration form, shown above.

  2. Once copied over, don’t forget to click Update!

Tip

Excellent! You have now configured TeamForm to import Projects and Issues from Jira, using the Atlassian TeamForm Integration.

Other TeamForm for Jira Config settings

Admin Page (Customised Message)

This section of the Admin Page is used to customise the appearance of the App for projects not yet linked to teams.

is used to customize customise the message shown when an Issue or Project is not linked to a Team - to this set up:

  1. Enter your custom message into the text box. You could use the following, as an example:

    1. Code Block
      languagehtml
      Please go to this <a href='https://www.example.co' target='_blank'>link</a> if you need TeamForm access

...

  1. Click

...

Admin Page (Permissions)

You can restrict who is able to link TeamForm Teams to projects in Jira:

...

...

Issue Picker
Status
colourBlue
titlebeta

In addition to linking Projects to teams, you can link issues to teams (Beta). Note: child issues will not be automatically linked.

...