User Profile Plugin Module


JIRA 5.2.1 and later

Purpose of this Module Type

A user profile plugin module defines the content displayed in the 'Details', 'Preferences' and 'Assigned Open Issues per Project' panels on the User Profile screen in JIRA. You can also define custom web panels to be displayed in the same column. Note, you cannot modify the Activity Stream nor add any web panels to the column that it is in.


Overriding the default web panels on the User Profile page

The 'Details', 'Preferences' and 'Assigned Open Issues per Project' sections on the User Profile page are implemented as standard web panels. The defaults for these web panels are shown below.

To override the default web panels, you need to do two things:

  1. For each web panel that you want to override, define the web-panel in your atlassian-plugin.xml specifying the appropriate key/location and the desired resource (as shown in the defaults below).
  2. Set the weight attribute less than or equal to the default value of the desired web panel. For example, the default weight of the Preference web panel is 200. If you want to override it, you must set the weight less than or equal to 200 when defining your web panel.

Default 'Details' web panel:

<web-panel key="custom-user-details" location="webpanels.user.profile.summary.details" weight="100">
    <resource name="view" type="velocity" location="view/details-profile.vm"/>
    <context-provider class="com.atlassian.jira.plugins.userprofile.DetailsUserProfilePanel"/>

Default 'Preferences' web panel:

<web-panel key="custom-user-prefs" location="webpanels.user.profile.summary.preferences" weight="200">
    <resource name="view" type="velocity" location="view/preferences-profile.vm"/>
    <context-provider class="com.atlassian.jira.plugins.userprofile.PreferencesUserUserProfilePanel"/>
    <condition class="com.atlassian.jira.plugins.userprofile.conditions.ProfileUserEqualsCurrentUser" />

Default 'Assigned Open Issues per Project' web panel:

<web-panel key="custom-user-assigned" location="webpanels.user.profile.summary.assigned" weight="300">
	<resource name="view" type="velocity" location="view/assigned-and-open.vm"/>
    <context-provider class="com.atlassian.jira.plugins.userprofile.AssignedAndOpenUserProfilePanel"/>
    <condition class="com.atlassian.jira.plugins.userprofile.conditions.UserCanBrowseProfileUserProjects" />

Adding a custom web panels to the User Profile page

To add a custom web panel, do the following:

  1. Define the custom web panel in your atlassian-plugin.xml specifying the appropriate key/location and the desired resource (as shown in the example below).
  2. Define the location of the custom web panel by setting the weight attribute to the desired value. The weight attribute for a custom web panel defines where the web panel will display in the left column of the User Profile page, from top to bottom.
    For example, if you have not changed the default weights of the 'Details', 'Preferences' and 'Assigned Open Issues per Project' web panels, and you set the weight of your custom web panel to 150, it will display between the 'Details' and 'Preferences' web panels.

Example custom web panel for User Profile page:

<web-panel key="custom-profile-panel" location="webpanels.user.profile.summary.custom" weight="150">
    <resource name="view" type="velocity" location="templates/webpanel/custom2.vm"></resource>
Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport