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.

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.  

Revert To Report Builder v1 by clicking the Revert icon.

Restore Deleted Reports with the Restore Reports Icon.

Access the components list by clicking the Show Components icon.  This will open a pane to the right side of the report editor listing all components added to the template.  

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.  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.  

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 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.

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.

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.

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.

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.   

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. 

The report will open in a new window for your review, depending on browser settings.  

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.

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 the report.

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.

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).