Reports

designInterfaces_reports included in the Core module.

Description

Each type of report will implement this interface. Implementations need to add attributes with tag ReportParameter to indicate the parameters that the report takes. There also needs to be a corresponding entry/standard item of design designs_reportTypes.

Properties

Property	Value
Name	Reports
Code	designInterfaces_reports
Type	Design interface
Context	Core
Title	{{attributes_reportsName}}
Subtitle	-
Icon	icon-reports
Colour	#25aae1

Implements

This interface does not implement any interfaces.

Applied to designs/interfaces

This interface is not added to any designs or interfaces when this module is installed.

Attributes

This interface directly creates the following attributes.

Name

Property	Value
Name	Name
Code	attributes_reportsName
Type	String
Required	true
Unique	false
Readonly	true
Options	{ "max": 128 }

Error

Property	Value
Name	Error
Code	attributes_reportsError
Type	String
Required	false
Unique	false
Readonly	false
Options	{ "max": 4096 }

Status

Property	Value
Name	Status
Code	attributes_reportsStatus
Type	String
Required	true
Unique	false
Readonly	false
Options	{ "max": 128, "defaultValue": "Created" }

Documents

Property	Value
Name	Documents
Code	attributes_reportsDocuments
Type	Link
Required	false
Unique	false
Readonly	false
Links to	Report Documents
Options	{ "code": "designInterfaces_reportDocuments", "graph": "Report" }

Items Reported On

Property	Value
Name	Items Reported On
Code	attributes_reportsItemsReportedOn
Type	Link
Required	false
Unique	false
Readonly	false
Links to	Items
Options	{ "code": "designInterfaces_items", "graph": "Report", "weakReference": true }

Default attribute permissions

This interface applies the following default permissions to all attributes against each user group.

Allows	Name	Code
ReadOnly	Report Viewers	userGroups_reportViewers
ReadWrite	Report Managers	userGroups_reportManagers

Permissions

User Group	Allows
Report Viewers	Read
Report Managers	Read, Create, Edit, Delete