Use this article to learn how to create and edit Custom Reports in Analyze Essentials. You will start from the Custom Reports page, choose a starting point, and then configure the report layout using the Live Edit page.
This article assumes that you already have access to Analyze Essentials. If you are new to the feature, we recommend reviewing the main Analyze Essentials overview article before you begin.
Creating a Custom Report
- Navigate to the Analyze Essentials Custom Reports page.
- Click Add from the Actions menu on the right-hand side of the page. The New Report page will open.
New Report Page
On the New Report page, you are prompted to choose a Template for your report.
Data Sources are captured in Base Templates and denoted by a Data Source label.
This page has three sections:
-
Templates Section: Contains cards for all templates, grouped visually by their associated Data Source. Each Data Source group is indicated by a unique icon.
-
Filter by Subject Section: Contains buttons labeled with common report subjects. When a button is clicked:
- The Templates displayed in the Templates section are limited to that subject.
- The button changes to dark blue to indicate the filter is applied.
- Only one subject filter can be applied at a time, so any previously selected button is automatically deselected.
-
Search Templates Section: Contains a search bar. Entering keywords filters the Templates displayed in the Templates section to those containing all entered keywords in at least one of these card elements:
- Template Card title or description.
- Template details, including data source name, data fields, or use cases.
Template Details
The following steps outline how to view and use Template Details:
- Click View Details on a Template Card to open the Template Details pop-up. This pop-up displays the template’s data source name, data fields, and use cases.
- Click Use This Template to start a new report based on the chosen template and open the Add Report page. Click Close to return to the New Report page.
All columns, filters, and sorts included in the Template appear in the report grid with the report data.
Actions
The following actions are available on the Add Report page:
| Page Element | Description |
| Report Name text box | Edit the Name of the Report Layout. If the chosen starting point was a Template, this text box will contain a default Name. If the chosen starting point was a Data Source, this text box will be blank. A Report Name must be supplied before the Layout can be saved. |
| Data Source text box | Displays the name of the Data Source. This field is read-only cannot be changed. |
| Export button | This button is available once the Report Layout has been successfully saved. Once clicked, the report will generate. |
| Email Upon Completion button | Available while a report is being generated. Clicking this button enables an email notification to be sent once the report is complete. This allows the User to leave the page while the report is being generated. |
| Download Report button | Available once a report has been successfully generated. Clicking this button downloads a copy of the report in CSV format. |
| Schedule button | Once the Report Layout has been successfully saved, the Schedule button is enabled. Clicking it loads the Schedule page, where Users can enable schedules, specifying the recurrence schedule and recipient list. |
| Add/Remove Columns button | Click this button to load the Available Columns dialog. This dialog shows a searchable list of Data Fields that can be added to the report, grouped by Table. Once selected, Data Fields are listed at the right, where they can be reordered or removed. Click the Apply button to save the changes, or Cancel to close without saving. |
| Filter button | Filters results by selected Data Field/Field Value pairs. Click this button to open the filter dialog, and select Data Field/Filter Value pairs to add to a Filter group. Click Apply to save your changes or Cancel to close the dialog and discard your changes. |
| Sort button | Click this button to open the sort dialog titled Sort Results By, where you can add one or more Data Field and Sort Direction pairs to define the sort order. To save your changes, click Apply. Click Cancel will close the dialog and discard your changes. |
| Back button | Navigates back to the Custom Report page. If changes were made on the Add Report page, an unsaved changes warning will appear: “You haven't saved your changes. Are you sure you want to leave this page?” Click Cancel to remain on the Add Report page, or click OK to return to the Custom Report page and discard any unsaved changes. |
| Save Report button | Available after you enter a Report Name, select a Data Source, and add at least one column. Click Save Report to save the Report Layout under the provided Report Name. |
Working in the Live Edit Page
The Live Edit page is where you configure the Layout, Columns, Filters, and Sorting for your Report before saving it as a reusable Layout.
Main Live Edit Controls
The following controls are available on the Live Edit page.
| Control | Description |
| Report Name | Text field where you enter the name of the Report Layout. You must supply a report name before you can save the Layout. |
| Data Source | Displays the Data Source used by the report. This field is informational only and cannot be changed from the Live Edit page. |
| Add/Remove Columns | Click to open the Available Columns dialog. Use this dialog to add, remove, or reorder data fields in the Report Layout. |
| Filter | Click to open the Filter dialog, titled Show results where. Add one or more Data Field and Filter value pairs to define Filter groups that limit which records are returned in the Report. |
| Sort | Click to open the Sort dialog, titled Sort results by. Add one or more Data Field and Sort direction pairs to define the order in which records appear in the Report. |
| Save Report | Click to save the current Report Layout under the entered Report name. This button is enabled when the layout has a Report Name, a Data Source, and at least one column. |
| Back | Click to return to the Custom Reports page. If there are unsaved changes on the Live Edit page, a warning message appears before you leave. |
Using the Filter and Sort Dialogs
The Filter and Sort dialogs share a consistent pattern for saving or discarding changes.
- Use the dialog fields to add or modify Filter or Sort criteria.
- Click Apply to save your changes and return to the Live Edit page.
- Click Cancel to close the dialog and discard any unsaved changes.
Managing Available Columns
Use the Available Columns dialog to control which Data Fields appear as columns in your Report. Type in the search box to limit the list of Data Fields to those that match your search text.
Follow these steps to Add or Remove a column:
- On the Live Edit page, click Add/Remove Columns. The Available Columns dialog opens.
- Review the list of data fields, which are grouped by Table.
- Click the checkbox beside a Data Field to add it to the Selected Columns list.
- Click the red X symbol next to a Selected Column to remove it.
- Click Remove All to remove all Selected Columns from the list.
After removing all fields, you must add at least one data field back to the report. If no fields are selected, your changes will not be saved.
Column/Data Field Symbols
A symbol to the left of the field name indicates the data type.
Symbol |
Symbol Definition |
Text Field |
|
Boolean or Binary Field |
|
Date/Time Field |
|
Numeric Field |
Data Fields that are already in the Report have a check mark next to the name and appear in the Selected Columns list on the right side of the dialog.
Reorder Columns
In the Selected Columns list, use the drag handle icon (=) to click and drag a column up or down to change its position in the report layout.
Apply or Cancel Column Changes
When you are finished managing columns, click Apply to save your changes and close the dialog. Click Cancel to close the dialog and discard any changes you made.
Saving Your Report Layout
Follow these steps to use the Save Report action:
- On the Live Edit page, confirm that the Layout includes a Report Name, a Data Source, and at least one column.
- Click Save Report.
- Verify that the Layout now appears on the Custom Reports page under the name you entered.
Analyze Essentials Data Dictionary
A comprehensive Analyze Essentials Data Dictionary is attached to this article. The data dictionary lists available fields, their descriptions, and the possible values for each field.
Use the data dictionary to understand which fields to include in your custom Reports and how those fields behave in different reporting scenarios.
To download the data dictionary, open the Attachments section on the right side of this article and select the Analyze Essentials Data Dictionary file.
Comments
Article is closed for comments.