Synchronize User Profile Elements (v 2.0)
- Philipp Schlegel (Deactivated)
- Almuth Boehme [Communardo]
For the following steps you need Confluence Administrator permissions.
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.
Image 1: Configure Synchronization Settings (click to enlarge)
Please 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 > Add-ons 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.
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.
If you want to change the execution of the periodical synchronization, you can edit it via JVM startup parameter:
communardo-user-profiles.sync-start-minutes-after-midnight
For example, if you want to start the job at 3:33 am:
-Dcommunardo-user-profiles.sync-start-minutes-after-midnight=213
(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 > Add-ons at top right of the screen > Advanced).
Note that the synchronization will only run for that single user.