KeyReporter Setup

KeyReporter is a web service hosted on the KeySever computer. It provides access from any web browser to a dashboard showing KeyServer reports which can be run on demand, scheduled, and archived.

Turning on KeyReporter is optional, but is highly recommended so that you may take advantage of the customizable dashboards, availability maps, and report scheduling. When enabled, the KeyReporter web server process will be automatically sub-launched by KeyServer on the KeyServer host computer.

If you have previously installed an version of KeyReporter older than 7.2, check the upgrade documentation and the KeyReporter documentation for details on upgrade steps and configuration changes.

KeyReporter Setup screen 1

When an admin with appropriate permissions first logs in to KeyConfigure, they will be prompted to turn KeyReporter on:

A web browser connection to KeyReporter (using the KeyServer DNS name or ip address for the url) will display a login screen. Privileges can be set up in KeyConfigure to control which reports are available through the KeyReporter web interface and to which login accounts. The KeyReporter login page also supports a "Guest" login, which by default, is set to bring up the "Availability widget". This widget initially just acts as an invitation to explore the possibilities for guest access – but before it can actually show anything, it has to be configured. Read the Guest Access section of the KeyReporter documentation and the Roles and Accounts documentation for details and for things to check if you are upgrading from a pre-7.2 KeyReporter version.

KeyReporter Setup screen 2

Next you are prompted to choose the ports which KeyReporter will run on. By default, the standard http and https ports are filled in on this screen.

It is probably most convenient to run on the standard ports. But if you already have a web server running on the KeyServer host computer, here you can configure KeyReporter to use different ports – then when you click Next, the setup wizard will check to determine if the custom ports you have chosen are in fact available. Of course the use of non-standard ports will mean that these port numbers must be explicitly included as part of any url that is used to connect to the KeyReporter web service.

KeyReporter Setup screen 3

If the port checks succeed, you are taken to the final screen.

Rather than using the ip address of the KeyServer host (as displayed in the screen shot above), typically you will want to set up a dns name for this server– e.g. http://keyreporter.mycompany.com.

In any case, from KeyConfigure, you can quickly jump over to the KeyReporter dashboard. Just use the first item in KeyConfigure's Reports menu, "Show Dashboard in Browser" – and the correct url will be handed off to your default browser. Note: when first connecting with a browser to KeyReporter, the actual data available for summarization by the various dashboard widgets will of course depend on what data is available from the KeyServer databases. If this is a new install, don't expect to see much until several client computers have had a chance to upload audit and usage data.