Platform report templates¶
Manage Reports stores uploaded report-template content and controls which module and organizational scopes can use it.
Open General Administration, locate General System Administration Settings, and select Manage Reports.
Create a report template¶
- Choose Add New Report.
- Enter a required, unique and recognizable Name.
- Add a Description explaining its purpose, inputs, and audience.
- Select the applicable report-capable Module.
- Choose whether the report is Active and displayed in the Portal.
- Upload the approved template file.
- Select at least the intended clients, client accounts, regions, branches, or sites.
- Select Save Report Settings.
- Reopen the record and run the report with test data.
A new report requires a name and uploaded file. Although Module is visually required, the editor can submit the placeholder category; always select a real module.
Active and portal display¶
- Active makes the template eligible for report workflows that honor activation.
- Display in Portal controls whether it is intended for portal selection.
These flags are separate. Enabling portal display on an inactive template does not guarantee that users can run it. Module availability, user permissions, associations, template validity, and report-engine support also apply.
Replace an existing template¶
Select an existing report. Its filename appears in the Items label. You can change metadata and assignments without uploading another file; the current content remains. Selecting a new upload replaces both the stored filename and Base64-encoded template content on Save.
The editor does not offer template download, preview, file-type validation, schema validation, or execution testing. Retain the approved source file and previous version outside TEKControl so rollback is possible.
There is no Delete action. To retire a template, clear Active and Display in Portal, review its assignments and scheduled-report dependencies, save, and follow the approved retention process.
Assign report scope¶
Associations can target clients, client accounts, regions, branches, and sites. These selections are additive: a user can qualify through any applicable assigned scope, subject to module and permission rules.
The editor does not require an assignment before saving. A template with no associations can be effectively unavailable to ordinary users. Avoid broad parent and narrow child assignments unless the wider access is intentional.
When an existing report is saved, all prior association rows are deleted and recreated from the current selections. Review every scope before saving; an omitted assignment is removed.
Save and verification boundaries¶
The template record is saved before its associations are replaced. A later association failure can leave the report metadata or content updated with incomplete scope.
After saving:
- reopen the template and confirm filename, flags, module, and every association;
- verify it appears only for intended users;
- run representative empty, normal, large, and boundary-date data sets;
- validate page layout, totals, time zones, images, export, and scheduled execution;
- confirm the uploaded template does not contain secrets or unsafe external references.