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?

Yanduganov Andrey Jul 24, 2017

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

2 votes
Yanduganov Andrey Aug 15, 2017

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());
}
1 vote
Branden McElveen Atlassian Team Jul 26, 2017

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!

Yanduganov Andrey Jul 26, 2017

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
This widget could not be displayed.
This widget could not be displayed.
Community showcase
Posted in Jira Software

Demo Den Ep. 5: Meet Jira Mobile

See how to use Jira on the go! Demo Den Episode 5 is here: meet Jira Mobile with  Jira  Product Manager Rayen Magpantay.  Demo Den is in our monthly series where a Jira PM demonstrates...

423 views 1 10
Join discussion

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