How to render wiki markup in velocity for JIRA

Question

For those who search for a way to render wiki markup in a Velocity file, for example in JIRA email templates:

#set ($rendererManager = $componentManager.getRendererManager() )

#set ($renderer = $rendererManager.getRendererForType("atlassian-wiki-renderer"))

#set ($ircontext = $renderer.getRenderContext() )

#set ($renderedText = $renderer.render($wikimarkuptext, $ircontext) )

Caveats:

Not all characters will be displayed by Outlook in the email. Bold and URL links worked for me, but not tables or emoticons.

Also, I'm not sure if the ComponentManager object is still accessible in the email template Velocity context for newer versions of JIRA

koenemann · Answer

Unfortunately, this does not work any more with Jira 10/11, because of further security restrictions:

[velocity] Invocation blocked as method is not allowlisted: com.atlassian.jira.issue.fields.renderer.wiki.AtlassianWikiRenderer#render(java.lang.String com.atlassian.jira.issue.fields.renderer.IssueRenderContext)

Only custom code can be "allowlisted". See here.

Priyanka Lavani1 · Answer

Thanks Matt and David! ComponentManager object is available in Higher JIRA version, have used it with JIRA 6.4.8 hence we do not need to define it again. The entire code I have used in velocity template of a custom field using wiki renderer is as below: #disable_html_escaping() #set ($rendererManager = $componentManager.getRendererManager()) #set ($wikiRenderer = $rendererManager.getRendererForType('atlassian-wiki-renderer')) #set ($ircontext = $issue.getIssueRenderContext()) #if ($customFieldManager.getCustomFieldObject("customfield_10005")) #set ($cfCustomFieldName = $customFieldManager.getCustomFieldObject("customfield_10005").getFieldName()) #set ($cfCustomFieldVal = $issue.getCustomFieldValue($customFieldManager.getCustomFieldObject("customfield_10005"))) #end #if ($cfCustomFieldVal) $cfCustomFieldName: $wikiRenderer.render($cfCustomFieldVal, $ircontext) #end

David_Turner · Answer

This is a very nice tip thank you. I've had to implement as part of a custom Velocity template including Description and Comments fields. Small adjustment in that (at least in my Jira 6.2) it actually needs the IssueRenderContext (not just any RenderContext) to be able to display inline images and attachments. Full result looks like this: {code} #set ($componentManagerClass = $constantsManager.getClass().getClassLoader().findClass('com.atlassian.jira.ComponentManager')) #set ($method = $componentManagerClass.getDeclaredMethod('getInstance', null)) #set ($componentManager = $method.invoke(null, null)) #set ($commentManager = $componentManager.getCommentManager()) #set ($rendererManager = $componentManager.getRendererManager()) #set ($wikiRenderer = $rendererManager.getRendererForType('atlassian-wiki-renderer')) #set ($ircontext = $issue.getIssueRenderContext()) #set ($issueComments = $commentManager.getComments($issue)) #if ($issueComments.size()>0) #set ($last = $issueComments.size() - 1) #set ($lastComment = $issueComments.get($last)) #end ... Response: $wikiRenderer.render($lastComment.body, $ircontext)
... {code}