Documentation's navigation

The documentation for versions 2.21 and older can be found here.


On this page


How many field types exist?




Common configuration options

There are several options that apply to every field type. 


Field label

Enter the name of the profile field here.

This is the name your users see in their profiles.


Help text

If you enter any text here, it will appear as a help icon for all users who edit their profiles. Use this field to guide your users.

Only plain text is allowed here (no HTML etc.).


Category

Select the correct category for your profile field. The correct category may be preselected already. Categories act as headings.


Field type

Select the correct field type. Many field types exist. They range from default text areas to date selects or imported LDAP data.

Depending on the field type, users will be able to enter different information into the profile field. In some cases, like with the field type "dependent field", the field value is fix and can not be changed by users.


In profile

Activate the slider button to display the profile field in the user's profile. 

Deactivate the slider button to hide the profile field in the user's profile.


Required

Activate the Required checkbox to make a profile field mandatory. This can be useful when the personalization depends on this field or the field is important in some other way.

Required profile fields will be shown inside the Profile Completion Assistant, if you choose to activate it.


LDAP attribute

If you synchronize your data with an LDAP resource, you can add the respective LDAP attribute name to every LUP profile field type.

Related topic: LDAP import


If the user exists in the user directory, the LDAP attribute will determine the profile value and the user can not edit this value within Confluence.

If the user does not exist in the user directory (or the LDAP attribute field is empty), the profile field can be edited from within Confluence.

If the user does exist, but the LDAP attribute is incorrect, the profile field will be blank and can not be edited from within Confluence.


Please note: This feature only works after the LDAP sync has run. It happens automatically every 3 hours.

To trigger it manually, navigate to Confluence administration → Scheduled Jobs → Bulk profile update (LDAP sync).



XML node name

If you set up an XML field, add the XML node name which should be retrieved for each profile update.

Related topic: XML import

Please note: When "XML file" is activated as a source, a user can not edit this field by themselves, if the xml file contains a value for the user in this field.

IdP import

Theoretically, it is also possible to include idP as a data source for profile fields.

Related topic: IdP import

Special fields

Full name

You can decide how the users' full names are being displayed.

Please note that this functionality only works with LDAP.

If you don't use LDAP in your system, you currently can't customize this field.


Conditions

There are a few conditions you must meet if you want to customize full names.

  1. Your system has to use LDAP.
  2. The full name customization only affects users imported from LDAP.
  3. To save the full name changes, you have to run the LUP: Bulk profile update (LDAP sync) scheduled job or manually synchronize a profile.
  4. The custom full name will only be saved for a user, when their profile data can be accessed from LDAP.
    1. Incremental synchronization will make saving a custom full name impossible if there were no changes made to the user.
    2. If no LDAP key exists for any Linchpin User Profiles field, saving a custom full name will not work.
The manual profile synchronization can be accessed under the More functions tab within a user profile.



Configuration

Navigate to Confluence administration → Linchpin User Profiles → Profile Editor → Special fields.

In the text field, enter the profile field keys which should form the full name. Use any of your previously created user profile fields.

For example: {cup.academictitle-1} {cup.firstname-2} {cup.lastname-3} will result in Dr. John Doe.


For this feature to work, you have to configure your LDAP permissions.


Navigate to Confluence administration → Users & Security → User Directories.

Set your LDAP permissions to Read/Write.

Important: Confluence will write the display name and possibly also the first and last name back into your LDAP resource.

Profile picture sources - URL, LDAP or Confluence

Profile pictures are a special kind of a profile field. They can be taken from three sources: URL, LDAP or direct upload to Confluence.

For a detailed guide on configuration and general information, please see the documentation on profile pictures.




Link to this page: https://seibert.biz/fieldtypes


This page was last edited on 10/02/2023.