Analyze Essentials is a paid add-on. If you are interested in this product, please contact your Client Success Manager or Account Manager.
Analyze Essentials is an add-on reporting tool that allows you to build Custom Reports from the bottom up. You can choose from a curated set of report Templates, add columns, filters, and sorting, share and schedule delivery, preview results during configuration, and generate Custom Reports on demand.
This article provides an overview of how Analyze Essentials works, including how to access the feature, work with Custom Reports, review generated reports, and manage access to the tool.
Data displayed in Analyze Essentials reports is synced from Absorb LMS every 4 hours. Data changes made less than 4 hours ago may not be reflected in Analyze Essentials reports. If a scheduled sync runs shortly after a change is made, it will be reflected in reports sooner than 4 hours.
Accessing Analyze Essentials
You can access Analyze Essentials through the Admin Interface using the following steps:
- Confirm that you are on the Admin Interface.
- Select the Reports button from the left-hand side. The Reports menu will expand.
- Select Analyze Essentials from the expanded Reports menu to open the Custom Reports page.
Custom Reports Page
When you access Analyze Essentials, you land on the Custom Reports page. This page displays your previously saved Custom Reports in a grid. From here, you can work with existing Custom Report Layouts or create new ones.
The Custom Reports grid can be refined using search, ownership filters, and sharing filters to help you locate specific Custom Reports.
Available Actions
Administrative Actions are available on the Custom Reports grid. The Actions menu is displayed on the right-hand side of the page and is context-sensitive, so available actions change depending on which rows are selected.
Actions When No Rows Are Selected
| Action Menu Option | Description |
| Add | Click to create a new Custom Report. |
| View Generated | Click to view a grid of your generated Custom Reports. |
Actions When a Single Row Is Selected
| Action Menu Option | Description |
| Edit | Click to edit the selected Custom Report. |
| Duplicate | Click to create a duplicate copy of the selected Custom Report layout. |
| Share | Click to share this Custom Report Layout with other Users, Groups, or Departments. |
| Generate | Click to generate the selected Custom Report Layout. |
| View Generated | Click to view your Generated Custom Reports, filtered for the Custom Report you selected. |
| Delete | Click to delete the selected Custom Report. Important: Custom Reports are permanently removed from the LMS and cannot be recovered. |
Actions When Multiple Rows Are Selected
| Action Menu Option | Description |
| Deselect | Click to clear the current selections. |
| Delete | Click to delete the selected Custom Reports. Important: Custom Reports are permanently removed from the LMS and cannot be recovered. The associated generations are not deleted when you delete the Custom Report. |
Creating a Custom Report
- From the Reports page, click the Add action to open the New Report page.
-
On the New Report page, choose a Template to use as the starting point for your report. The Templates section displays all available Templates, grouped by their Data Source (each with a unique icon).
Templates and LabelsData Sources are captured in Base Templates and denoted by a Data Source label.
- Narrow down the list of Templates by using:
- Filter by Subject buttons.
- The Search bar to enter keywords.
- Click View Details on any Template card to see additional information, such as:
- Included data fields.
- Supported use cases.
- Click Use This Template to start a new report based on this Template. The Add Report page will open.
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 | Contains the name of the Data Source. This field is read-only and 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 to 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. |
Live Edit Page
The Live Edit page allows you to configure and refine your custom Report Layout before saving and generating it.
Available Actions Live Edit Page
The Actions menu on the Custom Reports page is context-sensitive. The options that appear depend on whether no rows, a single row, or multiple rows are selected in the Custom Reports grid.
| Page Element | Available Actions |
| Report Name text box | Edit the Name of this 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 | This is information only. The Data Source cannot be changed from here. |
| Export button | Once the Report Layout has been successfully saved, the Export button is enabled. Once clicked, the Report will generate. While the Report is being generated, the Email Upon Completion button is clickable. This allows the User to leave this screen, and the Report will be emailed when it is done generating. Once the Report is successfully generated, click the Download Report button to downloaded as a CSV. |
| Schedule button | Once the Report Layout has been successfully saved, the Export button is enabled. Clicking it loads the Schedule page, where Users can enable schedules, specifying generation cadence and recipient list. |
| Add/Remove Columns button | Click this button to load the Available Columns page. This page shows all the available Data Fields that can be added to the Report, grouped by table. Typing characters in the search box will limit the Data Fields being displayed to those that match the search criteria. Data Fields that are already included in the Report have a check mark beside the name, and appear within the Selected Columns list on the right side of the page, along with two symbols: = Clicking and holding on this symbol allows columns to be reordered by dragging them up or down the list. X Clicking on this symbol removes the column from the Report. To save all changes made on the page, close it by clicking the Apply button. Clicking Cancel to close the page will discard all changes made. |
| Filter button | Click this button to load the filter dialog, titled Show Results where, where one or more Data Field/Filter Value pairs can be added to a Filter Group. All Data Field/Filter Value pairs in the Filter Group are joined by an OR statement. Click X to remove the Data Field/Filter Value pair from the Filter Group. Click + Add Filter to add another Filter Group. Each Group is joined to other Groups by an AND statement. To save all changes made on the page, close it by clicking the Apply button. All Data Field/Filter Value pairs and statements are collectively applied to limit data appearing in the Report. Clicking Cancel to close the page will discard all changes made. |
| Sort button | Click this button to load the sort dialog, titled Sort results by, where one or more Data Field/Sort Direction pairs can be added to the Sort Order. Clicking and holding = allows Data Field/Sort Direction pairs to be reordered by dragging them up or down the list. Clicking X removes Data Field/Sort Direction pairs from the Sort. To save all changes made on the page, close it by clicking the Apply button. All Data Field/Sort Direction pairs are joined by an AND statement, and are applied in the order they appear in the list. Clicking Cancel to close the page will discard all changes made. |
| Back button | Will return to the Custom Report page. If changes were made on the Live Edit 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 return the Live Edit page or click OK to return to the Custom Report page, discarding any changes. |
| Save Report button | Once there is a Report Name, a Data Source and at least one column has been added to the report, the Save Report button is enabled. Click this button to save this Report Layout under the entered Report name. |
Analyze Essentials Data Dictionary
A comprehensive Analyze Essentials Data Dictionary is attached to this article. It describes all available fields, their definitions, and possible values.
Open the Attachments section on the right side of this article to download the Analyze Essentials Data Dictionary.
Generated Custom Reports Page
The Generated Reports page displays the Reports that have been generated from your Custom Report Layouts. The results displayed in the Generated Reports grid can be refined using the Custom Report Name search.
Generated Reports Fields
When viewing the Generated Reports page, the grid includes the following columns:
| Data Column | Description |
| Name | Displays the name provided on the Add / Edit Report page. |
| Schedule | Displays the Schedule Frequency configured on the Add / Edit Report page. |
| Status | Displays the Status of a Custom Report generation. Refresh the page to see the latest status update. |
| Date Generated | Displays the date and time the Custom Report was generated. |
| File Size | Displays the file size of the Generated Report. |
| Row Count | Displays the number of rows included in the Generated Report. |
| Custom Report ID | Displays the unique identifier for the Custom Report. |
Generated Reports Actions
The Generated Reports page also includes a context-sensitive Actions menu. Available Actions depend on which rows are selected.
Actions When No Rows Are Selected
| Action Menu Option | Description |
| Back | Click to navigate away from the Generated Custom Report page and return to the Analyze Essentials landing page. |
| View Generated Custom Report | Click to view a grid of your Generated Custom Reports. |
Actions When a Single Row Is Selected
| Action Menu Option | Description |
| Delete | Click to delete the selected Generated Custom Report. Important: Generated Custom Reports are permanently removed from the LMS and cannot be recovered. |
| Download | Click to download a copy of the selected Custom Report generation. |
| Deselect | Click to clear the current selections. |
| Back | Click to navigate away from the Generated Custom Reports page and return to the Analyze Essentials landing page. |
Actions When Multiple Rows Are Selected
| Action Menu Option | Description |
| Delete | Click to delete the selected generations of a Custom Report. Important: Generated Custom Reports are permanently removed from the LMS and cannot be recovered. The associated Custom Report is not deleted when you delete the generation(s). |
| Deselect | Click to clear the current selections. |
Managing Report Permissions
Access to Analyze Essentials is controlled through Admin Roles and Permissions.
The following default Admin roles can access Analyze Essentials when the client Portal is enabled:
- System Admin
- Admin
- Reporter
All other Admins must be granted a Custom Role that includes the Analyze Essentials permission to access the tool. The Analyze Essentials permission is located under Reports when creating a Custom Admin Role.
Related Articles
For more information on the Analyze Essentials feature and its related workflows, refer to the following articles:
- Analyze Essentials: Creating and Editing Reports
- Analyze Essentials: Data Sources and Templates
- Analyze Essentials: Filtering and Sorting Reports
- Analyze Essentials: Exporting and Scheduling Reports
- Analyze Essentials: Working with Saved Reports
- Analyze Essentials: Sharing Custom Report Layouts
Comments
Article is closed for comments.