Project Team for Jira Cloud

On this page:

What this app does?

Project Team for Jira Cloud is an app for Jira Cloud that allows extending the profiles by adding custom attributes like Phone Number, Bio or Skills. Once defined, the custom fields become visible on an Advanced Profile page for each user and in the issue screen from Jira.

The Jira issue screen displays the advanced attributes of the issue's reporter and assignee.

Also, this app makes visible the team of the project by displaying its members and their roles in a tab named “Project Team” added to the project dashboard. From this page you can access the Advanced Profile page of each user for visualizing and editing their custom fields.

With this app you also can generate and display organizational charts based on your Jira users and their hierarchical relationships. The organizational charts are automatically generated based on those custom fields (and their values) that indicate the hierarchical relationship between the Jira users.

Adding user custom fields

The Jira administrators can add, edit or delete the user custom fields on the Profile Custom Fields page located in the Jira Settings area under Apps > PROJECT TEAM section.

Adding a user custom field

To add a new user custom field:

• Log on as a Jira admin
• Navigate to Jira Settings > Apps > PROJECT TEAM > Profile Custom Fields page
• Click the Add Custom Field button

• Select the Type of the new field
• Enter a Name for the new custom field
• Optionally, type a Description
• If you choose to add a Multi Line Text field, you can add one or more items that represent the possible values of the field.
• Choose where the new field to be displayed. If you check Show on User Advanced Profile, it will be displayed on the User Advanced Profile page of every user. If you check Show on View Issue Screen, the field will be displayed on "User additional attributes" section from the View screen of the Jira issues, but only if the field has a value.

NOTE: The User Advanced Profile page displays all the fields, regardless their Show on User Advanced Profile setting, to the users that have permissions for editing the field values.

• Click Save

Modifying a user custom field

To modify the attributes of a user custom field:

• Log on as a Jira admin
• Navigate to Jira Settings > Apps > PROJECT TEAM > Profile Custom Fields page
• In the table with available fields, locate the custom field that you want to modify and click its Edit icon
• Modify the field's attributes as you want
• Click Save

Deleting a user custom field

To delete a user custom field:

• Log on as a Jira admin
• Navigate to Jira Settings > Apps > PROJECT TEAM > Profile Custom Fields page
• In the table with available fields, locate the custom field that you want to modify and click its Delete icon
• If you are really sure that you want to delete the custom field, click Yes in the confirmation window

Configuring edit permissions

You can allow specific Jira users or groups to edit the custom fields of the users. For instance, a manager or your HR department. Follow these steps to grant edit permissions to a user or group:

• Log on as a Jira admin
• Navigate to Jira Settings > Apps > PROJECT TEAM > Permissions page
• Add the group or user to the list
• Click Save

NOTE: Regardless of these settings, the Jira users are allowed to edit the custom fields of their own Advanced Profile page. Also, the Jira administrators can edit the custom fields of any Jira user.

Viewing and editing the user custom field values on the Advanced Profile page

The value of the custom fields of a specific user profile can be visualized and set on the Advanced Profile page of that user.

Any Jira user can access his own Advanced Profile page by clicking the Apps>User Advanced profile menu-option of the Jira top menu bar.

The Advanced Profile page of another user can be opened from the Project Team tab of the Jira project the user belongs to, by clicking the user's display name.

Or, if you are on the view issue screen and the user is the issue's reporter or assignee, you can click the Advanced Profile link from the User additional attributes area of that user.

Once you reached the field to be edited, click its edit icon and change its value as you want.

The users can set their own custom field values. Special permissions are required to set the custom field values of the other users (see "Configuring edit permissions").

Displaying Organizational Charts

The organizational charts can be displayed on your Jira dashboards by using the Organizational Chart gadget. For the organizational chart to be generated, you must have a user custom field of type User Picker representing the hierarchical relationship between the Jira users. Also, the fields must be properly set on the user's Advanced Profile page. See "Adding a user custom field" above for how to add such field.

Assuming that you already have a dashboard created and at least one User Picker custom field defined and set on the user Advanced Profile page, follow these steps to display the organizational chart:

• Go to your Jira dashboard and click Add gadget
• Search for the org chart gadget and add it

• Enter the gadget settings as described in the table below

• Click Save. The organizational chart will be generated and displayed on your dashboard.

Visualizing the Project Team

The Project Team tab of a project displays those Jira users that have a role in that specific project.

Go to Project Settings > People and assign the users to project roles, so that they can be displayed on the Project Team tab of the project. In case you don't have the project roles created, new project roles can be added in Jira Settings > System > Project Roles.

Displaying the Team Members Info on Jira dashboards

You can also display the team of a project on your Jira dashboards by using the Team Members Info gadget.

Assuming that you already have a dashboard, follow these steps to display the project team on it:

• Go to your Jira dashboard and click Edit
• Search for the Team Members Info gadget and add it

• Enter the gadget settings as described in the table below

• Click Save. The team of the selected project is now displayed on your dashboard.

REST API

Retrieving the custom field values for the users

The value of the custom fields for a specific Jira user can be retrieved programmatically by using the REST API method below.

Request URL

The request URL takes the following form:
https:/ /MY_Jira_BASE_URL/rest/api/3/user/properties/CUSTOM_FIELD_ID?accountId=USER_ACCOUNT_ID&jsonValue=true
Replace "http:/ /MY_Jira_BASE_URL" with the base URL of your Jira server and the parameters as described below.

Parameters

You have to specify the following parameters:

An example of the request URL with parameters is as follows:

https:/ /myjira.atlassian.net/rest/api/3/user/properties/1667729115557?accountId=557058%3A682699a7-c8dd-4c7a-bc1f-00972ca096c4&jsonValue=true

In this example the value of field with id "1667729115557" of the user with account id 557058%3A682699a7-c8dd-4c7a-bc1f-00972ca096c4 is retrieved.

A successful response

An HTTP 200 status response indicates a successful request. The following data about the matching documents is returned in json format:

{"key":"1667729115557","value":{"value":"Programmer","customFieldId":1667729115557}}

Error Response

If the REST call fails, the service returns one of the following HTTP statuses:

Determining the id of a custom field

To determine the id of a user custom field:

• Open Google Chrome
• Log on as a Jira admin
• Navigate to Jira Settings > Apps > PROJECT TEAM > Profile Custom Fields page
• In the table with the available fields, hover the mouse cursor over the field. The field id is displayed in a tooltip.

Migrating app data from Connect to Forge

Project Team has been recently ported to Forge - the Atlassian's brand-new platform for apps development on Jira and Confluence Cloud. Initially, the app was created on top of the Atlassian Connect platform, which will be deprecated in the future.

After upgrading Project Team from a Connect-based version (1.2.x) to a Forge-based version (3.x or newer), the old app data consisting in the user custom fields and edit permissions is not visible in the new app until a data migration is performed.

Follow these steps to perform the app data migration from Connect to Forge:

• Log in to Jira Cloud as an admin
• Navigate to Jira Settings > Apps > PROJECT TEAM > Migration page
• If the migration was not performed yet, click Migrate
• Check the migration progress and status. In case of any errors, try again. If the errors persist, please contact StonikByte Support (support@stonikbyte.com) for assistance.

Migration from Jira Server / Data Center to Jira Cloud

There is currently no migration path from Jira Server / Data Center to Jira Cloud. The only method is to recreate the data manually.

Please also note that there are significant differences in functionality/features between the Server/Data Center and the Cloud version of Project Team.