User Profiles and Metadata Integration
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 a value for the metadata field.
To create such a metadata field choose "User Profile Element" as type. Afterward, 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 that 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 that 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 when there is at least one metadata field of type "User Profile Element" assigned to a set in the Confluence instance. By selecting a field the macro automatically matches content with the same value as it is defined in the current user's profile.
Alternatively, the Metadata fields of type “User Profile Element” can also be used in CQL conditions (for example in the "Expert filter criteria (CQL)" option of macros metadata-overview and content-by-metadata), as shown in the following example:
MYEXAMPLESPACE.metadatafield.metadataprofilefield = "upc.currentUser"MYEXAMPLESPACE is the key of a space in which a metadata field of type "User Profile Element" is defined. By using the special value “upc.currentUser” the search will only return content with a metadata field value which matches the current user’s value of the user profile element linked to the metadata field. For more information about metadata CQL conditions please refer to Searching with Metadata (v 3.3).
Related Articles