Changing icons for Remote Links in Jira
Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.
Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
Summary
This page will provide steps to change icons for existing Remote Links from the Jira application.
Remote Issue Links offers a simple but powerful way to integrate your application with JIRA. If you have an object in your application that relates to a JIRA ticket, you can link that object to the JIRA issue using Remote Issue Links.
Steps to Create Remote Links are described in Creating Remote Issue Linksand Jira REST API for Remote Issue Links page. Remote links can be created only using REST API. We don't have an option to create a Remote Link through UI.
Once Remote links are created default icon will be displayed along with the Remote Links.
Environment
Jira Data Center
Solution
When we create a Remote Link for a Jira issue with Confluence (linking the Confluence page) or any other internal/external application, along with the name of the Link, the default icon will be displayed in the Issue Links section of the View Issue page.
While creating a Remote Link, we would have the option to provide details for "Icon" in the request parameter. The “Icon” section would generally contain "url16x16" and "title" parameters. Jira would call this link to obtain the image of the icon to be displayed.
1
"icon": { 2 "url16x16":"http://www.openwebgraphics.com/resources/data/3321/16x16_voice-support.png", 3 "title":"Support Ticket" 4 }However, if we don't provide any details in "icon" parameter, Jira will automatically assign "generic icons" or default icons available in Jira’s system packages. These icons would be picked from /Jira_INSTALL_DIR/atlassian-jira/images/icons location.
If you want to have custom icons, we need to define the "icon" parameters in the 'Request body' when creating a Remote Link. You can refer to Using fields in Remote Issue Links page for more details on additional parameters that can be included in Request body.
The same icon file (generic_link_16.png) is picked by default for every new 'remote link' when "icon" parameters are not defined. To have a custom icon, we can replace the default icon file with a custom icon file in /Jira_INSTALL_DIR/atlassian-jira/images/icons location (maybe even have the same name as the default icon file) so that the application would pick them automatically when no "icon" parameters are defined in 'Request body'.
Was this helpful?