Versions Compared

Old Version 4

changes.mady.by.user Space Sync for Confluence

Saved on

compared with

New Version Current

changes.mady.by.user Space Sync for Confluence

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

This Marketplace The TeamForm for Jira App is still in Beta. currently in

Status
colourBlue
titlebeta

If you encounter any issues while using the App, please contact support@teamform.coraise a support request using the contact us option at the bottom of the page.

The TeamForm Atlassian for Jira Marketplace App is for existing TeamForm customers who also use using Atlassian’s Jira Cloud SaaS product.

Tip

The TeamForm for Jira Marketplace App allows existing TeamForm customers to ‘link’ using Atlassian’s Jira Cloud SaaS product to link both Jira Projects and their Jira Issues to a Team in TeamForm.

Tip

You can link a whole Project to a Team in TeamFrom.

Tip

TeamForm can use the TeamForm Marketplace App to import Jira Issues as TeamForm Objectives.

Setup & Usage Instructions

Info

This process can only be completed by a their respective team pages in TeamForm.

This creates transparency on which team is working on which work.

Table of Contents
stylenone

Why use the TeamForm for Jira App

With our TeamForm for Jira App, your organisation’s Jira Administrators can link 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.

Untitled-2.gifImage Added

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.

Image Added

Prerequisites

Identify your Jira Admin, you will need their help to establish the initial App Configuration.

Note

TeamForm Public API: If you have not setup TeamForm Public API access, you can request them for your TeamForm Tenant by raising a support request, using the contact us option at the bottom of the page. More information via TeamForm Public API.

Note

IP Based Restrictions: If your TeamForm tenant is configured with IP based restrictions you will also need to request the TeamForm Support so Atlassian IPs can be added to our whitelist (also via the contact us option).

A current list of Atlassian IPs can be found under the Outgoing Connections section on this page https://support.atlassian.com/organization-administration/docs/ip-addresses-and-domains-for-atlassian-cloud-products/.

Initial Setup

Note

This step can only be completed by your Jira Admin.

  1. Install the 'TeamForm for Jira' Marketplace App into your Jira Cloud instance.
    A link to the Marketplace App is here: https://marketplace.atlassian.com/apps/1232958/teamform-for-jira

  2. Within Jira, navigate to the Admin Page for the Marketplace App:

...

Image AddedImage Removed

  1. On the Admin Page, fill in your TeamForm Public API details including:

    1. Tenant IDClient ID and Client Secret provided to you by TeamForm (located via the help ? icon on the bottom left menu of TeamForm)

    2. Workspace ID (if left blank, the plugin will use TeamForm’s default Workspace)

...

If you have not requested Public API access, you can request them for your Tenant by emailing support@teamform.co.

...

    1. Client ID and Client Secret (refer below for TeamForm API steps)

    2. Optional: If you use a Custom TeamForm URL to connect to TeamForm, you can enter it on this page.

...

...

    1. e.g. company.teamform.co

    2. Click Change with each of the new setup details.

Issue Linking

...

Head to an Issue on any Jira board on the current Instance:

Click on ‘TeamForm Team’ on the right-hand side.

...

A panel will open, showing that this issue is currently ‘Unassigned’ to a TeamForm Team.

...

Tip

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

Info

Note

  • If you have setup the TeamForm Public API - you will have this information already

  • If you have not setup the TeamForm Public API before - contact TeamForm using the contact us option at the bottom of the page.

    Status
    colourYellow
    titleaction required
    Copy the information below into your request.

Code Block
TeamForm for Jira App Setup request:
- please provide: Client Credentials (ID and Secret)

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>

How-to Use

Project Linking

To link a project to one (or many) TeamForm Team(s):

  1. Click on TeamForm on the left-hand sidebar

    • Note: on smaller screens, you might need to scroll down

    • This will show the Project-level settings for the App.

  2. To assign a Team, click the select box at the bottom of the panel.

  3. Click on one of the Teams to ‘link’ link it to this Issue:

    Image Removed

    Jira Project.

  4. To search for other Teams in TeamForm, type the name, or part of a name into the select box. The Marketplace App will query TeamForm, and show potential Teams relevant to your search term. For example, try

    • e.g. typing: ‘customer', which should return 'Customer Success’ as the top result.

...

Note

If you need to remove a Team's Issue link, click the 'x' to the right of the Team in the list.

Project Linking

To link a project to one (or many) TeamForm Team(s):

  1. Click on ‘TeamForm’ on the left-hand sidebar.

    This will show the Project-level settings for the App.

    Once a team is linked, Jira issues will be synchronised to TeamForm however frequently the integration is configured for - every 15 minutes by default.

Tip

🎉 Congratulations - you have created 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.

Issue Linking
Status
colourBlue
titlebeta

  1. Head to an Issue on any Jira board on the current Instance:

  2. Click on ‘TeamForm Team’ on the right-hand side.

    • A panel will open, showing that this issue is currently ‘Unassigned’ to a TeamForm Team.

...

  1. To assign a Team, click the select box at the bottom of the panel.

    • Click on one of the Teams to

...

    • link it to this

...

    • Issue:

...

  1. To search for other Teams in TeamForm, type the name, or part of a name into the select box. The Marketplace App will query TeamForm, and show potential Teams relevant to your search term.

...

  1. Try typing: ‘customer', which should return 'Customer Success’ as the top result.

...

Note

If you need to remove a Team's Issue link, click the 'x' to the right of the Team in the list.

Tip

🎉 Congratulations, 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.

Mapping Issue Types to Team Types

Info

This process can only be completed by a Jira Admin.

For example, in your company, Epics might be completed by your organization's Departments. By mapping Jira Epics to TeamForm Departments, only Departments will be selectable in the Jira Marketplace App, and TeamForm can be configured to import all Epics as Objectives to their TeamForm Department on a schedule.

  1. Go to the Admin Page of the TeamForm for Jira Marketplace App.

  2. Scroll to the bottom of the Admin Page, to the section entitled: Team Type Mappings

  3. Make a note of, or copy-paste, a Team Type ID from TeamForm.

    1. You can see a particular Team Type’s ID in the Org Structure section of TeamForm.

  4. Find the Issue Type you would like to map to this Team Type.

  5. Click Change

  6. Enter your Team Type ID in the text field.

  7. Click Create

    1. You can add multiple mappings to the same Jira Issue Type.

    2. You can remove a mapping by clicking on it.

...

  1. Click Done

Linking & Importing

There are two types of linking.

  1. Project linking: When you link a Project to a Team, and say that all linked Projects should be imported, any child Issues under those linked projects are also imported.

    1. They will appear in TeamForm on a Teams page

    2. They are only imported if their Issue Type has been Included (see below)

  2. Direct linking: When you link an Issue to a Team, only that Issue is imported as an Objective. No Child Issues are imported.

    1. They are only imported if their Issue Type has been Included (see below)

Setting up Jira Issue Types to Show in TeamForm

Info

This process can only be completed by a Jira Admin.

We recommend only importing a subset of Issue types into TeamForm, so that only meaningful work items are visible in TeamForm, rather than work items of varying size and granularity
e.g. showing a bug that is open for day or two is not helpful to show in TeamForm, however a strategic Epic that other teams are contributing is essential to creating transparency

This section details how to include or exclude Jira issue types.

  1. On the Admin Page of the TeamForm for Jira Marketplace App, click the Reveal button to show a secret URL and Key (note: These are the credentials to be put into the Integration form)

    Image Added

  2. Select which Issue Types you would like to include in the Import, by using the Included column.

    1. Click Excluded on the Issue Type you wish to import, to toggle it to Included.

...

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. as described above

Setting up Jira Integration from TeamForm

  1. Log into your TeamForm instance, and navigate to the ‘Data Integrations’ Data Integrations Settings Page.

  2. Click Create on ‘New Integration’. New Integration

  3. Select ‘Atlassian Jira'. Connect next to Atlassian Jira

    Image Added

  4. Click Create datasource.

    Image Added

  5. Paste the Key and URL revealed earlier into the relevant fields.

  6. Click ‘Update’. Update

  7. Optional: Configure a schedule for the Integration. This determines how often the data in Jira is automatically imported into TeamForm. For example, to import every 2 hours, use the frequency of 7200 seconds.

The Datasource can now reach out to the Jira pluginconnect with the TeamForm for Jira App, and import any Issue of a Type that has been mapped to a Team Type in TeamForm.

Note

Note: the import process will not find any Issues to import, unless those Issue Types have been mapped to a Team Type in TeamForm. See the relevant section of this document for details.

Note

The import process will import all Issues of mapped Types into TeamForm. This includes Issues in the past.

Be sure this is what you want before creating a mapping from an Issue Type to a Team Type.

In particular, it is probably unsafe to create a mapping from Jira Tasks if there are a large amount of Tasks already in Jira.not recommended to map Jira Tasks, Bugs, Stories as they are not a helpful granularity of work to display in TeamForm.

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.

Set Un-linked default text is used to 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
      Please go to this <a href='https://www.example.co' target='_blank'>link</a> if you need TeamForm access

...

  1. Click Save default text

...

Admin Page (Permissions)

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

...

Related information

Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@9e4
maxCheckboxfalse
showSpacefalse
sortmodified
typepage
reversetrue
labelsteam team-details types
cqllabel in ( "system-admin" , "marketplace" ) and type = "page" and space = "OS"