EmForge Reporting

How to review tasks right now

There is implemented hard coded reports like:

• Your Active Tasks
• Active Tasks assigned to a milestone
• Finished Tasks assigned to a milestone
• etc.

These reports allow to review active tasks, finished tasks and etc. Any user can review these reports, but cannot modify it. To fix this problem we are going to replace these reports to some expandable reports - to this effect we've started support JasperReports.

So since EmForge-0.22 any user can create/modify a necessary report and use it.

How to create a new report

It is very simple! You can use iReport to design a JasperReport of any type.

See also:

• JasperReports Tutorial
• iReport Getting Started

How to use new reports

EmForge Reports page shows a list of available reports and allows to upload a new JasperReport.

When user clicks one of the available reports, a view will be shown to fill the report parameters (if any required exist).

EmForge report features

Default parameters

You can use predefined parameters which will have default values:

1. _site - base URL of current EmForge instance;
2. _user - current user;
3. _project - default project for current user;

Just specify it in report disign like:

<parameter name="_user" isForPrompting="false" class="java.lang.String"/>

If you want to redefine the default value then use isForPrompting="true" attribute.

Parameter prefixes

You can also use special prefixes for report parameters to allows users to select a necessary value from prepared listbox:

Prefix	Listbox of	Value type	Example
p_	all projects	java.lang.Long	p_projectId
m_<wiki name of required project>	milestones assigned to specified project	java.lang.Long	m_EmForge
u_	all users	java.lang.String	u_actorId
up_<wiki name of required project>	users assigned to specified project	java.lang.String	up_EmForge
ur_<wiki name of required project and role>	users assigned to specified project and role	java.lang.String	ur_EmForge_Developer
us_<site role name>	users assigned to specified site role	java.lang.String	us_ROLE_WIKIWRITER
r_	site roles	java.lang.Long	r_siteRoleId
pr_	priorities	java.lang.Integer	pr_priorityId

An example of prefix usage:

<parameter name="m_MyProject" isForPrompting="true" class="java.lang.Long">
    <parameterDescription><![CDATA[Select a milestone: ]]></parameterDescription>
</parameter>

It will look like:

Date type parameters

Also if you specify any parameter as java.util.Date type, then there will be displayed a localized calendar to select date:

The example of date type usage:

<parameter name="requiredDate" isForPrompting="true" class="java.util.Date">
    <parameterDescription><![CDATA[Just select date: ]]></parameterDescription>
</parameter>

The following ActiveTasksExample.jrxml file is a simple example of report with several required parameters.

How to manipulate reports

How there are implemented the following permissions:

1. EmForge admin can upload, delete any report;
2. Any registered user can review, download any report.

In future we are planning to expand user permissions and base it on project permissions.