Confluence Enterprise Profile Pictures - Administration Guide

The Enterprise Profile Picture plugin for Confluence allows enterprises to utilise their staff photos in the same way as Sharepoint or Exchange, by storing those photos either within Active Directory or on a central web or file server. The plugin then accesses those photos and imports them and links them to the user accounts in Confluence.

Profile Photos Location

Configuring the plugin is simple, allowing you to determine where your photos are stored:

  1. Active Directory
  2. File server
  3. Web server

 

Photo Attribute Name

If stored in Active Directory, you can choose which attribute the photos are stored in:

  • thumbnailPhoto
  • jpegPhoto

 

User to filename relationship

If using a File server or a Web server, you can supply a file path or URL reference to where the photos are stored and how the filenames map onto a user. A number of token substitutions are available, such as {username}, {firstname}, {lastname}, as well as their lowercase counterparts ({lc_firstname}, {lc_fullname} etc.) which will automatically be replaced with the user's details. Additionally, there are two simple string manipulation functions available: .charAt(n) and .substr(n[, m]) which can be used to select specific sub-strings or characters. A few examples will help to show you the flexibility:

Example data

 

Testing settings

Before confirming the plugin configuration settings, you can verify that your settings are correct by choosing any username that currently exists on your Confluence installation and click the Test button. This will fetch the photo from Active Directory, or the web or file server with the relationship settings you have currently entered and return the picture if found. If the Active Directory attribute is incorrect, or the relationship pattern doesn't match with a file, a "not found" image will be displayed instead.

Missing pictures

You can select an existing username with which to test your relationship to ensure your relationship is correct.

Administrative User

In order to modify the Confluence settings, a user with confluence-administration rights needs to be used. The username should be supplied of a suitable user. Typically this is the Confluence Administrator, such as confluence-admin.

Existing profile pictures

If some of your users have already set up their own profile pictures, you can decide to leave them be, by selecting the "Unedited / default.png only" option. By selecting this option, if the existing profile picture is called default.png (or default.gif on older installations) the picture will be replaced. If the existing profile picture has another name, the profile picture will be left unmodified.

New users over time

The plugin runs on a polling basis, setup by default to run daily at 19:23 hours. During this polling cycle you can opt to only check for users who do not or did not at the last polling cycle, have a photo mapped. If you change your staff photos annually, or some other frequency, untick this option to perform a complete refresh of all user photos.

Users without a profile picture

Users who do not have a profile picture associated have their usernames listed in the area at the bottom of the configuration screen. If your staff photos don't conform to a single relationship pattern, you can simply configure the relationship pattern again and re-run the polling job. If doing this, please ensure that the Incremental update checkbox is enabled.

Scheduled Job

The scheduled job can be edited, disabled, enabled and executed on demand via the Scheduled Jobs link under the Administration screen. The job is titled: 'Fetch Profile Pictures'.

© Copyright , Equion Consulting Ltd.