Fragment Portlet

What is it?

The problem you need to solve: You want access to reports you frequently use, but you do not want to configure them each time you need to generate them.

How Minyaa solves this problem: Minyaa provides a "Fragment" portlet that is used to provide shortcuts to frequently used reports.

FragmentPortlet Predefined Report

How to add the portlet/gadget

Add the portlet/gadget named Fragment Portlet

For more information on adding portlets/gadgets to your dashboard, please take a look at Configuring the Dashboard

Configuring the Portlet/Gadget

FragmentPortlet.configuration
Parameter Description
Project Represents the project on which reports will be based
Fragment Type The Predefined Reports for a User option provides the following reports:
  • My worklogs for current month
  • My worklogs for previous month
  • My worklogs for current quarter
  • My worklogs for previous quarter
The Predefined Reports for a Project option provides the following reports:
  • Project's worklogs for current month
  • Project's worklogs for current quarter
  • My worklogs for current month on this project
  • My worklogs for previous month on this project
  • My worklogs for current quarter on this project
  • My worklogs for previous quarter on this project
  • Project's worklogs for previous month
  • Project's worklogs for previous quarter

Extending the portlet/gadget to show more links

If you are a developer, you can extend the fragment portlet to provide more links.

Please note that you will need to provide the definition in an atlassian-plugin.

For more information on developing your own plugin, please take a look at the Jira Plugin Guide



The plugin you develop will have to provide following files :
  • atlassian-plugin.xml where you will define all your predefined reports ...

    <atlassian-plugin key="jira.plugin.your.comapany.reports" name="Your Company JIRA Plugin Predefined Reports">

		<plugin-info>
			<description>Atlassian JIRA Plugin - Your Company Predefined Reports</description>
			<version>1.0</version>
			<application-version min="3.13" max="3.13" />
			<vendor name="Your Company" url="http://your.company.com" />
		</plugin-info>

		<!-- Report with your Parameters -->
		<web-item key="your.predefined.report" name="Your Predefined Report" i18n-name-key="webfragments.preset.reports.item.your.predefined.report" section="browser.project.preset.reports" system="false" weight="1">
			<label key="weblink.reports.your.predefined.report" />
			<link linkId="your.predefined.report">/secure/ConfigureReport.jspa?reportKey=jira.any.plugin:report.key&amp;param1=value1&amp;param2=value2&amp;author=$user</link>
			<resource type="i18n" name="i18n" location="com.company.jira.webfragments.predefinedReports" />
		</web-item>

	</atlassian-plugin>
  • com/company/jira/webfragments/predefinedReports.properties where you will define the required I18n properties ...

    # A Predefined Report 
	webfragments.preset.reports.item.your.predefined.report=Short Report Description 
	weblink.reports.your.predefined.report=Detailed Report Description

See also