Package edu.internet2.middleware.grouper.app.reports

Class GrouperReportConfigAttributeNames

java.lang.Object
edu.internet2.middleware.grouper.app.reports.GrouperReportConfigAttributeNames
public class GrouperReportConfigAttributeNames extends Object

  • Field Details

    • GROUPER_REPORT_CONFIG_DEF

      public static final String GROUPER_REPORT_CONFIG_DEF
      main attribute definition assigned to groups, folders
      See Also:

    • GROUPER_REPORT_CONFIG_ATTRIBUTE_NAME

      public static final String GROUPER_REPORT_CONFIG_ATTRIBUTE_NAME
      main attribute name assigned to reportConfigDef
      See Also:

    • GROUPER_REPORT_CONFIG_VALUE_DEF

      public static final String GROUPER_REPORT_CONFIG_VALUE_DEF
      attribute definition for name value pairs assigned to assignment on groups or folders
      See Also:

    • GROUPER_REPORT_CONFIG_TYPE

      public static final String GROUPER_REPORT_CONFIG_TYPE
      report config type. Currently only SQL is available
      See Also:

    • GROUPER_REPORT_CONFIG_FORMAT

      public static final String GROUPER_REPORT_CONFIG_FORMAT
      report config format. Currently only CSV is available
      See Also:

    • GROUPER_REPORT_CONFIG_NAME

      public static final String GROUPER_REPORT_CONFIG_NAME
      Name of report. No two reports in the same owner should have the same name
      See Also:

    • GROUPER_REPORT_CONFIG_FILE_NAME

      public static final String GROUPER_REPORT_CONFIG_FILE_NAME
      e.g. usersOfMyService_$$timestamp$$.csv $$timestamp$$ translates to current time in this format: yyyy_mm_dd_hh24_mi_ss
      See Also:

    • GROUPER_REPORT_CONFIG_DESCRIPTION

      public static final String GROUPER_REPORT_CONFIG_DESCRIPTION
      Textarea which describes the information in the report. Must be less than 4k
      See Also:

    • GROUPER_REPORT_CONFIG_SQL_CONFIG

      public static final String GROUPER_REPORT_CONFIG_SQL_CONFIG
      sql config id
      See Also:

    • GROUPER_REPORT_CONFIG_SEND_EMAIL_WITH_NO_DATA

      public static final String GROUPER_REPORT_CONFIG_SEND_EMAIL_WITH_NO_DATA
      Set to false if should not send report email if no data
      See Also:

    • GROUPER_REPORT_CONFIG_STORE_WITH_NO_DATA

      public static final String GROUPER_REPORT_CONFIG_STORE_WITH_NO_DATA
      Set to false if should not store if no data
      See Also:

    • GROUPER_REPORT_CONFIG_VIEWERS_GROUP_ID

      public static final String GROUPER_REPORT_CONFIG_VIEWERS_GROUP_ID
      GroupId of people who can view this report. Grouper admins can view any report
      See Also:

    • GROUPER_REPORT_CONFIG_QUARTZ_CRON

      public static final String GROUPER_REPORT_CONFIG_QUARTZ_CRON
      Quartz cron-like schedule
      See Also:

    • GROUPER_REPORT_CONFIG_SEND_EMAIL

      public static final String GROUPER_REPORT_CONFIG_SEND_EMAIL
      true/false if email should be sent
      See Also:

    • GROUPER_REPORT_CONFIG_EMAIL_SUBJECT

      public static final String GROUPER_REPORT_CONFIG_EMAIL_SUBJECT
      subject for email (optional, will be generated from report name if blank)
      See Also:

    • GROUPER_REPORT_CONFIG_EMAIL_BODY

      public static final String GROUPER_REPORT_CONFIG_EMAIL_BODY
      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
      See Also:

    • GROUPER_REPORT_CONFIG_SEND_EMAIL_TO_VIEWERS

      public static final String GROUPER_REPORT_CONFIG_SEND_EMAIL_TO_VIEWERS
      true/false if report viewers should get email (if reportSendEmail is true)
      See Also:

    • GROUPER_REPORT_CONFIG_SEND_EMAIL_TO_GROUP_ID

      public static final String GROUPER_REPORT_CONFIG_SEND_EMAIL_TO_GROUP_ID
      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
      See Also:

    • GROUPER_REPORT_CONFIG_QUERY

      public static final String GROUPER_REPORT_CONFIG_QUERY
      SQL for the report. The columns must be named in the SQL (e.g. not select *) and generally this comes from a view
      See Also:

    • GROUPER_REPORT_CONFIG_SCRIPT

      public static final String GROUPER_REPORT_CONFIG_SCRIPT
      GSH script for report
      See Also:

    • GROUPER_REPORT_CONFIG_ENABLED

      public static final String GROUPER_REPORT_CONFIG_ENABLED
      logic from loader enabled, either enable or disabled this job
      See Also:

  • Constructor Details

    • GrouperReportConfigAttributeNames

      public GrouperReportConfigAttributeNames()

  • Method Details

    • retrieveAttributeDefNameBase

      public static AttributeDefName retrieveAttributeDefNameBase()
      marker attribute def assigned to stem or group
      Returns:
      the attribute def name

    • retrieveAttributeDefBaseDef

      public static AttributeDef retrieveAttributeDefBaseDef()
      attribute value def assigned to stem or group
      Returns:
      the attribute def

    • retrieveAttributeDefValueDef

      public static AttributeDef retrieveAttributeDefValueDef()
      attribute value def assigned to stem or group
      Returns:
      the attribute def