Page tree
Skip to end of metadata
Go to start of metadata

User Profiles for Confluence is integrated with Metadata for Confluence. Therefore you can use the following functionality when both add-ons are installed on your Confluence.

Metadata Fields of Type User Profile Element

SINCE METADATA VERSION 3.0.4 SINCE USER PROFILES VERSION 2.1

If the Metadata and User Profiles add-ons are both installed, it is possible to use existing single- and multi-select user profile elements for metadata fields. This for example allows you to create a multi-select profile element "location" holding all the locations of your company and reuse it in a metadata field which defines for which locations the information on a page is relevant. When adding a new location you only have to do it in the user profile element. It will be automatically available as value for the metadata field.

To create such a metadata field choose "User Profile Element" as type. Afterwards, select one of the suggested single- and multi-select user profile elements. If you don't see any suggestion you will have to add a user profile element first. The created metadata field can be used in metadata sets like any other field. When assigning a value to it you will be presented with the options of the user profile element. If the user profile element is single-select, the metadata field will be single-select too.

To prevent unintentional loss of data it is not possible to delete a user profile element which is used in a metadata field. You will receive an error message when trying to do so. For the removal to work you will have to delete the metadata field first.

Caution should be taken when editing user profile elements which are used in metadata fields while the metadata add-on is disabled or uninstalled. In this scenario modifications like deletion of options or the whole element won't be tracked. This can lead to inconsistent metadata values if the metadata add-on is reenabled or reinstalled later on.

User Profile CQL Integration

SINCE METADATA VERSION 3.0.4 SINCE USER PROFILES VERSION 2.1

The macros metadata-overview and content-by-metadata have a new parameter "User Profile Field Mapping". This parameter is shown if there is at least one metadata field of type "User Profile Element" assigned to a set in the confluence system. By selecting a field the macro automatically matches content with the same value as it is defined in the current users profile.

The new parameter "Expert filter criteria (CQL)" in the metadata-overview and content-by-metadata macro is now able to handle a metadatafield mapping with the current users profile. Here is an example

 MYEXAMPLESPACE.metadatafield.metadataprofilefield = "upc.currentUser"

MYEXAMPLESPACE ist the spacekey of a metadatafield in side of this space. Because the metadatafield is mapped to a profile field CQL knows how to match these two.

Expert Filter Criteria (deprecated)

Whenever you can define expert filter criteria in Metadata for Confluence, you can get the value of certain user profile fields by using the placeholder upc.currentUser.<FIELDNAME>. This parameter works for all field types except multiselect and the About me field.

The following example shows the basic structure:

  •  metadatafield.site:upc.currentUser.Location

Here the field "Site" is managed in Metadata for Confluence, while the values of that field are stored in the field "Location" provided by User Profiles for Confluence (and most likely this will be synchronized from the user directory).

This way you can tailor the results of a Metadata Overview macro to the location the logged-in user is working at.

For more information on expert filter criteria, please refer to the documentation.