The Report Builder feature is categorized into two pages, the Report List and Settings. The Report List view page contains all the existing reports, folders, list view options and allows you to create new reports. The Settings has options to enable/disable the report data downloads, lazy loading of report widgets, configure color palette settings and custom colors.
To access Report Builder, navigate to Administration > Report Builder (BETA). The following pages are available:
Report List Options
The options in the Report List page are categorized into three sections:
Report List View and Options
List View and Options
The Report List page displays all the existing reports from all the folders. The options available under Reports are:
Name: The Name field displays the name of the reports along with the visualization type. Click the Report Name of your choice to view or edit the report.
- Settings: Click the Settings/Gear icon next to the Filter icon to customize the Report List View. You can Search, Select a single or multiple fields, and click Apply to add them to the report list view.
Following fields are available under Settings option. Select and add the required fields to the Report List View:
- Name: The display name of the Report. This field is selected by default and you cannot deselect it.
- Description: It displays the details about the report a user entered while creating it.
- Folder Name: It displays the Folder Name of the report.
- Created By: it displays the Name of the user who created the report.
- Created Date: it displays the Created date of the report.
- Modified By: it displays the Name of the last user who modified the report.
- Modified Date: it displays the Last modified date of the report.
- Used In: it displays the name(s) of the dashboard(s) that specific report is used in. Hover on the specific report to see the name(s) and list of dashboard(s).
- Source Object: it displays the Source Object name of the report.
- Deleted: it displays the delete status of the report, either True or False. If the report is deleted, it displays True in the Trash folder.
Search: Type in the Report Name to see the search results.
- Filters: can be applied on reports based on Source Object, Created By, and Modified By criteria.
To apply a filter on Source Object:
- Click the Filter icon.
From the Field dropdown list, select Source Object.
From the Operator dropdown list, select either in or not in.
From the Select Items dropdown list, select or search the required source object(s).
- Click Apply.
To apply a filter on Created By or Modified By:
Click the Filter icon.
From the Field dropdown list, select either Created By or Modified By, based on your requirement.
From the Operator dropdown list, select either equals or not equals
From the Select User dropdown list, select either Current User, All Users or Other User. Type-in the User Name in the Search box, if you have selected Other User.
- Click Apply.
- Add more filters by clicking the + icon next to the Value text box.
- Delete a filter by clicking the X icon.
- Remove all filters by clicking the Clear button.
Context Menu: Click Context Menu to view the following actions:
- Edit Report: it allows you to Edit the selected report.
- Rename Report: it allows you to Rename the selected report.
- Delete Report: it deletes the selected report and the report is moved to the Trash folder.
Checkbox: Select the checkbox for one or more reports to move or delete.
You can sort and rearrange columns as required.
If a report is used in a dashboard, you cannot delete it.
Folders manage and organize the reports created in your org. By default, you can see All and Uncategorized folders. You can create folders and subfolders under All, as well as edit and delete folders/subfolders. If a report is not categorized or moved to a specific folder, the report remains Uncategorized.
All: It displays the list of reports available under all the folders and subfolders.
Uncategorized: All of the reports that are not categorized under a separate folder appear here.
To create Folders:
Click the Add new folder icon. The Add Folder window appears.
In the Folder Name text box, type-in the Folder Name as required.
Select the Parent Folder from the displayed list of folders. For example, you can select Home to create a Folder (or) Select an existing folder, if you want to create a Sub-folder.
- Click Save.
To Edit or Delete folders:
Click the Folder Name you wish to edit/delete.
Click the Pencil icon to edit the folder name, and click ✓.
- Click the Delete/Trash icon, if you want to delete a folder.
- Folders cannot be created under Uncategorized category.
- Only 2 (Base + 1) levels of subfolders under Home can be created.
- Drag and drop a folder (that has no subfolders) into another folder.
- Expand or collapse the folder section to see all the folders in sublevels.
- Type-in the folder name in the Search box to see the search results.
- Folders containing report(s) cannot be deleted.
If you have deleted any report(s) from the list page, you can still find them in the Trash folder. Deleted reports are stored up to 90 days in the Trash folder, and you can either Restore or Delete a report permanently from the trash folder.
If you have many reports, use the pagination tool at the bottom right corner of the screen to navigate through different pages and view multiple reports, in a set of 20, 40 or 60 on a single page, based on your selection.
Create or Edit Reports
Click Create Report to build a new report. To edit an existing report, click the report name of your choice from the reports list, and you will be navigated to the editing screen. For more information on how to create and edit reports, refer to the How to Build Basic Reports article in the Additional Resources section at the end of this article.
The options in the Settings page are categorized into 3 tabs:
- General Settings
- Color Palette Settings
- Custom Colors
The General Settings tab allows you to enable/disable the report data downloads and lazy loading of report widgets. Here, you can configure the following settings:
Disable downloading report data: enabling this toggle restricts the report data downloads from everywhere. For example, if you do not want a CSM to download a Report, toggle ON this option.
Disable downloading report data in external link shares: enabling this toggle restricts the report data downloads from the externally shared links.
- Enable lazy loading of report widgets: enabling this toggle improves the initial load times, by making sure only the reports that are visible on the dashboard get loaded.
Assume, you have a Dashboard that contains 10 report widgets, and have enabled the lazy loading option in the General Settings. Now, based on your screen resolution, you see only two report widgets initially. And, when you scroll down, the data in another two report widgets are loaded, and so on. The number of report widgets you see on the screen depends on the individual’s screen resolution.
Color Palette Settings
You can choose Gainsight Defaults color palette which has the best possible colors, once selected, it assigns the sequence of colors used in reports (or) you can use Custom Theme to customize the colors, as per your branding. For more information on how to configure Color Palette Settings, refer to the Color Setting in Reports article in the Additional Resources section at the end of this article.
Custom Colors allows admins to change the colors of the specific field values. Using Custom Colors, you can set colors for a specific field object under a source object.
Color palette defined in Gainsight Defaults does not understand data. There is always a meaning in the data and you might want colors to represent that data. For example: you want Risk CTA's to be shown in Red whereas Lifecycle CTA's in Blue. Leverage this custom colors option to add that meaning once, and it will reflect across all the reports which use the same field and value. For more information on how to configure Custom Colors, refer to the Color Setting in Reports article in the Additional Resources section at the end of this article.