Synchronize User Profile Elements (v 2.4)

Owned by Enrico Schierz
Last updated: Sept 16, 2024 by Andreas Ebert
2 min read

For the following steps you need Jira Administrator permissions.

LDAP

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 elements.

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”.

Synchronization is not working for internal directories with LDAP authentication.

See also this knowledge-base article: https://communardo.atlassian.net/wiki/spaces/KB/pages/2149923456/Synchronizing+constellations+-+does+Crowd+work 

Manual Synchronization

The manual synchronization can be started from the advanced configuration setting (choose Cog icon > Add-ons at top right of the screen > User Profile Configuration > Advanced Options ). 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 > User Profile Configuration > Advanced Options.

Note that the synchronization will only run for that single user.

SAML Single Sign On (Jira SSO)/User Sync by resolution

You can also use the app "SAML Single Sign On (Jira SSO)" from resolution to populate our custom fields from other cloud identity providers. For more information see: Integration with User Sync and SAML SSO from resolution.


Back to Top

All Versions