Report Bundles are used to generate a report or group of reports on demand or at scheduled intervals to be sent via email or to the File Archive.

Automatically Generated Report Bundles

SSDT Report Bundles will automatically generate reports to the Utilities/File Archive when certain actions trigger the events. USAS-R contains one standard SSDT Report Bundle for SSDT Monthly Reports.

SSDT Monthly Reports Bundle

By viewing the SSDT Monthly Reports bundle, you can see the detail of what event triggers the reports and exactly what reports are created from this bundle and sent to the File Archive. 

Click on  to view the specific Report Bundle:

The SSDT Monthly Reports bundle is triggered when a Posting Period is closed. See the following section for a full list of included reports.

Monthly Reports Included

All FYTD/MTD report totals generated with the "As of period" of the Posting Period that was closed.

SSDT Calendar Year End Reports Bundle

By viewing the SSDT Calendar Year End Reports bundle, you can see the Event details of what triggers the reports and what reports are created and sent to the File Archive. 

Click on  to view the specific Report Bundle:

The SSDT Calendar Year End Reports bundle will be sent to the Calendar Year Reports Archive when the December posting period is closed.  The Calendar Year Report Archive will also store the copy of the 1099 print files (XML), the copy of the 1099 submission extract file (TAP), the transmitter report (TXT) if the district is submitting the files to the IRS themselves, and the 1099 report (PDF) when these are processed by the user. See the following section for a full list of included reports.

Calendar Year End Reports Included

The following reports generate with Start/Stop dates for the calendar year.

SSDT Fiscal Year End Reports Bundle

By viewing the SSDT Fiscal Year End Reports bundle, you can see the detail of what event triggers the reports and exactly what reports are created from this bundle and sent to the Fiscal File Archive. 

Click on  to view the specific Report Bundle:

The SSDT Fiscal Year End Reports bundle is triggered when when the last posting period of the fiscal year is closed. The reports will be included in the Fiscal File Archive and triggered by the event of FiscalPeriodCloseCompletedEvent. This bundle includes any reports relevant to the end of the fiscal year that will not already be included in the SSDT Monthly Reports bundle for the last period of the fiscal year (ex. Budget Summary, Cash Summary, etc). See the following section for a full list of included reports. 

Fiscal Year End Reports Included

The following reports generate with Start/Stop dates for the fiscal year. 

SSDT 1099 Multiple Return Type Archive

By viewing this bundle, you can see the detail of what event triggers the reports and exactly what reports are created from this bundle and sent to the Calendar Year Reports Archive. 

Click on  to view the specific Report Bundle:

The SSDT 1099 Multiple Return Type Archive bundle creates a PDF report for 1099 when multiple types are selected. The reports will be included in the Calendar File Archive and triggered by the event of Multiple1099CreatedEvent. This bundle includes the SSDT 1099 Extract Report.

SSDT 1099 Submission Report Archive

By viewing this bundle, you can see the detail of what event triggers the reports and exactly what reports are created from this bundle and sent to the Calendar Year Reports Archive. 

Click on  to view the specific Report Bundle:

The SSDT 1099 Submission Report Archive bundle generates backup file for 1099 Report. The reports will be included in the Calendar File Archive and triggered by the event of Form1099CreatedEvent. This bundle includes the SSDT 1099 Extract Report and SSDT Downloaded File Backup.

SSDT Transmitter Summary Report Bundle

By viewing this bundle, you can see the detail of what event triggers the reports and exactly what reports are created from this bundle and sent to the Calendar Year Reports Archive. 

Click on  to view the specific Report Bundle:

The SSDT Transmitter Summary Report bundle creates a copy of the Transmitter Report for districts submitting 1099s to the IRS themselves. The reports will be included in the Calendar File Archive and triggered by the event of TransmitterCreatedEvent. This bundle includes the SSDT Downloaded File Backup.

Disable Automatically Generated Report Bundles

The check box in on the grid for each report bundle will determine if the Report Bundle is enabled or disabled. If the bundle is disabled then the reports will not be sent to File Archive. 

To disable a report bundle from going to File Archive, simply uncheck it:.

The SSDT Monthly Reports bundle is Enabled by default. 

Enabled:

Disabled:

View Reports in the Monthly Reports Archive

To view the reports, go to Utilities/File Archive/Monthly Reports Archive tab. The grid will contain a row for each Month that reports have been generated for. To view/download the Reports included in the Monthly Reports bundle, click on the row in the grid to open the detail on the right side of the page. Reports can be downloaded by clicking the generate  icon.

The Description of the Monthly Report bundle can be modified by clicking the edit  icon.

Monthly Report Bundles can be deleted by users with Administrative access by clicking the delete  icon. 

View Progress of Report Generation in the Job Scheduler

When the Monthly Reports bundle is triggered, Administrative users have the ability to view the job in the Utilities/Job Scheduler grid. This grid can be used to track the Status of the reports as they are generated. The Monthly Reports will be generated one by one in sequential order. Once all reports have been generated and sent to the File Archive, the Status will show "Completed." Click on the Job Scheduler grid to view the most up to date status.

User Generated Report Bundles

Creating a Report Bundle

To Create a new Bundle of reports, click on  option.

1. From the menu, select 'Report' and click on 'Report Bundles.'

2. Click on 

   1. Report Bundle Name: Name of the Report Bundle that will show in the grid and on scheduled Report Bundles.

   2. Description: Option to add additional description detail that will show in grid by default

   3. Tags: Tags are user-defined words that mean something to the user to help categorize report definitions. For example, a tag could be 'YEAREND' or 'MONTHLY' reports.  Then they can use these tags for several other reports , enabling them to search for them easily in the Grid.

      

3. To create a bundle of Reports, click on 

    or start typing the report name under Select the Report to Add to the Bundle.

   1. SSDT Template Reports and Custom Reports in the Reports manager are available to add to Report Bundles

   2. The following Canned Reports are also available to add to Report Bundles

      1. SSDT Accounts Payable Report

      2. SSDT Account Status Report

      3. SSDT Amend Certificates Report

      4. SSDT Appropriations Resolution Report

      5. SSDT Audit Report

      6. SSDT Budget Summary Report

      7. SSDT Certificate Available Balances Report

      8. SSDT Disbursement Detail Report

      9. SSDT Financial Detail Report

      10. SSDT Financial Summary By Fund

      11. SSDT Purchase Order Detail Report

      12. SSDT Revenues and Expenditures Report

   3. The SSDT Cash Reconciliation report is also available to add to a Report Bundles

      1. When adding this report to a bundle it must be scheduled to run on the PostingPeriodCloseCompleted event so that the report is able to determine which month should be used.

         

4. Once selected, this report will then show under Click + to Add this report with the desired Report Options to the Bundle. This grid will show one row for each of the saved parameters (created from the "Save and Recall" option) that exists for the chosen report. Use the   icon to select which version of the report to add to the Report Bundle.
   

   

5. The report will show that it has been added to the 'Reports currently in the Bundle' box below.
   

   

6. To add more reports to the bundle, select another report from the 'Select the Report to Add to the Bundle' option. Then click the  next to the report under 'Add this Report with the desired Report Options to the Bundle' box.  This report will then show with the others in 'Report currently in the Bundle' box.
   

   

7. To modify the report parameters for reports included in the Report Bundle, click on the icon next to the report in the grid at the bottom of the pop up window.
   

   

8. Update the report parameters as needed

   1. Click  to save the updated report parameters

   2. Click  to continue with the original report parameters

   3. Click to generate the report on demand with the entered parameters 

      

9. Click on  to save the Report Bundle. 

10. To Exit out of the report bundles selecting option, click on the x in the right had corner.

11. After the Report Bundle has been created, it will show in the Report Bundle Manager grid.

Search/View Report Bundles

The Report Bundle grid allows the user to search for existing report bundles. Report Bundles can be filtered using the headings on each column. 

Click on the  icon to view the Report Bundle. From this view, the option to Edit the reports or add additional reports can be accessed by clicking on and the option to clone the report bundle can be accessed by clicking on .

Edit Report Bundles

1.  To change the Report Bundle details or reports included, locate the Report Bundle in the grid and click on the edit   icon.

   

2. To edit the report parameters of a report that is included in the Report Bundle, select the report to edit and click on  in the grid on the pop up window.

   

3. Update the report parameters as needed. Updates made to the parameters on this page will only affect the report when it is run from this Report Bundle.

   1. Click to save the updated report parameters

   2. Click  to continue with the original report parameters

   3. Click  to generate the report on demand with the entered parameters 
      

      

4. Once all updates are complete click  to save changes the Report Bundle.

Clone Report Bundles

1. Click on the  icon to view the Report Bundle. From this view, the option to clone the report bundle can be accessed by clicking on .

   

2. Update the Report Bundle Name

3. To edit the report parameters of a report that is included in the Report Bundle, select the report to edit and click on  in the grid on the pop up window.
   

   

4. Update the report parameters as needed. Updates made to the parameters on this page will only affect the report when it is run from this Report Bundle.

   1. Click to save the updated report parameters

   2. Click  to continue with the original report parameters

   3. Click  to generate the report on demand with the entered parameters 
      

      

5. Once all updates are complete click  to save the new Report Bundle.

Delete a Report Bundle

Click on   in the grid beside the desired Report Bundle. A confirmation box will appear asking to confirm that the Report Bundle can be deleted.  

Schedule a Report Bundle

1. To schedule a report bundle, click on .
   

   

2. Enter Job Parameters to schedule the Report Bundle

   1. Job Types: Select one of 3 Job Type Options to determine when the Report Bundle will be generated. The parameter fields below will change based on which Job Type Option is selected. See sub sections below for additional information on each Job Type. 

      1. Cron - Schedule a reoccurring job to run on a regular interval or date/time.

      2. Event - Schedule to run based when a specific action is prompted in USAS-R.

      3. Immediate - Run on demand (now).

         

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

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

   3. Send Output to: This can be the email of the intended recipient or a path to the File Archive

      1. When entering the email of the intended recipient; you can enter multiple email addresses by separating each with a comma. The recipient is not required to have a user account for USAS-R.
         

         The Email Notification Services module must be installed and configured in order to send Report Bundles via email

      2. A path to the File Archive will send the Reports to a specific section of the File Archive under the Utilites menu. 

         1. The path will always start with fileinfo://

         2. Next the path will determine if the files should be sent to the Monthly Archive Tab or the Fiscal Archive Tab

            1. MonthlyReportFileSet

            2. FiscalYearReportFileSet

         3. Last, the group of reports must be determined - Fiscal year OR Fiscal year & Period(month) depending on which Tab is chosen. These should be entered as numerical values where the "month" is the period number when July is the first Period of the Fiscal Year (ex. Enter 1 for July, 2 for August, 3 for September, etc.)

            Description	Path
            Send Reports to Monthly Archive for December 2019 (FY2020)	fileinfo://MonthlyReportFileSet/2020/6
            Send Reports to Fiscal Archive for FY 2020	fileinfo://FiscalYearReportFileSet/2020

         4. When the File archive option is used with a specific Event, then the path to the File Archive can include variables so that the file location will be based certain even factors. Example - If a specific Posting Period is being closed, then the Fiscal year & Period where the Reports are sent to the File Archive correspond to the Fiscal year & Period that is being closed.
            

            Description	Path
            Send Reports to Monthly Archive when connected to the event of closing a Posting Period	fileinfo://MonthlyReportFileSet/eventFiscalYear/eventMonth

         5. The reports can be sent to a directory if you so chose.  You would just type in the Send Output to field:  example if I was sending it to my NWOCA4 directory:

            • ftp://miller:yourpassword@nwoca4.nwoca.org - sends as binary format

            • ftpa://miller:yourpassword@nwoca4.nwoca.org - sends as ASCII format

            • sftp://miller:yourpassword@nwoca4.nwoca.org - send as a secure file

   4. Archive type: Determines if reports in bundle will be combined and sent together or sent in individual notifications for each report chosen.

      1. Send a single notification with multiple attachments (One email with multiple attachments)

      2. Send a multiple notifications with a single attachment (Multiple emails with a single attachment in each)

      3. Send a single notification with a zip file attachment.

Cron Job Type

This Job Type can be used to schedule a reoccurring job to run on a regular interval or date/time.

1. Select Cron as the Job Type
   
   

2. Enter a Cron Expression 

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

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

   3. Free online cron expression generators:

      • https://www.freeformatter.com/cron-expression-generator-quartz.html 

      • http://www.cronmaker.com

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

3. Enter the remaining parameters

4. Click  to schedule the Report Bundle

5. The scheduled job will be listed under Utilities/Job Scheduler. 

Event Job Type

This Job Type  can be scheduled to run based when a specific action is prompted in USAS-R.

1. Select Event as the Job Type

   

2. Select an Event for when to run the Report Bundle from the drop down

   1. Events correspond to actions that happen in USAS-R

   2. 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.

      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.

      
      

3. Enter the remaining parameters

4. Click to schedule the Report Bundle

Events

Immediate Job Type 

This Job Type can be used to run the Report Bundle on demand (now).

1. Select Immediate as the Job Type

2. The reports will immediately be sent to the output specified