Reports

This interface is 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

This interface has the following properties.

Property	Value
Name	Reports
Code	designInterfaces_reports
Type	Interface
Context	Core
AI agent enabled	true
AI agent description	Base interface implemented by all report designs, providing report name, status, error, and document fields.
Icon	icon-reports
Colour	#690095
Title	{{attributes_reportsName}}
Subtitle	-

Implements

This interface doesn't implement any other interfaces.

Attributes

This interface has the following attributes.

Name

The name of the report.

Property	Value
Name	Name
Code	attributes_reportsName
Type	String
Required	true
Unique	false
Read-only	true
AI agent enabled	true
Options	{ "max": 128 }

Error

Any error message generated when running the report.

Property	Value
Name	Error
Code	attributes_reportsError
Type	String
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "max": 4096 }

Status

The current status of the report run (e.g. Pending, Running, Complete, Failed).

Property	Value
Name	Status
Code	attributes_reportsStatus
Type	String
Required	true
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "max": 128, "defaultValue": "Created" }

Documents

Links to one or more output documents generated by this report.

Property	Value
Name	Documents
Code	attributes_reportsDocuments
Type	Link
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Links to	Report Documents
Options	{ "code": "designInterfaces_reportDocuments", "graph": "Report" }

Items Reported On

Links to one or more items that were included in the scope of this report run.

Property	Value
Name	Items Reported On
Code	attributes_reportsItemsReportedOn
Type	Link
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Links to	Items
Options	{ "code": "designInterfaces_items", "graph": "Report", "weakReference": true }

Standard paths

This interface doesn't have any standard paths of its own.

Permissions

This interface defines the following permissions.

User group	Allowed
Report Viewers	Read
Report Managers	Read, Create, Edit, Delete

Default attribute permissions

This interface applies the following default permissions to all attributes for the following user groups.

Allowed	User group	Code
ReadOnly	Report Viewers	userGroups_reportViewers
ReadWrite	Report Managers	userGroups_reportManagers