Summary Report Example

Overview
This section will contain a tutorial to create a Summary report and show the results. This can be used as a template so you can see the sample output and learn to change the report to display what you need.

Report Specifications
For this report we want to list all invoices, the accounts they belong to, and the grand total amount. As this is a summary report we want to sum the invoice totals for each account. We also want to filter the results by invoice due date and payment status so we can filter to all invoices that have not been paid.

Step 1. Set Report Name, Entity, and Position

Begin the report creation wizard. The screenshot below will show how we filled out the fields to reach our end goal.

Field Name Description
Report Name This can be anything you wish, we named ours "Invoice Totals" to describe what the report will contain.
Entity Name Here we selected invoices as this is as far down the hierarchy we need to go. According to the entity map (linked to on the Report page here) this entity is below accounts so it will cover the account data we will need in the report.
Report Position We selected "Customer Specific Reports" category so it will be displayed on the UI in the Reports section. It can be placed anywhere you need.

Use the above table to see why fields were set as they are.

Step 2. Complete Report Settings

Here we will set the fields that drive the report to show the information we need. Please see the completed form below.

Field Name Description
Show Grand Total Setting this check-box allows us to put a grand total of all unpaid invoices at the bottom of the report. This allows us to see the entire amount accrued by unpaid invoices.
Show Subtotal We want to show sub totals of grand totals from unpaid invoices from each account. This field allows us to insert subtotals under each account to give us a more granular view of how much is unpaid on the account level.
Report Fields
  • Field Name - Here we chose three fields to report on, invoice id, grand total amount, and account id. These will be the three columns in the final report.
  • Convert Function - This is unused as we are not reporting on any data concerning invoice dates.
  • Report Label - Here we provided easy to recognize labels that will be displayed on the UI. This will not affect the functionality of the final report.
  • Summary Function - Here we need to tell the report what field you want to sum. As we want to know the totals for the invoices, we will set "SUM" on the row for invoice grand total.
  • Pivot - Do not use this box as we are creating a summary report. This will be used for pivot style reports.
  • Hidden - Select Yes or No if the column is hidden when the report is generated.
  • Sort Order - Here we want the list to be sorted by account ID so we set the priority to 1.
  • Sort Direction - We want the account IDs to be sorted ascending, so we choose "asc".
  • Format Result - This is used to string various fields sand literals when dealing with aggregated results. In this example, we will accept the aggregated invoice totals as is so this field can be left blank.
Report Date Filters
  • Field Name - We want to be able to filter the report by invoice due dates. We select the due date for both rows as we want to set upper and lower limits.
  • Report Label - This is simply a user friendly label that will appear on the UI.
  • Condition - Set the rule for comparison. For upper and lower limits we will use "Greater Than" and "Less Than"
  • Default Value - We do not want this field to be pre-populated, so we leave it blank.
  • Required - We do not want the user to be required to filter by date, only if they want to, so this is left blank.
  • Linked Filter - This allows the selection of previously defined filters, in this case date filters, so that additional hidden filters can use data that was previously entered by the user instead of having to enter the same information on two different filter fields. We will not use this in this example.
  • Hidden - This is usually used when the filter conditioned is always defaulted to a specific value. This can be entered manually here on this wizard or if a linked filter is used, this becomes automatically selected and cannot be updated.
Report Non Date Filters 
  • Field Name - We want to be able to filter the report by payment status, so we select the payment status field.
  • Report Label - This is simply a user friendly label that will appear on the UI.
  • Condition - Set the rule for comparison. We want to match payment status so we select the "EQUALS" rule.
  • Default Value - We want to filter by non paid invoices by default. We enter our default search query here by entering "NOT PAID".
  • Required - We do not want the user to be required to filter by payment status, so we leave this blank.
  • Linked Filter - This allows the selection of previously defined filters, in this case non-date filters, so that additional hidden filters can use data that was previously entered by the user instead of having to enter the same information on two different filter fields.
  • Hidden - This is usually used when the filter conditioned is always defaulted to a specific value. This can be entered manually here on this wizard or if a linked filter is used, this becomes automatically selected and cannot be updated.

Use the table above to explain why the selections were chosen.

Step 3. Set Report Permissions

Here we want the report to be usable only to application administrators.



We set the permissions for BRM_ACCOUNT_ADMIN to "YES".

Select Save to complete the report.

The Result
Here we can run our new report. In the screenshot below, you can see we filtered by invoices that are not paid, and had due dates between 09/01/2013 and 12/17/2013. In the results table you can see all the invoices that are unpaid and the account they belong to. This report also give you a sub total for each account. You can see this highlighted in green in the report. See the screenshot below to see the results.



Remember we also selected grand total, so if we skip to the last page and look near the end, you will see our grand total. The result is shown below.

Have more questions? Submit a request

Comments

Powered by Zendesk