Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Definition

Value

reportConfigMarker

reportConfigDef<none>
reportConfigTypereportConfigValueDefCurrently only SQL is available
reportConfigFormatreportConfigValueDefCurrently only CSV is available

reportConfigName

reportConfigValueDefName of report. No two reports in the same owner should have the same name
reportConfigFilenamereportConfigValueDefe.g. usersOfMyService_$$timestamp$$.csv
$$timestamp$$ translates to current time in this format: yyyy_mm_dd_hh24_mi_ss

reportConfigDescription

reportConfigValueDefTextarea which describes the information in the report. Must be less than 4k
reportConfigViewersGroupIdreportConfigValueDefGroupId of people who can view this report. Grouper admins can view any report

reportConfigQuartzCron

reportConfigValueDefQuartz cron-like schedule

reportConfigSendEmail

reportConfigValueDeftrue/false if email should be sent
reportConfigEmailSubjectreportConfigValueDefsubject for email (optional, will be generated from report name if blank)
reportConfigEmailBodyreportConfigValueDef

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
will go to the report instance screen for this report

note: the $$reportLink$$ must be in the email template if it is not blank

reportConfigSendEmailToViewersreportConfigValueDeftrue/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

reportConfigValueDefSQL for the report. The columns must be named in the SQL (e.g. not select *) and generally this comes from a view

reportConfigEnabled

reportConfigValueDefUse logic from loader enabled, either enable or disabled this job

...