It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

How to use velocity templates?

Hi.

I found many questions and answers about velocity templates in Confluence. And what about JIRA?

I have tried example from this page:

// Create the Velocity Context
Map context = MacroUtils.defaultVelocityContext();
context.put("myCustomVar", customVar);
context.put("otherCustomVar", otherCustomVar);
// Render the Template
String result = VelocityUtils.getRenderedTemplate("/com/myplugin/templates/macro.vm", context);

 but I cannot find appropriate packages for MacroUtils and VelocityUtils in JIRA.

What packages I need to user for it? Or does exists anything else way to use velocity templates in JIRA?

Thanks.

2 answers

To use Velocity Template you need:

  1. add Scanned annotation to your class
  2. add TemplateRenderer field with ComponentImport annotation
  3. add TemplateRenderer to constructor
  4. use it

For example:

@Scanned
public class MyClass {
@ComponentImport
private final TemplateRenderer templateRenderer;

public MyClass(TemplateRenderer templateRenderer) {
this.templateRenderer = templateRenderer;
}
}

 After that you can use it, for example

@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
Map<String, Object> context = Maps.newHashMap();
resp.setContentType("text/html;charset=utf-8");

context.put("key", "value");

templateRenderer.render("path_to_vm_template", context, resp.getWriter());
}
2 votes

Hi Yanduganov,

You'll want to use the JIRA templates and JSP's guide for Velocity Templates in JIRA.  MacroUtils and VelocityUtils appear to be for Confluence per the Confluence Velocity template documentation and I was unable to find references to those methods in the JIRA docs.

Cheers,

Branden

Gaston_Valente Community Leader Jul 26, 2017

great doc, saves a lot of time, thanks!

Hi Branden.

Your answer isn't about templates which I meant.

I write JIRA plugin and I have servlet. And I wanna render it using velocity template. I tryed write HTML just in java but I think that it's a wrong way.

Suggest an answer

Log in or Sign up to answer
Community showcase
Published in Jira

Keep your team in the loop with Team @mentions in Jira Software!

Hi everyone! My name is Jenny, a Product Manager at Atlassian. After launching Team @mentions in Confluence, we heard a lot of positive feedback from customers that they love how easy it is to @men...

501 views 5 17
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you