KeyReporter Reports

Clicking Reports in the Side Bar navigation of KeyReporter will take you to the Quick Reports where you will see 8 popular reports in tile form in the core pane. Each tile has buttons to run the report, or add the report as a widget to your Dashboard.

This is an easy way to get in to reports, and once you have sampled these you can move on to building custom reports.

Report Builder

Clicking on Build Report under the main Reports side bar item will take you to the custom report builder. The intent is to have every bit of power and flexibility that you have in KeyConfigure for report construction, but in a clean modern web UI.

The very first thing you need to do is choose a report type. As the text in the core pane explains, this is done using the Search in the Header Bar. Remember, this is used universally in KeyReport to search for things in the current navigation context, so first we search for a Report and then choose the criteria to build it. The Report Criteria sub pane on the left can lead you through each aspect of a report. Icons and text mark each item, followed by the selection you have made for it.

Report

Very simply, which Report type you want to run. Once you pick a report a short description will be shown in the core pane. You can change the selected report by using the top Search bar to find and pick a different one.

Save As

In this screen you can set several options that have important effects as detailed below. It is important to note that the Scope set in the header bar will apply to the Report you run, much like setting a Target. This has special interaction with Time Sets.

• Display Name - Optional Display Name for the report for later easy reference. This name is not important if you leave the run option as Run Now and do not set a Folder as the report will in no way be saved. Setting this is most useful when you save multiple reports of the same type with different criteria so you can distinguish them from each other later. Five saved reports named Hardware are hard to tell apart, but Hardware: Lab A says what the report targets. This name will also be used in the title of any Widget using this report (like one-click)
• Folder - This is where you want to save the Report results and optionally the report template. If you want to run a report again in the future, giving it a name and saving it to a convenient location (depending who you are saving if for) is recommended. Even if you are only running the report as a one off you may want to choose a Folder to save the results in as it will allow you to sort by columns without the report having to regenerate, and it will enable saving as PDF and KSR as options.
  • Uncategorized will result in the saved report only being seen by you and no other admins, regardless of their permissions, and will not save the report results. The exception is the root Administrator account which can always see everything.
  • Export is a special option which will save it for ODBC export to an external database.
  • One-Click will save it in a way that also adds it as a tile on the main Reports page in addition to the list of Saved Reports. Pay close attention that when choosing this option an additional option appears for Visible to all Admins. If this is off only you will see the one click widget, if enabled then anyone with proper permissions to reports will see it.
  • Other folders can be created in KeyConfigure as well as setting their ACLs to control visibility.
• Run - Controls the execution time and behavior of the report.
  • Run Now is the default which simply runs the report and does not save it for later use. Note the results can be saved by choosing a Folder as stated above.
  • Run on Demand will save the report in the Saved Reports in the Folder of your choice so you can run it again later. Used with the One-Click Folder, it will result in a tile on the Reports page to quickly run a report any time you want.
  • Schedule lets you choose a variety of schedule options on which the report will routinely run. This can be useful for having pre-run report results available at given times, optional ODBC export, and most often used with the E-mail setting below so for example they receive a weekly lab use report.
  • If you use Run on Demand or Schedule an additional option will appear for Replace Previous Runs. This is useful for avoiding clutter so that a scheduled report or often re-run report does not create saved copies every time it is run and instead replaces the previous. However, there may be cases where you wish to store an archive of completed monthly reports for example for later reference without having to regenerate them.

Date Range

This screen lets you pick the date range (if applicable) for the Report. There are several preset ranges and you can build your own range. Any custom date ranges created in KeyConfigure will also appear here. Creating custom ranges for things like semesters can be useful for often re-used dates.

Time Sets

Not to be confused with the Date Range of the report, Time Sets have a special function. These allow you to narrow the report time from 24/7 during the selected date range, to specific days of the week, and hours of the day. One example would be making a time set that is class times in a lab that are distinct from the lab open hours. This would let you run a report of use during the class or classes and compare to overall use of the lab. See the documentation on Time Sets for more details on how to create them in KeyConfigure. You can also create time sets on the fly.

Target

The target of the report is the Division or computer(s) you want to include in the report results. Use the pane search bar in this panel to look for targets and select them for inclusion. As you add them, they appear in a list, and can be removed by clicking their x. The Aggregate option will collapse distinct targets into a composite result. That is, instead of each division or computer you targeted being a separate expandable item under which you had for example Product use (i.e. use by target), you would simply have total Product use of each product for all targeted items (total use of all targets as one).
Note that while the report builder in KeyReporter is robust, there may be some very advanced options only available by building a report in KeyConfigure. One such item is the ability to add a Filter to the report Target.

Tags

If you have defined Division Tags in KeyConfigure, they will appear here. These can be used in a similar way to the Computers window in KeyConfigure to filter results. That is, if you Target a Division, then select a Tag, your results will only include the computers with that Tag in that Division. This allows for very granular reporting of systems.

Options

Various report specific options are available here, like ignoring Usage shorter than x seconds and using division from usage event (instead of current division). Note that not all reports will have additional Options.

Columns

Simply, you can choose which columns are shown in the final report. Hardware is a great one to look at for this as it has a lot of available columns, and you may only want a couple of them for a specific purpose. The + and x buttons can be used to add and remove, or simply drag and drop to set which are used and in what order. You can change columns after a report runs as well, but setting the desired columns in a saved report is most convenient.

Notes

These are arbitrary notes you can save in the report as a detailed description or purpose notation. However, if you save as a one-click or use the report in a Widget the notes will show in the widget to serve as a description.

E-mail

Here you can input an email address to email a link to the report when it has been run. This is typically used when scheduling a report. You can put in multiple addresses with comma or semicolon delimitation. Note this does not email the report content, just a link to the completed report. As such, the recipient needs to have access to the report, be it public or via authentication to the Web UI.

Sharing

As of 7.7.0.4 there is a small button in the lower left of the report builder sidebar. Clicking this will download a text file that is a descriptor of all the current choices set above in the builder. This can be sent to another user who can drag the file onto this button to load the settings into the builder. In some cases this may be preferable to setting up shared folders for saving report templates which requires ACL configuration.

Completed Reports

Once a report has been run you will see a few tool options in the Ribbon bar at the top. The available buttons and options will depend on the type of report you ran.

On the Left:

• Name - The name of the report you ran
• Collapse and Expand all - If you ran a report that has a hierarchy, like Program x Computer, you will have these icons to expand and collapse all rows.
• Paginate - This lets you break up the report results into pages or show as one long list.

On the Right:

• Arrange Columns - Change your selected columns and display order
• Views - Invert the arrangement order of the report. For example Computer x program instead of Program x computer.
• Change Date Range - Rerun the report with a different date range applied.
• More Options
  • Create Similar - Return to the Report Builder with the same options selected that created this report so you can make minor changes without starting over entirely.
  • Download - Save the results in a variety of formats. Note that KSR and PDF are ONLY available if the report result has been saved (see Folder under Save As above).
  • Open in KeyConfigure - Will open the KSR report in KeyConfigure if this was run from a saved report and KeyConfigure is installed.
  • Delete - Only shown if the report was saved. This only deletes the saved results, NOT the template. To delete the template go to the Saved Reports list.

Saved Reports

Any report you saved or saved the results (see Folder above) will show under the Saved Reports section of KeyReporter. You can filter on the type of report and the folder the report was saved in to narrow the display list. Additionally you can filter on the timeframe the report was created using the drop down in the upper right with the clock icon.

You can drag and drop reports to other folders to move them around. Note Folders must be created (and ACLs set) in KeyConfigure.

You can drag to the Trash and they will be deleted on a clean up schedule. If you hover the item you're dragging on the Trash you will note a small alert icon to the right side. Dropping onto that (will highlight red) will activate a delete immediately option. Mass deleting of reports if often easier in KeyConfigure.

Saved reports will have a variety of options available depending on if they are saved results or saved templates (on demand). You can edit templates, run if they are on demand, and access other options from the popup menu on the left like downloading completed items or creating similar reports based on the criteria.

The star icon in the When column indicates the option to replace previous runs is enabled.

For full description of all available reports see Reports.

For a comparison to building reports in KeyConfigure see Report Builder Window.

For managing reports in KeyConfigure see Reports Window.