Page History

...

######################################
## Grouper Reporting
######################################

# folder where system objects are for reporting config
# {valueType: "stem"}
reportConfig.systemFolder = $$grouper.rootStemForBuiltinObjects$$:reportConfig

# if grouper reporting should be enabled
# {valueType: "boolean", required: true}
grouperReporting.enable = true

# grouper reporting storage# grouper reporting storage option. valid values are database, fileSystem or S3
# {valueType: "string", required: true}
reporting.storage.option = fileSystemdatabase

# grouper reporting file system path where reports will be stored, e.g. /opt/grouper/reports
# {valueType: "string", required: false}
reporting.file.system.path = 

# grouper reporting s3 bucket name where the reports will be uploaded
# {valueType: "string", required: false}
reporting.s3.bucket.name =

# grouper reporting s3 bucket name where the reports will be uploaded, e.g. us-west-2
# {valueType: "string", required: false}
reporting.s3.region = 

# grouper reporting s3 access key
# {valueType: "string", required: false}
reporting.s3.access.key =

# grouper reporting s3 secret key
# {valueType: "string", required: false}
reporting.s3.secret.key =

#grouper reporting email subject
# {valueType: "string"}
reporting.email.subject = Report $$reportConfigName$$ generated 

#grouper reporting email body.  Can use variables 
# {valueType: "string"}
reporting.email.body = Hello $$subjectName$$, \n\n Report $$reportConfigName$$ has been generated. Download the report: $$reportLink$$ \n\n Thanks

...

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 or filesystem with the report encrypted.  We can add more storage options later

In 2.5.34+ this is stored by default in the database.

Database

Stores in grouper_file table

AWS S3

The deployer will need an AWS account, the free level might suffice

...

• Add entity relationship diagram on wiki to help with making queries
• Add ability to use SCP to store reports
• Add ability to use SCP to send reports
• Add ability to store reports in box folder
• Errors in report should be logged and throw error but maybe also store error in txt report (not sent out or available except to admins)
• Add diagnostics to test that a report is setup correctly
• Add paging to report instance list
• Configure how long reports are stored
• Screen in a user's subject screen that shows all the reports they have access to
• Centralized report dashboard
• Have a config option to "run now" (allows report viewers to run now)
  • This would send a message to a daemon to run so it doesnt run in the UI
  • Like Loader "run now"
• Allow another report type which runs off membership list (not straight SQL)
  
  • Allow non admins to configure?
  • Allow more columns to be added (join other database tables if allowed)
• Allow reports from GSH / java?
• Allow reports from WS as user
• Add another output type for JASPER report (PDF, etc)
• Support excel
• Add ability to display a CSV in the JSP in an HTML table
  • Add metadata to make it clickable?
  Support more storage options, e.g. database with blobs (needs to wait until 2.5)
• Allow fields to be added from an LDAP filter
• Add the daily Grouper report to run like this (dont email)
• Email batching per user (user gets a weekly digest about their reports)?

• In another pass we could create a report based on loading/provisioning.

• On the Daemons job screen, show user friendly names for jobs (pull grouper object name from id and show under the report job id)

...