--- language: "en" --- # User Profiles for Jira (Microsoft Attributes Sync) ## About the App ### The best way to make Jira workflows more personal and productive. *User Profiles for Jira (Microsoft Attributes Sync)* allows you to enhance Jira user profiles. * **Add fields** of various field types to your Jira user profiles * **Synchronize profile fields** and **user pictures** from configured LDAP repositories * **Display user profile fields** in Jira issues * **Search** for Jira issues based on profile field values ## Documentation The Confluence Cloud version of this app is not completely feature-congruent. Please refer to the Cloud [++documentation++](https://help.elevatic.com/user-profiles-for-jira-cloud.md) for more information. You will find on this page the currently released user documentation of our app. Use the navigation on the left side to guide yourself through the chapters of the documentation. * On the [introductory page](https://help.elevatic.com/user-profiles-for-jira/documentation.md), you will find more information about the target groups and all released versions of our app. ### Questions \& Answers If you have any problems or questions with our app, please do not hesitate to contact us or search in the following platforms: * [Frequently Asked Questions](https://help.elevatic.com/user-profiles-for-jira/frequently-asked-questions.md) * * [Product Website](https://www.communardo.com/solutions-products/communardo-apps/user-profiles-for-confluence) --- language: "en" --- # Add Profile Element as customized link In some cases, it is helpful to format information in the user profile as a link. This is easily possible with Jira's standard functionality when markup is used. Markup can also be used with mapping for LDAP Attribute(s). ## Example for LDAP mapping 1. [Create a profile Element](https://help.elevatic.com/user-profiles-for-jira/display-profile-elements-in-issues-v-2-6.md) with the field type "Textfield" 2. In the Mapping for LDAP Attributes, insert your link with markup. For example, if you want to add a link to an Organization chart that is available via https://example.com/chart/\, you can use the following markup: `[Link|https://example.com/chart/%%username%%]` 3. To display the link in the user profile, activate the visibility ("Display in Hover Profile") ![Profile_Element.png](https://help.elevatic.com/__attachments/a_1a4e8ea8f8e987290fe5b54f596414d2417061fbc86acf2a35d96e475b7d5fef/Profile_Element.png?cb=46921029364f72ebdc08dd964fa89084) 4. Please note: After configuring an LDAP/AD mapping, a [manual synchronization](https://help.elevatic.com/user-profiles-for-jira/synchronize-user-profile-elements-v-2-6.md) will be required before the data from LDAP/AD becomes available. 5. After configuration and synchronization, you will be able to see the Link in the user profile ![Ticket.png](https://help.elevatic.com/__attachments/a_f0ca914b2109c297118c834781040159edb9b1723ff784b671c47e6a3750a4a3/Ticket.png?cb=2b48dc5dd0942fcbee185b0d82c7f055) 6. To display this link in Jira issues, please have a look at the documentation: [Display Profile Elements in Issues](https://help.elevatic.com/user-profiles-for-jira/display-profile-elements-in-issues-v-2-6.md) ## Related articles * [Problem Synchronizing Multiple User Directories](https://help.elevatic.com/user-profiles-for-jira/problem-synchronizing-multiple-user-directories.md) * [Fetch user profile data through script](https://help.elevatic.com/user-profiles-for-jira/fetch-user-profile-data-through-script.md) * [Add Profile Element as customized link](https://help.elevatic.com/user-profiles-for-jira/add-profile-element-as-customized-link.md) * [Cannot find User Profile field in pie chart gadget](https://help.elevatic.com/user-profiles-for-jira/cannot-find-user-profile-field-in-pie-chart-gadget.md) * [Unusual large size of profile picture when editing customer details on service desk](https://help.elevatic.com/user-profiles-for-jira/unusual-large-size-of-profile-picture-when-editing-customer-details-on-service-desk.md) --- language: "en" --- # Add user profile field to email template Use case: you want to add part of the user profile information of a user (e.g., the reporter) to JIRA's (NOT Service Desk's ![warning](https://help.elevatic.com/__attachments/a_8930357b13b2db414a07b8b65e8016d3febab4cd6f0e814d32454f2de0db492f/atlassian-warning?cb=14432459925d605e05cae2605cdfe666) ) notification mails. ## Solution To achieve this, you need to create a new custom field for the profile field, e.g., telephone number and add that custom field to an email template. So, please try this: 1. Create a new *User Profile Field* for the reporter's telephone number, [as described in our product documentation](https://help.elevatic.com/user-profiles-for-jira/display-profile-elements-in-issues-v-2-6.md). 2. Update or create a new email template, [as described in Atlassian's documentation](https://confluence.atlassian.com/adminjiraserver/customizing-email-content-938847640.html). Add the newly created custom field to the email template of your choice, [as described in Atlassian's developer documentation](https://developer.atlassian.com/jiradev/jira-platform/jira-architecture/jira-templates-and-jsps/adding-custom-fields-to-email). The important code snippets are (remember to insert your own custom field ID): * The field's name: `$issue.getCustomField("customfield_10000").name` * The field's value: `$issue.getCustomFieldValue("customfield_10000")` ## Related Articles * [Problem Synchronizing Multiple User Directories](https://help.elevatic.com/user-profiles-for-jira/problem-synchronizing-multiple-user-directories.md) * [Fetch user profile data through script](https://help.elevatic.com/user-profiles-for-jira/fetch-user-profile-data-through-script.md) * [Add Profile Element as customized link](https://help.elevatic.com/user-profiles-for-jira/add-profile-element-as-customized-link.md) * [Cannot find User Profile field in pie chart gadget](https://help.elevatic.com/user-profiles-for-jira/cannot-find-user-profile-field-in-pie-chart-gadget.md) * [Unusual large size of profile picture when editing customer details on service desk](https://help.elevatic.com/user-profiles-for-jira/unusual-large-size-of-profile-picture-when-editing-customer-details-on-service-desk.md) * [Add user profile field to email template](https://help.elevatic.com/user-profiles-for-jira/add-user-profile-field-to-email-template.md) * [Does the click-to-call function work with VoIP?](https://help.elevatic.com/user-profiles-for-jira/does-the-click-to-call-function-work-with-voip.md) * [Unable to synchronize a User Profile Field with Active Directory (JIRA)](https://help.elevatic.com/user-profiles-for-jira/unable-to-synchronize-a-user-profile-field-with-active-directory-jira.md) * [Custom User Field not Appearing in Issues](https://help.elevatic.com/user-profiles-for-jira/custom-user-field-not-appearing-in-issues.md) --- language: "en" --- # Administrator's Guide (v 2.6) The **Administrator's Guide** is intended for Jira administrators. It helps you to install the app, to add new profile fields, or to configure the synchronization with an LDAP. Use the navigation on the left to guide you through the documentation's chapters. * [Installation and Licensing (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/installation-and-licensing-v-2-6.md) * [Create and Edit User Profile Elements (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/create-and-edit-user-profile-elements-v-2-6.md) * [Display Profile Elements in Issues (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/display-profile-elements-in-issues-v-2-6.md) * [Synchronize User Profile Elements (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/synchronize-user-profile-elements-v-2-6.md) * [Synchronize User Profile Pictures (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/synchronize-user-profile-pictures-v-2-6.md) * [Synchronizing user directories without LDAP connection (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/synchronizing-user-directories-without-ldap-connection-v-2-6.md) * [Company Chat App Integration (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/company-chat-app-integration-v-2-6.md) --- language: "en" --- # Cannot find User Profile field in pie chart gadget ## Problem At the request of our JIRA users, we are pulling Active Directory information into user profiles and have placed a User Profile field on JIRA issues to display the value. We can successfully search on the User Profile field and create filters. However, we cannot create pie chart gadgets based on the User Profile field because it does not appear in the Statistic Type field for the gadget. Can the User Profile fields be made statable so that we can use them in gadgets? ## Solution The User Profile custom field is already selectable if you choose the right configuration. It is possible to use the following combinations: * User Profile Field "Userfield" with Search Template "User Picker \& Group Searcher" * User Profile Field "Single Select (Radiobuttons)" with Search Template "Multiple Select Searcher" * User Profile Field "Multiple Select (Checkboxes)" with Search Template "Multiple Select Searcher" Complete the with the aforementioned settings to make the custom field you created available for the pie chart gadget. ## Related Articles * [Problem Synchronizing Multiple User Directories](https://help.elevatic.com/user-profiles-for-jira/problem-synchronizing-multiple-user-directories.md) * [Fetch user profile data through script](https://help.elevatic.com/user-profiles-for-jira/fetch-user-profile-data-through-script.md) * [Add Profile Element as customized link](https://help.elevatic.com/user-profiles-for-jira/add-profile-element-as-customized-link.md) * [Cannot find User Profile field in pie chart gadget](https://help.elevatic.com/user-profiles-for-jira/cannot-find-user-profile-field-in-pie-chart-gadget.md) * [Unusual large size of profile picture when editing customer details on service desk](https://help.elevatic.com/user-profiles-for-jira/unusual-large-size-of-profile-picture-when-editing-customer-details-on-service-desk.md) * [Add user profile field to email template](https://help.elevatic.com/user-profiles-for-jira/add-user-profile-field-to-email-template.md) * [Does the click-to-call function work with VoIP?](https://help.elevatic.com/user-profiles-for-jira/does-the-click-to-call-function-work-with-voip.md) * [Unable to synchronize a User Profile Field with Active Directory (JIRA)](https://help.elevatic.com/user-profiles-for-jira/unable-to-synchronize-a-user-profile-field-with-active-directory-jira.md) * [Custom User Field not Appearing in Issues](https://help.elevatic.com/user-profiles-for-jira/custom-user-field-not-appearing-in-issues.md) --- language: "en" --- # Company Chat App Integration (v 2.6) For the following steps you need Jira Administrator permissions. The Company Chat App Integration allows you to start a chat with Microsoft Teams or Skype for Business directly from the user profile or hover card. You can configure the Company Chat App Integration in the administration section *at Cog icon \> Apps \> User Profile Configuration* \> *Integration Options* \> *Company Chat App Integration* . You can choose between an integration for Skype for Business or Microsoft Teams. Only one integration can be activated at a time. To have no integration at all, just disable all the options. ![upj-2.PNG](https://help.elevatic.com/__attachments/a_eff22a4bfc7b058dc73c4efe21d732b0dffc4ae18d4648128e0d2afd256597c1/upj-2.PNG?cb=953ba6bf675742c98fce9fdebe7e3be7) *Image 1: Configuration -- Company Chat App Integration* If one of the options is enabled, user profiles and hover cards will be enriched with a link for starting a chat with the user. ![upj-1.PNG](https://help.elevatic.com/__attachments/a_614296f129af427b84b26fca01613aa7a46e0136b15f625ea0cf4cfe12c4cd0d/upj-1.PNG?cb=e255f31f598bce8b90ac816e773c37be) *Image 2: User Profile -- Company Chat App Integration* **Information about Performance** Be aware that Skype for Business or Microsoft Teams link contains the user's email address. If you limited the rendering of the email address to administrators in the security settings, you should probably also disable this option. *** ** * ** *** [Back to Top](https://communardo-products.atlassian.net/wiki/spaces/UPJ/pages/572195239/Company+Chat+App+Integration+v+2.6#CompanyChatAppIntegration(v2.6)-top) --- language: "en" --- # Create and Edit User Profile Elements (v 2.6) For the following steps you need Jira Administrator permissions. ## Configuration Overview With version 2.0, the configuration has moved from "User Management" to "Apps" in the Administration. You can access the configurationin the JIRA Administration (choose *Cog icon \> Apps* at top right of the screen or use the keyboard shortcut: press "gg" then type "User Profile Configuration") via the menu item *User Profile Settings \> User Profile Configuration* in the panel on the left side. ![Administration - Profile Elements - Overview](https://help.elevatic.com/__attachments/a_0fcd5381ea8f92cfd665326b4315e80ceda9e4428f329e40411dc6b00a48ff3c/Administration%20-%20Profile%20Elements%20-%20Overview?cb=1a31c018ef03be8c96b5b499b4372a4e) *Image 1: Profile Elements Overview (click to enlarge)* On this screen the Personal and Company sections are displayed by default. The full name and email are taken from JIRA itself and cannot be edited. Once you have some elements set up, you can rearrange the order on these elements with the up and down arrows in the *Order* column. You can also edit each element or delete the elements you no longer want. Please note, that the elements are only visible at the profile, if they contain any information. Otherwise they are hidden! See the next section for information on setting up a new profile element. ## Create a new Profile Element Below the displayed elements, you can find the option to add a new element ("Add Element"). Once you click on this button, a new window will pop up which allows you to configure a new profile element. ![Administration - Profile Elements - Add new Element](https://help.elevatic.com/__attachments/a_c123c6b5a834ab0c092ec7bc732535a16717ef4d186add50c63cd3e310f997bd/Administration%20-%20Profile%20Elements%20-%20Add%20new%20Element?cb=0566403fab4dd6cdc56cf684badeb71c) *Image 2: Create new Profile Element (click to enlarge)* You can configure the following options: ### Title for this Element * Title (Default): Define a default title for the element which will be English in most systems. * Title (German): Optionally define a German title for the element. It will be displayed when the language setting is changed to German. ### Help Text for this Element You also have the option to add a help text. This will give a description of what this element means or a hint as to what's expected in this element. ### Field Type Configuration #### Field Type since version 2.0 The following options are available as element types: * Textfield * Userfield * Phone Number * Single Select (Radiobuttons) * Multiple Select (Checkboxes). #### Mapping for LDAP Attribute(s) You can set up the profile element to synchronize with configured LDAP directories. For the synchronization to work, you have to provide a mapping of LDAP attributes to standard or additional user profile elements. It is possible to relate more than one LDAP attribute to one user profile element. The mapping has to be provided at "Mapping for LDAP Attribute(s)" by using the following syntax: * Any LDAP attribute has to be given as **%%LDAP_ATTRIBUTE%%** (i.e. name of an LDAP attribute enclosed in two percent signs (%%)). * If you reference a **user** , e. g. to display the manager of a user, set the check mark for "**The field value is a DN reference to the user".**This ensures that the name is resolved correctly. * Multiple LDAP attributes with the same name are supported. If there are such attributes they will be mapped to the same profile element, separated by comma. * You can also specify static text (e.g. %%street%% %%number%% in %%city%%) * Use %%upp_delete_value%% as a placeholder to delete the data for previously synchronized profile element. Synchronized user profile elements cannot be edited by JIRA users. ### Visibility If you check this box, the profile element will be displayed in the user profile which pops up when hovering over a user name. *** ** * ** *** --- language: "en" --- # Custom User Field not Appearing in Issues ## Problem A custom user field was created to sync with a user profile element. The user profile add-on has been installed and is working well, but the custom field set up to display a user profile element is not appearing on forms, even after adding it to the relevant screens. ## Solution 1. Check that you performed all the steps in the documentation, including the re-index: 2. Check that the **user profile** field of the Reporter/Assignee/whatever field you configured as *Reference User Field* contains a value. An empty field won't be displayed. 3. Go to the issue view where you expect the field and choose "Admin" at the top right and "Where is my field?". Make sure the field is configured to appear on the relevant screens. The field will not appear on the edit screen, even if it is set up correctly. It is not possible to change these fields in the ticket - only in the user profile - therefore, they will not appear on an edit screen. ## Related Articles * [Problem Synchronizing Multiple User Directories](https://help.elevatic.com/user-profiles-for-jira/problem-synchronizing-multiple-user-directories.md) * [Fetch user profile data through script](https://help.elevatic.com/user-profiles-for-jira/fetch-user-profile-data-through-script.md) * [Add Profile Element as customized link](https://help.elevatic.com/user-profiles-for-jira/add-profile-element-as-customized-link.md) * [Cannot find User Profile field in pie chart gadget](https://help.elevatic.com/user-profiles-for-jira/cannot-find-user-profile-field-in-pie-chart-gadget.md) * [Unusual large size of profile picture when editing customer details on service desk](https://help.elevatic.com/user-profiles-for-jira/unusual-large-size-of-profile-picture-when-editing-customer-details-on-service-desk.md) * [Add user profile field to email template](https://help.elevatic.com/user-profiles-for-jira/add-user-profile-field-to-email-template.md) * [Does the click-to-call function work with VoIP?](https://help.elevatic.com/user-profiles-for-jira/does-the-click-to-call-function-work-with-voip.md) * [Unable to synchronize a User Profile Field with Active Directory (JIRA)](https://help.elevatic.com/user-profiles-for-jira/unable-to-synchronize-a-user-profile-field-with-active-directory-jira.md) * [Custom User Field not Appearing in Issues](https://help.elevatic.com/user-profiles-for-jira/custom-user-field-not-appearing-in-issues.md) --- language: "en" --- # Developer's Guide (v 2.6) The Developer's Guide provides you with a detailed Java API documentation. [Java API Documentation (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/java-api-documentation-v-2-6.md) --- language: "en" --- # Display Profile Elements in Issues (v 2.6) since version 2.0 Starting with version 2.0 you can display user profile elements in JIRA issues. This will at the same time allow you to search for these elements in the JIRA search. Below you will find the necessary configuration steps. ## 1. Create a Custom Field First you will need to create a custom field in JIRA, which will be mapped to a user profile element. 1. Go to the Administration (cog icon) \>*Issues* \> *Custom fields* (under the heading *Fields*). 2. Click "Add custom field" at the top right. 3. Click "Advanced" on the left and search for "User Profile Field". (see image 1 below) 4. Choose "User Profile Field" and click "Next". 5. Enter a name and a description (optional) (see [Best Practice](https://communardo-products.atlassian.net/wiki/spaces/UPJ/pages/572195137/Display+Profile+Elements+in+Issues+v+2.6#DisplayProfileElementsinIssues(v2.6)-best)) 6. Click "Create". 7. Choose a screen/screens where the field should be displayed and confirm with "Update" (see [Best Practice](https://communardo-products.atlassian.net/wiki/spaces/UPJ/pages/572195137/Display+Profile+Elements+in+Issues+v+2.6#DisplayProfileElementsinIssues(v2.6)-best)) ![Create_Custom_Field.png](https://help.elevatic.com/__attachments/a_91c7b54eb0e334ce0d0fb9a1722811c4dca2d6a00f7c8239b1eda2883b76b818/Create_Custom_Field.png?cb=e1196ff59703612050d1097680d25e0d) *Image 1: Create a Custom Field (click to enlarge)* ### Best Practice * Choose a **name** which is self-explanatory in the context of the purpose of this field. The name you choose for the custom field will be used in the JIRA search. * It is not recommended to display the field on an edit screen. Changes to the field value can only be made in the corresponding user profile. Putting the field on an edit screen might raise confusion why the value cannot be edited. ## 2. Map the Custom Field to a Profile Element Now that you have set up a custom field, you can map it to a user profile element and choose a search template. 1. Go to the Administration (cog icon) \>*Apps* \> *User Profile Fields* (under the heading *User Profile Settings*). 2. Click "Configure" next to the field you created in the previous step. 3. Choose a Reference User Field. (see image 2 below) The "Reference User Field" can be any field which is of type "single user picker field". So all **standard fields** , like reporter or assignee, and **custom fields** of this type are supported. 4. Choose a Profile Element. 5. Choose a Search Template (what works best with the chosen element type in 4. will be displayed as recommendation). 6. Confirm with "Update". ![Configure_Custom_Field](https://help.elevatic.com/__attachments/a_97bda72e94d93c9adaa906df0ad46ba66f3c1aea0bb8649e27ff03a7b14f1e5b/Configure_Custom_Field?cb=537c8ce2f4b2d62f992edc295457d7b5) *Image 2: Configure User Profile Field (click to enlarge)* ## 3. Perform a Re-index When changes are made to a custom user field in JIRA, it is necessary to perform a reindex so the changes are reflected in the issues. 1. Go to the Administration (cog icon) \>*System* \> *Indexing* (under the heading *Advanced*) or search by entering "." and typing "indexing" into the search box that opens. 2. Choose a re-index option and confirm with "Re-Index". Now you can display user profile element values in JIRA issues. ## Further Information * [Configuring a custom field in JIRA](https://confluence.atlassian.com/adminjiraserver/configuring-a-custom-field-938847235.html) ## User Profile Field Re-Indexer Job When a profile element is updated it can take several minutes until the changes are reflected in an issue. You can find the job responsible for updating the values in the JIRA Administration \> *System* \> *Scheduler Details*under "User Profiles for JIRA Job Runner". When you click "Show more" you'll see #2 "User Profile Field Re-Indexer", which runs once per minute by default. ![User_Profile_Reindexer_Job](https://help.elevatic.com/__attachments/a_e83396db7b2f621ab955064d6eab50a540f9ef3cc8d31025d68e9d9335099ee2/User_Profile_Reindexer_Job?cb=f1b9c7847ca6b841875402cb10683caf) *Image 3: User Profiles for JIRA Job Runner (click to enlarge)* *** ** * ** *** [Back to Top](https://communardo-products.atlassian.net/wiki/spaces/UPJ/pages/572195137/Display+Profile+Elements+in+Issues+v+2.6#DisplayProfileElementsinIssues(v2.6)-top) --- language: "en" --- # Documentation ## Introduction On the following pages, you can find the complete documentation of all *User Profiles for Jira (Microsoft Attributes Sync)* releases. Use the navigation on the left side to guide yourself through the chapters of the documentation. * The User's Guide is intended for anyone using *User Profiles for Jira (Microsoft Attributes Sync)*. It provides you with about editing the user profiles and the profile picture synchronization. * The Administrator's Guide is intended for Jira administrators. It helps you to install the app, to add new profile fields, or to configure the synchronization with an LDAP repository. --- language: "en" --- # Does the click-to-call function work with VoIP? If a telephone number element is configured in the user profiles, can the click-to-call function be used only with instant messengers, or does it work, e.g., with Microsoft Teams or a Smartphone? ## Solution The number will be called via the application that is configured for the "tel" protocol on the client, e.g., Microsoft Teams on a PC or the telephone app on a Smartphone. If such an application is not yet configured, the user will be asked to choose one. You can find additional details in the [documentation](https://help.elevatic.com/user-profiles-for-jira/administrator-s-guide-v-2-6.md). ## Related Articles * [Problem Synchronizing Multiple User Directories](https://help.elevatic.com/user-profiles-for-jira/problem-synchronizing-multiple-user-directories.md) * [Fetch user profile data through script](https://help.elevatic.com/user-profiles-for-jira/fetch-user-profile-data-through-script.md) * [Add Profile Element as customized link](https://help.elevatic.com/user-profiles-for-jira/add-profile-element-as-customized-link.md) * [Cannot find User Profile field in pie chart gadget](https://help.elevatic.com/user-profiles-for-jira/cannot-find-user-profile-field-in-pie-chart-gadget.md) * [Unusual large size of profile picture when editing customer details on service desk](https://help.elevatic.com/user-profiles-for-jira/unusual-large-size-of-profile-picture-when-editing-customer-details-on-service-desk.md) * [Add user profile field to email template](https://help.elevatic.com/user-profiles-for-jira/add-user-profile-field-to-email-template.md) * [Does the click-to-call function work with VoIP?](https://help.elevatic.com/user-profiles-for-jira/does-the-click-to-call-function-work-with-voip.md) * [Unable to synchronize a User Profile Field with Active Directory (JIRA)](https://help.elevatic.com/user-profiles-for-jira/unable-to-synchronize-a-user-profile-field-with-active-directory-jira.md) * [Custom User Field not Appearing in Issues](https://help.elevatic.com/user-profiles-for-jira/custom-user-field-not-appearing-in-issues.md) --- language: "en" --- # Faster Ticket Resolution with Additional Contact Details from Microsoft Entra ID ## System Jira Service Management, Microsoft Entra ID App: [++User Profiles for Jira (Microsoft Attributes Sync)++](https://communardo.app/9UIaIJ) ### Short Description Reduce ticket resolution time by giving IT agents full visibility of user details from Microsoft Entra ID directly in Jira tickets. ### Challenge IT support agents often face the challenge of incomplete information when resolving tickets. Without easy access to contact details or department data, agents need to reach out to reporters or search other systems, leading to longer resolution times and unnecessary communication steps. ### Actors 💻 Rita -- IT Support Specialist 👔 John -- Employee 🛠️ Taylor -- IT Admin ### Actors' Goals * **John (Employee):** Wants his request to be resolved quickly without having to provide additional details. * **Rita (IT Support Specialist):** Wants to have complete and accurate reporter information available in Jira to resolve tickets without back-and-forth communication. * **Taylor (IT Admin):** Wants user data from Microsoft Entra ID to be synchronized with Jira automatically, ensuring information accuracy. ### Use Case Scenario (step-by-step) 1. John submits an IT request through Jira Service Management. 2. The ticket is automatically assigned to Rita. 3. When Rita opens the ticket, she immediately sees John's department, phone number, and office location synchronized from Microsoft Entra ID and displayed on the issue. 4. With all relevant details available, Rita identifies the issue context and solves the ticket without back and forth. 5. The ticket is resolved faster, and John receives a timely update. ### Outcome * IT support agents like Rita can resolve requests without repeated communication, as all reporter details are readily available in Jira. * Employees like John spend less time following up on their requests. * The company benefits from shorter resolution times and more efficient service operations. ## **Documentation** * User's Guide -- [++Link++](https://communardo.app/rWT42r) * Configuration Guide -- [++Link++](https://communardo.app/VMGT68) ## Additional Content [How IT Service Management Teams Benefit from User Profiles for Jira Cloud](https://www.communardo.com/knowledge/blog/how-it-service-management-teams-can-benefit-from-user-profiles-for-jira-cloud/) [User Profiles for Jira app for Business Teams](https://www.communardo.com/knowledge/blog/how-business-teams-can-benefit-from-user-profiles-for-jira-cloud/) ## **Atlassian Marketplace** Find User profiles for Jira on the [Atlassian Marketplace](https://marketplace.atlassian.com/apps/1212508/user-profiles-for-jira-microsoft-attributes-sync?hosting=cloud&tab=overview). --- language: "en" --- # Fetch user profile data through script There is some profile data, which I would like to fetch for a large number of users. How can I fetch the data in scripts for several users? ## Instructions ### Java API or Groovy Script Since Version 2.2.0 It is possible to access profile data through the Java API or with [Adaptavist ScriptRunner for Jira](https://marketplace.atlassian.com/apps/6820/scriptrunner-for-jira?hosting=server&tab=overview). For details, please refer to our [Java API Documentation](https://help.elevatic.com/user-profiles-for-jira/java-api-documentation-v-2-6.md). ### Alternative Workaround (before version 2.2.0) This is what you can do at the moment: 1. Create a project where each user you are interested in is, e.g, the assignee of an individual issue (or the reporter or another single user picker field) 2. Add a User Profile custom field to each issue that provides the user profile field of the assignee (or reporter, ...) that you are interested in by following [the instructions](https://communardo-products.atlassian.net/wiki/spaces/UPJ/pages/572195137/Display+Profile+Elements+in+Issues+v+2.6) in our documentation 3. Use your script to fetch the data from that field for each issue/user ## Related articles * [Problem Synchronizing Multiple User Directories](https://help.elevatic.com/user-profiles-for-jira/problem-synchronizing-multiple-user-directories.md) * [Fetch user profile data through script](https://help.elevatic.com/user-profiles-for-jira/fetch-user-profile-data-through-script.md) * [Add Profile Element as customized link](https://help.elevatic.com/user-profiles-for-jira/add-profile-element-as-customized-link.md) * [Unusual large size of profile picture when editing customer details on service desk](https://help.elevatic.com/user-profiles-for-jira/unusual-large-size-of-profile-picture-when-editing-customer-details-on-service-desk.md) * [Does the click-to-call function work with VoIP?](https://help.elevatic.com/user-profiles-for-jira/does-the-click-to-call-function-work-with-voip.md) * [Add user profile field to email template](https://help.elevatic.com/user-profiles-for-jira/add-user-profile-field-to-email-template.md) * [Cannot find User Profile field in pie chart gadget](https://help.elevatic.com/user-profiles-for-jira/cannot-find-user-profile-field-in-pie-chart-gadget.md) * [Custom User Field not Appearing in Issues](https://help.elevatic.com/user-profiles-for-jira/custom-user-field-not-appearing-in-issues.md) * [Unable to synchronize a User Profile Field with Active Directory (JIRA)](https://help.elevatic.com/user-profiles-for-jira/unable-to-synchronize-a-user-profile-field-with-active-directory-jira.md) --- language: "en" --- # Frequently Asked Questions Find answers to **frequently asked questions** for User Profiles for Jira (Microsoft Attributes Sync) and **general resources** for migration and support below. ## 🚀 App-specific FAQs Select a page below to find answers to specific features, configuration, and usage questions. These pages are updated regularly to reflect the latest app versions. * [Custom User Field not Appearing in Issues](https://help.elevatic.com/user-profiles-for-jira/custom-user-field-not-appearing-in-issues.md) * [Unable to synchronize a User Profile Field with Active Directory (JIRA)](https://help.elevatic.com/user-profiles-for-jira/unable-to-synchronize-a-user-profile-field-with-active-directory-jira.md) * [Does the click-to-call function work with VoIP?](https://help.elevatic.com/user-profiles-for-jira/does-the-click-to-call-function-work-with-voip.md) * [Add user profile field to email template](https://help.elevatic.com/user-profiles-for-jira/add-user-profile-field-to-email-template.md) * [Unusual large size of profile picture when editing customer details on service desk](https://help.elevatic.com/user-profiles-for-jira/unusual-large-size-of-profile-picture-when-editing-customer-details-on-service-desk.md) * [Cannot find User Profile field in pie chart gadget](https://help.elevatic.com/user-profiles-for-jira/cannot-find-user-profile-field-in-pie-chart-gadget.md) * [Add Profile Element as customized link](https://help.elevatic.com/user-profiles-for-jira/add-profile-element-as-customized-link.md) * [Fetch user profile data through script](https://help.elevatic.com/user-profiles-for-jira/fetch-user-profile-data-through-script.md) * [Problem Synchronizing Multiple User Directories](https://help.elevatic.com/user-profiles-for-jira/problem-synchronizing-multiple-user-directories.md) * [Where can I find Information about Data Privacy?](https://help.elevatic.com/user-profiles-for-jira/where-can-i-find-information-about-data-privacy.md) * [Where can I find Information about Data Security?](https://help.elevatic.com/user-profiles-for-jira/where-can-i-find-information-about-data-security.md) ## 📚 General Resources If your question is not specific to a single app, please refer to our general documentation and migration resources. * [++**General App Documentation**++](https://help.elevatic.com/general-app-documentation) Find general how-to articles and cross-product information. * [++**Cloud Migration Hub**++](https://help.communardo.app/general-app-documentation/cloud-migration-hub) Access migration guides, feature parity overviews, and migration-specific FAQs. ## 🤝 Support If you cannot find the answer to your question in the documentation or the app-specific pages above, our support team is here to help. * [++**Create a request**++](https://go.communardo.app/support) Open a support ticket with our team for personalized assistance. * [++**Service Level Agreement**++](https://help.communardo.app/general-app-documentation/service-level-agreement-for-paid-apps) Review response times and support commitments for paid apps. When contacting support, please include the **product name** and a **detailed description** of your query to help us assist you faster. ## 🔒 Privacy and Trust We value your data security and transparency. Detailed information regarding our privacy policy, data collection, and compliance is available in our central resources. * [++**Trust Center**++](https://trust.communardo.com/) Find our privacy policy, compliance certifications, and subprocessor lists. For any specific security inquiries not covered in the links above, please [++create a support request++](https://go.communardo.app/support). --- language: "en" --- # Installation and Licensing (v 2.6) For the following steps you need Confluence Administrator permissions. ## Installing the App The app is available on the [Atlassian Marketplace](https://marketplace.atlassian.com/plugins/de.communardo.jira.plugins.userprofile). To install the app, log in as a system administrator and navigate to the app management in the administration console (choose *Cog icon \> Apps* at top right of the screen or use the keyboard shortcut: press 'g g' then type 'Finde new apps'). In the menu on the left click the "Find New Apps" link. Search for "user profiles for jira" to display our app *User Profiles for Jira (Microsoft Attributes Sync)* . Click the **Buy Now** or **Free Trial** button to install the app. If the installation was successful, a new section "User Profiles for Jira (Microsoft Attributes Sync)" should appear on vertical navigation within the "User Management". This is where the customization of the user profiles takes place. If this section is not visible, please ensure that all required modules of the app are enabled. For this, you should select the *User Profiles for Jira (Microsoft Attributes Sync)* app from the list of installed apps. ## Licensing The app needs a valid license to have all the provided features working. Valid licenses include full licenses, renewal licenses, or 30-day trials and are available on the Atlassian Marketplace. The license model is the same as the one Atlassian uses for its products -- for further information see [Atlassian's documentation](http://www.atlassian.com/licensing/marketplace). To get a license and provide it for the app, please carry out the following: * Go to the license settings page (*Administration \> Apps \> "Manage apps"*: Extend the "User Profiles for Jira (Microsoft Attributes Sync)") * Use the links to create a new license at the Atlassian Marketplace (use "Free Try" to get a new trial license or "Buy Now" to purchase a full license), or copy a license you got from Elevatic. * Enter the license key in the license screen. Without a valid license, the user profiles show the message "Plugin is not licensed" instead of the user profile data. *** ** * ** *** [Back to Top](https://help.elevatic.com/user-profiles-for-jira/installation-and-licensing-v-2-6.md#top) --- language: "en" --- # Java API Documentation (v 2.6) ## Quick Start Guide ### Jira Plugin #### Download the following files * [user-profiles-external-api-1.1.0.jar](https://communardo-products.atlassian.net/wiki/download/attachments/9798347/user-profiles-external-api-1.1.0.jar?api=v2) * **Documentation:** [user-profiles-external-api-1.1.0-javadoc.jar](https://communardo-products.atlassian.net/wiki/download/attachments/9798347/user-profiles-external-api-1.1.0-javadoc.jar?api=v2) #### Add the files to your Maven repository There are two possibilities to install the library files. Either install them in a local Maven repository or deploy them to a hosted Maven repository. ##### Install in the local Maven repository mvn install:install-file -Dfile=user-profiles-external-api-1.1.0.jar -DgroupId=de.communardo.atlassian.plugins.userprofile.external.api -DartifactId=user-profiles-external-api -Dversion=1.1.0 -Dpackaging=jar -Djavadoc=user-profiles-external-api-1.1.0-javadoc.jar ##### Deploy to a hosted Maven repository mvn deploy:deploy-file -Dfile=user-profiles-external-api-1.1.0.jar -DgroupId=de.communardo.atlassian.plugins.userprofile.external.api -DartifactId=user-profiles-external-api -Dversion=1.1.0 -Dpackaging=jar -Djavadoc=user-profiles-external-api-1.1.0-javadoc.jar -DrepositoryId= -Durl= #### Include the UPJ Java API in your App pom.xml de.communardo.atlassian.plugins.userprofile.external.api user-profiles-external-api 1.1.0 provided #### Usage in our own classes (e.g. your components) To import the services provided by our API as components, using [Atlassian Spring Scanner](https://bitbucket.org/atlassian/atlassian-spring-scanner) as an example: Java import com.atlassian.plugin.spring.scanner.annotation.imports.ComponentImport; import de.communardo.atlassian.plugins.userprofile.external.api.service.UppProfileElementDataManager; import de.communardo.atlassian.plugins.userprofile.external.api.service.UppProfileElementManager; import org.springframework.stereotype.Component; @Component public class MyComponent { public MyComponent(@ComponentImport UppProfileElementManager uppProfileElementManager, @ComponentImport UppProfileElementDataManager uppProfileElementDataManager) { // do stuff with uppProfileElementManager and/or uppProfileElementDataManager } } #### Make sure the *User Profiles for Jira (Microsoft Attributes Sync)* App is already installed on your Jira system. Check [Installation and Licensing (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/installation-and-licensing-v-2-6.md) 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: #### Make sure the *User Profiles for Jira (Microsoft Attributes Sync)* App is already installed on your Jira system. Check [Installation and Licensing (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/installation-and-licensing-v-2-6.md) for further information. #### Examples 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: ##### Example 1 Example that prints all profile elements and the available element data for the current user in the log (log-level INFO, which may prevent you from seeing anything per default, so maybe use log-level ERROR instead if you want to directly see something in the log). Groovy 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()))) ##### Example 2 Example that shows the data in a given profile element for a given user: Groovy // sample script for app "User Profiles for Jira", showing how to diplay profile data of a user // config variables: def userName = "admin" // or leave empty to use currently logged-in user instead def profileElementId = 1 // ID can be found in URL of profile-element's "Edit"-link // end config // start code 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 import de.communardo.atlassian.plugins.userprofile.external.api.model.elements.* @WithPlugin("de.communardo.jira.plugins.userprofile") @PluginModule UppProfileElementManager uppProfileElementManager @PluginModule UppProfileElementDataManager uppProfileElementDataManager // get user def user = userName ? ComponentAccessor.userManager.getUserByName(userName) : ComponentAccessor.jiraAuthenticationContext.loggedInUser // get Profile Element by ID def profileElement = uppProfileElementManager.getProfileElement(profileElementId) // get data object in given profile element of given user def profileData = uppProfileElementDataManager.getProfileElementData(new UserKey(user.getKey()), profileElement) // get human readable version of data object, depending on data type, see docu: https://communardo-products.atlassian.net/wiki/spaces/UPJ/pages/9798347/Java+API+Documentation+v+2.5#Profile-element-and-data-types def humanReadableValue if (profileElement instanceof MultiSelectProfileElement) { humanReadableValue = profileData.getOptions()*.getName() } else if (profileElement instanceof SingleSelectProfileElement) { humanReadableValue = profileData.getOption()?.getName() } else if (profileElement instanceof TextBasedProfileElement) { humanReadableValue = profileData.getText() } else if (profileElement instanceof UserProfileElement) { // value is a userKey -> 1) get referenced user def referencedUser = ComponentAccessor.userManager.getUserByKey(profileData.getUserKey()?.getStringValue()) // 2) get displayName of referenced user humanReadableValue = referencedUser?.getDisplayName() } """ Showing data of user ${user.getDisplayName()} in profile element ${profileElement.getName()} (ID ${profileElement.getId()}, type ${profileElement.class.simpleName}):
${humanReadableValue} """ ## Internal structure and basic usage The 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 UPJ administration (check [Create and Edit User Profile Elements (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/create-and-edit-user-profile-elements-v-2-6.md) 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. To interact with profile elements, just inject and use the provided UppProfileElementManager. With this manager you will be able to load the available profile elements. Afterwards you may want to access some data which is related to a user. To achieve that, just inject and use the provided UppProfileElementDataManager. ### Profile element and data types There are several profile element and data types which are used to work with the API. To provide you a better start, we are going to list all currently available profile elements and their matching data models in the following table: | **Profile Element Models** | **Profile Element Data Models** | **getter Method** | **setter Method(s)** | |----------------------------|---------------------------------|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | MultiSelectProfileElement | MultiSelectProfileElementData | Set\ getOptions() | setOptions(Set\ options) Show additional methods... addOption(OptionedProfileElement.Option option) addOptions(Set\ options) removeOption(OptionedProfileElement.Option option) removeOptions(Set\ options) removeAllOptions() | | SingleSelectProfileElement | SingleSelectProfileElementData | OptionedProfileElement.Option getOption() | setOption(OptionedProfileElement.Option option) Show additional methods... removeOption() | | TextBasedProfileElement | TextBasedProfileElementData | String getText() | setText(String text) | | UserProfileElement | UserProfileElementData | UserKey getUserKey() | setUserKey(UserKey userKey) | You have to use matching profile element and data types to be able to interact with the API. Furthermore, the specialized data objects make an interaction with a specific data type more easy. ### Event publication #### ProfileElementDataChangedEvent The User Profiles for Jira App publishes events every minute, which contain all changes that are taken since the last publication. One event contains a maximum of 1000 changes as a collection of updates. Each update contains a key of a user, a profile element and the new data. The following table shows the models of the updates: | **Profile Element Update Models** | **Profile Element Models** | **Data Models** | |--------------------------------------|----------------------------|--------------------------------------| | MultiSelectProfileElementDataUpdate | MultiSelectProfileElement | Set\ | | SingleSelectProfileElementDataUpdate | SingleSelectProfileElement | OptionedProfileElement.Option | | TextBasedProfileElementDataUpdate | TextBasedProfileElement | String | | UserProfileElementDataUpdate | UserProfileElement | UserKey | #### ProfileElementNameChangedEvent This event is published when the default name of a profile element is changed. It contains the updated profile element. #### ProfileElementRemovedEvent This event is published when a profile element is removed. It contains the removed profile element. #### ProfileElementOptionNameChangedEvent This event is published when the default name of an option of a profile element is changed. It contains the updated profile element and the updated option. #### ProfileElementOptionRemovedEvent This event is published when an option of a profile element is removed. It contains the updated profile element and the removed option. ### Examples To kickstart you a little bit more, we want to provide you with a few examples on what you can currently do with our Java API: #### UppProfileElementManager ##### Loading all profile elements Collection profileElements = uppProfileElementManager.getProfileElements(); ##### Loading a specific profile element with a specific id (for example 1) Java ProfileElement profileElement = uppProfileElementManager.getProfileElement(1); //or if you know the type of the profileElement (in this example it is a TextBasedProfileElement) TextBasedProfileElement textbasedProfileElement = uppProfileElementManager.getProfileElement(1); #### UppProfileElementDataManager ##### Loading profile element data for a profile element and a user Java ProfileElementData data = uppProfileElementDataManager.getProfileElementData(userKey, profileElement); //or if you know the type of the profileElement or the data (in this example it is a TextBasedProfileElementData) TextBasedProfileElementData data = uppProfileElementDataManager.getProfileElementData(userKey, profileElement); ##### Loading all profile elements for a user Java Map data = uppProfileElementDataManager.getProfileElementData(userKey); ##### Storing profile element data for a profile element and a user Java uppProfileElementDataManager.storeProfileElementData(userKey, profileElement, data); To be able to store data, the type of the profile Element must match the type of the data. #### ProfileElementDataChangedEvent ##### Event Listener example This example describes how to write an event-listener for user profile data changes in your own Jira app. (Fyi, due to limitations in *ScriptRunner* these events are not available there; which unfortunately means that it's not possible to write scripted event-listeners for our events.) XML public class ProfileElementDataChangeEventListener { public ProfileElementDataChangeEventListener(@ComponentImport EventPublisher eventPublisher) { // register the event listener class in the event publisher eventPublisher.register(this); } @EventListener public void onProfileElementDataChange(ProfileElementDataChangedEvent profileElementDataChangedEvent) { // get all change sets in the event (the number of elements are not limited) Collection updates = profileElementDataChangedEvent.getProfileElementDataUpdates(); // iterates over all change sets for(ProfileElementDataUpdate update : updates ) { if (update instanceof TextBasedProfileElementDataUpdate) { // do some stuff for a change of a TextBasedProfileElement } else if (update instanceof MultiSelectProfileElementDataUpdate) { // do some stuff for a change of a MultiSelectProfileElement } else if (update instanceof SingleSelectProfileElementDataUpdate) { // do some stuff for a change of a SingleSelectProfileElement } else if (update instanceof UserProfileElementDataUpdate) { // do some stuff for a change of a UserProfileProfileElement } } } } You can also follow the instructions on . --- language: "en" --- # Migration from Jira Data Center to Jira Cloud All the information that you need to migrate User Profiles for Jira from Jira Data Center to Jira Cloud, can be found at the [Migration Hub](https://help.elevatic.com/general-app-documentation/cloud-migration-hub-user-profiles-for-jira-microsoft-attributes-sync.md). ## So, why should you go Cloud? * [Atlassian's end of support](https://www.atlassian.com/migration/journey-to-cloud) for Server, as of 2024-02-24 * Atlassian's [end of support](https://www.atlassian.com/licensing/data-center-end-of-life) for Data Center * The Cloud version offers easier configuration for the admins. * With the Cloud version, you get instant access to new feature releases and automatic upgrades, alleviating the need for manual work. If you need more information to help you decide if moving from Server or Data Center to Cloud is a good option for you for the entire Atlassian suite, check out [Atlassian Cloud Migration Center](https://www.atlassian.com/cloud-migration). If you have further questions and want to get in touch with us, please [raise a support request](https://go.communardo.app/support)! --- language: "en" --- # Optimizing Work Processes and Approvals in Jira with Microsoft Attributes Sync ## **System** Jira, Microsoft Entra ID App: [++User Profiles for Jira (Microsoft Attributes Sync)++](https://communardo.app/9UIaIJ) ## **Short description** Optimize work and approval processes by syncing Microsoft Entra ID attributes into Jira and using the manager attribute to route requests automatically and keep workflows efficient. ## **Challenge** Approvals in Jira - such as purchase orders - can be delayed when the right approver isn't clear or notified, causing back-and-forth and inefficiencies. With Microsoft Entra ID attributes synced into Jira, it is possible to optimize the approval process by leveraging the manager attribute to route requests to the correct approver and speed up decision-making. ## **Actors** 👔 John -- Employee 👤 Alex -- HR Manager 🛠️ Taylor -- IT Admin ## **Actors Goals** **John (Employee)** -- Wants his purchase request approved by the manager without chasing for updates. **Alex (Manager)** -- Wants to be notified directly in Jira when an approval is required, without extra confusion. **Taylor (IT Admin)** -- Wants reliable synchronization of manager attributes from Entra ID so workflows always run smoothly. ## **Use Case Scenario (step-by-step)** 1. **John** creates a purchase request in Jira for a new laptop. 2. The workflow contains an approval step, with the approver set to the *manager attribute* from Microsoft Entra ID. 3. **Alex**, John's manager, is automatically assigned and notified in Jira to approve the request. 4. **Alex** reviews and approves the purchase directly in Jira. 5. **Taylor**, the IT Admin, ensures that manager attributes remain synchronized from Entra ID so the workflow continues to route requests reliably. ## **Outcome** * Employees like **John** get their requests routed to the right approver without delays. * Managers like **Alex** receive clear approval tasks, avoiding missed updates. * IT Admins like **Taylor** keep processes reliable with synchronization in place. ## **Documentation** * User's Guide -- [++Link++](https://communardo.app/rWT42r) * Configuration Guide -- [++Link++](https://communardo.app/VMGT68) ## Additional Content [How IT Service Management Teams Benefit from User Profiles for Jira Cloud](https://www.communardo.com/knowledge/blog/how-it-service-management-teams-can-benefit-from-user-profiles-for-jira-cloud/) [User Profiles for Jira app for Business Teams](https://www.communardo.com/knowledge/blog/how-business-teams-can-benefit-from-user-profiles-for-jira-cloud/) ## **Atlassian Marketplace** Find User profiles for Jira on the [Atlassian Marketplace](https://marketplace.atlassian.com/apps/1212508/user-profiles-for-jira-microsoft-attributes-sync?hosting=cloud&tab=overview). --- language: "en" --- # Problem Synchronizing Multiple User Directories ## Problem While synchronizing user data from configured user directories, the directories are currently processed in the same order as defined. I.e., if there are 3 directories A, B, and C, data for users in directory A will be processed before data for directory B, and data for directory C will be processed last. This might cause problems if users appear in more than one directory and have different data stored for them in each directory. If e.g. user "Bob" exists in directories A and C, and only has data stored in directory A, then the data from A would be overridden with the data from C. Since no data is stored in C, the profile elements will remain empty for Bob. The only way to prevent this is to change the order of the user directories, which might cause other problems (then directory C wins over A for authentication, which is standard Jira behavior). For more info please refer to our [Jira ticket](https://communardo.atlassian.net/browse/UPJ-201). ## Cause Occurs if a specific user is synchronized from two or more directories into Jira. The user's display name and email address will be taken from the first directory where the user is found (in the directory order within Jira administration). All additional user profile elements for this user (configured via the user profile plugin administration) will be taken from the last directory where the user is found. Atlassian does not recommend synchronizing the same user across different directories. --- language: "en" --- # Release (v 2.6) ## Introduction On the following pages, you can find the complete documentation for this *User Profiles for Jira (Microsoft Attributes Sync)* release. Use the navigation on the left side to guide yourself through the chapters. * The User's Guide is intended for anyone using *User Profiles for Jira (Microsoft Attributes Sync)*. It provides you with about editing the user profiles and the profile picture synchronization. * The Administrator's Guide is intended for Jira administrators. It helps you to install the app, to add new profile fields, or to configure the synchronization with an LDAP repository. --- language: "en" --- # Search Issues (v 2.6) ## since version 2.0 When your administrator has followed the Administrator's Guide to [Display Profile Elements in Issues (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/display-profile-elements-in-issues-v-2-6.md), you are able to search JIRA issues based on the user profile elements you configured. We are using standard JIRA functionality for the search. Thus there are some basic principles you should be aware of when searching: * You cannot search profile element values if you haven't configured a mapping for that profile element. To set it up, follow the Administrator's Guide to [Display Profile Elements in Issues (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/display-profile-elements-in-issues-v-2-6.md). * You are searching the **JIRA custom field** your Administrator has configured. You are *not* searching the user profile elements directly. Therefore you have to use the name of the custom field for the search. The name might differ from the name of the user profile element. * The value of the custom field is always relative to a reference user field in the ticket. You might get results based on the user profile of the Assignee, the Reporter etc. This too depends on the configuration made by your administrator. If the search doesn't work as expected, please ask your administrator for details on the configuration so you are aware of the current set-up and how it is supposed to work. You can find an example below which illustrates the behavior of the search. ### Example Configuration: The user profile element *Manager* has been mapped to the JIRA custom field *Manager of Reporter* . As the name suggests, the field *Manager of Reporter* is set up to display the manager of the reporter in an issue (provided the user profile element *Manager* has a value). In this examples, the *Reporter* is the Reference User Field. ![mapping.jpg](https://help.elevatic.com/__attachments/a_c9e64fe067e77d962a1dff6ce1592b99afabde30ad15081fa3e722fc5f42753e/mapping.jpg?cb=5365241d7a0396e9da75de68517e41d3) *Image 1: Relationship between user profile element and JIRA custom field* The manager of the current user is Jane. Therefore if you open an issue where the current user is set as Reporter the field *Manager of Reporter*will display the value "Jane". To search for issues with the *Manager of Reporter* Jane 1. navigate to the [basic search](https://confluence.atlassian.com/jiracoreserver073/basic-searching-861257184.html) in JIRA 2. click "More" and search for the field *Manager of Reporter* 3. after selecting the field, enter the value "Jane" You will now see all tickets where the field *Manager of Reporter* is filled with the value "Jane". This will include tickets where the current user is set as reporter, but it can e.g. also include tickets where colleagues of the current user who also report to Jane are set as reporter. You can now refine your search by adding values for other JIRA fields, e.g. filtering for a specific project or for tickets with a specific reporter. ### Further Information * [Basic searching in JIRA](https://confluence.atlassian.com/jiracoreserver073/basic-searching-861257184.html) *** ** * ** *** [Back to Top](https://communardo-products.atlassian.net/wiki/spaces/UPJ/pages/572194941/Search+Issues+v+2.6#SearchIssues(v2.6)-top) --- language: "en" --- # Smooth Project Task Completion Using Microsoft Attributes in Jira ## System Jira, Microsoft Entra ID App: [++User Profiles for Jira (Microsoft Attributes Sync)++](https://communardo.app/9UIaIJ) ### Short Description Provide full visibility of user attributes in Jira issues and let teams use them in automations to trigger notifications, approvals, or other workflow actions. ### Challenge Project teams need context about task owners and reporters to act quickly. Missing user details in Jira means communication is manual, approvals are delayed, and urgent tasks can be blocked. By making user attributes available for Jira automations, teams can configure notifications, approval requests, or other triggers based on attributes like location, manager or department. ### Actors 👩‍💼 Lara -- Project Manager 👥 Joanna -- Team Lead 🛠️ Taylor -- IT Admin ### Actors' Goals * **Lara (Project Manager):** Wants to ensure critical tasks are escalated automatically to the right manager without manual follow-ups. * **Joanna (Team Lead):** Wants to create automations that use user attributes to notify, comment, or escalate tasks as needed. * **Taylor (IT Admin):** Wants to synchronize Microsoft Entra ID attributes in Jira so teams can reliably use them in workflow automations. ### Use Case Scenario (step-by-step) 1. Lara creates a new project task in Jira and assigns it to a team member. 2. The issue displays reporter and assignee information, including manager, department, job title, and location, synced automatically from Microsoft Entra ID. 3. The team configures Jira automations to use these attributes. For example: 4. Notify the manager automatically when task priority changes from "Urgent" to "Critical." Add a comment or create a subtask for a specific department when a task is updated. 5. When a task property changes, Jira automation references the synced attributes to execute the configured actions. 6. The relevant stakeholders are notified, approvals are requested, or other workflow steps happen without manual intervention. 7. The task progresses smoothly, and delays caused by missing information or manual follow-ups are eliminated. ### Outcome * Teams can use Microsoft Entra ID attributes in Jira automations to trigger notifications, approvals, or other actions as needed. * Project managers and team leads have complete visibility of user details directly in Jira. * Faster task execution, improved collaboration, and more efficient cross-department workflows for the company. ## **Documentation** * User's Guide -- [++Link++](https://communardo.app/rWT42r) * Configuration Guide -- [++Link++](https://communardo.app/VMGT68) ## Additional Content [How IT Service Management Teams Benefit from User Profiles for Jira Cloud](https://www.communardo.com/knowledge/blog/how-it-service-management-teams-can-benefit-from-user-profiles-for-jira-cloud/) [User Profiles for Jira app for Business Teams](https://www.communardo.com/knowledge/blog/how-business-teams-can-benefit-from-user-profiles-for-jira-cloud/) ## **Atlassian Marketplace** Find User profiles for Jira on the [Atlassian Marketplace](https://marketplace.atlassian.com/apps/1212508/user-profiles-for-jira-microsoft-attributes-sync?hosting=cloud&tab=overview). --- language: "en" --- # Support "user" smart values for custom fields with "User Picker" search template (v 2.6) SINCE VERSION 2.5 User Profiles for Jira gives you the possibility to use a custom field of type "User Profile Field" as smart value within Automation for Jira. This is applicable for custom fields that use the "User Picker \& Group Searcher" as search templates. This allows the use of the smart value where Automation for Jira expects an actual user and not just it's String representation. There is a distinction in the representation of the user from custom fields of Jira's standard type "User Picker (single user)". When using a custom field of type "User Profile Field", the value `{{issue.CustomFieldName}}` will resolve to the complete JSON representation of the user. On the other hand, for custom fields of type "User Picker (single user)", `{{issue.CustomFieldName}}` will resolve to only the user's name. It is important to consider this distinction when formulating Jira automation rules as it can impact the outcomes. Please refer to the following code snippet - demonstrating how to update the approvers of an issue [using advanced field editing](https://confluence.atlassian.com/automation/advanced-field-editing-using-json-993924663.html) - for a clearer understanding of the dissimilarity. {"update": { "Approvers": [ {"add": {"name":"{{issue.JiraUserPickerField}}"} //custom field created through Jira}, {"add": {"name":"{{issue.UserProfileField.name}}"} //custom field created through our application} ]}} --- language: "en" --- # Synchronize User Profile Elements (v 2.6) For the following steps you need Jira Administrator permissions. ## LDAP There are 3 ways a synchronization can happen: Periodical or manual for all users (full synchronization), or at login for a single user. During this process, the data of a users profile elements is updated with the values from the [configured LDAP repositories](https://confluence.atlassian.com/display/DOC/Connecting+to+an+LDAP+Directory) according to the mapping that was defined during configuration of the profile elements. ![Administration - Profile Elements - Synchronisation](https://help.elevatic.com/__attachments/a_840eebb0589dc5a2bbcf416585ff63d28ea14b580b6ba44babaafcde2cdf2c73/Administration%20-%20Profile%20Elements%20-%20Synchronisation?cb=7345c02a45cf36cef363d3d2aacf1441) *Image 1: Configure Synchronization Settings (click to enlarge)* ### Please Note The synchronization is only working in**one** direction. Data will only be *pulled* from a repository and will never be written back. This also applies to repositories which are configured as "Read/Write". Synchronization is not working for [internal directories with LDAP authentication](https://confluence.atlassian.com/adminjiraserver/connecting-to-an-internal-directory-with-ldap-authentication-938847055.html). See also this knowledge-base article: ### Manual Synchronization The manual synchronization can be started from the advanced configuration setting (choose *Cog icon \> Apps* at top right of the screen *\> User Profile Configuration \> Advanced Options* ). There is a button **"Start Synchronization"** below in the synchronization settings. After clicking it, a full synchronization will happen. This means that the profile for every user will be synchronized according to your configuration. After the synchronization a short summary will be shown. Since a full synchronization is a resource consuming task, it should not be started during business hours! ### Periodical Synchronization A full synchronization will be executed periodically. The app is configured to start this synchronization at *1:11 a.m. each night*. If you want to change the execution of the periodical synchronization, you can edit it via JVM startup parameter: communardo-user-profiles.sync-start-minutes-after-midnight For example, if you want to start the job at 3:33 am: -Dcommunardo-user-profiles.sync-start-minutes-after-midnight=213 (please do not forget -D at the beginning to mark the parameter as custom parameter and to restart your JIRA server after the customization) The above example will cause the job to run every night at 3:33, **starting with the next day**. I.e. the job will not run at 3:33 am on the day that you restarted your server (even if you did the restart at 2 am). ### Single-User Synchronization Whenever a user logs in, his profile data is synchronized with the user repository. This setting is disabled by default, because it can have an impact on the login performance. You can enable this synchronization type if you select the checkbox "Enable Login Synchronization" from the advanced configuration settings (choose *Cog icon \> Apps* at top right of the screen \> *User Profile Configuration \> Advanced Options*. **Note** that the synchronization will only run for that single user. ## Synchronizing without direct LDAP connection You can also use the apps from the vendor *resolution* to populate our custom fields from other cloud identity providers. For more information see: [Synchronizing user directories without LDAP connection (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/synchronizing-user-directories-without-ldap-connection-v-2-6.md). *** ** * ** *** [Back to Top](https://communardo-products.atlassian.net/wiki/pages/resumedraft.action?draftId=9799548#SynchronizeUserProfileElements(v2.4)-top) --- language: "en" --- # Synchronize User Profile Pictures (v 2.6) For the following steps you need Jira Administrator permissions. ## Synchronize User Profile Pictures The synchronization of user pictures is supported from a central storage. You can find the configuration under the heading "Special Elements" in the *User Profile Settings \>* *User Profile Configuration* \>Manage Profile Elements (choose *Cog icon \> Apps* at top right of the screen or use the keyboard shortcut: press 'g g' then type 'User Profile Configuration'). **Start Synchronization of User Pictures** Click "Edit" to open the configuration dialog for the picture synchronization. ![Administration - Profile Elements - User Profile Picture Synchronisation](https://help.elevatic.com/__attachments/a_6cd20c9b440cee590e2e249050fa2db76ed5e1c78a411c2dfea796302035bdf9/Administration%20-%20Profile%20Elements%20-%20User%20Profile%20Picture%20Synchronisation?cb=753b421ed8353380d3bab86609643c97) *Image 1: Configure User Profile Picture synchronization (click to enlarge)* To synchronize user pictures from a central user directory you have to enter the attribute name where the picture is stored. The name of the attribute is typically "thumbnailPhoto" for Active Directory and "jpegPhoto" for OpenLDAP. You may set multiple attributes separated by a comma, i.e. "thumbnailPhoto,jpegPhoto". This is useful, if you have configured multiple directories of different types. The synchronization is based on the following features * While the synchronization process is running a picture of a user is read out, cropped to a square format and if necessary scaled-down. * Pictures are stored in standard size used in JIRA. * If a picture is updated in the picture storage, the user picture will be overwritten in JIRA during the next synchronization. * Users can upload own pictures, but after a new synchronization the picture from the picture storage is displayed again. * ![info](https://help.elevatic.com/__attachments/a_cfcba1aa49976f6af3dac6aff4b152e36da675202b51f4f6f064cee883be5f69/atlassian-info?cb=feab5cd71111204d6b52545f3027dd0c) If there is no picture for the user in the external repository defined, the users uploaded image will be preserved through synchronization tasks. **Stop Synchronization of User Pictures** Leave the field "Attribute Name" blank if no synchronization is required or if you want to **stop the synchronization**. **Information about Performance** On systems with many users (1000+) the first synchronization may take very long (several hours) and can impact your systems performance. To improve the process or in case of synchronization errors it is recommended to enable "Login Synchronization" for a couple of days. *** ** * ** *** [Back to Top](https://communardo-products.atlassian.net/wiki/spaces/UPJ/pages/572195213/Synchronize+User+Profile+Pictures+v+2.6#SynchronizeUserProfilePictures(v2.6)-top) --- language: "en" --- # Synchronizing user directories without LDAP connection (v 2.6) *User Profiles for Jira (Microsoft Attributes Sync)* can also synchronize data from user directories that are connected through one of the following third party apps: * [https://marketplace.atlassian.com/apps/1219399/user-sync-users-provisioning-sync-groups-sync-jira?hosting=datacenter\&tab=overview](https://marketplace.atlassian.com/apps/1219399/user-sync-users-provisioning-sync-groups-sync-jira?hosting=datacenter&tab=overview) (starting with version 2.2) * [https://marketplace.atlassian.com/apps/1212130/saml-single-sign-on-jira-sso-jira-saml-sso-oidc-user-sync?hosting=datacenter\&tab=overview](https://marketplace.atlassian.com/apps/1212130/saml-single-sign-on-jira-sso-jira-saml-sso-oidc-user-sync?hosting=datacenter&tab=overview) (starting with version 5.2) When *User Profiles for Jira (Microsoft Attributes Sync)* is installed, the attributes configured in *User Profiles for Jira (Microsoft Attributes Sync)* can be mapped via User Sync connectors and kept up to date via the apps Just-in-Time Provisioning feature. This allows to synchronize user attributes from a cloud Identity Provider like Azure AD, Okta, or Google in the absence of an LDAP sync. For more details, please follow the official tutorial provided: With this setup you do not need to configure the mapping of LDAP attributes as described on [Create and Edit User Profile Elements (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/create-and-edit-user-profile-elements-v-2-6.md). --- language: "en" --- # Unable to synchronize a User Profile Field with Active Directory (JIRA) ## Problem After adding a User Profile Field, configuring the mapping for LDAP attribute(s), and a manual synchronization, an error message is shown: The profile data for 0 users has been synchronized with the configured directories in 0.0 seconds. For the following attributes no values were found in the configured directories. This could mean that those attributes do not exist in the directories. Please review the attribute mappings in the relevant profile elements. • ## Solution Please check the following points: ### [Configuration Summary](https://confluence.atlassian.com/jirakb/generate-a-directory-configuration-summary-in-jira-server-298976246.html) of your LDAP-based directory (such as Microsoft Active Directory) If the "Type" is `DELEGATING` you can currently not retrieve data from your user directory because the connected directory is delegated. This means that all user data is stored in JIRA and you only get the authentication data from the directory. If there is no special reason for this type, we recommend switching to Active Directory or OpenLDAP (without delegation). If you need to use the delegated connection, you can still use User Profiles for JIRA, but synchronization won't work. Users can manually enter their data in their profiles. ### Field Configuration for the affected User Profile Fields Please make sure that you've mapped the referenced LDAP attribute correctly: * surrounded by %%: `%%attributeName%%` * correct spelling: `%%phone%%` instead of `%%pohne%%` * case sensitivity: `%%department%%` instead of `%%Department%%` If you still experience this issue, please raise a request in our [customer portal](https://go.communardo.app/support) and provide us with the following information: * A screenshot of the complete field configuration for the affected User Profile Field(s) * The [Configuration Summary](https://confluence.atlassian.com/jirakb/generate-a-directory-configuration-summary-in-jira-server-298976246.html) of the user directory Please execute a [manual synchronization](https://help.elevatic.com/user-profiles-for-jira/synchronize-user-profile-elements-v-2-6.md) again and provide us with the [support zip](https://confluence.atlassian.com/support/create-a-support-zip-790796819.html) afterward. ## Related Articles * [Problem Synchronizing Multiple User Directories](https://help.elevatic.com/user-profiles-for-jira/problem-synchronizing-multiple-user-directories.md) * [Fetch user profile data through script](https://help.elevatic.com/user-profiles-for-jira/fetch-user-profile-data-through-script.md) * [Add Profile Element as customized link](https://help.elevatic.com/user-profiles-for-jira/add-profile-element-as-customized-link.md) * [Cannot find User Profile field in pie chart gadget](https://help.elevatic.com/user-profiles-for-jira/cannot-find-user-profile-field-in-pie-chart-gadget.md) * [Unusual large size of profile picture when editing customer details on service desk](https://help.elevatic.com/user-profiles-for-jira/unusual-large-size-of-profile-picture-when-editing-customer-details-on-service-desk.md) * [Add user profile field to email template](https://help.elevatic.com/user-profiles-for-jira/add-user-profile-field-to-email-template.md) * [Does the click-to-call function work with VoIP?](https://help.elevatic.com/user-profiles-for-jira/does-the-click-to-call-function-work-with-voip.md) * [Unable to synchronize a User Profile Field with Active Directory (JIRA)](https://help.elevatic.com/user-profiles-for-jira/unable-to-synchronize-a-user-profile-field-with-active-directory-jira.md) * [Custom User Field not Appearing in Issues](https://help.elevatic.com/user-profiles-for-jira/custom-user-field-not-appearing-in-issues.md) --- language: "en" --- # Unusual large size of profile picture when editing customer details on service desk ## Problem When editing customer details in the service desk, the customer's profile picture is unusually large. This problem occurs ***only*** when the profile picture is one of the sample avatar pictures. ## Solution 1. Upload a custom image as a profile picture 2. Select the default "gravatar" image as a profile picture ## Related Articles * [Problem Synchronizing Multiple User Directories](https://help.elevatic.com/user-profiles-for-jira/problem-synchronizing-multiple-user-directories.md) * [Fetch user profile data through script](https://help.elevatic.com/user-profiles-for-jira/fetch-user-profile-data-through-script.md) * [Add Profile Element as customized link](https://help.elevatic.com/user-profiles-for-jira/add-profile-element-as-customized-link.md) * [Cannot find User Profile field in pie chart gadget](https://help.elevatic.com/user-profiles-for-jira/cannot-find-user-profile-field-in-pie-chart-gadget.md) * [Unusual large size of profile picture when editing customer details on service desk](https://help.elevatic.com/user-profiles-for-jira/unusual-large-size-of-profile-picture-when-editing-customer-details-on-service-desk.md) --- language: "en" --- # Use Cases * [Optimizing Work Processes and Approvals in Jira with Microsoft Attributes Sync](https://help.elevatic.com/user-profiles-for-jira/optimizing-work-processes-and-approvals-in-jira-with-microsoft-attributes-sync.md) * [Faster Ticket Resolution with Additional Contact Details from Microsoft Entra ID](https://help.elevatic.com/user-profiles-for-jira/faster-ticket-resolution-with-additional-contact-details-from-microsoft-entra-id.md) * [Smooth Project Task Completion Using Microsoft Attributes in Jira](https://help.elevatic.com/user-profiles-for-jira/smooth-project-task-completion-using-microsoft-attributes-in-jira.md) --- language: "en" --- # User Profile Picture (v 2.6) User Profiles for JIRA allows for your profile pictures to be synchronized from a central storage. If this feature is activated by your administrator, users will be able to upload their own pictures, but after a new synchronization the picture from the picture storage is displayed again. If there is no photo set for the user within the picture storage, the manually uploaded photo will not be overwritten. *** ** * ** *** [Back to Top](https://communardo-products.atlassian.net/wiki/spaces/UPJ/pages/572194981/User+Profile+Picture+v+2.6#UserProfilePicture(v2.6)-top) --- language: "en" --- # User's Guide (v 2.6) The **User's Guide** is intended for anyone using *User Profiles for Jira (Microsoft Attributes Sync)*. Use the navigation on the left side to guide yourself through the chapters. * [Search Issues (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/search-issues-v-2-6.md) * [User Profile Picture (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/user-profile-picture-v-2-6.md) * [View and Edit User Profile Elements (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/view-and-edit-user-profile-elements-v-2-6.md) * [Support "user" smart values for custom fields with "User Picker" search template (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/support-user-smart-values-for-custom-fields-with-user-picker-search-template-v-2-6.md) --- language: "en" --- # View and Edit User Profile Elements (v 2.6) ## Description *User Profiles for Jira (Microsoft Attributes Sync)* enhances the functionality of Jira's user profiles. By using this app, user profiles can be centrally extended with additional elements. On top of that, the app supports the synchronization of any attribute from LDAP-based external user directories (e.g. Active Directory or OpenLDAP) with the user profile by extending the LDAP integration functionality of Jira. This means that the users no longer need to update their personal data manually. The benefit to you: The data of synchronized user profiles is always kept up-to-date and can be used to display on the hover profile. ![Hover Profile.png](https://help.elevatic.com/__attachments/a_8a67a56a28e22ee298441d11e1cb1e24d4dcd04782c83530b6f0456721f169d3/Hover%20Profile.png?cb=6288f61ed473101816706d08283897e0) *Image 1: Hover profiles with additional information about the user* ## Editing the User Profile The edit mode allows administrators to edit all users' profiles. Users can adjust the data for the additional profile elements of their own profiles. To open the edit mode either navigate to your profile and use the edit icons or by clicking on the the profile icon in the top menu bar and select "Edit profile data" ![quick-profile-edit.png](https://help.elevatic.com/__attachments/a_1a3296f3f1bfcbae5863227f19fc2abf2b0c1b75e54cb9479b8555de97d5ad12/quick-profile-edit.png?cb=86df6dcdab5981dacc5621baaa93b65d) *Image 2: Edit your profile quickly by using the top navigation bar (click to enlarge)* Elements of profiles for external (LDAP) users that are synchronized **cannot** be edited. ![User Profile View.png](https://help.elevatic.com/__attachments/a_bf977a3d52dcff9b271d5832415d8488e547ccf7b88a9ba412d650fba8979c13/User%20Profile%20View.png?cb=c8294147a1c060912ff9037899daf63b) 513px *Image 3: A user profile with the extended profile information (click to enlarge)* Please note, that the elements are only visible at the profile, if they contain any information. Otherwise they are hidden. Starting with version 2.0, user profile elements can be displayed in Jira issues. ![info](https://help.elevatic.com/__attachments/a_cfcba1aa49976f6af3dac6aff4b152e36da675202b51f4f6f064cee883be5f69/atlassian-info?cb=feab5cd71111204d6b52545f3027dd0c) When changing a profile value, it can take up to 1 minute until the changes are reflected in a Jira issue. Do not forget to refresh the page (hit F5) to see the changes. ## Edit Service Management Customer profiles since version 2.1 A customer profile can only be edited when the customer is a local user in JIRA. Starting with version 2.1 the profiles of Service Management customers can be edited by JIRA service Management agents without admin permissions. 1. In a JIRA Service Management project Click on "Customers" in the left hand menu. 2. Search for your customer. 3. Click on "Edit Profile Info" to change profile elements in the customer's profile. ![image2018-7-19_18-13-29.png](https://help.elevatic.com/__attachments/a_042e84630f70d0f64e2dba04a4a76c1ecc20802f5a7937cb0989281172cb6993/image2018-7-19_18-13-29.png?cb=6f47e3695887b1ede2f5f82d2bca1d30) *Image 4: Edit Profile Info (click to enlarge)* ### Phone Numbers Starting with version 2.0 phone numbers are click-to-call, provided the administrator used the element type Phone Number when creating the profile element (see [Create and Edit User Profile Elements (v 2.6)](https://help.elevatic.com/user-profiles-for-jira/create-and-edit-user-profile-elements-v-2-6.md)). --- language: "en" --- # Where can I find Information about Data Privacy? We provide detailed documentation on how we process personal data and how you can configure privacy settings to meet your organization's requirements. Please refer to these sections for more information: * **Privacy Policies** : Our central [++Privacy Policy++](https://www.communardo.com/privacy-statement/data-protection-policy-apps/) page explains our general approach to data protection and GDPR compliance. * **Subprocessors** : A current list of all third-party service providers we use is available on our [++Trust Center++](https://trust.communardo.com/). For further inquiries regarding data protection or to request a **Data Processing Addendum (DPA)** , please contact our [++Customer Support Team++](https://go.communardo.app/support). --- language: "en" --- # Where can I find Information about Data Security? Information regarding the security measures, infrastructure, and compliance standards for our apps is centralized in our **Trust Center** and specific documentation pages. To find the details you need, please refer to the following resources: * **General Security Overview** : Visit our [++Trust Center++](https://trust.communardo.com/) for information on encryption, infrastructure, and certifications. * **Data Residency** : For details on where your data is stored and how to pin it to specific regions, see [Data Residency for Elevatic Cloud apps](https://help.elevatic.com/general-app-documentation/data-residency-for-bitvoodoo-cloud-apps.md). * **App-Specific Security** : Every app listing on the **Atlassian Marketplace** contains a **Privacy \& Security** tab with a standardized security questionnaire. If you have specific security requirements or need a security whitepaper, please [++contact Customer Support++](https://go.communardo.app/support). --- language: "en" --- # Repository Templates for Bitbucket documentation Welcome to the documentation of Repository Templates for Bitbucket. ## Table of Content * [Installation](https://help.elevatic.com/repository-templates-for-bitbucket/installation.md) * [Usage](https://help.elevatic.com/repository-templates-for-bitbucket/usage.md) * [Changelog](https://help.elevatic.com/repository-templates-for-bitbucket/changelog.md) * [REST API](https://help.elevatic.com/repository-templates-for-bitbucket/rest-api.md) * [Frequently Asked Questions](https://help.elevatic.com/repository-templates-for-bitbucket/frequently-asked-questions.md) ## Helpful links [Marketplace Listing](https://marketplace.atlassian.com/apps/1213038/repository-templates-for-bitbucket) [Support Portal](https://go.communardo.app/support/include-bitbucket-for-confluence) --- language: "en" --- # Changelog ## Version 4.x ### 4.5.0: 2026-02-24 #### Improvements Many more repository settings can be copied over and synced from the template repositories to the associated repositories. The new settings that you can chose to copy over are * Required Builds * Auto-Merge * Required Tasks * Jira Issues * Code Insights * Branch Model * Auto-Decline * Secret Scanning * Reviewer Groups * Pull Request Description Templates ##### Changes A repository currently associated to a template can no longer become a template itself. #### 4.4.0: 2025-10-21 ##### ⚠️ Announcements * **Bitbucket 10.0 on Java 21 Support** * [++Bitbucket 10.0++](https://confluence.atlassian.com/bitbucketserver/bitbucket-data-center-10-0-release-notes-1621492175.html) includes a major overhaul on how it integrates with the apps, also known as [++Atlassian Data Center Platform 8++](https://confluence.atlassian.com/bitbucketserver/bitbucket-data-center-10-0-release-notes-1621492175.html#BitbucketDataCenter10.0releasenotes-platform-7AtlassianDataCenterPlatform8). This required many adaptions to make Repository Templates to continue to work on Bitbucket 10.0. ##### Bug Fixes * fixed some rendering issues with repository selection in the UI. *** ** * ** *** #### 4.3.4: 2025-09-04 ##### Bug Fixes * Fix issue where template entries made in old app versions caused the UI to now show up correctly. *** ** * ** *** #### 4.3.2: 2025-06-20 ##### Bug Fixes * Creating a repository from a template required `PROJECT_ADMIN` permissions, while `REPO_CREATE` is now enough. *** ** * ** *** #### 4.3.1: 2025-05-28 ##### Bug Fixes * Fix deletion of project level reviewer groups when syncing repository level reviewer groups *** ** * ** *** #### 4.3.0: 2025-02-04 ##### ⚠️ Announcements * **Bitbucket 9.5 Support: Default Reviewers can contain Reviewer Groups** * Bitbucket 9.5 supports reviewer groups inside default reviewers. Repository Templates **4.3.0** merges the synchronization settings to one setting for easier maintenance. ##### Bug Fixes * Fix deletion of project level reviewer groups when syncing repository level reviewer groups *** ** * ** *** #### 4.2.3: 2024-12-13 ##### Bug Fixes * **Fix Creation of template with complete mirror on Bitbucket Mesh** * We fixed the creation of creating repository without history on Bitbucket Mesh in the previous release (see below for details). This release also fixes the creation of repository using the **complete mirror** setting on Bitbucket Mesh. *** ** * ** *** #### 4.2.2: 2024-12-09 ##### Improvements * Added [Web Sudo](https://confluence.atlassian.com/bitbucketserver/configure-secure-administrator-sessions-websudo-1415752298.html) support for Repository Templates global administration pages. ##### Bug Fixes * Fix Creation of template on Bitbucket Mesh * A Bitbucket Mesh [implementation bug](https://jira.atlassian.com/browse/BSERV-19737) was preventing the creation of new repositories from a template. While the bug has been solved for Bitbucket Data Center 9.4, we have implemented a workaround for people stuck in previous versions of Bitbucket. Creating a new repository **without history** will now work properly even when using Bitbucket Mesh. *** ** * ** *** #### 4.2.1: 2024-10-18 ##### Bug Fixes * Fix REST API endpoint to create repository from template. Due to a regression introduced in 4.0.0, it was required to send a template repository id, even when using the template slug and its project key. See our [REST API docs](https://mibexsoftware.github.io/repository-templates-rest-api/#tag/Create-repository). *** ** * ** *** #### 4.2.0: 2024-10-04 ##### ⚠️ Announcements * **JVM Flag is no longer required for usage with Java 17** * In our previous release 4.0, we were requiring an extra JVM flag to make Repository Templates to work. This requirement has been lifted. You therefore don't need to start Bitbucket with the `--add-opens=java.base/java.lang.reflect=ALL-UNNAMED` option. Other `--add-opens` options may still be required by Bitbucket itself. ##### New Features * **Reviewer Groups and Pull Request Description templates settings can be synchronized** * Repository Templates can now copy and synchronize the [Reviewer Groups](https://confluence.atlassian.com/bitbucketserver/reviewer-groups-for-pull-requests-1064084872.html) and [Pull Request Description Templates](https://confluence.atlassian.com/bitbucketserver090/create-a-pull-request-1431768816.html) configuration of your template repositories. * Go to the Project Settings and select *Reviewer groups* or *Description template* in your configuration * Synchronization of Repository permissions is required for Reviewer groups, in order to ensure that users within these groups will have sufficient permissions in associated repositories. ##### Improvements * Project Settings page has a new layout * With the increasing number of synchronizable settings, we have re-thought the layout for the project settings page. Available settings for synchronization should now follow the same structure as in Repository settings. *** ** * ** *** #### 4.1.0: 2024-08-20 ##### New Features * **Default Reviewers setting can be synchronized** * Repository Templates can now copy and synchronize the [Default Reviewers](https://confluence.atlassian.com/bitbucketserver/add-default-reviewers-to-pull-requests-834221295.html) configuration of your template repositories. * Go to the Project Settings and select *Default reviewers* in your configuration * Synchronization of repository permissions is required to ensure that default reviewers will have the necessary rights on the created repositories. *** ** * ** *** #### 4.0.0 and 4.0.1: 2024-08-01 ##### ⚠️ Announcements * **Bitbucket 9 on Java 17 Support** * [++Bitbucket 9.0++](https://confluence.atlassian.com/bitbucketserver/bitbucket-data-center-9-0-release-notes-1369277827.html) includes a major overhaul on how it interacts apps, also known as [++Atlassian Data Center Platform 7++](https://confluence.atlassian.com/bitbucketserver/bitbucket-data-center-9-0-release-notes-1369277827.html#BitbucketDataCenter9.0releasenotes-platform-7). This required many adaptions in Repository Templates to continue to work on Bitbucket 9.0. * Versions 4.0.1 and 4.1.0 of Repository Templates for Bitbucket require a JVM flag to work on Bitbucket 9.0 on Java 17 . Read the instructions [here](https://help.elevatic.com/repository-templates-for-bitbucket/installation.md#Extra-requirement-for-Repository-Templates-4.0.1-and-4.1.0-with-Bitbucket-9-/-Java-17). We recommend to directly upgrade to version at least [4.2.0](https://mibexsoftware.atlassian.net/wiki/spaces/REPOTMPL/pages/edit-v2/4020404225#Skip-version-4.0.0-for-Java-17), where the requirement has been lifted. **Skip version 4.0.0 for Java 17** If you are running Bitbucket on Java 17 (in particular, if you are using Bitbucket 9), then you have to skip version 4.0.0 and use (at least) 4.0.1. ##### Improvements * Support for running Repository Templates for Bitbucket on Java 17 *** ** * ** *** ## Version 3.x ### 3.8.0: 2022-12-15 #### New Features * Sync all Repository Detail settings - Git LFS \& Transcode Diff * Support for syncing the following repository settings added: * [++**Git LFS**++](https://confluence.atlassian.com/bitbucketserver/git-large-file-storage-794364846.html) * [++**Transcode Diff**++](https://confluence.atlassian.com/bitbucketserver/use-diff-transcoding-776640069.html) *** ** * ** *** #### 3.7.0: 2022-08-29 ##### Improvements * **Sync Default Branch when creating a Repository from an Empty Template** * Sync the default branch setting when using a empty template repository. * **Disable global templates when file mirroring is disabled** * Global templates can not be used to sync any settings, using a global template without file mirroring had no effect. Therefore, the option to select global templates in this case was removed. * **Improved Creating Speed for Main Branch Only Template** * The option 'New Git repository with initial commit of main branch only' has performance improvements when the template repository has a long git history. * **Link to Release Nodes in Admin Settings** * Added the version info and a link to the release notes on the admin page. *** ** * ** *** #### 3.6.0: 2022-04-28 ##### ⚠️ Announcements * **Bitbucket 8 compatibility** * The app now supports Bitbucket 8. The minimum Bitbucket required is 7.14 for this version. ##### Maintenance * Repository Templates does not support using Git repositories with LFS enabled as templates. Now there is a clear error message about the missing Git LFS support when you try to use it in a template. **git LFS support added in later version 3.8** *** ** * ** *** #### 3.5.3: 2022-01-26 ##### Improvements * Use red color for disabled debug logging toggle button in admin settings * Make clear with help messages that global templates do not support setting sync ##### Bug Fixes * Unable to save settings with enabled "commit verifying hooks" despite unselected mirroring option * No visual indication what hooks are excluded from settings sync in Chrome * Repositories created from global templates do not respect a different default branch * Pull request hooks alternate state between template repo and project if project inheritance is used *** ** * ** *** #### 3.5.0: 2021-04-18 ##### New Features * **Bitbucket 7 compatibility** * The app now supports Bitbucket 7. * **Allow editing the repository of a template** * Instead of having to delete the existing template and create a new one with all the associated repositories, the app now offers to edit the repository of a template. --- language: "en" --- # Frequently Asked Questions Find answers to **frequently asked questions** for Repository Templates for Bitbucket and **general resources** for migration and support below. ## 🚀 App-specific FAQs Select a page below to find answers to specific features, configuration, and usage questions. These pages are updated regularly to reflect the latest app versions. * [Where can I find Information about Data Privacy?](https://help.elevatic.com/repository-templates-for-bitbucket/where-can-i-find-information-about-data-privacy.md) * [Where can I find Information about Data Security?](https://help.elevatic.com/repository-templates-for-bitbucket/where-can-i-find-information-about-data-security.md) ## 📚 General Resources If your question is not specific to a single app, please refer to our general documentation and migration resources. * [++**General App Documentation**++](https://help.elevatic.com/general-app-documentation) Find general how-to articles and cross-product information. * [++**Cloud Migration Hub**++](https://help.communardo.app/general-app-documentation/cloud-migration-hub) Access migration guides, feature parity overviews, and migration-specific FAQs. ## 🤝 Support If you cannot find the answer to your question in the documentation or the app-specific pages above, our support team is here to help. * [++**Create a request**++](https://go.communardo.app/support) Open a support ticket with our team for personalized assistance. * [++**Service Level Agreement**++](https://help.communardo.app/general-app-documentation/service-level-agreement-for-paid-apps) Review response times and support commitments for paid apps. When contacting support, please include the **product name** and a **detailed description** of your query to help us assist you faster. ## 🔒 Privacy and Trust We value your data security and transparency. Detailed information regarding our privacy policy, data collection, and compliance is available in our central resources. * [++**Trust Center**++](https://trust.communardo.com/) Find our privacy policy, compliance certifications, and subprocessor lists. For any specific security inquiries not covered in the links above, please [++create a support request++](https://go.communardo.app/support). --- language: "en" --- # Installation ## Installing Repository Templates for Bitbucket directly from Atlassian Marketplace 1. Click the **admin** drop-down on your Bitbucket Server instance and choose **Add-ons** ***.*** 2. Click**Find new add-ons** from the left-hand side of the page. 3. Locate **Repository Templates for Bitbucket Server** via search. 4. Click **Install** to download and install Repository Templates for Bitbucket Server. 5. You're done! ## Installing Repository Templates for Bitbucket by file upload 1. Download Repository Templates for Bitbucket Server on the Atlassian Marketplace (**Details Tab** , click the **download** button). 2. Click the **admin** drop-down on your Bitbucket Server instance and choose **Add-ons** ***.*** 3. Click**Manage Add-ons...** 4. Click the **Upload add-on**link at the top right side of the page. 5. Enter the location of the JAR file you downloaded. 6. Click **Upload**. 7. You're done! ## Extra requirement for Repository Templates 4.0.1 and 4.1.0 with Bitbucket 9 / Java 17 When using Repository Templates for Bitbucket **4.0.1** and **4.1.0** on Java 17 (required by Bitbucket 9), a JVM flag is required. This requirement has been removed for Repository Templates **4.2.0** onwards, and we recommend to directly upgrade. Add \``--add-opens=java.base/java.lang.reflect=ALL-UNNAMED`\` to the `JVM_SUPPORT_RECOMMENDED_ARGS` environment flags of Bitbucket: 1. Navigate to your Bitbucket installation, like\`/opt/atlassian/bitbucket/current/bin\` 2. Edit the `_start-webapp.sh` file 3. Note the `#JVM_SUPPORT_RECOMMENDED_ARGS=`line. Remove the `#` in front of it and add \``--add-opens=java.base/java.lang.reflect=ALL-UNNAMED`\` 4. Restart Bitbucket Alternative: Define the value of the `JVM_SUPPORT_RECOMMENDED_ARGS` in your service manager, like in the Systemd unit definition, Docker container, etc. --- language: "en" --- # REST API You can find the [REST API documentation](https://mibexsoftware.github.io/repository-templates-rest-api/) on Github. --- language: "en" --- # Usage The app supports **global** and **project-based templates**. Templates are just ordinary Bitbucket repositories with common files (e.g., README.md, LICENSE.txt, .gitattributes, Maven project structure) in them that can be used to standardize new repositories and to get your team started quickly. The following instructions should help you to setup new templates and to allow your team members to choose them when creating new repositories. |---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 1 | **Bitbucket Server Administration / Repository Templates** → Configure **global repository templates** that are available in all projects of your Bitbucket instance: ![globalsettings.png](https://help.elevatic.com/__attachments/a_4162e9de5329df493c15d2a4cc9941cec9c7a17cf54bf8daf19c1862cc69ac58/globalsettings.png?cb=6d0e52231004005eb0afe57209add252) | | 2 | **Project Settings** **→** **Repository Templates** **→** **Enable** repository templates feature in all projects where you want to use templates when creating new repositories: ![enabled_project_templates.png](https://help.elevatic.com/__attachments/a_4e132fa4eefc3ad7b3584b22a53cad586fec246d56bdb176563cc494a5964169/enabled_project_templates.png?cb=27253d9aa167ddc0d679e2c2fe91118f) | | 3 | **Project Settings →** **Repository Templates** **→** If you want to provide project-specific templates, you can add them in the **project settings of the** **app**: ![add_repository_template.png](https://help.elevatic.com/__attachments/a_ea5cf7cb9c84ab4ce30c5df0d50a3fab1f7961ad97ba9c1b5155be9340dfc8ec/add_repository_template.png?cb=7d789c46b3775dd8ff4d64cdc02f91d0) | | 4 | **Project Settings →** **Repository Templates** **→** If not already the case, enable **Allow users to choose templates** and **Mirror template to new repository** to let your team members choose templates when creating new repositories (otherwise, the default template is used) and to mirror the content of them: ![default_settings.png](https://help.elevatic.com/__attachments/a_edc10da59b41bb96c5390ae7c18722cbe68ccc2712fb17ab5ea279f635363105/default_settings.png?cb=0f9ec3b57d1c935912ec4a88cf24e3fb) | | 5 | **Create a new repository**. Now, the app shows you all configured templates that can be used. Select one if you want to use a template, enter the name of the new repository and click "Create repository": ![newproject.png](https://help.elevatic.com/__attachments/a_4ad899708b43303a6485e0e56d1064decaab8ac8053efcbc9c7a1d47b6be4eb6/newproject.png?cb=c9139c50c29602bb8d850b3d04b708e7) After that, a new repository is created with the content and settings of the template. | | 6 | **OPTIONAL:** **Project Settings →**The app also allows to copy settings like branch permissions or web hooks from a template to newly created repositories. You can configure which setting types you want to synchronize: ![image2024-10-4_8-57-28.png](https://help.elevatic.com/__attachments/a_670fbcaaea6ba19531dd12f46133a5357577bd4c75579dd621042888d41a2970/image2024-10-4_8-57-28.png?cb=fd0a68192998804f746a62d047bffa1f) | | 7 | **OPTIONAL: Project Settings →**Periodic reset of repository settings You can also configure a cron expression on this page to **periodically reset** the settings of associated repositories (repositories that were created from a template) to the one of their template. This allows you to ensure that your repositories are always correctly configured (e.g., if you want that "force push" is not accepted). You can enable it by entering a cron expression: ![image2024-10-4_9-0-25.png](https://help.elevatic.com/__attachments/a_5f2c8a5f6c54b9b2834a2499c3f2ddaf482f8909bb1b4b6fe95a2e74fb9a7d70/image2024-10-4_9-0-25.png?cb=33163f9500b61cbe2289c599552f7f23) | --- language: "en" --- # Where can I find Information about Data Privacy? We provide detailed documentation on how we process personal data and how you can configure privacy settings to meet your organization's requirements. Please refer to these sections for more information: * **Privacy Policies** : Our central [++Privacy Policy++](https://www.communardo.com/privacy-statement/data-protection-policy-apps/) page explains our general approach to data protection and GDPR compliance. * **Subprocessors** : A current list of all third-party service providers we use is available on our [++Trust Center++](https://trust.communardo.com/). For further inquiries regarding data protection or to request a **Data Processing Addendum (DPA)** , please contact our [++Customer Support Team++](https://go.communardo.app/support). --- language: "en" --- # Where can I find Information about Data Security? Information regarding the security measures, infrastructure, and compliance standards for our apps is centralized in our **Trust Center** and specific documentation pages. To find the details you need, please refer to the following resources: * **General Security Overview** : Visit our [++Trust Center++](https://trust.communardo.com/) for information on encryption, infrastructure, and certifications. * **Data Residency** : For details on where your data is stored and how to pin it to specific regions, see [Data Residency for Elevatic Cloud apps](https://help.elevatic.com/general-app-documentation/data-residency-for-bitvoodoo-cloud-apps.md). * **App-Specific Security** : Every app listing on the **Atlassian Marketplace** contains a **Privacy \& Security** tab with a standardized security questionnaire. If you have specific security requirements or need a security whitepaper, please [++contact Customer Support++](https://go.communardo.app/support). --- language: "en" --- # Metadata for Confluence ## About the App Metadata for Confluence allows you to **centrally assign** and **administer page metadata** in Confluence. With our Metadata app you can: * Assign metadata sets to single pages, part of or even the whole page tree of a space * Add metadata sets to Confluence page templates * Search metadata and display pages based on their metadata values ## Documentation This is the documentation on the Server/Data Center version of the app. For the Cloud version, refer to [Metadata for Confluence Cloud Home](https://help.elevatic.com/metadata-for-confluence-cloud.md). You will find on this page the currently released user documentation of our app, divided into **User's** and **Administrator's Guide** . Use the navigation on the left side to guide yourself through the chapters of the documentation. * On the [introductory page](https://help.elevatic.com/metadata-for-confluence/documentation.md) of the documentation you will find more information about the target groups and all released versions of our app. * There is also a chapter to help you [get started](https://help.elevatic.com/metadata-for-confluence/how-to-get-started.md) with the app ### Questions \& Answers If you have any problems or questions with our app, please do not hesitate to contact us or search in the following platforms: * [Frequently Asked Questions](https://help.elevatic.com/metadata-for-confluence/frequently-asked-questions.md) * [Product Support](https://go.communardo.app/support) * [Product Website](https://www.communardo.com/products/metadata-for-confluence/) --- language: "en" --- # Administrator's Guide (v 3.3) Please refer to this guide for instructions on how to install the Metadata app, and how to make Metadata available for pages in a space or globally. Use the navigation on the left side to guide yourself through the chapters of the documentation. The required permissions (Confluence Administrator, Space Administrator, ...) are indicated at the top of every page. [Metadata Permission Scheme (v 3.3)](https://help.elevatic.com/metadata-for-confluence/metadata-permission-scheme-v-3-3.md) [Manage Global Metadata (v 3.3)](https://help.elevatic.com/metadata-for-confluence/manage-global-metadata-v-3-3.md) [Installation and Licensing (v 3.3)](https://help.elevatic.com/metadata-for-confluence/installation-and-licensing-v-3-3.md) [Manage Metadata in Spaces (v 3.3)](https://help.elevatic.com/metadata-for-confluence/manage-metadata-in-spaces-v-3-3.md) [Export and Import Metadata Sets (v 3.3)](https://help.elevatic.com/metadata-for-confluence/export-and-import-metadata-sets-v-3-3.md) --- language: "en" --- # Bulk change of global Metadata sets and fields. ## Problem Currently, bulk changes are limited to space metadata fields and sets. It would be beneficial if Confluence administrators could also perform bulk changes on global metadata sets and fields. ## Actual Status We have received feedback from numerous customers regarding this matter, and it is increasingly capturing attention. Rest assured, we are monitoring this internally. We encourage you to keep an eye on the [Marketplace](https://marketplace.atlassian.com/apps/1213690/metadata-for-confluence?hosting=datacenter&tab=overview) to stay informed about our latest features. ## Workaround You can perform a bulk change to any field, including both global and space fields, provided these fields are included in a Space Metadata set. If they are not, you will need to utilize the Metadata Java API to implement the global bulk change manually. For further guidance, please refer to the following [link](https://help.elevatic.com/metadata-for-confluence/developer-s-guide-v-3-3.md). If you need to make bulk changes to the global Metadata fields, consider the following approach: 1. Create a new temporary Metadata set within the space. 2. Include the necessary Metadata field in this set. 3. Execute the bulk change for the Metadata field. 4. Finally, delete the temporary Metadata set. This method streamlines the process and ensures efficient management of your Metadata fields. ## Related Articles * [SubSpace and Metadata Integration](https://help.elevatic.com/subspace-navigation-for-confluence/subspace-and-metadata-integration.md) * [Query Page Status (Comala Workflows) alongside Metadata](https://help.elevatic.com/metadata-for-confluence/query-page-status-comala-workflows-alongside-metadata.md) * [Import Fails: It is not possible to import metadata from space A into space B](https://help.elevatic.com/metadata-for-confluence/import-fails-it-is-not-possible-to-import-metadata-from-space-a-into-space-b.md) * [REST API, common errors and examples:](https://help.elevatic.com/metadata-for-confluence/rest-api-common-errors-and-examples.md) * [Bulk change of global Metadata sets and fields.](https://help.elevatic.com/metadata-for-confluence/bulk-change-of-global-metadata-sets-and-fields.md) --- language: "en" --- # Change date format of date field type ## Question How can we change the date format for a date field? We need to use dd-mm-yy and not yy-mm-dd. ## Solution The "Metadata for Confluence" app is working with the Confluence date settings. This means if you would like to display a different format, your Confluence administrator will need to change the settings in the global Confluence administration. During date fields configuration, a default date format is always used. However, if you change the global date setting, metadata date fields will be displayed in the globally configured format whenever you are in view mode of a Confluence page. ## Related Articles * [SubSpace and Metadata Integration](https://help.elevatic.com/subspace-navigation-for-confluence/subspace-and-metadata-integration.md) * [Query Page Status (Comala Workflows) alongside Metadata](https://help.elevatic.com/metadata-for-confluence/query-page-status-comala-workflows-alongside-metadata.md) * [Import Fails: It is not possible to import metadata from space A into space B](https://help.elevatic.com/metadata-for-confluence/import-fails-it-is-not-possible-to-import-metadata-from-space-a-into-space-b.md) * [REST API, common errors and examples:](https://help.elevatic.com/metadata-for-confluence/rest-api-common-errors-and-examples.md) * [Bulk change of global Metadata sets and fields.](https://help.elevatic.com/metadata-for-confluence/bulk-change-of-global-metadata-sets-and-fields.md) * [How to show all pages where Metadata field is empty](https://help.elevatic.com/metadata-for-confluence/how-to-show-all-pages-where-metadata-field-is-empty.md) * [We are getting too many Metadata notifications](https://help.elevatic.com/metadata-for-confluence/we-are-getting-too-many-metadata-notifications.md) * [Configure the "Search Macro" from "Refined for Confluence" to use page metadata fields as search parameter](https://help.elevatic.com/metadata-for-confluence/configure-the-search-macro-from-refined-for-confluence-to-use-page-metadata-fields-as-search-parameter.md) * [Use status macro for single select values](https://help.elevatic.com/metadata-for-confluence/use-status-macro-for-single-select-values.md) * [Error when I create a new Metadata field](https://help.elevatic.com/metadata-for-confluence/error-when-i-create-a-new-metadata-field.md) --- language: "en" --- # Comala Publishing ## Integration of Metadata and Comala Publishing Metadata for Confluence offers a powerful integration with **Comala Publishing** . With this integration, you can configure your Metadata sets and fields once in a **draft space** and have them **published seamlessly** to your **target space** together with your content -- a must‑have synchronization for consistent metadata across spaces. If you are interested in Comala Publishing's additional features and configuration options, refer to their official documentation: *** ** * ** *** ### General Prerequisites Before using Metadata together with Comala Publishing, make sure you meet the following prerequisites: 1. **Global configuration of Comala Publishing** The global configuration of the Comala Publishing app must contain the prefix: `com.communardo` in the list of content property prefixes that will be copied. In current versions of Comala Publishing, this configuration is set **by default** . If you have a customized configuration, verify that this prefix is present. 2. **Content Properties enabled in publishing settings** In the publishing settings of your space, the option **"Content Properties"** must be **enabled**. You can find this option in: * **Data to Include** section of **Content Options** → "Content Properties" Only if this option is enabled will Metadata information be copied along with the pages. 3. **Draft space must have a homepage** The **draft space** has to have a **space homepage** . This is required especially when you use **space Metadata** in the draft space (see below). 4. **Publishing the homepage when using space Metadata** If you use **space Metadata** in the draft space, the space homepage must also be published to the target space. To ensure this: * Enable **"Top level pages"** in the **Space Publishing Options** section of the Comala Publishing configuration. Once these prerequisites are met, you are ready to use Metadata together with Comala Publishing. *** ** * ** *** ### Recommended Approach: Use Global Metadata > **We strongly recommend using** ***global Metadata*** **for this integration.** The integration between Metadata and Comala Publishing is **designed and optimized** for **global Metadata**. Using **space Metadata** is possible, but comes with several important **limitations** and **edge cases** that you need to be aware of (see next section). To keep your configuration robust and predictable, use **global Metadata wherever possible**. Benefits of using global Metadata: * Fewer restrictions and edge cases in synchronization * Cleaner administration and reuse across multiple spaces * Better support for cross‑department and cross‑space collaboration *** ** * ** *** ### Limitations When Using Space Metadata When you choose to use **space Metadata** in combination with Comala Publishing, keep the following behavior and restrictions in mind. #### 1. Possible publication of unintended Metadata changes If you work on **multiple pages** in the draft space but **publish only a single page** via Comala Publishing: * **Changes in Metadata of other pages might still be published.** This can happen, for example, when: * The configuration of the **Metadata fields** and/or **Metadata sets** used on those pages has been changed (not just the values on one page). In such cases, structural changes can cause additional Metadata changes to be synchronized, even if you did not explicitly publish those pages. #### 2. Default values from draft space are not published If you use **default values** for Metadata in the draft space: * These **default values cannot be published** to the target space with Comala Publishing. Only the explicitly stored values per page are considered; default definitions in the draft space do not propagate. #### 3. Not all changes to a space Metadata set are synchronized Not every change you make to a **space Metadata set** in the draft space will be reflected in the target space when publishing. The following changes might **not** be synchronized reliably: * Changing the **name** of the space Metadata set * Changing the **description** * Changing the **"default for"** setting * Reordering the **fields** within the set Synchronization is typically triggered only by **structural** modifications to the fields, for example: * Changing a field's **hidden** or **required** flag * Adding or removing fields * Changing field definitions Without such structural changes, some Metadata set updates will not be transferred. #### 4. Page template assignments are not published Assignments of **page templates** to a Metadata set in the **draft space**: * **Cannot be published** to the target space using Comala Publishing. You will need to reconfigure these manually in the target space if required. *** ** * ** *** ### Summary and Best Practices To get the best results from the integration of Metadata for Confluence and Comala Publishing: * ✔ **Use global Metadata** wherever possible * ✔ Ensure **Comala Publishing** is configured to copy content properties including `com.communardo` * ✔ Enable **Content Properties** in your **Content Options → Data to Include** * ✔ Make sure your **draft space has a homepage** * ✔ If you must use **space Metadata** , make sure the **homepage is included** in the publishing configuration (enable "Top level pages") By following these guidelines, you avoid the known limitations of space Metadata and benefit from a stable, predictable metadata synchronization across your draft and target spaces. *** ** * ** *** ### Related Issues and Technical Details For more technical background and current status of known issues, see the Jira tickets: * [METADATA-2308: Publishing a single page with Comala Publishing, Metadata of other pages might be published too](https://communardo.atlassian.net/browse/METADATA-2308) * [METADATA-2520: Default values defined in the draft space are not published with Comala Publishing](https://communardo.atlassian.net/browse/METADATA-2520) * [METADATA-2522: Some changes to a space Metadata set might not be published with Comala Publishing](https://communardo.atlassian.net/browse/METADATA-2522) * [METADATA-2521: Page template assignments to a Metadata set in the draft space are not published with Comala Publishing](https://communardo.atlassian.net/browse/METADATA-2521) These tickets describe the specific behaviors and edge cases in more technical detail. *** ** * ** *** #### Source [Integration of Metadata and Comala Publishing](https://help.elevatic.com/metadata-for-confluence/integration-of-metadata-and-comala-publishing.md) --- language: "en" --- # Comala Workflows ## Does Metadata work with Appfire's Comala Document Management Data Center (formerly Comala Workflows)? ### Short answer Metadata values *can* be used as [Value References](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649694302) by the *Comala Document Management* app. For details on how to access and integrate Metadata for Confluence in Comala Document Management, refer to the official Appfire documentation: * [Value References](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649694302) * [Elevatic Metadata for Confluence app](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650348379/Communardo+Metadata+for+Confluence+app) ### Can Comala change Metadata values? It is currently *not* possible to change Metadata values via Comala Document Management. This limitation is tracked as a potential new feature: * [METADATA-193: Change Values with Comala Workflows](https://communardo.atlassian.net/browse/METADATA-193) #### Source [Does Metadata work with appfire's Comala Document Management Data Center (formerly Comala Workflows)](https://help.elevatic.com/metadata-for-confluence/does-metadata-work-with-appfire-s-comala-document-management-data-center-formerly-comala-workflows.md) --- language: "en" --- # Configure the “Search Macro” from “Refined for Confluence” to use page metadata fields as search parameter In this article, we will describe how to configure the "*Search Macro* " in the "*Refined for Confluence*" app to use page metadata fields as search parameters. This macro can be configured with several parameters, including the **"CQL" parameter** , which lets you define a search query as described in "[Advanced Searching using CQL](https://developer.atlassian.com/server/confluence/advanced-searching-using-cql/)". For more information regarding the "*Search Macro* ", click [here](https://docs.refined.com/display/rwot/Search+macro). ## Instructions To adjust the "*Search Macro*" to search pages according to their metadata field values, configure the following as CQL parameter: (space ="SPACE_KEY") or (METADATA_FIELD_KEY="$query") ![search-macro-cql-parameter.PNG](https://help.elevatic.com/__attachments/a_e85100000af59abbc73ed86d367669081e1be88890077828a3ab307b03470768/search-macro-cql-parameter.PNG?cb=9135db8bf90357d757bfb87df6b094e8) *Search Macro parameters - CQL parameter* You should: * Change "METADATA_FIELD_KEY" to the key of the metadata field you want to include in your search. * Change the space key "SPACE_KEY" to your space key. With this configuration, if you enter the value "jira" in the search input, **you will get the following results:** 1. All Confluence pages (from every space) that have the value "jira" in the metadata field with key "METADATA_FIELD_KEY" 2. Pages from the space with key "SPACE_KEY" that have the word "jira" in their title 3. Pages from the space with key "SPACE_KEY" that have the label "jira" ## Related articles * [SubSpace and Metadata Integration](https://help.elevatic.com/subspace-navigation-for-confluence/subspace-and-metadata-integration.md) * [Query Page Status (Comala Workflows) alongside Metadata](https://help.elevatic.com/metadata-for-confluence/query-page-status-comala-workflows-alongside-metadata.md) * [Import Fails: It is not possible to import metadata from space A into space B](https://help.elevatic.com/metadata-for-confluence/import-fails-it-is-not-possible-to-import-metadata-from-space-a-into-space-b.md) * [REST API, common errors and examples:](https://help.elevatic.com/metadata-for-confluence/rest-api-common-errors-and-examples.md) * [Bulk change of global Metadata sets and fields.](https://help.elevatic.com/metadata-for-confluence/bulk-change-of-global-metadata-sets-and-fields.md) [Next Page](https://help.elevatic.com/llms-full.txt/1)