---
title: "Report Builder"
slug: "report-builder-1"
updated: 2026-02-10T09:50:16Z
published: 2026-02-10T09:50:16Z
canonical: "help.symphonysummitai.com/report-builder-1"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.symphonysummitai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Report Builder

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, perform the following steps:

1. Select **Admin** > **Infrastructure** > **General** > **Report Builder**.
2. On the **Report Builder** page, click **Add New** from the right actions panel.
3. In 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. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-P4M9F2SN.png) 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.

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.
5. The selected columns are displayed in the **Column Re-Order & Grouping** section. You can also change their sequence by moving them up and down.
6. 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.
7. 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.
8. Click **Preview** to view the preview of the report. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-MMSR0E9P.png) Figure: CUSTOM REPORT BUILDER page: Designer tab
9. Under the **Preview** tab, select the required filter options on the **FILTERS** pop-up page and click **SUBMIT** (see, [Filters](/apex/docs/report-builder-1#ReportBuilder-Filters)). The preview of the report is displayed based on the filter criteria. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-T9TOZW57.png) 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 right 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**.

**Show List**

Click **Show List** to display the **LIST** table showing all the custom reports for the selected Tenant.

- 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]
> Note
> 
> When the reports are displayed under the **LIST** table, the **Add New** action is displayed on the right 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.
