...
Name | Definition | Value |
|---|---|---|
reportConfigMarker | reportConfigDef | <none> |
| reportConfigType | reportConfigValueDef | Currently only SQL is available |
| reportConfigFormat | reportConfigValueDef | Currently only CSV is available |
reportConfigName | reportConfigValueDef | Name of report |
| reportConfigFilename | reportConfigValueDef | e.g. usersOfMyService_$$timestamp$$.csv $$timestamp$$ translates to current time in this format: yyyy_mm_dd_hh24_mi_ss |
reportConfigDescription | reportConfigValueDef | Textarea which describes the information in the report. Must be less than 4k |
| reportConfigViewersGroupId | reportConfigValueDef | GroupId of people who can view this report. Grouper admins can view any report |
reportConfigQuartzCron | reportConfigValueDef | Quartz cron-like schedule |
reportConfigSendEmail | reportConfigValueDef | true/false if email should be sent |
| reportConfigEmailSubject | reportConfigValueDef | subject for email (optional, will be generated from report name if blank) |
| reportConfigEmailBody | reportConfigValueDef | optional, will be generated by a grouper default if blank body for email, support \n for newlines, and substitute in: $$reportConfigName$$, $$reportConfigDescription$$, $$subjectName$$ and $$reportLink$$ The link note: the $$reportLink$$ must be in the email template if it is not blank |
| reportConfigSendEmailToViewers | reportConfigValueDef | true/false if report viewers should get email (if reportSendEmail is true) |
reportConfigSendEmailToGroupId | reportConfigValueDef | if reportSendEmail is true, and reportSendEmailToViewers is false), this is the groupId where members are retrieved from, and the subject email attribute, if not null then send |
reportConfigQuery | reportConfigValueDef | SQL for the report. The columns must be named in the SQL (e.g. not select *) and generally this comes from a view |
reportConfigEnabled | reportConfigValueDef | Use logic from loader enabled, either enable or disabled this job |
...
The report will take the SQL and columns and make a CSV with all the results. Chris has this logic and will commit it in the branch. This will be delivered as a download from browser
Report emails
If reports are being configured to be emailed, then the configured or default email will be sent. Note, the actual report will not be attached in the email for security reasons. A link to the report instance screen will be in the email.
Report storage
In 2.4 we dont want to add a new table to store files, so for people who want to use this feature the only option will be AWS S3 buckets with the report encrypted. We can add more storage options later
...
When a report is deleted, delete all the metadata and report data from storage. If not it will be deleted eventually with a clean up daemon
There are no direct links to reports, and they are encrypted anyways. The only way to download reports is through the Grouper UI (or API), by authorized users. This is a reverse proxy to the report storage.
Overall report daemon
The overall report daemon should go through storage, and
...