Client Actions Simple Report Menu

Owned by Shaun Forbes
Last updated: 05 Feb, 2019 by Lucy Minato (Unlicensed)
1 min read

Provides a means of displaying a menu with reports that the user can quickly generate.

Note that for BIRT reports the report menu uses existing report configuration items to populate the menu, it does not point directly to the BIRT report definition files.

ID

com.cohga.client.action.simplereportmenu

Sub-tags

Name

type

cardinality

description

label

String

0..1

Label to display in button

format

String

0..1

The format to generate the report in (can also be set per-report)

reports

report list

1..1

The list of reports to include in the menu

Example

	<item action="com.cohga.client.action.simplereportmenu">
		<label>Quick Reports</label>
		<tooltip>
			<title>Quick Report</title>
			<text>Generate a preset report</text>
		</tooltip>

		<!-- Set a default format, the user can't choose one if you do this -->
		<format>pdf</format>

		<reports>
			<report>
				<report>map_portrait_a4</report>
			</report>

			<!-- Overwrite the report label -->
			<report>
				<label>A4 Landscape Map Report</label>
				<report>map_landscape_a4</report>
			</report>

			<!-- Only enable the entry for a particular entity -->
			<report>
				<entity>property</entity>
				<label>Property Detail</label>
				<report>property_details</report>
			</report>

			<!-- set the report parameter rather than the user having to enter it -->
			<report>
				<entity>property</entity>
				<label>Property Detail - 1:5000</label>
				<report>property_details</report>
				<!-- assumes the report has a parameter called 'scale' that the user usually inputs -->
				<parameters>
					<scale>5000</scale>
				</parameters>
			</report>
		</reports>
	</item>