Custom Report Creator
The custom report creator option allows for dynamic reporting of all data objects in USAS-R. It allows the user to filter the data using advanced search criteria, determine which columns to include on the report and the order of the columns, and do control breaks with totals. The user can output to a variety of formats including text, pdf, excel, and csv format, along with other lesser known formats, and select page size and orientation. The report definitions can be saved under a given name under 'Save Report'. Once a report definition is saved it will appear on the Report Manager grid as well as in the 'Restore' drop-down in the 'Custom Report Creator' menu option. If the report definition is selected from the restore drop-down or viewed in the Report Manager all report criteria will be restored as defaults and can then be overridden as needed before generating the report. The user may wish to view a listing of saved reports which can be done by clicking on the . This will then take them into the Report Manager.
There are many different ways to generate a Custom Report.
Generate New Custom Report
Select 'Custom Report Creator'
Select Object
Available Objects are listed in the Select Object Drop-down
Select Properties
Reportable properties are available for nearly all possible related data types. The properties within those related data types are represented in an expandable tree format. Properties are selected by either double clicking on the properties on the left or drag and drop them into the box on the right. Once the user has selected the desired properties, they can order them in the box on the right as they wish the columns to appear on the report by drag and drop. Properties may be removed by clicking on the beside the property. Within the properties selected, the user will need to determine how to sort the report. Sorting is accomplished by choosing a number under the Sort Priority column. In order to control break or page break by a property it must first be assigned a sort priority.
Customize Properties
For each property, the user may customize the following:
Sort Priority: the order in which the report will be sorted
Sort Order: sort the property in ascending (lowest to highest) or descending order
Control Break: if the property changes, it will bold the change. For example if you run a budget report and sort/control break on the fund every time there is a new fund it will bold the fund number.
Function: available on a numeric property which will allow the user to get subtotals, average, min or max
- Set Extended Properties: ability to modify several details of the template report.
- Remove: removes the property from the report.
- Set Extended Properties
- Suppressed: if the box is checkmarked, the property will not appear on the report. This is useful if the user selects a property for control break purposes but does not want it to appear on each detail line of the report.
- Sort Priority: available on the 'select properties' menu but can also be changed from the set extended properties menu.
- Sort Order: available on the 'select properties' menu but can also be changed from the set extended properties menu.
- Suppress Repeating: repeating properties will not appear on the report.
- Control Break: available on the select properties' menu but can also be changed from the set extended properties menu
- Page Break: advance to the next page when the property value changes
- Function: available on the 'select properties' menu but can also be changed in the set extended properties menu
- Alignment: choose from left, right, center or justified
- Column title: customize the default column title
- Control Footer Only: Checkmark if the property should appear in the control footer instead of as a column on the report.
- Control Header Only: Checkmark if the property should appear in the control header instead of as a column on the report.
- Detail Header Only: Checkmark if the property should appear in the detail header instead of as a column on the report
- Width: change the width of the column
Configure Filters
User Parameters in Template Reports
Click here for an example on how to create a 'filter value' parameter under "Configure Filters" so that it is displayed as a user parameter when generating a report.
You will select Properties you want to filter the report on. It does not have to be a property you included on the report (Step 3). Properties to filter on are selected by either double clicking on the properties on the left or drag and drop them into the 'Display Name' column.
- Select the desired Operation from the drop down.
- The property can be set up to filter on:
- a specified 'filter value' . This is a 'hard-coded' value and the report will use the filter value entered. When generating the report, it will not be listed as a parameter you can enter a value into.. that was already accomplished when you entered the specific value under configure filters.
- When entering a specified filter value the following formats can be used:
- Date fields - MMDDYYYY, MMDDYY, MM/DD/YYYY, MM/DD/YY, M/D/YYYY, M/D/YY
- Amount fields - can be entered with or without decimal
- Number fields (for record/transaction numbers) - cannot include a decimal
- When entering a specified filter value the following formats can be used:
- or a 'parameter value' can be created. Once set up, the user is prompted to enter in a value when generating the report.
- In the Filter Value you will enter the following function: param("name","default value","label")
- Both the default value and label are optional. The name must be unique within the query. You can include a param on any type of operation and have as many as necessary. You can have multiple param's on a single filter (if appropriate, like on a "between" operation). If a default value is not provided, then the parameter will default to "null", which has the effect of ignoring the filter. The label is the value shown to the user in the Report Generation UI.
- The 'Operation' definitions and examples of specified (hard-coded) filter values and parameter values are provided in the table below.
Operation Definition Specific Filter Value Example in Configure Filters (parameter will not display when generating report) Parameter Value Example in Configure Filters (parameter will display when generating report) How Parameter Value display when generating report Equals Match an exact value (i.e. account filter) One of Able to enter multiple values with commas (i.e. several ven. #s) Not Equals Exclude a value (i.e. exclude 1099 type) Like Begins with (i.e. all object codes starting with 1) Contains Entered Value Anywhere in the Field (i.e. contains part of vendor name) Between Between two Values Is Null Null looks for blank fields Not Null Excludes blank fields Greater Than Greater than value entered Greater Or Equal Greater than or equal to value entered Less Than Less than value entered Less Than or Equal Less than or equal to value entered Not One Of Exclude multiple values separated by commas Sort Type Match Any of the Following Match any of the value entered - a specified 'filter value' . This is a 'hard-coded' value and the report will use the filter value entered. When generating the report, it will not be listed as a parameter you can enter a value into.. that was already accomplished when you entered the specific value under configure filters.
- Select the desired Operation from the drop down.
- In the Filter Value you will enter the following function: param("name","default value","label")
- Both the default value and label are optional. The name must be unique within the query. You can include a param on any type of operation and have as many as necessary. You can have multiple param's on a single filter (if appropriate, like on a "between" operation). If a default value is not provided, then the parameter will default to "null", which has the effect of ignoring the filter. The label is the value shown to the user in the Report Generation UI.
Generate Report
Report Options - choose the desired options from the drop-downs
Format:
- Format - Defines the output type of the Report generated
- Comma Separated Values (CSV)
- Tab Separated Values
- Excel - Includes fonts and formatting
- View(html) - View report in a web page
- HTML-Table - Most commonly used with Report link option. Will display data in a simple table on a web page
- 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.
- Plain Text
- Jasper Report Design
- Excel-Data - Standard Excel spreadsheet of information. Summary Report and Control break options will not be included in this format type
- 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
- Format - Defines the output type of the Report generated
Page Size: Letter, Legal, Halfletter, Note, Ledger
Orientation: Portrait or Landscape
Name: Enter the name to be displayed on the top of the report
Save Report: To save the report settings to be restored later, enter a name in the save as box and click on Save Report
Click on 'Generate Report' to create the report using the format specified
Restore Custom Report
Previously Saved Reports may be restored to be generated again or to make changes and generate a new report.
- From the Report menu select 'Custom Report Creator'
- Select the desired Report Name from the Restore drop-down
- Report definitions will be applied immediately upon selecting the report name from the drop-down
- Make any desired changes and create the report by clicking the tabs to select and customize properties, configure filters and generate the report.
- Report definitions will be applied immediately upon selecting the report name from the drop-down
Import Report
Users can download their own previously saved report definitions via the Saved Reports and share them with others. For example a saved report may be downloaded by a user and then emailed to another. In order to generate a report definition that has been shared by a different user it has to be imported into the custom report option.
- From the Report menu select 'Report Manager'
- Click on
- Browse to find the desired report and once it has either been double clicked or selected and open clicked in the browser pop-up window the report definition is applied immediately.
- Make any desired changes and create the report by clicking the tabs to select and customize properties, configure filters and generate the report.
Save Custom Report
Users can save report definitions. Previously saved reports are managed in the Report Manager
- From the Report menu select 'Custom Report Creator'
- Make desired report selections
- Enter in a Report Name in the box beside the Save Report button
- Click on
Special Characters
If included in the report name, some special characters like "/" may cause limitations when filtering grids using wildcards.
View Saved Reports
Users may view saved reports via the Report Manager.
- From the Report menu select 'Report Manager'. This will take a user to the Report Manager grid.
Miscellaneous Information
Please refer to the Grid section of the Navigation chapter for more information on how to use the advanced search. Users have the ability to save their current query and load any previously saved queries from the advanced search . Any saved queries for that object will appear in a drop-down, the query will be applied immediately upon selecting that option from the drop-down.
You also have the option of loading a Advanced Query saved from one of the menu options. The example below is an Advanced Query saved in the Expenditure Account grid and now loaded into this report.
Reporting Levels
The following reporting levels for account code dimensions are available to use when configuring filters on reports.
Function | 1 & 2 digit |
Receipt | 1 & 2 digit |
Object | 1 digit |
Subject | 2 digit |
OPU | 1 digit |