Page tree
Skip to end of metadata
Go to start of metadata

Predefined SSDT template report definitions as well as user-created reports are displayed under Report Manager. A template report is basically a 'starter' report available for you to generate as is or customize to your specifications.  Previously saved report definitions may be generated, viewed, renamed, deleted, downloaded and shared with specific roles.  The SSDT template reports may be generated, viewed and downloaded only.  However, when a user views a SSDT template report definition, it will take them to the 'Custom Report Creator' option where they can edit the report options, allowing them to save the edited report definitions, enter filters and save it under a new report name.  Their username will be tied to the newly created report.  Here is the grid of the SSDT's available template reports.

They have the option to Import Reports from an outside source and Create Forms.  The Create Forms option allows the user to create alternate versions of forms like Direct Deposit Notices or Payroll Checks, they can add their own "Form" and then the dropdown will show these.  The "how" of setting this up is in the works in the future.

Tags can be created by the user.  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.

SSDT Reports Definitions

SSDT has provided several template reports (listed above).  All SSDT created reports are displayed with the username 'SSDT'.  You won't be able to change the report name, delete or have the ability to share the reports with users with a specific role because these reports are available to everyone The list of SSDT created reports will continue growing as we add more template report definitions.

Generate and Download Report

Automatically generates the report as is, allowing you to save or recall desired report settings, select the format, orientation, and name of the report before it is generated.

  1. From the Report menu, select 'Report Manager'.
  2. Click on beside the desired report. This is the 'Generate and Download Report' option which automatically generates the report as is, allowing you to save or recall desired report settings, select the format, orientation, name of the report and query parameters before it is generated. (Please see 'Query Parameters section for more details).
    1. Save and Recall options: 
      1. Most Recent: By default, it will remember the entries you made from your previous report run.
      2. Default: If you want to select the 'default' settings of the report, select 'default' from the drop down menu. 
      3. To Save current report settings (in order to be used again), select the blank option and enter a save name.  Once you tab off the field, the 'save' icon will be active.  Click on  to save your report and parameter settings.  Your saved report name will now be included in the 'save and recall' drop down menu.  To delete an existing saved report, select the saved report and click on .


    2. Report Direct Link:
      1. The Show Report Link icon will become available for any report parameters saved via the Save and Recall option. The icon will open a window containing a direct hyperlink to execute the report. The link may be bookmarked, sent via email, placed on a web page, etc.
      2. Include Parameters?This checkbox can be used to include all of the current parameters in the report link. When used, the report link will always use the original saved parameters. If this is not checked, the report link data will be run with the currently saved parameters for the Save and Recall name. If the saved parameters are changed and saved, the changes will affect future invocations of the link. 
      3. The Report Direct Link can also be used in Excel as a Web Query (Get Data from Web) to pull data directly from the application without downloading the output. In this case, one of the HTML (Table or FieldName) output formats should be selected.   When used in Excel, these output formats can be understood and formatted as a sheet. A web query in Excel this way can also be refreshed on demand.
      4. A username is required to access the report via direct link.
      5. The report direct link can be shared with other users. Each user will be required to login with their USPS-R credentials when the report link is accessed.
    3. Summary Report will generate a summary version of the current report. The summary will include any property designated as a Control Break or a Control Header and the related total and subtotal amounts.
    4. Show Report Options includes a printout of the report options selected for the report run. This option applies for PDF format only.
                     
    5. Job Scheduler icon 
      1. Allows you to schedule a report to run as a background or periodic job and automatically emailed to specified person. 
        1. Job Name:  Enter in a Name for the Job (Report name)
        2. Cron Expression:  This field will be used to specify when/how often the report should run.  Example:  Every day at a specific time, every month on the 12th, every week on Monday, every 3 hours, etc, etc.
        3. Send output to: Enter an email address, FTP, URL or other destination address
        4. Click on  to save the Job Parameters.

Report Generation Options and Dynamic Sort

The Report Generation Options are split into three separate tabs - Report Options, Query Options, and Sort Options. These options can be updated when generating report to define format, filters, sort and subtotals on the report. Information entered and/or updated in all three tabs will be saved in the 'Most Recent' Save and Recall and can be saved when creating a custom Save and Recalls. Users can navigate through these three tabs by clicking the tab names across the top or by using the left and right arrows below the options. 

  1. Report Options - These report options define the general format settings and the title on the report. These will be standard for all template reports
    1. Format - Defines the output type of the Report generated
      1. PDF
      2. Comma Separated Values (CSV)
      3. Tab Separated Values
      4. Excel - Includes fonts and formatting
      5. View(html) - View report in a web page
      6. HTML-Table - Most commonly used with Report link option. Will display data in a simple table on a web page
      7. HTML-Fieldnames - Can also be used with Report link option. Will display data in a simple table on a web page and where the headers include field names that can be used for importing data back into Redesign.
      8. Plain Text
      9. Jasper Report Design
      10. Excel-Data - Standard Excel spreadsheet of information. Summary Report and Control break options will not be included in this format type
      11. Excel-Fieldnames - Standard Excel spreadsheet of information where the headers include field names that can be used for importing data back into Redesign. Summary Report and Control break options will not be included in this format type
    2. Page Size - When generating options for print, like PDF, this will determine the size of the page used in the output file. Options include standard Page sizes like Letter or Legal.
    3. Orientation - Select page orientation as Portrait or Landscape for the report.
    4. Name - The entered text will will appear as the Title at the top of each page of the report.
    5. Summary Report will generate a summary version of the current report. The summary will include any property designated as a Control Break or a Control Header and the related total and subtotal amounts.
    6. Show Report Options includes a printout of the report options selected for the report run. This option applies for PDF format only. 
  2. Query Options - The Query Options determine how to filter the information that will be included on the report. The Query Parameters vary by report and can be customized by modifying the Report Template. 
  3. Sort Options - The Sort Options will determine how the information in the report is sorted, subtotaled, and if there will be page breaks. 
    1. Sortable Properties - Any Properties that are included in the report definition would be available to use as a Sortable Property (see the Select Properties section of the Custom Report Creator page for information). These include fields that would appear as the report columns along with any additional properties that are suppressed. In order to choose properties to sort on, users can click and drag the property to the 'Select Properties' box on the Sort Options. To move multiple Sortable Properties at once, click the check box in front of each property then click and drag the properties together. When dragging and dropping properties into the list of Selected Properties, the property being added can be placed anywhere within the list. Once properties are added to the Selected Properties they cannot be reordered. Instead, remove the property then re-add. When re-adding the property, place it in the desired order within the list.
    2. Selected Properties - The properties showing in this section will determine the order in which the report will be sorted. The property listed highest in the list will determine the first sort priority. By default, the report will show the Selected properties based on the Sort Priority order defined on the report definition. 
      1. Ascending - When checked the sort on this property will display in Ascending order - from smallest to largest for numerical fields and A to Z for alphabetical fields. If the box is unchecked, the sort on this property will be displayed in Descending order - from largest to smallest for numerical fields and Z to A for alphabetical fields. 
      2. Control Break - When checked for a property, the property will be bolded and included as a report sub header each time that property changes. This will also add subtotals each time the property changes for any numerical fields that are configured with the Sum Function.
      3. Page Break- When checked for a property, the report will advance to a new page each time the property changes.

View Saved Report

Opens the report definition details in order for you to see all of the options chosen for the report.  You can then customize it by adding, changing or deleting properties or filters so you get the report you want.  You can save your changes under a new report name in order to re-generate it as needed.

  1. From the Report Menu select 'Report Manager'
  2. Click on beside the desired report to make any changes.  To save the changes under a new report name, enter a report name in the 'Save As' box and click on .

  3. Your report will be found in the 'Home menu' and in 'Report Manager'.
This will take the user to the 'Detail Report' interface where they can see all the options chosen for that Saved Report 


Add or Edit a Tag name 

Click on any report you created in order to rename it, edit the description of the report or the edit the tag names associated with the report.

  1. From the Report Menu, select 'Report Manager' 
  2. Click on to add or edit a tag name of the report you created.
  3. Your report will be found in the 'Home menu' and in 'Report Manager'.

Tags can be created by the user.  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.

Delete Saved Reports

  1. From the Report Menu select 'Report Manager'
  2. Click on beside the desired report
  3. The user will be given a confirmation box to confirm the deletion. 

Download Report Definition

Allows you to  download the report definition to your computer so it can be sent to others via email where they can then import it into the Report-Detail to be generated as well as save the report to show in their 'Report Manager' grid. 

  1. From the Report Menu select 'Report Manager'
  2. Click on  beside the desired report
  3. Save the report on your computer.  Enter a filename but leave the 'save as type' in .RPD-JSON format.
  4. Email it as an attachment.

Example of a 'Report Definitions':

Then this can be sent to other employees to be revised and generated for their use.

Share Saved Report via a Role

Allows you to share a saved report definition with users who have a specific role.  For example, if you create a Budget Summary Report for grant accounts and want to share the report with your building principals (who all have an existing role called "Principals"), you will select the 'Principal" role in this option and your report will be displayed under each of the principal's Report Manager.

  1. From the Report Menu select 'Report Manager'
  2. Click on  beside the desired report. A window will open listing all the Roles currently on the user's system
  3. Check beside the desired Roles to grant access to this saved report.
  4. Click on to save the change and click on to return to the Report Manager grid and not assign the report to a role.
    1. Any user with the checked Role will now see the report in their 'Report Manager'.

Import Report

In order to generate a report definition that has been shared, it has to be imported into the custom report option.

    1. From the Reports menu select 'Report Manager'
    2. Click on 
    3. Browse to find the desired report and select it to import the report definition.  You may modify the description or enter a tag before clicking on 'save' to save the report definition.     

Favorite

A report can be marked as a 'Favorite' and it will show up on the 'Home' option page under the 'Report Links' Favorites

Query Parameters

When generating a report, the 'Generate Report' box contains a section called "Query Parameters' allowing the user to enter one or more parameters to filter their reports on.  For example, the Payroll Account Report contains query parameters to select specific pay accounts.  

Example of Payroll Account Report Options:


Public Share USPS Report Library

Contains USPS template reports created and shared by other users which can be downloaded and used in your local application.

Go to Help and click on 'Public Shared Reports Library';

Click on the 

There are template reports for USPS-R and USAS-R:

To download a .rpd-json file, click on the file name and save to your desktop or file.  Once saved, you can then import this file into your Report Manger.

To view what the report before downloading the .rpt-json file, click on .

Create Form

Users are able to create forms and load them into the Report Manager for future use:

  1. Enter in the Report Name for the Form
  2. Enter in a Description for the Form
  3. Tags can be created by the user.  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. 
  4. Search for the Entity Type from the drop down box.  
  5. click on  and attach new Form 
  6. Click on SAVE


  • No labels