Quick Start Guide

Jira Plugin

Download the following files

...

mvn deploy:deploy-file -Dfile=user-profiles-external-api-1.0.0.jar -DgroupId=de.communardo.atlassian.plugins.userprofile.external.api -DartifactId=user-profiles-external-api -Dversion=1.0.0 -Dpackaging=jar -Djavadoc=user-profiles-external-api-1.0.0-javadoc.jar -DrepositoryId=<id-to-map-on-server-section-of-settings.xml> -Durl=<url-of-the-repository-to-deploy>

Include the

...

UPJ Java API in your Add-On pom.xml

<dependency>
    <groupId>de.communardo.atlassian.plugins.userprofile.external.api</groupId>
    <artifactId>user-profiles-external-api</artifactId>
    <version>1.0.0</version>
    <scope>provided</scope>
</dependency>

Import

...

UPJ components to your atlassian-plugin.xml

<component-import key="uppProfileElementManager" interface="de.communardo.atlassian.plugins.userprofile.external.api.service.UppProfileElementManager" />
<component-import key="uppProfileElementDataManager" interface="de.communardo.atlassian.plugins.userprofile.external.api.service.UppProfileElementDataManager" />

Make sure the User Profiles for Jira Add-on is already installed on your Confluence system.

Check Installation and Licensing (v 2.2) for further information.

Scriptrunner

General

Our Java API may also be accessed via Scriptrunner. To be able to do that you have to follow the steps which are described in the official Scriptrunner documentation, which can be found here: https://scriptrunner.adaptavist.com/latest/jira/scripting-other-plugins.html

Make sure the User Profiles for Jira Add-on is already installed on your Confluence system.

Check Installation and Licensing (v 32.32) for further information.

Example

To provide you a more easy way to start developing scripts with Scriptrunner, we prepared a minimal example, which provides you our API managers with whom you can access profile elements and their data:

import com.onresolve.scriptrunner.runner.customisers.PluginModule
import com.onresolve.scriptrunner.runner.customisers.WithPlugin
import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.sal.api.user.UserKey
import de.communardo.atlassian.plugins.userprofile.external.api.service.UppProfileElementManager
import de.communardo.atlassian.plugins.userprofile.external.api.service.UppProfileElementDataManager

@WithPlugin("de.communardo.jira.plugins.userprofile")

@PluginModule
UppProfileElementManager uppProfileElementManager
@PluginModule
UppProfileElementDataManager uppProfileElementDataManager

log.info(uppProfileElementManager.getProfileElements())
log.info(uppProfileElementDataManager.getProfileElementData(new UserKey(ComponentAccessor.getJiraAuthenticationContext().getLoggedInUser().getKey())))

The example prints the currently available profile elements and the available element data for the current user in the log (info log level, which may prevent you from seeing anything per default, so maybe use error instead if you want to directly see something).

Internal structure and basic usage

The UPC UPJ Java API consists out of two basic elements: the profile element and the profile element data. Profile elements can be added and removed in the UPC UPJ administration (check Configure Create and Edit User Profile Elements (v 32.32) for further information). Values may afterwards be added for every user via an LDAP sync or by manually editing user profiles (in the administration or the user does it on his own) or even by using our new Java API.

...