Wiki

Clone wiki

Project Team / 340

Project Team version 3.4.x

The content of this page applies to the following version(s) of Project Team:

  • v. 3.4.x for JIRA 6.0 or newer

On this page:

What's new in this version?

User custom field of type Multi Line Text

Multi Line Text custom fields can now be added for mapping user attributes like Bio or Description.

Adding a Multi Line Text field

Options for configuring the visibility of the user custom fields

Additional options were added to the user custom field settings for configuring the visibility of the fields on the user Profile page and on the Project Team tab of the projects.

Options for configuring the visibility of fields
NOTE After the upgrade to this new version, all the existing fields will have these options checked to that they remain visible on both Profile page and the Project Team tab.

Option for restricting the users to add new input options in the Multi Value Picker field

A new option was added for the Multi Value Picker field that allows restricting the users to add new input options to the Multi-Value Picker field by themselves.

Settings for restricting users to add new options

When the option is checked, the dialog for setting-up the value of the Multi Value Picker field will offer the "Create a new option" link to the users.
The link for adding a new input option


NOTE After the upgrade to this new version, the existing Multi Value Picker fields will have this option checked in order to preserve the existing functionality.

Other improvements

Some bug fixes and small improvements were included in this version. Also the add-on icon and banner were updated.

What Project Team does?

The add-on adds a new tab to the JIRA projects named "Project Team" on which the team members are displayed along with their project roles as they are defined and configured by the JIRA or project admin. Also, it allows you to extend the profile of your team members by adding user custom fields. The custom fields and their values are displayed on the Project Team tab next to the other user attributes.

The team can be displayed in two different modes, depending on the user's selection.

Project team displayed by members

In this mode each team member is listed along with its full name, username, avatar, email address, project role(s) and the user custom fields defined by the JIRA administrator. You can click the username to see the profile of the user.

The project team displayed by members

You can sort the data in the table by clicking a column header. Also, the data can be filtered by typing a text in the Filter by field.
This mode is used when Display mode is set to By members. The size of the avatar (small or large) can also be changed in the add-on configuration page (see Configuring the add-on settings).

JIRA Project Admin displayed on top of the page represents the JIRA project lead - an user that usually has admin rights over the project and can, for instance, add new components or new versions to the project. The JIRA administrator can choose to display (or not to display) the JIRA Project Admin via add-on configuration settings.

Project team displayed by project roles

In this mode each role defined in the project is listed along with its members. You can click the username to see the profile of the user.

The project team displayed by project roles

You can sort the data in the table by clicking a column header. Also, the data can be filtered by typing a text in the Filter by field.
This mode is used when Display Mode is set to By roles.

JIRA Project Admin displayed on top of the page represents the JIRA project lead - an user that usually has admin rights over the project and can, for instance, add new components or new versions to the project. The JIRA administrator can choose to display (or not to display) the JIRA Project Admin via add-on configuration settings.

The Total Members column indicates the number of members belonging to each project role.

Changing the display mode

The user can change the display mode via the Display mode dropdown list from the top-right corner of the Project Team project tab.

If the user never changed the display mode, the default display mode configured in the Add-on Configuration Settings page is used.

Setting the value of the user custom fields

If the display mode is set to By members, the team members can set their values of the custom fields by moving the mouse over the field and clicking the link displayed.

A link used for setting the value of a custom field

When choosing to set the value of a custom field of type Text, a window like in the picture below is displayed:

Entering the value of a text custom field

When choosing to set the value of a custom field of type Multi Value Text, a window like in the picture below is displayed:

Entering the value of a Multi Value Picker custom field

In this window the team member can select one or more options from the Available Options list and add them to the Selected Options list by clicking the ">" button. The user can add a new option to the Available Options list, by clicking the Create a new option button, but only if the custom field was configured to allow users to add new input options by themselves (see "Editing a user custom field").

NOTE The JIRA Project Admin of a project can change the value of these custom fields for all the team members of that project.
The values of the custom fields are also displayed on the Profile page of the JIRA users in a newly added section named Additional Attributes.

User custom fields displayed on the Project Team tab of the project

Installing Project Team

Project Team is a deployable add-on, composed of a single JAR file, which can be installed directly from the Universal Plugin Manager (UPM).

But if you manually downloaded the JAR file by accessing the add-on's Download link from Marketplace, follow the next steps to install it:

  • Log on to JIRA as an administrator
  • Go to Administration
  • Go to Plugins menu and click Plugins to open UPM page
  • Go to Install tab
  • Click Upload Plugin
  • Select the JAR file of Project Team
  • Click Upload to start the installation. When the installation is done, a confirmation message is displayed.

The add-on is not fully functional at this time. You must obtain and activate a trial or commercial license in order to use Project Team. See Activating the add-on license.

Activating the add-on license

In order to run the Project Team add-on you need a trial or a commercial license. You can purchase Project Team from the Marketplace or through the Universal Plugin Manager (UPM). Once you obtained a license code you must activate it.

Follow the next steps to activate Project Team license:

  • Log on to JIRA as an administrator
  • Go to Administration
  • Go to Plugins menu and click Plugins to open UPM page
  • Locate and expand the Project Team add-on under User-installed Plugins
  • Enter the license code in the Enter the new license field
  • Click Update. If your license is valid, a confirmation message is displayed on top of the page.

    License activation in UPM

Configuring the add-on settings

To configure the Project Team add-on settings follow the next steps:

  • Log on to JIRA as an administrator
  • Go to Administration > Project Team
  • Click Settings under Project Team Add-on Configuration
  • On the Settings tab, change the settings to suit your preferences. See the table below for a complete description of the available settings.
  • Click Save to apply the settings

    Configuring add-on settings
ItemDescription
Default display modeThis option indicates how the team is displayed on the Project Team tab if a display mode was not yet selected by the user.
There are two options available:
By members – displays the members of the team along with their e-mail address and project roles. This is the default option.
By roles – displays the roles of the project and their members.
Not displayed project rolesYou may not want to display some of the project roles. For instance, those project roles that are only used for granting permissions over the project or for notification schemes.
Check the roles that you don’t want to be displayed on the Project Team tab. All the project roles defined in JIRA are listed.
Avatar sizeChoose between using large or small avatars. The default value is Use large avatars.
This option only applies when the current display mode is set to By members.
Other display optionsCheck Display the project roles description in tooltip if you want the description of the project role to be displayed in a tooltip when the user moves the mouse pointer over a project role. This option is by default unchecked.
Check Display the inactive members of the project roles if you want the inactive (deactivated) JIRA users that are members of a project role to be shown on the Project Team tab. This option is by default unchecked.
Check Display JIRA Project Admin if you want the JIRA Project Admin (project lead) to be displayed on top of the Project Team tab. This option is by default checked.
Check Display the indirect members of the project roles if you want the indirect members to be shown on the Project Team tab. Indirect members of a project role are those members that were added to the role via a group. This option is by default checked.

Configuring the add-on permissions

By default anyone can visualize the "Project Team" tab of a project. You can restrict the access to the "Project Team" tab through add-on permissions configuration. Follow the next steps to configure the add-on permissions:

  • Log on to JIRA as an administrator
  • Go to Administration > Project Team
  • Click Permissions under Project Team Add-on Configuration
  • On the Permissions tab, check the project roles that are allowed to View the "Project Team" tab.

    Configuring add-on permissions

NOTE If a JIRA user is member of a project role that has View permission but he/she is also member of another project role that does not have the View permission, it is considered that the user in question has View permission.

  • You can also specify who can edit the custom fields on the user's Profile page. You might want to grant this permission to managers or HRs. If so, select the specific user or group and click Add.

NOTE These editing permissions apply over the Profile page only. The user himself and the Project Lead can still edit the custom field values from the Project Team tab of the project.

  • Click Save to apply the changes.

Configuring roles display order

You can specify the order in which the project roles are displayed. For instance, you can choose to display the Project Manager or Product Owner on the top of the Project Team tab, followed by the other team members and roles. All you have to do is add these roles and set their order in the new Roles Display Order section from the add-on configuration.

Follow the next steps to configure the roles display order:

  • Log on to JIRA as an administrator
  • Go to Administration > Project Team
  • Click Roles Display Order under Project Team Add-on Configuration
  • On the Roles Display Order tab, use the Add button to add the roles to the list.
  • Use the up/down arrows to set the roles order
  • You can remove a role from the list by checking the box next to it and then clicking Remove
  • Click Save to apply the changes.

    Defining the display order of the project roles

NOTE The roles added here and their members will be displayed on the top of the Project Team table, in the configured order. The roles that are not added here will also be displayed but at the end of the table, ordered alphabetically.

Configuring user custom fields

You can extend the profile of your team members by adding user custom fields. The custom fields and their values are displayed on the Project Team tab next to the other user attributes.

The team members can set their values of these custom fields on the Project Team tab of a project. Also, the JIRA Project Admin (or project lead) of a project can change the values of these custom fields for all the team members of that project.

The user custom fields can be added in the add-on's administration area and their type can be Text or Multi Value Picker. The Text custom fields are suitable for mapping simple text attributes like Phone Number or Skype ID. The Multi Value Picker fields can be used for mapping multi-value attributes like Technical Skills or Foreign Languages because they allow users to select one or more options from a list.

The page from add-on's administration area used for adding user custom fields

Adding a user custom field

Follow the next steps to add a user custom field:

  • Log on to JIRA as an administrator
  • Go to Administration > Project Team
  • Click User Custom Fields under Project Team Add-on Configuration
  • On the User Custom Fields tab, click the Add Custom Field button. The Add User Custom Field screen is displayed.
  • Select the Type of the custom field.
  • Type a Name for the new field. The Name is required and must be unique.
  • You can enter a Description for the new field. The description is optional.
  • Configure the display options. Check Visible on project tab panel if you want the field to be displayed on the Project Team tab of the project. Check Visible on user profile if you want the field to be displayed on the user Profile page.
  • If you chose to add a field of type Multi Value Picker, you can enter the input options of the field in the Add Input Options table. The input options can also be added later, by editing the custom field. So it is not required to add all the input options during the field creation. Also, you can decide if the users are allowed to add new input options by themselves by checking or unchecking Allow users to add new input options by themselves.

    Adding a user custom field of type Multi Value Picker
  • When you are done, click the Add button from the bottom of the page to add the new custom field. Once added, the new field is listed in the table from the User Custom Fields tab and it also appears as a new column in the table from the Project Team tab of the JIRA projects.

Editing a user custom field

Follow the next steps to edit a user custom field:

  • Log on to JIRA as an administrator
  • Go to Administration > Project Team
  • Click User Custom Fields under Project Team Add-on Configuration
  • On the User Custom Fields tab, click the icon from the row corresponding to the field that you want to edit.

    The menu-option to be used for editing the user custom field
  • Click the Edit menu-option. The Edit User Custom Field screen is displayed.
  • Change the attributes of the custom field as you wish.
  • If the field is of type Multi Value Picker, you can edit the input options of the field in the Edit Input Options table. Also, you can decide if the users are allowed to add new input options by themselves by checking or unchecking Allow users to add new input options by themselves.
  • When you are done, click the Save button from the bottom of the page to save the changes you made.

Deleting a user custom field

Follow the next steps to delete a user custom field:

  • Log on to JIRA as an administrator
  • Go to Administration > Project Team
  • Click User Custom Fields under Project Team Add-on Configuration
  • On the User Custom Fields tab, click the icon from the row corresponding to the field that you want to delete.

    The menu-option to be used for deleting the user custom field
  • Click the Delete menu-option. A pop-up message is displayed asking if you are sure that you want to delete that field.
  • If you are sure that you want to delete the custom field, click Delete to delete it. Otherwise, click Cancel.

Using Project Team Gadget

The Project Team Gadget displays the team belonging to a specific project in your JIRA dashboards. Moreover, because JIRA gadgets can be added to the Confluence pages, you can also display your project team in Confluence.
Project Team Gadget
The gadget displays the same members as the "Project Team" tab of the project, based on the add-on configuration settings.

NOTE The current JIRA user must have permissions for browsing the project and View permissions in Project Team in order to visualize the team displayed by the gadget.

Adding the Project Team gadget to a JIRA dashboard

Follow the next steps to add the gadget to a JIRA dashboard:

  • Log in to JIRA or navigate to your dashboard, if you are already logged in.
  • Click the Add Gadget link in the top right. The Gadget Directory screen will be displayed.
  • Find the Project Team gadget in the list of gadgets and click Add it Now.
  • Click the Close button in the bottom right.
  • The Project Team gadget will be displayed on your dashboard. Enter the following setup details for your gadget:

    Configuring Project Team Gadget
ItemDescription
ProjectThe Jira project for which the team will be displayed.
Fields to displayThe fields to be displayed in the gadget. The user custom fields can be also selected. You can choose the display order of the fields by moving them up or down.
Avatar sizeChoose either the Large or the Small avatar to be displayed.
Refresh IntervalChoose how often the data in the gadget will refresh.
  • Click the Save button. The Project Team gadget will be displayed on your dashboard.

Adding the Project Team gadget in Confluence pages

Follow the Atlassian documentation for how to add JIRA gadgets to a Confluence page: https://confluence.atlassian.com/display/DOC/Adding+JIRA+Gadgets+to+a+Confluence+Page

Updated