|
Compatibility
Installation
Installing the Plugin
The plugin is available at the Atlassian Plugin Repository. To install the plugin, log in as system administrator and navigate to the global administration (Browse > Confluence Admin). Enter the "Plugin Repository", search for "User Profile Plugin" and press "Install".
If the installation was successful, a new item should appear on the left panel in the "Administration" section: "User Profile Configuration". This where the customization of the user profiles takes place. If this link is not visible, please ensure that all required modules of the plugin are enabled. You can do this by clicking "Plugins" in the global administration and selecting the "User Profile Plugin". Of the listed modules only the module "profile" is not required for the plugin to work. Each other module should be enabled (green).
Exchanging the {profile}-Macro
The User Profile Plugin provides its own version of the "profile" macro (which is a part of the bundled plugin "Profile Macros"). The macro is required to display user data at the people directory, the hover for each user and at the personal space. This version behaves exactly like the one from "Profile Macros" but displays additional profile elements too:
If you want to exchange the macros you have to apply the following customizations in the given order:
- Deactivate the original "profile" macro from the Profile Macros:
- Navigate to the global administration and select "Plugins" > "Profile Macros"
- click "Disable" next to the module "profile"
- Activate the macro "profile" from the User Profile Plugin
- Navigate to the global administration and select "Plugins" > "User Profile Plugin"
- click "Enable" next to the module "profile"
Licensing
Without an installed license the plugin runs in trial mode. This means you can only synchronize 10 users against your LDAP. Beyond that, there are no limitations to the functionality.
If you purchased a license it stays valid for one year. During that period you are entitled to support and to install updates for your plugin. After the year you can continue to use the plugin but it is no longer supported and falls into trial mode if you update it. You than have the option to purchase a renewal license which is less expensive than a full one. Each renewal license extends the validity of your plugin for another 12 months.
To purchase a license and provide it for the plugin please carry out the following instructions:
- Go to the license settings page (Global Administration > Plugins > User Profile Plugin > Configure Plugin).
- Decide for the kind of license you want to purchase: full or renewal
- A renewal license can only be applied if a full license was installed previously
- Click on the link that leads to your desired kind of license or directly navigate to the ShareIT Websites for the full or renewal license
- Decide for how many users you have to purchase the license and choose the specific product.
- This has to match the amount of users you purchased your Confluence license for (provided that license is still valid)!
- Follow the instructions of the shop
- At the last step ("Review Your Data") you have to provide the Server ID of your Confluence installation (section "Additional Ordering Information"). You can find the ID on the license settings page at the section "Product Information".
- After you finished the ordering process, you will receive an e-mail with the license key.
- Enter this license key (using copy & caste) into the text area below the section "License Key" on the license settings page and click on "Store License Key".
- After that you should see the period of validity for your license.
Configuration of user profile elements
You can access the configuration via the menu item "User Profile Configuration" in the panel on the left side of the administration section (Browse > Confluence Admin).
At the configuration page you can hide standard elements (1) or add new elements (2) for user profiles. The only standard elements that cannot be manipulated are Full Name and Email. This is to protect important system functionalities. Previously added profile elements can be deleted (4). A special feature is to configure mappings for LDAP attributes (3). Finally there is a link to invoke a manual synchronization (5). You can find more about this feature in the next section.
(1) The data for hidden elements stays stored as long as the checkbox "Hide" is active and is displayed again after it is unchecked.
(2) Additional elements are placed at the end of the sections Personal and Company in each users profile. The data for title and type is required. The element title is not internationalized (only the one given at the administration will be displayed). The type of the element determines the kind of the element: You can choose "Text field" or "Text area". The latter is convenient for elements which might carry longer texts (like the "About Me" element). Data for the LDAP attribute mapping is optional. Also consider the information about the attribute mapping stated below. It is recommended not to create more than 15 additional user profile elements.
(3) The mapping of LDAP attributes can be provided for standard and additional user profile elements. It is also possible to relate more than one LDAP attribute to one user profile element. The mapping has to be provided by using the following syntax:
- Any LDAP attribute has to be given as %%LDAP attribute%% (i.e. name of an LDAP attribute enclosed in %%).
- You can also specify static text (e.g. %%street%% %%number%% in %%city%%)
- Use %%delete_value%% as a placeholder to delete the data for a synchronized profile element.
Users cannot edit synchronized profile elements. An element is considered "synchronized", if the field "Mapping for LDAP Attribute(s)" in the customization form is not empty, even if the value of the mapped LDAP attribute is empty. This restriction only applies to users that are synchronized via LDAP. Local users can edit each profile element. Unknown LDAP attributes are recognized during synchronization and will be ignored. They are listed after each manual synchronization and produce a warning in the logs.
Note: For the data of the user profiles to be updated, a synchronization has to run first. See the next section on how this can be achieved.
(4) When a previously added profile element is deleted, all the data belonging to this element is purged as well for each user.
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 LDAP repository according to the mapping that was defined during configuration.
Manual Synchronization
The manual synchronization can be called from the configuration menu (there is a link at the bottom of the page). After clicking this link 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.
As 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 plugin is currently configured to start this synchronization at 1:11 a.m each night.
Single-User Synchronization
Whenever a user logs in its profile data is synchronized with the user repository. Note that the synchronization will only run for that single user.