Report Builder Version 2 - January 2023
The Report Builder is designed to allow you to create a repeatable framework for your business review reports by providing reporting components and additional features to create a High-Quality business report for your clients that is both complete and comprehensive.
The report builder uses a Template method to create reports that are usable across all of your vCIO companies in Lifecycle Insights. The report template is comprised of individual components that each contribute to the overall report.
Some components can be set to company specific or global components within the template.
This document will show you the steps to create and use report templates, how to work with individual components, downloading and presenting reports, and finally, how to use the report locker to store your reports.
NAVIGATING THE REPORT BUILDER
The report builder window has many options and features for creating reports. Report Builder v2 can be accessed by selecting Report Builder from the navigation pane.
The report builder window will open to a blank window. Use the template menu lists and action items menu to select from saved templates or to create new templates by adding components. See Templates and Components section below.
Revert To Report Builder v1 by clicking the Revert icon.
REPORT TEMPLATES
Report Templates are an arranged set of report components each configured to your data specifications.
Sample templates are available from the template menu or you can build and edit your own templates.
To select a sample template or an existing template, click on the drop-down report template menu and select the template from the list of available templates.
When you open an existing template, the report will open and show the first component data in the data window. See editing components section below.
You can navigate through the component list using the component list shown in the template and component menu at the top of the window or by clicking on a component in the Manage Component column. The Template Actions menu will show you any components that need attention to select a data source for the report components.
You can also click the Template Action icon to download, save, and delete your template. (Some actions are not available when components are in need of attention.)
REPORT COMPONENTS
Several report components are available for your template. Each component will have different configuration options and settings that will need to be set and selected to build your report to fit your needs. Every component will not be available to use depending on your data integrations.
Using the A.I. Assistant to Build Report Templates
Our new A.I. assistant can help you generate the report components you need automatically. This will save you the time and effort of adding components to your report templates.
The A.I. assistant is available by clicking the A.I. icon located next to the Template Action selector.
When you open the A.I. Assistant, a pop-up window will show. Here you can type in your selections or choose items from the Top Ten Components selector.
When typing your selections for the components, do not use commas as separators simply type the component names as you would like them ordered in the template.
When you click submit the A.I. assistant will setup the report template with the selected components.
Some components will require further detail such as setting your reporting options or selecting specific events for the components.
Manually Adding and Deleting Components
Use the drop-down selector to add a component to your report template.
When you have selected your component type, a selection window will appear to allow you to select options available for the component. You can select components from available sources, as well as component sub-types. Click the Add button to include this component in your report template.
Once you have added the component, the item will show in the preview window. You can edit some components, or apply filters or column selections for other components.
Global and Company Based Components
Some components now include a Global or Company specific setting available. Use the slide selector to set the component as global or company specific. When a component is set as company specific, the component data can be set to specific data for the selected company, while the global setting will be retained for use with other company reports. Components that do not show a selector will always default to global components.
For example: When using an MS Word template, you can insert a document as a global document which will include the document in the report for all companies.
You can also move the selector to Company Based and insert a second document into the component that will be used only for the selected company's reports.
Use the Show Component icon to open/close the right-hand component manager.
From the component manager, you can rename, delete, or re-order the components within your report template. Components that need attention are shown in the component manager with yellow highlighting and an accompanying warning symbol.
You can also move through the components in your report by using the component selector available in the template menu bar.
Components that show as needing attention can be addressed by navigating through the components using either the selector buttons or component manager. The component window will show what need is missing from the component or what other edits are required for use.
When you have setup and configured your components, use the Template Action selector to save, save as new, rename, save and download or delete your template.
AVAILABLE COMPONENTS AND FUNCTIONALITY
The following section contains instructions and information for the component types and their functionality and/or available options.
Agenda Component
The Agenda component is used to create a meeting agenda. You can select from either a blank agenda or use the provided sample agenda. This component can be set as a company specific or global component item.
The agenda editor is available when the component is selected. You can add or edit current items in the agenda editor window.
Text formatting tools are available in the editor for customizing the look and feel of the agenda.
Use the more options icon in the upper right corner to reveal extended text editing options for each editing tool shown in the agenda editor window.
Assessment Comparison Component, Assessment Form Component, Assessment Item Detail Component, and Assessment Summary Component
Assessment reports will show assessment scoring data in various formats depending on the level of detail you want to show. For more information on configuring assessment reports, click here.
Asset List Component
The Asset List component will display the asset table within the report. Types of assets and columns displayed can be configured for the asset list component. Click here for Asset List Reporting instructions
Augmentt Component
If you have implemented an Augmentt integration in LCI the Augmentt component will bring that data into your report template. Click here for information on Augmentt Reporting options and configuration settings
Breach Secure Now Component
If you have added Breach Secure Now integration to your LCI tenant, you can include the report data in your report template.
Click here to see information regarding Breach Secure Now report options
Budget Forecast Detail Component & Budget Forecast Spreadsheet Component
The Budget forecast detail and spreadsheet components will import your budget forecast data into your report template. Al l budget reporting options are available from these components. Click here to review the budget forecast reporting options and settings.
Contract List Component
This component will show the current list of contracts imported or created in LCI.
Use the available search bar and type selector to narrow the list down to specific contract data.
Use the column header sort buttons to sort the table data. (No secondary column sorting is available)
Please note, table columns shown to the right of Auto Renew are not displayed in downloaded reports.
Crewhu Component
The Crewhu component is available for CSAT reporting.
Click Here for more information on Crewhu reporting.
Goals Component Hook Component
This component is available for Customer Success subscribers.
Click here for more information on Customer Success - Goals Reporting
Hook Component
Click here for more information on Hook Security Awareness Reporting.
Image File
The Image file component will allow you to attach PDF documents or image files to the report template for more robust reporting capabilities. Use this component to add any relevant PDF reports to your template.
KnowBe4 Component
The KnowBe4 component is available for KB4 security awareness reporting.
Click Here for more information on KnowBe4 reporting.
MS 365 Summary Component
The MS 365 Summary component adds Microsoft Licensing data to your report. The report is designed to pull the license information available from Microsoft for the company that is currently selected only.
You can use the column filters and swatches to narrow down your report data. Also, the search bar and checkbox to ignore trial licenses can hone down your data further.
MS Word File Component
The MS Word File component is designed to allow you to insert external data from other sources into your business reports.
When you select the component, the report edit window will provide a file upload quadrant. You can click this area to open a file explorer window to select an MS Word document, or you can drag and drop your file into the quadrant.
The MS Word file component can also be set as a global component or company-based component.
Once you have uploaded a word file, the report editor window will display the file information. You can enter a description of the document contents in the description window. You can click the replace file link to upload new or a different Word document.
Please note: The MS Word document should be configured to meet the required specifications below:
Set Orientation to Portrait
Set Margins to Narrow
Set Page Size to Letter
Watermark images are not supported
Images set in the document should be anchored to text or inserted into a table for correct placement during the report generation process.
Recommendation Roadmap Component
The recommendation Roadmap tile allow you to insert a listing of recommendations ordered by date with costs mapped across a selected time period.
You can select options to modify the report to your needs, including specified recommendation statuses, priorities, cost types, and timespans.
Recommendation Summary Report
The recommendation summary report component will show the summary report for a selected recommendation.
Click here for instructions on setting up your recommendations.
Recommendations List Report
Add a complete list of recommendations to your report using the Recommendations List Component
Use the Search Bar and checkboxes to narrow down your list. You can also use the column sorting icons to sort the list.
Saaslio Detail Component and Saaslio Summary Component
The Saaslio components will integrate Saaslio SaaS data into your report. Detail and Summary components will add both the summary charts and detailed application usage tables to your report.
Click here for information on Saaslio Reporting and Integration
SmileBack Component
Use the SmileBack component to include your available CSAT data from your SmileBack integration. The report data includes both scoring summary tiles and detail report data.
Use the Search Bar, Table Column Options, Timespan selector and column sorting tools to customize the look and feel of your report. SmileBack links are also available for items listed in the detail table.
Text Block Component
The Text Block component is designed to allow you to insert elements into your report template that are not part of the Lifecycle Insights report items. This data can include advertising, notification data, cover pages, executive summaries, or any other relevant data you wish to include in your report.
When you select the text block component, the design window will display the open text box and formatting tools. Use these tools to create you text box data. You can also insert images, horizontal lines, ordered lists, tables, and web links into the text block component.
You can configure the text block component as a global or company specific component. Data entered into the text block will be displayed only for the company the component data is created under.
The text block will grow in size as you add data into the block.
Tickets Component
Insert ticket report data into your template with the Tickets component.
Click here for information on ticket reporting options and configuration.
User List Component
The User List Component will allow you to insert user list data into your report template. You can use filters, swatching, sorting, and searching tools to configure your user list data to your preference.
Click here for more information on user list configuration settings.
Use the filter selection bar to apply Location, Asset Type, or Asset Status filters to the report data within your components. You can hide and unhide the filter bars by clicking the filters icon.
DESIGN MODE AND REVIEW MODE
Switch between Design Mode and Review Mode using the mode icon located in the upper-right corner of the Report Builder window.
Design Mode allows you to edit and configure data within your components. Review Mode will show the data as it will be seen in presentation mode so you can preview your finalized component data
PRESENTATION
Presentation mode is available for you to present your completed report template to clients.
The presentation mode is interactive for report drill-through data and links.
Click the Presentation Mode Icon at the top right of the Report Builder window.
A presentation window will be displayed showing the component list on the left with navigation arrows at the top of the window. Use these arrows to page through your presentation. You can collapse the component list by clicking the list icon just above the component list.
Note: The present view will always be “LIVE” so as asset dates go to EOL, the link will show the up-to-date details. If you want a “point in time” report, you will want to download the document.
You can download the report to either a PDF formatted document or an MS Word document format (docx).
click the Export icon located in the upper right of the Report Builder window.
The report export window will appear. You can select from PDF or Docx format using the selection buttons at the top of the window.
You can select an existing logo using the logo selector box to on the left or drag and drop or click to select a new logo using the box to the right.
A report preview pane is available at the bottom of the export window. You can scroll through your report to preview before downloading.
When the report assembly is completed the Download Now! button will become available at the top of the export window.
Click to Download the report to your PC. You can also choose to download the report to your report locker for future retrieval.
The report window will begin rendering your report. A progress bar will be shown in the header bar of the export window.
You may receive an error message when the report begins to build if there are components that have not been assigned an event or item within the component. The error message will show this message and the download will need to be cancelled to correct the components
The system will generate the report in the background. A banner will be displayed at the top of your window while the report is generating. You can click the dismiss button to exit the message banner. You can also navigate to other areas of the application without affecting your file download
When your download is completed, you will see the message banner below. At this point your file is available, you can click the dismiss button on the message banner to close.
See below for more information on the Report Locker feature.
THE REPORT LOCKER
The report locker is available to store and archive your report builder exported reports. You can also add other artifacts to your report locker as well as link your archived reports to your business review meetings.
To access your Report Locker, click the report locker icon located in the upper right corner of the Report Builder window.
The report locker will display a list of all reports stored in your locker. The file list will include the last generated timestamp, linked meeting dates, along with icons to delete, rename, or link the report to a business review meetings.
You can also upload other documents into your report locker (PDF, or Docx files only)
You can click on any filename to download the report to your local device.
Click the upload icon in the upper right corner of the report locker window.
Use the upload box to drag and drop or click to select reports to upload to your locker.
Use the return to locker icon in the upper right corner of the window or use the close button to close the report locker.
To link a report to your Business Reviews, click the Link icon next to the report you would like to link.
A drop-down selector will be available to select the meeting(s) you want to link the report to.
Select the business reviews by clicking the corresponding checkbox in the drop-down list. Click the Submit button when you have finished selecting the meetings.
You can access the linked reports directly from the business review meeting details window.
Restore Deleted Reports with the Restore Reports Icon.
KNOWN ISSUES
-
Error cutting and pasting an image
-
WYSIWIG to Word formatting
-
If you try to download a report and it takes a very long time, check and make sure that you have selected options for any components that require a selection (project and assessments).