Settings for Reporter plugin

To access the plugin's general settings, go to Administration > Plugins, find Reporter plugin in the list and select Configure.

General settings

General tab

Here you will find the following option:
  • Public links for issues - With every report a link to it is generated (found right beneath it). If this option is enabled any user will be able to view it, if it is disabled - only users with permission to view issues.

In the Report stylesheet (CSS) field you can prepare an external CSS stylesheet to be used by all your report templates.

Report templates tab

Here you can prepare the list of your report templates. Every report is generated using a template, so without one a report cannot be generated.

To create one, press . You can also current ones.
  • Type - Select Issue for a template of a single-issue report or Issues List for a multi-issue one.
  • Name - Provide a name for your template. Make sure for it to be distinctive, because whenever a new report is requested, you will be choosing a template by its name.
  • Description - This description is visible only in the template list on the Report templates tab.
  • Author - The name of the user that created the template.
  • For all projects - If you create a template here, it will be applied to all projects(regardless of this option). To create a project-specific template, go to the project's settings.
  • Report template - Here you prepare the template in Liquid markup language.

While preparing a template, the only object you can directly access is issue (or issues, the array of issues included in the report when preparing a multi-issue template). The syntax to acces a specific attribute of an object is {{issue.issue_attribute}}.

When preparing a multi-issue template, you can iterate through every issue in the list with:

{% for issue in issues %}
...
(Access contents of each issue)
...
{% endfor %}

Below you will find a list of available objects, as well as their respective sets of accessible attributes. Attributes in bold represent further objects with attributes of their own.

issue
id subject description visible? open? estimated_hours
start_date due_date overdue? done_ratio priority spent_hours
is_private? closed_on updated_on created_on link total_spent_hours
url author assignee tracker status total_estimated_hours
category version time_entries parent color story_points
project subtasks notes journals* tags day_in_state
checklists

* journals refers to the list of notes of the issue

array (issues, subtasks, users... are objects of this type)
all visible each size
project
id identifier name is_public description short_description
link visible? active? start_date due_date completed_percent
url archived? overdue? issues users subprojects
user (author, assignee are objects of this type)
id name firstname lastname mail active? admin?
logged? language avatar permissions groups projects
time_entry
id hours comments spent_on tyear tmonth tweek
visible? updated_on created_on user issue activity
checklist_item
id_done subject

Note: For example, with {{issue.project.users}} you reference the array of all users involved in the project this issue belongs to.

To access the content of a custom field, use
{{issue | custom_field: "custom_field_name"}}.
You can also iterate through all custom fields with
{% assign custom_fields = issue | custom_fields%}
{% for field in custom_fields %}
<p><b>{{field}}:</b> {{issue | custom_field: field}}</p>
{% endfor %}

Note: 'issue' here is a an object of type issue. When preparing a multi-issue template there is no such object initially, rather the array 'issues'. You can use this loop to refer to each issue separately.

To add CSS styling direct into the template use the <style> tag as you would in an HTML document.

Alternatively, you can a template. You cannot import a template that has the same name as an existing one, unless you mark Rewrite existed. In that case the existing one will be replaced by the import.

Note: You can try out our sample templates. Just download the .yml template file and import it into your Redmine.

Use to try a template. A report will be generated using some issue(s).

You can also a template. Doing so will not cause attached reports generated through this template to be deleted as well.

Project settings

Report templates tab

The same things apply here as in Report templates tab of General settings. When you create a template here you can choose whether it will be for all or only for this project. You can also make local templates global. As soon as a template is declared global, it can only be made local again by deleting it and importing/creating it anew.

Was this article helpful? Yes  No
7 from 10 found this helpful