Versions Compared

Key

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

The TeamForm for Jira App is currently in

Status
colourBlue
titlebeta

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

Tip

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

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

...

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. To accelerate your request, copy the information below into your request:

Code Block
languagecss
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>

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/.

Installation and Setup

Note

This process 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:

...

Issue Linking
Status
colourBlue
titlebeta

Info

This feature is still in Beta and is still being tested. It may not always behave as expected until final release.

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

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

...

Mapping Issue Types to Team Types

Note

This process can only be completed by your Jira Admin.

For example, in your company Epics might be completed by your organization's Departments.

...

Setting up Jira Issue Types to Show in TeamForm

Note

This process can only be completed by your Jira Admin.

Info

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.

...

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

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

...

Info

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.

...

This section of the admin page is to restrict who is able to link TeamForm Teams to projects in Jira:

...

Grouping by Custom Field

Once Issues have been imported into TeamForm, you can group them into Themes, or other high-level work objectives, using the procedure below:

  1. You can learn how to create a Custom Field here: https://support.atlassian.com/jira-cloud-administration/docs/create-a-custom-field/

    1. Only Single Select and Multi Select drop-down Field Types are supported.

  2. Once you have set up your Custom Field, go to the Jira Admin page, and head to the Custom Fields section.

  3. Click Expand.

  4. Select, or type to search, from the drop-down list as many Custom Fields you wish to use - most people just use one.

  5. Click Submit - you should receive a message saying your changes have been submitted.

Tip

That’s it! Now, the plugin will import each assigned value of this Custom Field, when it imports Issues across to TeamForm. The value will then be used to group all Issues under that value.

Example

Linking the Theme Custom Field to a high level objective shown in TeamForm:

...

Image Added

Image Added

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"

...