KeyReporter

KeyReporter runs a web service that provides a browser UI to K2. This interface is primarily used for reporting - configuration is still done through KeyConfigure. KeyReporter has a dashboard view that can be configured independently for each Administrator, pages where maps of each division can be drawn in order to show availability, and the ability to run reports automatically on a configured schedule.

Dashboard

After logging in to KeyReporter, your default view will be of your dashboard. This dashboard can be customized to include whatever widgets you want. Widgets provide quick summaries of richer K2 configuration and data. For a full tour of how to use the dashboard UI, click the "Quick Intro" button in the Welcome widget, the question mark icon in the lower right of the window, or just press F1.

Default dashboard in KeyReporter

Widgets can be resized and dragged around to reposition. Clicking the Plus button in the upper right lets you add additional widgets to the dashboard. In the default view there is a single tab named "Main" - additional tabs can be added by clicking the smaller plus just to the right of the existing tabs.

Each administrator has their own distinct dashboard. Any time changes are made they can be saved so that whenever that administrator logs into KeyReporter again using their login name, they will see their own saved dashboard. Administrators with appropriate permissions can configure and save Dashboard layouts for other administrators. For example, the primary K2 Administrator might pre-configure appropriate dashboards for other users within the IT Asset Management team.

Additionally, named dashboards can be saved which are independent of the Administrator login name. These can then be loaded later whenever needed, by clicking the gear button and choosing "Other Dashboards"

For documentation and screenshots of all of the available widgets, see the Widgets documentation.

Sample Hardware dashboard in KeyReporter

The picture above shows a "sample" dashboard which is installed with KeyReporter. You can look at this dashboard using your own data by selecting "Other Dashboards" from the gear menu. The various sample dashboards should give you some ideas of the sort of things you can do, without you having to test each and every widget one by one. Ultimately you will probably want to do some customization - our samples are probably not precisely what you need. If you want to start with a sample dashboard and make it your own default, you can load that dashboard, then select "Save Dashboard As..." from the gear menu - you will then have the option to save as "My Dashboard" - this will overwrite the previously saved instance of "My Dashboard".

Guest Access

By default, when KeyReporter is first enabled, Guest access is allowed but the guest page will show only the special Availability widget with no actual data displayed until it is configured (as described below). Guests are not allowed to access the builder page and they are not allowed add widgets or to customize in any way.

To change these dashboard view displayed to Guest users, connect a web browser to the KeyReporter and login with the Administrator account (or any account that has the "Change Miscellaneous Settings" privilege in the "KeyReporter Privileges" section of Role Details).

To change the default behavior of what is allowed from a guest connection to KeyReporter, or to turn off guest access completely, use KeyConfigure. Logon with the Administrator account:

Availability Widget

Until it is configured, the Availability widget is just a place holder presented to guest users based on the incomplete default configuration. After configuration it is designed to display a graphic view of lab computers showing which are available for login vs those which are not. Its configuration and functionality is somewhat different from most widgets since it depends on special KeyReporter pages - the lab Map pages for each computer division. Until these maps are drawn, it shows nothing.

To make the Availability widget functional, refer to the Availability Widget documentation – or follow the documentation above to choose a different Dashboard for display to guest users.

Integration

KeyReporter publishes its archive of completed reports in html format for viewing with any web browser. The archive of KeyReporter saved reports can also be viewed using the admin component, KeyConfigure. When viewed in KeyConfigure, these reports are fully integrated into the administrative interface (e.g. with support for drag & drop etc.) just like reports initiated directly from a KeyConfigure menu command. KeyReporter is designed to allow easy integration back and forth with other web pages.

The KeyReporter process interacts with the KeyServer process (and its databases) in much the same way as KeyConfigure. But unlike KeyConfigure, the KeyReporter process itself has no user interface - instead, a web browser is used as the front end for defining report templates, specifying scheduled run times, running reports, and accessing the archived results.

As illustrated in the diagram above, the combination of a Web Browser plus KeyReporter is roughly equivalent to the reporting functionality implemented by KeyConfigure alone. However, KeyReporter has the added benefit of customizable dashboards, which are a convenient summary view that avoid the need for logging into KeyConfigure until maximum detail and configuration is needed. Use your favorite web browser to connect to the KeyReporter web server process- the url is the ip address (or a DNS name) of the computer hosting KeyReporter.

KeyReporter is an optional component included in the K2 toolkit - the same set of "report modules" is used by KeyConfigure to display usage and audit summary reports in its own windows without using a web browser. KeyReporter is installed along with KeyServer, and when you first connect with KeyConfigure, you will be prompted to turn on KeyReporter. We recommend enabling KeyReporter, if only for the dashboard functionality. Additionally, you may find the scheduled reports useful, either to ensure that reports are run and archived at set intervals, or to run slower reports automatically so that you don't have to wait for them. Access to KeyReporter's archive of completed reports from either a web browser or KeyConfigure is an additional benefit.

As shown in the diagram above, KeyReporter gathers data from KeyServer just like KeyConfigure – so like KeyConfigure, it must login in to KeyServer using a specific account and password. By default, KeyServer is configured with both a Guest account and a Schedule account enabled. The Guest account is used internally by KeyReporter when someone in a browser clicks Guest. By default, guests can ONLY see the Availability widget, showing divisions for which a map has been defined. For more about the Guest account, see the Guest Access section of the KeyReporter documentation. You can change the Guest behavior by changing what roles and permissions the KeyReporter Guest account has, in the Roles and Accounts window.

The Schedule account is used internally by KeyReporter in order to run reports on schedules, whenever schedules have been configured by other administrators. By default the Schedule account has enough permissions to run reports. Still, each administrator can only create schedules if they have the necessary permission. To disable scheduled reports entirely you could modify the KeyReporter Schedule account in the Roles and Accounts window, but this is not recommended.

KeyServer creates random passwords for its default communication with the KeyReporter process unless it has been installed as an upgrade to a previous installation where the passwords had already been set. Under normal circumstances, no one would manually login as KeyReporter Guest or KeyReporter Schedule so these passwords do not need to be known – but if you created them in an older KeyReporter version, they should none the less be strong. These passwords can be changed in KeyConfigure in order to support hosting of the KeyReporter process on a separate computer – but this is rarely desirable. Contact tech support if this is relevant.

Enabling KeyReporter

KeyReporter is installed along with KeyServer, and KeyConfigure will prompt you to turn KeyReporter on:

Wizard for turning on KeyReporter

The wizard will walk you through configuration of ports (which default to standard http/https ports) and enabling Guest access if that is your desired configuration. For more details see the page about KeyReporter Setup.

Builder

The Report Builder page is used to create new reports and templates (including scheduled templates).

By default, the Builder page is not available for guest access. Because the KeyReporter Guest account has "Public Role" permissions, guests can "run" a report if a Quick Link widget has been added to the Guest dashboard, or "view" reports saved for guest access but a guest can't "build" a new Template nor define a new report. You can allow a guest to run their own reports by giving them a Role that has the "Build Reports" privilege in the "KeyReporter Privileges" section of Role Details.

On the builder page you can choose a report module and then specify appropriate parameters such as a time period. The various report module choices are grouped according to type: Login Reports, Usage Reports, etc.

Just like in KeyConfigure, a general (COMP x lic) report can be restricted to a single computer instead of including all Computers. Click on the "Subject" field in the form to search for the Computer you want to limit to.

Archive

The Archive page lets you see all templates, schedules, and completed reports. You can sort and filter this list. You will see reports that have been run manually in KeyReporter, generated in order to provide data for dashboard widgets, run on schedules, or run manually in KeyConfigure.

Within this list, you can see the result of a complete report in your browser by clicking the gray arrow icon. There is also a small gear icon at the left of each row that gives you further options such as viewing a report in KeyConfigure, or editing a schedule.