Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Summary

The Comment Header allows you to prefix specific content onto comments when they are processed by JEMHC.

Creating a Comment Header template

Comment header content is create and modified through the use of a template. Templates are found within Notification > Template Sets.

...

Information about the data available to you for use within a Template’s content can be found here.

Changing the Template that is used by the Profile

Once the template has been created you will then have to select the template within the Profile so that it will then be applied within the comment. To change the template you go to Profile > Project mapping > Templates and press Edit.

...

You will now be able to select the Comment Header Template that was just created.

...

Choose the sender categories this should apply to

Within the Profile you are also able to set when the Comment header should be applied whether you would the comment header to be applied for only email users or for email users and Jira watchers. This configuration is found within Profile > Project Mapping > Issue > Comment > Comment Header Mode

...

Example Comment Header

Once you have the comment header configured you will then see that new comments will have the new comment header applied.

...

Data available for use within a Template’s content (with usage examples)

The data available to you for use within your template can be found by expanding the Preview Context and Velocity Context sections.

...

This will allow you to see how your template will render when in use, given the example Preview Context shown on this section.

Preview Context data

...

Preview Context data is specific to the context in which your template is used and is available at render time. From the example above we can see that the context for an incoming email shows the address from which the email was sent, and the intended recipients.

...

In the above example the recipients field has multiple entries surrounded by square braces. These data structures are called “arrays” and we can access each element by its positional index within the list as shown above with $context.recipients[0]. The positional indices for arrays start at zero, therefore the first element is found at $context.recipients[0] the second at $context.recipients[1], and so on.

Velocity Context data

...

Velocity Context data is also available to your template at render time but provides more general utilities for your use.

...