Report Builder

Owned by Chilukuri Srinivasa Reddy
Last updated: Apr 23, 2024 by Mayuresh Balaji Kamble (Unlicensed)Version comment
3 min read

Using Report Builder, you can write a query using the Query Builder or select the required columns in the report and generate reports based on your requirements.

To generate a report:

  1. Select Admin > Basic > Infrastructure > Report Builder.
  2. On the REPORT BUILDER page, click ADD NEW on the ACTIONS panel.
  3. Under the Details section, fill in the required details and click NEXT. For more information about the fields on the REPORT BUILDER page, see Field Description.


    Figure: REPORT BUILDER page: Details page

  4. Under the Designer tab, you can select the Use Query Editor check box to write the query in the SQL Query text box. The Use Graph option is not available for the Tabular Report type.
  5. Or, select the column you want to be displayed in the report from the Select Columns section. If you select the Filters check box, the selected column becomes a filter/search criteria in your report. Similarly, you can select fields that can be used for sorting by selecting the Sort check box.
  6. The selected columns are displayed in the Column Re-Order & Grouping section. You can also change their sequence by moving them up and down.
  7. The columns that you select for filter are displayed under the Filters section. Similarly, the columns that you select for sorting are displayed under the Sort Columns section. You can choose their sorting order by moving them up and down.
  8. Once you have selected the columns for the report, the filter options and the sort options, click VALIDATE QUERY. It will automatically generate a query based on your selections in the SQL Query text box.
  9. Click Preview to view the preview of the report.


    Figure: CUSTOM REPORT BUILDER page: Designer tab

  10. Under the Preview tab, select the required filter options on the FILTERS pop-up page and click SUBMIT (see, Filters). The preview of the report is displayed based on the filter criteria.


    Figure: CUSTOM REPORT BUILDER page: Preview tab

Field Description

The following table describes the fields on the CUSTOM REPORT BUILDER page:

Field

Description

Details

Tenant

Lists all the configured Tenants. Select a Tenant from the list.

Module Name

Lists all the configured modules for the selected Tenant. Select a module from the list.

Report Type

Select the report type from the list Tabular Report or List Report.

Report Name

Type in a name for the report.

Access Type

Select the access type from the list.

  • Private: Select this option to make the report available only to the selected user(s). If selected, User field is displayed to select the user(s).
  • Public: Select this option to display the report to all the users in the Custom Report list.

Active

Indicates the status of the report.

  • If selected, the report becomes active.
  • If cleared, the report becomes inactive.

Designer

Use Graph

Select this option to create a graphical report.
Note: This option is available only for the List Report type.

Use Query Editor

Select this option to type the query string directly in the SQL Query text box.

Select Columns

Select the columns you want to be displayed in the report.

Column Re-Order Grouping

Displays the columns you have selected to be displayed in the report. You can also change their sequence by moving them up and down.

Sort Columns

Displays the columns you have selected for sorting. You can also change their sequence by moving them up and down.

Filters

Displays the columns you have selected for filter.

SQL Query

Displays the SQL query based on your selection.

Preview

Displays the preview of the report.

ACTIONS

This section explains all the icons displayed on the ACTIONS panel of the REPORT BUILDER page.

 Filters

Click the Filters icon to specify a particular filter criteria to display the custom reports. On clicking the Filters icon, the FILTERS pop-up page is displayed. Select the Tenant, Module Name, and Report Type. Click SUBMIT.


Figure: FILTERS pop-up page

 SHOW LIST

Click SHOW LIST to display the LIST table showing all the custom reports for the selected Tenant.


Figure: CUSTOM REPORT BUILDER page: List of reports

  • To edit a report, click the Report Name. Make appropriate changes and click SUBMIT.
  • To display the inactive reports, click the Include Inactive check box.


Note:

When the reports are displayed under the LIST table, the ADD NEW action is displayed on the ACTIONS panel. Click ADD NEW to configure a new custom report.

 EXPORT TO EXCEL

Click EXPORT TO EXCEL to export and download the data to a Microsoft excel sheet. This icon is available only on the Preview tab.