Internal Report Builder

[KB-Team]

Overview

The Internal Report Builder lets you to build and create reports with customized elements that can be viewed on-screen, as a PDF, scheduled to run on a regular basis, and emailed to your users. It is very similar to the Executive Summary Report Builder, but is designed to be sent to staff members rather than customers.

 

Table of Contents

• Video Summary
• Getting started
• Internal Report Builder Templates
• Add a Report Template
  • Visual Summary Section
    • Custom Field Counter
  • Text Summary Section
  • List Summary Section
• Run an Internal Report

 

Video Summary

Release Update - Internal Report Builder

 

Getting Started

Navigate to More > Admin > Reports, then under Report Builders, click Internal Report Builder. You can do several things from here.

1. Click the dropdown and select the desired Report Template. It comes with one Default Template.
2. Generate the report selected in the dropdown. Go ahead and try this with the included Default Template.
3. Add the selected report to Favorites section in Admin > Reports, eliminating the need to return to this module to select and print it.
4. Return to the Reports screen.
5. Go to the Internal Report Builder Templates screen where you can create your own templates.
6. Create a report schedule where you can set a schedule to regularly email an internal report to selected staff members.
7. After running a report, click to generate a PDF of the report on the screen. After it takes you to the File Downloads screen, wait a few moments, refresh the page (Ctrl+R Windows, Command+R Mac), then click the internal_report_builder.pdf link.

 

Internal Report Builder Templates

This screen lets you create new report builder templates, manage and edit existing ones, and run any of the reports.

1. Type a full or partial template name and click Search to find one you want.
2. Add a Report Template.
3. Return to the Internal Report Builder screen (see previous section).
4. Click a template name to edit it.
5. Run the selected report.
6. Click the three dots to Rename, Edit, Clone or Delete the selected template.

 

Add a Report Template

On the Internal Report Builder Templates screen, in the upper right click New Report Template. This will take you to the Internal Report Builder screen.

1. Enter a Template Name.
2. Click Insert Report Element, then click one of the following.
   • Visual Summary Section
   • Text Summary Section
   • List Summary Section
   • Static Content — Lets you add a header and block of plain text with whatever content you want. There is no ability to add formatting, such as bold.
   • Page Break — Starts a new page on the generated PDF report, regardless of how much content there is on the current page.
3. Repeat as desired, adding as many Elements as you want.
4. Use the hamburger icon to drag and drop entire sections into the order you want.
5. When finished, on the right above the Element sections, click Save Template.
6. Return to the Internal Report Builder screen. From there you can select your report you built and click Run Report.
   

 

Visual Summary

The Visual Summary module shows graphs and charts of the report information. You can add as many Visual Blocks as you want. They will display up to three blocks per row. When adding Blocks, they will display "Sample" at the top to indicate you are not seeing actual data. Here is what you can do.

1. Drag and drop the entire Element section to where you want in the report.
2. If desired, name the section.
3. Delete the entire Element section.
4. Clone the Visual Block.
5. Edit the Visual Block.
6. Delete the Visual Block.
7. Add a new Visual Block. Note: This does not work in Safari. Please use another browser such as Chrome or Edge.

Once you add or edit a Block, follow these steps.

1. Select one Report Module to display in the Visual Block. Once you select one, it will display a description of what it is.
   • Alerts Detected
   • Alerts Resolved
   • Antivirus Coverage
   • Antivirus Threats Detected
   • Asset Health Summary
   • Custom Field Counter
   • Device Breakdown
   • Labor Hours
   • Operating System Breakdown
   • Phone Calls Received
   • Prepay Hours Balance
   • Script Statistics
   • Ticket Distribution Metrics
   • Tickets by Type
   • Tickets Opened/Resolved
   • Unsupported Operating Systems
   • Windows Update Coverage
   • Windows Update Statistics
2. Almost all modules will default to Select All Customers. If desired, uncheck, then select a desired customer. It is not possible to select multiple customers in a single block, but you can as many blocks as desired to select more customers.
3. Select any other desired parameters that appear.
4. When finished, click Save.

Custom Field Counter

This tallies the number of times a custom field value is matched based on the criteria entered into the dialog. This can be used in both Visual and Text Blocks.

1. Customize the name if desired.
2. Uncheck to then search for and select a single customer.
3. Select to display the values as Total Quantity or Percentage.
4. Select the custom Asset Field to count.
5. Select how you want the Asset Field to be compared with the Value (#6).
6. Enter the Value to compare with the Asset Field.
7. When finished, click Save.

Text Summary

Shows lines of text with the number of various elements such as alerts detected, devices with AV, and more. The steps are the same as for Visual Summaries.

These are the Report Modules available.

• Alerts Detected
• Alerts Detected - Highest Frequency
• Alerts Resolved
• Alerts Resolved - Highest Frequency
• Antivirus Coverage
• Antivirus Threats
• Asset Health Summary
• Remote Access
• Script Runs
• Support Tickets
• Tickets By Type
• Windows Update Coverage
• Windows Update Statistics

 

List Summary

Here you can add one of four different tables with the criteria and up to eight columns of data you want displayed, similar to what you find on the Tickets and Assets pages.

 

Steps are similar for each Report; differences will be noted in subsequent sections.

1. Select one Report Module to display in the List Block.
   • Assets
   • Contacts
   • Customers
   • Tickets
2. This varies for each Report. See the Report Modules listed in #1 above.
3. Drag and drop columns in the order you want.
4. Select the field to display in the column.
5. Delete the column.
6. Add a new column, up to eight.
7. Select the column to sort the list by.
8. Select Ascending or Descending sort order for the Sort By column.
9. Select anywhere from 5-500 rows of data to display.
10. When finished, click Save.

Assets

1. Uncheck to select a specific customer.
2. If you have saved any asset searches, you can select which one to use.
3. Select the desired Asset Type to display.

Customers

The only option different from the others is to select which saved customer search to use.

Contacts

This is a great option to display all contacts for a customer who match a certain criteria, such as those who live in a certain city, as illustrated in the example below.

1. Enter and select a customer name.
2. Choose which field you want to search for a certain Value (4 below).
3. Choose from Equals, Does Not Equal, Contains (case sensitive), or Does Not Contain (case sensitive) for the comparison Operator.
4. Type the Value to search or exclude in the Contact Field (2 above).

Tickets

1. Uncheck to select a specific customer.
2. Select the time period of tickets to display.
3. If you have saved any ticket searches, you can select one here.

 

Run an Internal Report

There are two different places you can run an Internal Report.

1. On the main Internal Report Builder screen. Select a report in the Report Template dropdown and click Run Report.
   
2. On the Internal Report Builder Templates screen. Next to the desired report, click Show Report.