# Report content
# Report flow
# static
static reports contain the data that needs to be presented in the report object.
# dynamic
dynamic reports contain one or more queries that will request the data upon report generation
# Report status
# todo (raw)
A report in the raw format has not been validated and no template is assigned.
# in progress (validating)
A validator is assigned but has not finished the validation.
# to be verified (verification optional step)
After validation, a supervisor can still verify the result before it is allowed to publish.
# done (validated and optional verified)
After validation and verification, the content has been reviewed and optionally a template has been assigned so that a report can be generated upon request.
# blocked (exceptional status)
In case on of the steps above cannot be executed e.g. no validator is assigned the report will be given the status blocked.
# Report generation
HTML All reports in the status done can be generated on the fly. By default as a web-page in HTML based on the default or assigned template. Reports can be shared in different export formats outside the application (storage server, e-mail ....)
# Report types
# Default reports
A default report is a report that is generated without a template.
# Template reports
A template report is a report that has a template assigned that isgenerated with the report template builder.
# Custom reports
A custom report is a report that has a template assigned that is custom made (not by the template builder)
# Features
# Viewing reports
In the reports interface you will find a list of all reports that can be filtered on company, project, service or user.
Following information is availalble:
# Properties
| Property | EN | NL | Comment |
|---|---|---|---|
| report_id | reportnumber | verslagnummer | unique report number |
| created | date created | datum aangemaakt | date created |
| organization_id | organization | organisatie | organization name |
| department_id | department | afdeling | department name |
| unit_id | unit | eenheid | unit name |
| validator_id | validator | validator | user name of the user that created the validated report |
| supervisor_id | supervisor | supervisor | user name of the user that needs to approve the report before sharing |
| validation_date | date validation | datum validatie | date of validation |
| version | version | versie | version number |
| type | type | type | enum: [{"raw", "validated"}], raw is the original report in JSON format, validated is the processed report by the validator |
| size | size | grootte | document size in bytes |
| comment | general comment | algemene opmerking | general remark on the report |
| task_id | tasknumber | taaknummer | unique task number |
| task_start | start time | starttijd | starttime of the task, i.e. start time of the first timetracking linked to the task |
| task_end | end time | eindtijd | endtime of the task, i.e. end time of the last timetracking linked to the task |
| task_duration | duration | totale tijd | sum of all timetracking time linked to the task |
| task_next_date | next date | datum volgende uitvoering | date next execution for this task (with this specific tasktype and for this specifice service and project) |
| task_duration_invoicable | duration invoicable | aan te rekenen tijd | sum of all timetracking time that is invoicable linked to the task |
| timetrack_id | timetrack number | tijdstregistratienummer | |
| timetrack_start | timetrack starttime | timetrack starttijd | |
| timetrack_end | timetrack_endtime | timetrack eindttijd | |
| legend | legend | legende | mapping table |
| project_id | project | project | |
| service_id | service | dienst |
# Editing reports
As as user with edit rights, you can edit the report.
TIP
Note that multiple iterations of editing a report is allowed, each iteration will create a new version of the report with a unique revision number.
# Editing report content
Every property is by default shown as a seperate element in the report or as configured in the report configuration of the property.
# Elements
When editing the report, one can add or remove elements in the report.
Each element can Following type of elements are supported
| Property | Description | Example |
|---|---|---|
| Veld | Omschrijving | Voorbeelden |
| Text | een tekstvak met één regel. | Naam, straat, job titel, ... |
| Text area | een tekstvak met meerdere regels | Omschrijvingen, vak voor een open antwoord |
| Yes/No | een Ja/nee veld | Akkoord met voorwaarde |
| Multiple choice | Meerkeuzelijst waar je één of meerdere keuzes kan aankruisen | examen vraag, man/vrouw keuze |
| Dropdown list | een uitklaplijst waar je één waarde uit kiest | Land keuze |
| Date | een Datum veld |
WARNING
When editing the report, one can add, update and delete comment fields but not values. Updating report content values is not supported (yet) since this will require an update of the report content to the database.
# Editing report layout
A report is created based on the default report template.
Following settings are configurable
# Columns
one two three
# Document size
A3 A4 A5
# Document orientation
Portrait Landscape
# Sharing reports
A report is by default available in HTML format. However the report can be shared outside of the platform by download or e-mail in following formats:
Pdf A data-only export allows to export the data in following formats:
Excel csv