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.

Setting up Jira Integration from 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.

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 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 Configuration settings for the TeamForm for Jira

...

App

...

Customised Message (admin page)

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

...

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

    code

    • Please

    • go

    • to

    • this

    • <a

    • href='https://www.example.co'

    • target='_blank'>link</a>

    • if

    • you

    • need

    • TeamForm

    • access.

...

Image Added

  1. Click Save default text.

...

Image Added

...

Permissions (

...

admin page)

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

...

Grouping by Custom Field

Some organisations use a Custom Field to define a higher level strategy or work item that Jira issues contribute to, or are grouped under. These might be called Strategic Goals, Themes or Objectives (or any other term used to define higher level work). You can configure the TeamForm for Jira app to recognise custom fields so that links between these and Jira issues are visible in TeamForm.

  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

Custom field: TeamFormSelect

Expand

This custom field allows users to embed a teamform connected select within Jira.

Info

Why would you use this? Maybe you want to associate a team as a dependency. Or perhaps design a workflow that references teams.

This field allows you to have a field that displays and allows association of TeamForm teams with the customisation of naming, which team types are shown and whether to allow association with just one or multiple teams.

 

Configuration Options

Select team types to filter by - This select is connected to the 'GroupTypes' configuration object and allows an admin to configure what teams the Custom Field can query/search against. It is a multi-select, allowing the admin to show multiple team types in the results.

Image Added

 

Allow user to select multiple teams - This checkbox determines whether the CustomField allows multiple values, or only a single value.

Image Added

 

JQL and TeamformSelect

There are two ways of querying a CustomField.

Option 1: "My Custom Field" {{operator}} {{value}}

IS - This operator is only usable with EMPTY or NULL checking for an empty value and will not trigger the autosuggest.
See more at Jira documentation.

IS NOT - This operator is only usable with EMPTY or NULL checking for an empty value and will not trigger the autosuggest.
See more at Jira documentation.

CONTAINS (~) - The "~" operator is used to search for issues where the value of the specified field matches the specified value (either an exact match or a "fuzzy" match — see examples in Jira documentation).
See more at Jira documentation.

 

CONTAINS (~) - The "!~" operator is used to search for issues where the value of the specified field is not a "fuzzy" match for the specified value.
See more at Jira documentation.

 

Option 2: "My Custom Field.Name" {{operator}} {{value}}

 

IS - This operator is only usable with EMPTY or NULL checking for an empty value and will not trigger the autosuggest.
See more at Jira documentation.

IS NOT - This operator is only usable with EMPTY or NULL checking for an empty value and will not trigger the autosuggest.
See more at Jira documentation.

 

IN - This operator searches for issues where the value of the specified field is one of multiple specified values. The values are specified as a comma-delimited list, surrounded by parentheses.
See more at Jira documentation.

NOT IN - This operator searches for issues where the value of the specified field is not one of multiple specified values. The values are specified as a comma-delimited list, surrounded by parentheses.
See more at Jira documentation.

= - This operator searches for issues where the value of the specified field matches exactly the specified value.
See more at Jira documentation.

!= - This operator searches for issues where the value of the specified field does not match the specified value.
See more at Jira documentation.

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"

...