Versions Compared

Key

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

This document details one of the many ways to create and customize reports and report bundles. 

...

  •  In Report/Report bundles 
    •  Click on the 'clock' icon. 
    •  Enter the required information"
      • Job Type: Select 1 of 3 job type options to determine when the report bundle will generate. The parameters below will change based on which job type option is selected. 

        • Expand
          titleCron - Schedule a reoccurring job to run on a regular interval or date/time.

          A Cron Expression is a command set up to run periodically at fixed times, dates, or intervals

          Cron Expressions can be set up by using a free online cron expression generator: 

          Once the Cron Expresssion for the preferred interval has been generated, copy and paste or type the cron expression into the Cron Expression field.



        • Expand
          titleEvent - Schedule to run based when a specific action is prompted in USAS-R.

          Select an Event for when to run the Report Bundle from the drop down.  Events correspond to actions that happen in USAS-R

          • For Example, selecting the event org.ssdt_ohio.usas.model.fiscalPeriod.FiscalPeriodCloseEvent will generate the report bundle when the last period of the fiscal year is closed on the Core/Posting Periods page.

            Warning
            For custom Report Bundles, the reports will generate based on the current posting period. When scheduling a Report Bundle for a posting period close event, make sure to allow the custom bundles to create before changing the current period to the new period.




        • Expand
          titleImmediate - Run on demand (now).
          Immediate - Run on demand (now)This generates the report bundle as soon as the scheduler is saved.


      • Job Name: Defaults to what is displayed in the 'Name' parameter.  You can overwrite the default job name.  

        Tip

        If the report is scheduled using the Cron option, the Job Name must be unique for each scheduled job.  


      • Send output to: This can be the email of the intended recipient or a path to the File Archive.
        • You may enter multiple email addresses by separating each with a comma.
        • Path to the File Archive will send the Reports to a specific section of the Utilities/File Archive
      • Archive type: Determines if reports in bundle will be combined and sent together or sent in individual notifications for each report chosen.
        • Send a single notification with multiple attachments (One email with multiple attachments)
        • Send a multiple notifications with a single attachment (Multiple emails with a single attachment in each)
    •  

      Click Save 

      Info

      The scheduled job w ill be listed under Utilities/Job Scheduler. 


...