Tabular Report Example

Overview
This section will contain a tutorial to create a Tabular 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
This example report will display a list of all active invoices and the accounts they belong to. We will be able to filter this report by invoice due dates and payment status, showing invoices that are not 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.

First Page of the Creation Wizard



Field Name Description
Report Name This can be anything you wish, we named ours "Monthly Activity Revenue" to describe what the report will contain.
Entity Name Here, the entity selected is the INVOICE entity. From here, we can select fields later on that are accessible via the object reference model as long as they have a relationship with the INVOICE entity.
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.

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.

Second Page of the Wizard

 

Field Name Description
Show Grand Total Do not use this box as we are creating a tabular report. This will be used for summary style reports.
Show Subtotal Do not use this box as we are creating a tabular report. This will be used for summary style reports.
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. The object reference model can be used here to source fields that are not necessarily on the invoice but linked via lookups and parent/child relationships as necessary. Also, functions that are available in the platform language can also be used to format the field output.
  • 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 - We are not performing any functions on the fields for this report. This field was left blank as we want individual invoice totals. If needed, however, this can be leverage to aggregate rows together such as SUM, COUNT, etc.
  • Pivot - Do not use this box as we are creating a tabular 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 only applicable when aggregating results (e.g. Summary Function is used). Otherwise, the value here is ignored.
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. In this example, the Account creation date is compared to the Billing Cycle Start Date.
  • 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.

Sample Permissions Page



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 where the Billing Cycle falls on 1st October 2016 and later. In the results table you can see all the invoice IDs that match this criteria, the grand total of the invoice, and the account it belongs to.

Furthermore, the results are filtered by the hidden linked filter where only invoices for accounts that were also created from 1st October 2016 are displayed. Due to the linked filter nature of the account creation date portion, it is not visible on the UI and the user did not have to enter separate dates for the Billing Cycle Start and Account Creation Date.

Sample Report Output

Updating Existing Reports

Existing reports can be opened for editing. Simple open them for editing and a consolidated Edit page will be displayed where you can change the attributes of the report such as the example below:

Have more questions? Submit a request

Comments

Powered by Zendesk