Skip to end of metadata
Go to start of metadata

Available:

JIRA 5.0 and later.

The issue link renderer plugin module allows you to add new custom renderers for issue links to JIRA.

When a Remote Issue Link is rendered, if there is no custom renderer for the application type of the link, a default renderer is used.

For background information, see the overview of JIRA Remote Issue Links. If you are interested in creating Remote Issue Links, take a look at the REST API Guide.

Example of an Issue Link Renderer Definition

Issue Link Renderer Configuration

The root element for the issue link renderer plugin module is issue-link-renderer. It allows the following attributes and child elements for configuration:

Attributes

Name

Required

Description

Default

class

(tick)

The Java class of the issue link renderer plugin module. Classes must implement com.atlassian.jira.plugin.issuelink.IssueLinkRenderer. There is a com.atlassian.jira.plugin.issuelink.AbstractIssueLinkRenderer defined which issue link renderers can extend to minimise the number of methods that are required to be implemented.

 

key

(tick)

The identifier of the plugin module. This key must be unique in the plugin where it is defined.
Sometimes, in other contexts, you may need to uniquely identify a module. Do this with the complete module key. A module with key fred in a plugin with key com.example.modules will have a complete key of com.example.modules:fred.I.e. the identifier of the custom field type module.

 

i18n-name-key

 

The localisation key for the human-readable name of the plugin module.

 

name

 

The human-readable name of the plugin module.

 

application-type

(tick)

The application type that the issue link renderer will handle. You can only have one custom renderer map to a specific application-type.

 

Elements

Name

Attribute

Required

Description

resource

type

 

Type of the resource. At the moment only "velocity" is supported.

resource

name

 

Name of the resource. Use either "initial-view" or "final-view" to specify a resource for the initial viewing and the async loading respectively.

Issue Link Renderer

Custom issue link renderers may extend com.atlassian.jira.plugin.issuelink.AbstractIssueLinkRenderer to minimise the number of methods required to be implemented.

  • No labels