...
...
...
...
...
...
| Table of Contents |
|---|
Installing the Add-on
The add-on is available on the Atlassian Marketplace. To install the add-on, log in as a system administrator and navigate to the add-on management in the administration console (choose Cog icon > Add-ons at top right of the screen or use the keyboard shortcut: press 'g g' then type 'Finde new add-ons'). In the menu on the left click the “Find New Add-ons” link. Search for “user profiles for jira” to display our add-on “User Profiles for JIRA”. Click the Buy Now or Free Trial button to install the add-on.
If the installation was successful, a new section “User Profiles for JIRA” should appear on vertical navigation within the “User Management”. This is where the customization of the user profiles takes place. If this section is not visible, please ensure that all required modules of the add-on are enabled. For this you should select the “User Profiles for JIRA” from the list of installed add-ons.
Licensing
The add-on needs a valid license to have all the provided features working. Valid licenses include full licenses, renewal licenses, or 30-day trials and are available on the Atlassian Marketplace. The license model is the same as the one Atlassian uses for its products – for further information see Atlassian’s documentation.
To get a license and provide it for the plugin, please carry out the following:
- Go to the license settings page (Administration > Add-ons > “Manage add-ons”: Extend the “User Profiles for JIRA”)
- Use the links to create a new license at the Atlassian Marketplace (use “Free Try” to get a new trial license or “Buy Now” to purchase a full license), or copy a license you got from Communardo.
- Enter the license key in the license screen.
Without a valid license, the user profiles show the message “Plugin is not licensed” instead of the user profile data.
Configuration
Several configurations are possible.
User Profile Elements
Configuration Overview
You can access the configuration via the menu item User Profile Settings > Profile Elements in the panel on the left side of the administration console (choose Cog icon > User Management at top right of the screen or use the keyboard shortcut: press 'g g' then type 'Profile Elements').
On this screen you have the Personal and Company sections as default. The full name and email are taken from JIRA itself, and cannot be edited. Below these elements, you’ll see the option to add a new element (“Add Element”). Once you click on this button, a new window will pop up where you’ll be able to create your own profile element.
There are a few options here:
- The Title – This is where you choose the name of the element.
- Help Text – You also have the option to add a help text. This will give a description of what this field means or a hint as to what’s expected in this field.
- Field Type Configuration – This allows you to choose the type of input the user has for this element. The options are a text field, a text area, a user field, single select (radio buttons), or multiple select (checkboxes). There’s also the option here to set up the element to synchronize with configured LDAP directories.
For the synchronization to work, you have to provide a mapping of LDAP attributes to standard or additional user profile elements. It is possible to relate more than one LDAP attribute to one user profile element. The mapping has to be provided at “Mapping for LDAP Attribute(s)” by using the following syntax:
Any LDAP attribute has to be given as %%LDAP_ATTRIBUTE%% (i.e. name of an LDAP attribute enclosed in two percent signs (%%)).
Multiple LDAP attributes with the same name are supported. If there are such attributes they will be mapped to the same profile field, separated by comma.
You can also specify static text (e.g. %%street%% %%number%% in %%city%%)
Use %%upp_delete_value%% as a placeholder to delete the data for previously synchronized profile element.
- Visibility – This enables the profile element to be seen on a user’s Hover Profile
Once you have some elements set up then you can rearrange the order on these elements with the up and down arrows on the Profile Elements main page. You can also edit each element or delete the elements you no longer want.
| Info |
|---|
Please note, that the fields are only visible at the profile, if they contain any information. Otherwise they are hidden! |
Synchronize User Profile Pictures
The synchronization of user pictures is supported from a central storage. You can find the configuration under “Special Elements” in the User Profile Settings > Profile Elements (choose Cog icon > User Management at top right of the screen or use the keyboard shortcut: press 'g g' then type 'Profile Elements').
Start Synchronization of User Pictures
Click "Edit" to open the configuration dialog for the picture synchronisation.
To synchronize user pictures from a central user directory you have to enter the attribute name where the picture is stored. The name of the attribute is typically “thumbnailPhoto” for Active Directory and “jpegPhoto” for OpenLDAP. You may set multiple attributes separated by a comma, i.e. “thumbnailPhoto,jpegPhoto”. This is useful, if you have configured multiple directories of different types.
The synchronization is based on the following features
- While the synchronization process is running a picture of a user is read out, cropped to a square format and if necessary scaled-down.
- Pictures are stored in standard size used in JIRA.
- If a picture is updated in the picture storage, the user picture will be overwritten in JIRA during the next synchronization.
- Users can upload own pictures, but after a new synchronization the picture from the picture storage is displayed again.
If there is no picture for the user in the external repository defined, the users uploaded image will be preserved through synchronization tasks.
Stop Synchronization of User Pictures
Leave the field “Attribute Name” blank if no synchronization is required or if you want to stop the synchronization.
| Note | ||
|---|---|---|
| ||
On systems with many users (1000+) the first synchronization may take very long (several hours) and can impact your systems performance. To improve the process or in case of synchronization errors it is recommended to enable “Login Synchronization” for a couple of days. |
Synchronization
There are 3 ways a synchronization can happen: Periodical or manual for all users (full synchronization), or at login for a single user. During this process, the data of a users profile elements is updated with the values from the configured LDAP repositories according to the mapping that was defined during configuration of the profile fields.
| Note | ||
|---|---|---|
| ||
The synchronization is only working in one direction. Data will only be pulled from a repository and will never be written back. This also applies to repositories which are configured as “Read/Write”. The synchronization is currently not working for directories of type “Apache Directory Server (ApacheDS)”. |
Manual Synchronization
The manual synchronization can be started from the advanced configuration setting (choose Cog icon > User Management at top right of the screen > Advanced). There is a button “Start Synchronization” below in the synchronization settings. After clicking it, a full synchronization will happen. This means that the profile for every user will be synchronized according to your configuration. After the synchronization a short summary will be shown.
| Warning |
|---|
Since a full synchronization is a resource consuming task, it should not be started during business hours! |
Periodical Synchronization
A full synchronization will be executed periodically. The add-on is configured to start this synchronization at 1:11 a.m. each night.
| Note | ||||
|---|---|---|---|---|
If you want to change the execution of the periodical synchronization, you can edit it via JVM startup parameter:
For example, if you want to start the job at 3:33 am:
(please do not forget -D at the beginning to mark the parameter as custom parameter and to restart your JIRA server after the customization) The above example will cause the job to run every night at 3:33, starting with the next day. I.e. the job will not run at 3:33 am on the day that you restarted your server (even if you did the restart at 2 am). |
Single-User Synchronization
Whenever a user logs in, his profile data is synchronized with the user repository. This setting is disabled by default, because it can have an impact on the login performance.
You can enable this synchronization type if you select the checkbox “Enable Login Synchronization” from the advanced configuration settings(choose Cog icon > User Management at top right of the screen > Advanced).
Note that the synchronization will only run for that single user.
| Include Page | ||||
|---|---|---|---|---|
|