Linchpin User Profiles - Documentation
Create a meaningful and up to date profile
See the documentation for your Release
Inhalte auf dieser Seite:
Profile fields
You can create and manage profile categories to group fields. Profile fields can be assigned to a group.
Easier field order configuration
In older CUP versions you had to assign position numbers to fields and categories to define the order of fields. Now you are able to reposition fields via drag&drop. Just drag fields to a new position in the same or another category! To reposition the categories themselves, click the "Move category" button, reorder the categories and click "Finish moving".
Synchronized Confluence profile fields
Since release 1.4 the default Confluence profile fields are migrated into Custom User Profile fields. Starting with release 1.6, all changes to these migrated fields will be kept in sync with the default Confluence fields. So if you need to disable the Custom User Profile, the Confluence profile fields will still be up to date.
If you remove or uninstall the CUP, the values will be copied back to Confluence fields.
Profile field types
Text input
A text input is a single line text which a user can complete as desired.
Select
For a select, you can define options for the user to choose from. All possible options must be configured. The user can only select exactly one value from the option list.
Multi-Select
A multi-select is basically like a select except that a user can choose any number of options. See example screenshot of a multi-select configuration.
Retrieved from LDAP
If you set up an LDAP field, add the LDAP attribute name which should be retrieved for each profile update. Releated topic: CUP - Alternative LDAP connection 1.13
Date input
A date field allows the user to select and store a date in his or her profile.
User select (autocomplete)
A user select field displays an input field which will autocomplete user names. It can store only one user name and will display a link to the users profile.
Language select
A language select displays a list of languages. Users can select multiple entries.
New since 1.13: Retrieved from XML
If you set up an XML field, add the XML node name which should be retrieved for each profile update. Releated topic: CUP - XML import 1.13
Please note: If set, a user can't edit this field by themselves, if the xml file contains a value for the user in this field.
New since 1.13: Cascade Selection
The cascade selection lets you insert some sort of tree structure for this use case. See how to do this: Cascade Selection
Add an LDAP attribute name
Before this release, you had to decide if a profile field was retrieved from a user directory (like LDAP / AD) or filled in within Confluence.
Now you can optionally add an LDAP attribute to every CUP profile field type. If the user exists in the user directory, the LDAP attribute will determine the profile value and the user cannot edit this value within Confluence.
If the user does not exist in the user directory (or if you leave the LDAP attribute field blank), the profile field can be edited from within Confluence like in previous versions.
Please be aware that this feature only works after the CUP profile sync has run. The sync runs automatically every 3 hours, but can be triggered manually (Confluence administration --> Scheduled Jobs --> Bulk profile update (LDAP sync)).
Please make sure that you enter the correct LDAP attribute name. If the name is incorrect, the profile field will be blank for all users (and not editable).
Special fields
- A user's display name
- A user's profile picture: URL, LDAP attribute or Confluence
Display Name
As a confluence administrator you can flexibly define the look of your users' full names.
Go to the CUP Profile Editor on the administration screen and switch to the special fields tab. Insert your desired values into the text box labelled 'full name' to set up a user's displayed full name. Use any of your previously created LDAP fields in curly brackets as variables.
For example: {xup.academictitle-1} {xup.firstname-2} {xup.lastname-3}
Profile Picture: URL, LDAP attribute or Confluence
The Custom User Profile plugin can download profile pictures directly from your LDAP directory, from a custom URL or uploaded by the user itself.
As a Confluence administrator go to the 'Profile Editor' screen in the administration area and switch to the special fields tab. Use the radio buttons to select if you want to use profile images from Confluence, a URL, or an LDAP attribute. If you select URL you can enter a URL pointing to the users' profile picture in the text field below. Use any of your previously created LDAP fields in curly brackets as variables (Example: http://mypictures.net/{xup.anyfield-1}/user/{xup-userid-2}.png). If you select the LDAP option, enter an LDAP attribute for the users' profile picture (You can use JPEG- or PNG-Pictures) in the text box below (Example: jpegPhoto). You can also set the maximum size of the profile picture, this can be necessary for privacy reasons or disk space issues. The Images will be automatically re-sized on upload.
General Settings
Add a help text for profile edit
Provide information for your users when they edit their profile. You can give them hints why certain fields (LDAP) cannot be edited by the user, or add a support email address.
Profile Completion Assistant
See CUP - Profile Completion Assistant 1.7 for further information
New since 1.13: Cascade Selection
With this release you can configure cascade selection. Imagine you have a lot of products, with groups and categories to combine them. Every product has its responsible person, every group has its team leader and every category has its manager. So if you want to find the responsible persons for a certain product, the manager must have been assigned every single product he is responsible for.
Build a hierarchical cup field to structure your values
- Absolute path on server to a file in Excel or CSV format (.xlsx/.csv), which contains all selectable data.
- Save the field (The file will be uploaded and validated in this step)
- Edit the field again and import the data
The file import button only works after saving the profile field and re-editing it.
This cascade_selection_example.csv contains two categories ("foodstuffs", "tools"), which contain several groups ("vegetables", "fruits", "hand", "electric") and products ("tomato", and so on).
The first row are the field headlines. The uneven columns are the ids ("1", "aa"), which are needed to structure / sort the output. The even columns contain the actual values ("foodstuffs", "hand" or "banana").
Left picture: After importing the given file, you'll get a cascading profile field.
Right picture: If you select "banana" you are only assigned to "banana", but if you select tools, you are also assigned to every subnode (p.e. "hand" or "drilling machine")