Report

Owned by Shaun Forbes
Last updated: 05 May, 2023
2 min read

A report provides a link to a report design that the server can generate and display to the user.

Currently BIRT is the default report engine, and the BIRT designer should be used to create the report designs. To aid integration between Weave and BIRT there are two plugins available for BIRT that provide additional functionality, one to provide a map component for embedding a map in your report, and another for connecting BIRT to a Weave data definition which can then be used to supply data to the standard BIRT reporting components.

www.amazon.com provides additional support for developing BIRT reports as well as the online help available within the BIRT designer itself.

Once the reports designs are created they need to be copied to the Weave workspace directory (or a sub-directory, or referenced with a fully qualified filename) and a report entry added to the Weave configuration to reference the report design.

Namespace

urn:com.cohga.server.report.birt#1.0

Tags

report

Properties

Name

Type

Required

Description

id

string

yes

Unique identifier

label

string

yes

User presented label for the report

design

string

yes

The name of the report design file

description

string

no

A description to show to the user

entity

string

no

The name of the entity that this report should be associated with

formatsstringnoA comma separated list of the formats that should be available for the reports, e.g. "pdf,html,docx"

enablesFor

string

no

An expression that indicates the number of selected entities required for the report

groupstringnoUser presented label for groups. Reports with same group label will appear together within the same sub menu

Sub-tags

Name

Type

Cardinality

acl

urn:com.cohga.server.acl#1.0:acl

0..1

Content

None

Notes

  • An ACL can either be defined in-line or referenced indirectly, but only one should be used (the in-line version will take priority)

  • enablesFor can be one of:

    !

    size = 0

    ?

    size = 0 or 1

    +

    size >= 1

    *

    size >= 0

    n

    size = n

    n+

    size >= n

    n-

    size >= n

    -m

    size <= m

    n-m

    n <= size <= m

reports

Properties

Name

Type

Required

Description

id

string

yes

Unique identifier pre-pended to report design name to generate report id

dir

string

yes

Directory name containing report to be added, either relative to workspace or absolute

entity

string

no

The name of the entity that these reports should be associated with

enablesFor

string

no

An expression that indicates the number of selected entities required for the reports

Sub-tags

Name

Type

Cardinality

acl

urn:com.cohga.server.acl#1.0:acl

0..1

Content

None

Notes

  • An ACL can either be defined in-line or referenced indirectly, but only one should be used (the in-line version will take priority)
  • The label and description for the reports will be extracted from the report design itself
  • Both entity and group attributes can be specified together. When both attributes present, groups sub menus are created inside entity sub menu within the reports menu.

Examples

<birt:report id="property_report" label="Property Report" entity="property" group="Special Reports" design="proprpt.rptdesign" description="Provides a full property report for the selected property" enablesFor="1"/>

<birt:report id="pothole_report" label="Potholes" design="potholes.rptdesign" description="Summary report of currently reported potholes">
	<acl:acl>
		<entry type="deny">anonymous</entry>
		<entry type="allow">*</entry>
	</acl:acl>
</birt:report>

<birt:reports id="property_reports" dir="reports/property" entity="property"/>