KeyConfigure Internal Reports

Overview

KeyConfigure's internal reports allow administrators to seamlessly summarize usage and audit information, and view internal data in hundreds of ways. The reports are supported by KeyServer's various databases, which are also accessible externally through the KeyServer ODBC driver, ksODBC, using any reporting tool. The internal reports have the advantage of being integrated into the User Interface.

In addition to using the Reports menu, specific reports can be invoked using the context menu attached to any appropriate selection in the user interface - this has the effect of passing the selected item as a parameter to refine the report's scope. The context menu for any selected item will list only those reports which can accept that item as a parameter.

The following user interface items can be selected for use as a report parameter (via the context menu):

• Computer    (from the Computers Window - or other windows listing the computer name)
• Computer Login type    (from the Computers Window)
• Computer Division    (from the Computers Window)
• Computer Filter    (from the Computers Window)
• Program    (from the Programs Window - or other windows listing the program name)
• Program Action    (from the Programs Window)
• Program Folder    (from the Programs Window)
• Program Filter    (from the Programs Window)
• License    (from the Licenses Window - or other windows listing the license name)
• Time Set    (from the Time Sets Window)
• User    (from the Users Window)

You can also select multiple items. e.g. if you select five computers, then right-click and select a report, it will only contain data from those 5 computers. In this case, the Report Options dialog that comes up will have a checkbox labeled "Aggregated". Checking this box will combine usage from all five computers into a single line item (named "*"). Leaving it unchecked will show five distinct entries for the five computers, as always.

Once a report has finished building its display, any item in the report can be manipulated in all the same ways that are familiar in other windows: double-clicking will open the details for the object, items can be dragged into appropriate targets, etc. You can even select a line in a report window and use the context menu to run a "sub-report" on just the selected item.

Many columns in the reports will sort when you click in the column header. This is extremely useful for quickly finding the most extreme cases of any particular attribute (e.g. program which is used most often, or for the most hours, etc.). Also, many reports have columns which are not shown by default. For example, all grouped reports have an optional column named "Count Details". This column allows you to see how many details lines are contained under each group line. If you right-click in any of the column headers, you will be able to Customize Columns, and show columns which are hidden by default, or hide default columns which you are not interested in.

KeyConfigure 6.2 has a powerful new feature - reports can have multiple views. What this means is that you can run a report once, then view the data in more than one way (beyond simply sorting by different columns). In most reports this is used to allow you to "flip" the report. That is, you might run a Usage (COMP x lic) report and then decide you really want to see all the computers that have used a license. Instead of running a second report, you can simply switch this report so that it shows license groups instead of computer groups. The data is essentially the same, it is just organized differently. If a completed report has multiple views, you will see two little arrows next to the report name in the upper left of the report window. Clicking on the report name will bring up a pop-up menu that allows you to change views.

As each report is opened from the Reports menu you will see a report options dialog where you can typically specify a date range on which to run the report. This date range will then be used for any reports which are invoked from a context menu within the original report. For example, after running Logins (DIV x comp) from the Reports menu on a time period of "This Week", if you right-click a computer Division within that report and then invoke the Usage (DIV x prog) report you will see just the program usage from this week for computers belonging to the selected division.

Also new in KeyConfigure 6.2, you can specify in the report options that you want to "Accumulate into the times checked below:". After checking this option, you must put check-marks next to the Time Sets in the list which you wish to include in the report. Basically, this will split usage into recurring time ranges. For example, you could run a Usage (COMP x lic) report on a Date Range of Last Month, but using Time Sets, could further distinguish usage by working hours vs non-working hours. In order to use this option, you must first define Time Sets by creating them in the Time Sets window via a right-click. When you use Time Sets in a report, they will add an extra level of detail to the report. So in the Usage (COMP x lic) example, you will end up with a report with three levels of detail instead of two. You are able to include overlapping Time Sets in a report, but the results may be easier to use if you use non-overlapping Time Sets. You may always select Unspecified times, which will collect usage that is not included in any other Time Set you have selected.

With proper ODBC support, all internal reports can be pointed to a high performance database server as data source instead of to the KeyServer. This option is available from the Options button with the Report Options dialog. See Exporting and Report Options Dialog for more information.

Reports can be saved using the "Save" or "Save As..." menu items from the File menu. Various formats including HTML and TEXT are available in a pull down menu from the save dialog. There is also a special format, "KS Report Document" or KSR, that offers a compact, single file format for text and graphics that is readable by KeyConfigure. When a KSR is opened by KeyConfigure, the window it is presented in will look almost identical to the original report window. Columns will still be sortable, and items such as Computers can still be double-clicked, if you are connected to the KeyServer. Reports can also be printed from the file menu.

Program Actions displayed in reports

Generally speaking, all reports will ignore data from programs which are currently set to Ignored. So, even if a program was set to Logged in the past, usage reports will not select launch and quit events if the program is now set to Ignored. Presumably if a program is now set to Ignored, an administrator has decided that usage information on that program is not interesting, so reports should not show information on usage of the program. In addition, while Audit related reports will show data for programs which are set to Audited, Usage related reports will not - they only show data for Logged and Controlled programs. One exception to this rule is the Event Dump report, which is designed solely to show an exhaustive list of all events in KeyServer's usage database.

Computer Login types displayed in reports

Most reports will show data from all computers. However, Audit related reports will only show data for computers which are currently set to be included in audits.

Naming Conventions

The report names are meant to be short, yet understandable and meaningful. We use the following standard abbreviations:

• comp - Computer
• div - Division
• fix - Hotfix
• fldr - Folder
• lic - License
• pool - License Pool (e.g. the name of the Group used as an access restriction for a license pool - configured in the details of a custom license)
• path - Path
• prog - Program
• sn - Serial Number
• user - User

These abbreviations are used within parenthesis following the name of various reports. If there is only one term, the report will usually generate a flat list. For example, "Histogram (PROG)" indicates a list of programs. If there are two terms in parenthesis, the first term (CAPS font) indicates the summary (header) records. Below the expansion triangle for each summary record, the detail records (lower case font) are listed. For example, "Usage (COMP x lic)" indicates a usage summary, where summary lines are computers, and detail lines are licenses  -  "under each COMPuter, list in detail the licenses that were used". In some cases, there may be a third level of detail, but this will not be referenced in the report name.

Report Categories

• Audit - Reports that list programs deployed on each computer or relevant licenses controlling these programs.
• Chart - Histograms of concurrent usage or logins.
• Control - Reports that show control policies - what licenses control which programs.
• Denial - Reports summarizing program Denial events.
• Login - Summaries of who logged in where, and for how long.
• Miscellaneous - Reports that may be useful for very specific situations.
• Node Locked - Reports that compare deployment and usage data to license configuration data.
• Summarize - General Summaries of configuration and usage.
• Usage - Two-level usage summaries of program or license usage.

Audit reports

installed programs
RUN Audit (COMP x prog)
RUN Audit (PATH x prog)
RUN Audit (PROG x comp)
RUN Audit (PROG x path)
RUN Audit (PROG x sn)
RUN Audit (SN x prog)

These reports show which programs are installed on various computers. When they are first completed, they are collapsed by default. This is because they may contain huge amounts of information. You can expand any particular group you want to look at by clicking on the triangle next to it, or you can right-click in the report window and Expand All. The most basic of these reports are Audit (COMP x prog) and Audit (PROG x comp), and they simply show which computers have which programs installed. The others are new for 6.2. They group audit entries by path or serial number, regardless of what computer the audit information comes from.

• The "Name" column tells the name of the computer or program variant (as named in the computer or programs window).
• The "Variant" column shows the masked version number for a program or the complete KeyAccess version number for a computer.
• The "Action" column show how a program is being managed.
• The "First Seen" column is used in detail lines to show when a program was first discovered on each computer. In summary (header) lines of Audit (COMP x prog), it shows the most recent audit date (using italic font).
• The "Last Used" column shows the date when the program was last used on a computer. In a summary line, it is the most recent of all the times listed in the detail lines below (note that this information is recorded as part of an audit, so if a computer has recently used the program but has not since performed an audit, the recent usage will not be reflected).
• The "Copies" column shows the number of copies of a particular program which are installed on a particular computer (for detail lines), and for group lines, shows the sum of the values in the detail lines for that group.
• The "Identifier" column shows the Program identifier (for the program family), or for a computer line, the last user of the computer (in italic font).

The Audit (COMP x prog) report lists under each computer, all the programs that are currently installed. This is similar to the information displayed when you select an individual computer and use its context menu item, "Show Installs". However, the report lists program variants while the "Show Installs" context menu lists variants and individual distinct versions. This report has the advantage of consolidating the audit for all computers (or a selected Division) into a single window while supressing unnecessary distinct version details.

The Audit (PROG x comp) report lists under each program, all the computers where it is currently installed. This is similar to the information displayed for a single selected program using "Show Installs" from its context menu. Note: in both cases the "programs" we are talking about here are actually "program variants" - the same items that appear in the Programs window. To list instead the computers where a fully specified version is installed, use the "Version Installs" button in the program details window rather than the "Variant Installs" button (which does the same thing as "Show Installs").

baseline / delta programs
RUN Audit Baseline (COMP x prog)
RUN Audit Delta (COMP x prog)

The Audit Baseline (COMP x prog) report shows where programs were deployed as of the "baseline" date. By default, the baseline date for each computer is the time of first audit. This can be reset in the Computer Details window. All of the other audit reports show current program deployment based on all the most recent audit data available. You control how "current" to maintain the audit data in the "General Settings..." dialog from the Admin menu.

The Audit Delta (COMP x prog) report is conceptually the difference between Audit (COMP x prog) and Audit Baseline (COMP x prog) - it shows what programs have been installed, updated, or removed between the baseline audit date and the current audit date.

Both of these reports have the same columns as the Audit (COMP x prog) and Audit (PROG x comp) reports, but they also have additional columns.

• The "Date Stamp" column shows the date which is most relevant to that row of the report. For a computer, this shows the date of the Baseline Audit on the computer. For a program in the Baseline report, it shows the date when the program was discovered on the computer. For the Delta report, it shows the date when a change was observed. If the program was newly installed, this is the date when it was first seen. If the program was uninstalled, this is the date when it was last seen.
• The "Change" column in the Delta report shows what has changed.
  • "Installed" means that no version of the program was in the Baseline Audit, but it has since been installed.
  • "New Vers" means that there was some version of the program in the Baseline Audit, but since then, another version of the program has been installed as well.
  • "Changed Vers" means that there was one version of the program in the Baseline Audit, but since then, it was deleted, and replaced by a different version of the program.
  • "Deleted Vers" means that there were two or more versions of the program in the Baseline Audit, and since then, at least one has been deleted, but at least one is still installed.
  • "Deleted" means that one or more versions of the program were in the Baseline Audit, but all copies of the program have since been deleted.
• The "Version" column identifies a particular version within the program variant. In the Baseline report, the highest numbered version discovered on each computer is shown. In the Delta report, when a program is added, deleted, or upgraded, the specific program version is shown.

programs controlled by a license
RUN Audit Licenses (COMP x lic)
RUN Audit Licenses (LIC x comp)

These reports show audit information, organized by license. Instead of simply showing where every program file is installed, they show where any program controlled by a certain license is installed. This allows you to quickly see which computers could request a certain license, and which licenses a particular computer could request. Note: audit data comes from local file systems only - none of the audit reports give any information about possible access to programs from a file server or other shared file system.

Since a single license can control multiple programs, the Audit License (COMP x lic) report may list the same license multiple times under one particular computer (one entry for each program controlled by the license that was found on this computer). If there are distinct licenses controlling the same program, you will see the same computer appearing under each of the licenses (assuming the computer has a copy of this program installed). This may be confusing at first: the point is to reveal what the audit tells you about which licenses might potentially be requested from each computer based on any relevant programs that are installed. The "Last Used" time along with various usage reports will tell you which licenses have actually been requested.

• The "Name" column tells the name of the computer or license.
• The "Limit" column shows the license limit for license lines, and indicates whether it is a Node Locked license.
• The "Program" column shows which program controlled by this license is installed on the computer.
• The "Variant" column specifies which variant of the program is installed on the computer.
• The "Last Used" column tells when the program variant was last used on the computer, and can help decide which licenses to reallocate (note that this information is recorded as part of an audit, so if a computer has recently used the program but has not since performed an audit, the recent usage will not be reflected).
• The "Copies" column tells how many copies of the program variant are installed on the computer.

All programs, even those that are not installed
RUN Audit Summary (PROG)

This report summarizes Audit information for all programs which are not set to Ignored. It is similar to a fully collapsed Audit (PROG x comp) report, but there is one important difference. Audit (PROG x comp) only shows programs which are currently part of an audit of some computer. Audit Summary (PROG) shows ALL non-Ignored programs, regardless of whether they are currently part of an audit. This lets you identify programs which are no longer installed on any of your clients.

• The "Name" column tells the name of the program variant (as named in the programs window).
• The "Variant" column shows the masked version number of the program.
• The "Action" column shows how a program is being managed.
• The "Last Used" column shows the date when the program was last used on any computer (note that this information is recorded as part of an audit, so if a computer has recently used the program but has not since performed an audit, the recent usage will not be reflected).
• The "Copies" column shows the number of copies of the program which are installed.
• The "Identifier" column shows the Program identifier.
• The "Active" column shows a checkmark if the program is installed on any computers. This column is the default sort.

installed hotfixes
RUN Audit (COMP x fix)
RUN Audit (FIX x comp)

These reports are new for K2 6.2, and show which hotfixes are installed on various computers. The format is very similar to Audit (COMP x prog) and Audit (PROG x comp).

Chart reports - Daily reports

These reports let you see visually the pattern of usage of a program or license throughout the course of an "average" day. When the report is run on usage data spanning several days, all of the 1 pm data is averaged together for the 1 pm display, all the 2 pm data is averaged together for the 2 pm display, etc. Each "bar" of the histogram represents 10 minute of the day. The right side of the window lists each program or license, and when you click on one, a graph is drawn on the left side of the window. The Daily Logins (DIV) report shows graphs of users logged into computers within the various divisions.

• The black part represents the average (over the various days) of the maximum usage values during that hour of the day.
• The red part represents the average (over the various days) of the maximum queued values during that hour of the day.
• The first line of Daily (LIC) says "KeyServer" and will show you a graph of "KeyServer usage" - that is, users logging on to the KeyServer, and logging off again.
• The horizontal axis labels the hours of the day from Midnight to Midnight.
• The name of the program or license is displayed below. If it is a program, it is followed by the version, and either M or W (Macintosh or Windows), and possibly K (Keyed).
• Peak usage and other summary statistics are calculated. For a license, these statistics include the license limit and maximum length of the waiting queue (for the entire data set selected by the report).

Clicking on the graph (left) portion of "Daily (License)" will toggle between choosing the vertical axis to show the license total (if not infinite), and showing only up to the peak usage. This is useful if the license total is significantly higher than the peak usage, because it magnifies the vertical differences.

Chart reports - Histograms

These reports let you see visually the pattern of usage of a program or license. The right side of the window lists each program or license, and when you click on one, a histogram is drawn on the left side of the window. The Histogram Logins (DIV) report shows graphs of users logged into computers within the various divisions.

• The black bars represent the maximum concurrent use of the program or license during each time slice.
• If there is red drawn, that shows that there was a waiting queue for the license (or the license controlling the program).
• The first line of Histogram (LIC) says "KeyServer" and will show you a histogram of "KeyServer usage" - that is, users logging on to the KeyServer, and logging off again.
• In Histogram (PROG), the programs are divided into two sections: first the Controlled programs are listed, then the Logged programs are listed. This is to emphasize the fact that the usage information for these two types of program is tracked slightly differently.
• Below the histogram, the beginning and end time of the x-axis are printed.
• Next, the name of the program or license is displayed. If it is a program, it is followed by the version, and either M or W (Macintosh or Windows), and possibly K (Keyed).
• Next, there is a series of lines describing highlights of usage, such as peak usage. For the license histogram, there are more lines, since licenses can have a limit, and waiting queues.

Clicking on the histogram (left) portion of "Histogram (LIC)" will toggle between choosing the vertical axis to show the license total (if not infinite), and showing only up to the peak usage. This is useful if the license total is significantly higher than the peak usage, because it magnifies the vertical differences.

The Histogram reports have many columns which are hidden by default. These are the same columns which are shown in the Summarize reports.

Chart reports - Histogram Lease

This report is much like Histogram (LIC), but instead of charting license usage over time, it charts allocations of the license over time. So for a lease or node locked license, this report gives the graph of the value that is restricted by the license limit. So while Histogram (LIC) will give you a better sense of actual usage patterns, Histogram Lease (LIC) will show you how close to the license limit you actually got over time.

Chart reports - Weekly reports

These reports let you see visually the pattern of usage of a program or license throughout the course of an "average" week. When the report is run on usage data spanning several weeks, all of the Monday data is averaged together for the Monday display, all the Tuesday data is averaged together for the Tuesday display, etc. Each "bar" of the histogram represents 1 hour of a day. The right side of the window lists each program or license, and when you click on one, a graph is drawn on the left side of the window. The Weekly Logins (DIV) report shows graphs of users logged into computers within the various divisions.

• The black part represents the average (over the various weeks) of the maximum usage values during that part of the week.
• The red part represents the average (over the various weeks) of the maximum queued values during that part of the week.
• The first line of Weekly (LIC) says "KeyServer" and will show you a graph of "KeyServer usage" - that is, users logging on to the KeyServer, and logging off again.
• The horizontal axis labels the days of the week starting with Sunday.
• The name of the program or license is displayed below. If it is a program, it is followed by the version, and either M or W (Macintosh or Windows), and possibly K (Keyed).
• Peak usage and other summary statistics are calculated. For a license, these statistics include the license limit and maximum length of the waiting queue (for the entire data set selected by the report).

Clicking on the graph (left) portion of "Weekly (License)" will toggle between choosing the vertical axis to show the license total (if not infinite), and showing only up to the peak usage. This is useful if the license total is significantly higher than the peak usage, because it magnifies the vertical differences.

Control reports

Control (LIC x prog)

This report is intended to give you an overview of what programs each license controls. The summary lines show licenses, while the detail lines show programs. Many licenses will most likely control a single program, so often you will see a strict alternation of one summary header for the license, one detail for its single program.

• The "Name" column tells the name of the license or program.
• The "Variant" column only applies to program lines (details). It shows the version of the program variant, and also indicates whether the program is keyed.
• The "Limit" column only applies to the license lines, and shows the license limit.
• The "Type" column only applies to license lines. It indicates whether the license is a "Site", "Node", "Lease", "Floating", or "Custom" license.
• The "Offline?" column shows a checkmark for programs which are allowed to launch offline.
• The "Group" column indicates if there is a group restriction on the license. If the license is a custom license, you may see "multiple (custom)" in grey, meaning that there are multiple pools with different group restrictions.

Control (PROG x lic)

This report is intended to give you an overview of how each program is being controlled by KeyServer. The summary lines show programs, while the detail lines show licenses. A third level of detail shows each pool for a license. Every license has at lease one pool.

• The "Name" column tells the name of the program or license. In some cases, following a license name, the column may be blank for some number of lines. This means that the license is a custom license, which has multiple pools. In this case, there is one line for each pool, but since they all belong to the same license, the name of the license is displayed once for the first pool, and suppressed for subsequent pools.
• The "Variant" column only applies to program lines (summary headers). It shows the significant digits of the program variant, and also indicates whether the program is keyed.
• The "Limit" column shows how many copies of the program or license (under the proper circumstances) can be used at once. For a program, it is the sum of the totals of all the licenses which control the program.
• The "Type" column only applies to license lines. It indicates whether the license is a "Site", "Node", "Lease", "Floating", or "Custom" license.
• The "Offline?" column shows a checkmark for programs which are allowed to launch offline.
• The "Group" column indicates if there is a group restriction on the license, if it is not a custom license. For custom licenses, the column contains the group for each pool of the license.

Occasionally, you may see "license not found!!!" in red. This means that a license was deleted, but a program is still supposed to be controlled by the missing license. If the program is controlled only by the missing license, the result will be that the program cannot be run.

Denial reports

These reports are very simple - they show which programs were denied (a user tried to run the program, but was denied because they could not get a license for the program), and how many times they were denied. These reports always involve programs, since that is what gets denied.

• The "Name" column tells the name of the program / computer / division / user.
• The "Variant" column only applies to program lines. It shows the significant digits of the program variant, and also indicates whether the program is keyed.
• The "Type" column indicates the action for a program, or the platform for a computer. It is empty for division and user lines.
• The "Count" column tells how many times the program was denied.
• The "Last Denied" column tells when the most recent denial occurred.

Login reports

These reports summarize Login information. They show who logged in from where, and for how long.

• The "Name" column shows the name of the computer, division, or user.
• The "Type" column shows the client platform: Windows or Macintosh.
• The "Total Time" column shows the total login time (hours:minutes). For a summary line, it is the total login time for all the detail lines listed below the expansion triangle. For a detail line, it is the total login time for that particular detail record.
• The "Total Count" column shows the number of sessions (logout events) which are summarized on the line.
• The "Avg Time" column shows the average login time per week (hours:minutes). If the report is on less than half a week, this field shows "N/A", since an average would be misleading.
• The "Avg Count" column shows the average number of sessions per week. If the report is on less than half a week, this field shows "N/A", since an average would be misleading.
• The "Last Session" column shows the time of the last logout. This does not give you any information on a currently active session, if any.

Miscellaneous reports

Duplicate Names (COMP)

This report is similar to the Hardware report, but it only shows computer records which may be Duplicates. Duplicate computer entries occur when a single client computer is unreliable in recognizing hardware properties such as MAC address. KeyAccess on that computer may start out using one computer ID, but then be forced to switch IDs when the hardware properties appear to have changed.

If the report gives the message "No data to report on", it means that your data does not contain any duplicate computer entries.

If the data in a column is displayed in bold, then the computer ID for the computer is based on that piece of data. For example, if the MAC column for a particular computer is in bold, then the computer ID is the letter "N" plus the MAC address. If the value is also dimmed (medium grey instead of black), then the computer record doesn't actually have a value recorded for this property, but it is displayed in the report since it can be inferred from the computer ID.

The "Dup?" column lets you sort apart the computers according to what type of entry this report has guessed that they are. If this column is empty for a particular computer, it means that this computer record is almost certainly still in use, and should not be deleted. If the column contains a question mark (?), then this row shares the computer name with another entry, but has a distinct MAC address. This means that the computer could be a duplicate entry which should be deleted, or it could be a unique entry which simply has the same computer name. For these rows, you should sort by name, and compare this row to other rows with the same name, to see if other hardware properties match or are distinct. If the column contains a red "x", then this row is almost certainly a duplicate and should be deleted. Not only does it share the computer name with another entry, it also has the same MAC address (or the other entry has a MAC address and this entry has no known MAC address).

This report is intended to be used in order to identify and delete duplicate computer entries. After running the report, it is recommended that you create a new computer division, to temporarily move duplicates into. Then sort the report by the "Dup?" column. Scroll to the bottom and select all the computers with an "x" in that column, then drag them to the new division. Now you can filter the main computers window to show only those computers in the new division, select them all, and cut them (delete them).

Event Dump

Event Dump is the most detailed report on usage information. As such, it is probably not generally that useful, but is extremely valuable in certain situations. It shows, in chronological order, one line for every single event which KeyServer records. All events relate to Server startup/shutdown, Computer audit, client activity, Program launch/quit, and License usage.

Caution: on a KeyServer supporting thousands of clients with heavy usage data going back several months, the Event dump might require several gigabytes of memory space to hold perhaps many millions of event records. In order to avoid virtual memory thrashing, you should always run the Event Dump report on a limited data set. Restrict to a specific time period of interest, and/or select a specific Computer, Program, or License. Use its context menu to run the report - this will download events concerning only the selected item.

• The "Name" column shows a name which is associated with the event. For server events, it is simply "KeyServer" (the name as configured in KeyConfigure appears in the "User" column). For logon/logoff events, it is the computer name. For programs, it is the program variant name. For licenses, it is the license name. This name, and the icon next to it, shows what details window will be opened when you double-click that line in the report.
• The "Vers" column shows the version of the KeyServer process, the version of KeyAccess which was used to log on/off, the version of a program, or the license total and type of a license.
• The "Event" column shows a short name for the event type. For program events, the icon for the program action is also shown. Note that the icon may not agree with the event type. The event type was recorded when the event occured, while the icon simply tells the current action for the program. For example, you may see a gray diamond for a logged launch event. This simply means that at the time of the event, the program was Logged, but now it is Ignored.
• The "Why" column shows a short description of why the event occurred.
• The "License" column shows the name of the enabling license, in the case of program launch events, and shows time at which the event began, for all "end" type events (shutdown/logoff/quit/return).
• The "When" column shows when the event occurred. This is the column on which the entire report is sorted by default.
• The "User" column shows the name of the user who triggered the event.
• The "Address" column shows the address of the computer on which the event occurred, at the time at which it occurred.
• The "Computer" column shows the name of the computer on which the event occurred.
• The "Extra" column shows the name of the group which enabled the usage event, if there was one.

This report can be given any of the four types of parameters (computer/program/license/user). Regardless of parameter type, server events are always shown.

• If a computer is the parameter, all events on that computer are shown (user events, license events, program events, audit events).
• If a program is the parameter, all events of that program are shown (only launch/quit events).
• If a license is the parameter, all events pertaining to that license are shown (license events, and program events which were enabled by that license).
• If a user is the parameter, all events for that user are shown (logon events, license events, program events, audit events).

Under a few conditions, lines will be highlighted in red. These are events where something is wrong. These are the specific conditions:

• The license no longer exists. In this case, "License Not Found" will appear in either the "Name" column (for a license event), or the "License" column (for a program event).
• The program is no longer known to the KeyServer (it has been manually deleted, or the programs table was deleted entirely). "Program Not Found" will appear in the "Name" column.
• This is a server startup event, and there is no server shutdown event in between the last startup event and this one. Thus, the server must have crashed at some point in between.

Hardware

This report is similar to the Computers Window, but shows many more attributes of each computer. All of the information displayed can be seen in each individual Computer Details Window, but this report allows all of the information to be seen at once, and will sort the computers by any of the attributes which are displayed. The Computers Window can in fact be customized to show additional values as well, but still, the Hardware report may be a convenient way to quickly see a long list of values for each computer.

If the data in a column is displayed in bold, then the computer ID for the computer is based on that piece of data. For example, if the MAC column for a particular computer is in bold, then the computer ID is the letter "N" plus the MAC address. Most likely, almost all of the computers will be using the same attribute for the computer ID. If the value is also dimmed (medium grey instead of black), then the computer record doesn't actually have a value recorded for this property, but it is displayed in the report since it can be inferred from the computer ID.

Lease Simulator (LIC)

This report helps you determine how many copies of a license you would need if you changed the license to a lease license. When it runs, it looks at historical license usage, and simulates what would have happened if the license had already been a lease license, and there were allocations of a lease, using different lease durations. You can run this report on any date range, but the longer the range you use, the more meaningful it will be. The format of the report is very simple - there are columns for various lease durations, so for each license, you can see what the maximum allocation would have been assuming those different durations.

Shadow

This report shows a list of shadows that served at some point in the specified time period.

• The "Address" column shows the address of the shadow.
• The "Total Count" column shows how many times the shadow served.
• The "Total Time" column shows how long the shadow served for (hours:minutes).
• The "Avg Time" column shows how long the shadow served, as an average per service interval (Total hours:mins / Total count).

Suite (LIC x prog)

This report shows you a summary of both license and program usage, organized by license. The group headers are licenses, and show usage summaries for each license over the time period. The details are programs, and show usage summaries for the program, in the cases where it was enabled by the particular license.

• The "Name" column shows the name of the license or program
• The "Variant" column shows the version of the program (with the keyed symbol, if appropriate)
• The "Computers" column shows a distinct count of the number of computers on which the license or program was used.
• The "Total Time" column shows the total usage time for the license or program (hours:minutes).
• The "Total Count" column shows the number of times the license or program was used.
• The "Avg Time" column shows the average usage time per week (hours:minutes). If the report is on less than half a week, this field show "N/A", since an average would be misleading.
• The "Avg Count" column shows the average number of uses per week. If the report is on less than half a week, this field shows "N/A", since an average would be misleading.

If the same program is controlled by multiple licenses, it may appear on multiple lines in the report, under different licenses.

It is important to note that the header lines do not necessarily show a sum of the detail lines. They show a usage summary for the license. So if it is a suite license (one which controls multiple programs), the license usage total may be less than the sum of the program usage totals, since computers may have used multiple programs at the same time. This is different from most reports, where intead each group line is a summary of the details below it.

Node Locked reports

Note that these reports changed substantially with the release of version 6.2.0.2 of KeyConfigure and KeyReporter. For documentation on the older version, refer to the 6.1 documentation.

These reports show information related to Node Locked licenses only. They show where node-locks have been allocated, where programs which are controlled by node-lock licenses are installed, and where these two conditions do not exactly correspond.

There are three basic cases which are represented in these reports.

1. A computer has a node-lock allocated to it for a license. It also has at least one program which is controlled by the license installed, and furthermore, that program has been used recently. This is the "normal" case, where node-locks have been allocated correctly.
2. A computer has a node-lock allocated to it for a license, but does not have any programs installed which are controlled by the license. This may happen if an administrator allocated node-locks manually, before installing software on the computer, or if a computer used a program once, but has since uninstalled the program. In this case, the node-lock is not necessary. In the same category are cases where the program is installed but has not been used in over 90 days. These are likewise candidates for removing the lock.
3. A computer has a program installed which is controlled by a node-lock license, but the license has not been allocated to the computer. This may happen if the program has been installed, but not yet used (or if a standard image installs the same program on all computers, regardless of whether it is needed on each computer). In these cases either the license should be locked or the program should be uninstalled.

Both reports show exactly the same information, but organize it in different ways. Since a single license can control multiple programs, there is a third level of detail showing the program or programs that are actually installed that correspond to each particular license/computer pair. The mid-level line (computer or license) shows the status for that computer/license pair. The top-level line shows an overall status for that computer or license, which summarizes and generalizes the status of the mid-level lines below that top-level line. Note that these reports get "Last Used" information from audit and Node Locked records - they do not directly access usage data. The only time Usage events would differ significantly from the data used here is if a license has been recently created.

• The "Name" column tells the name of the computer, license, or program.
• The "Variant" column specifies which variant of a program is installed on a computer.
• The "Issued" column shows how many licenses are issued (locked to computers).
• The "Limit" column shows the license limit.
• The "Status" column shows the status for the line. For a top-level line, it is a summary which essentially indicates whether the configuration of that license or computer needs any attention or whether it is correct as it is. For a mid-level line, it shows two pieces of information. First, it may or may not have a checkmark icon in it. If it does, the license is locked to the computer. Second, it has a short string describing the status of the license allocation for the computer, and perhaps suggesting what you may want to change about the license allocation. For a complete description of each status code, see the next section. If this field is highlighted in red, it is one of the "non-standard" cases, and you may want to change how licenses are allocated.
• The "Last Used" column tells when the program variant was last used on the computer - this can help you decide which licenses to reallocate.
• The "Copies" column tells how many copies of the program variant are installed on the computer.

Top-level Status strings:

• "OK" - this is the general category for top-level lines where everything seems to be configured properly.
• "Unclear" - this is the general category for top-level lines where a node-lock license controls software which is also controlled by a non-node-lock license. In such cases, it is hard to tell whether any given computer needs to have the Node Locked license locked, since it might be possible for it to also use the non-Node Locked license.
• "Optimize" - this is the general category for top-level lines where licenses are allocated to computers that don't seem to be using them.
• "Reconcile" - this is the general category for top-level lines where licenses are not allocated to computers even though software controlled by the license is installed on those computer. Note that "Optimize" takes precedence over "Reconcile". That is, if some license can be unlocked from some computers, and at the same time, other computers have the software installed, so it should be uninstalled, the Status for the license will be "Optimize" - since this is the more interesting action to take. If the license is Optimized, and then the report is run again, it will then show Reconcile.
• "Over-limit" - this is the general category for top-level lines where licenses are set to Over-limit, and in fact have more copies Allocated than the configured Limit. This takes precedence over both "Optimize" and "Reconcile", since it is a state which should be corrected.

Mid-level Status strings:

• "locked" - this is the "normal" case for a mid-level line - the license is locked to the computer, and a program controlled by it is installed. This falls under the general category "OK".
• "locked other" - a program controlled by this license is installed, and this license is not locked, but at least one other node-lock license which controls the same program IS locked on this computer. This falls under the general category "OK".
• "used non-node" - a program controlled by this license is installed, and this license is not locked, but the computer has used a different, non-Node Locked license to control use of the program - so presumably the computer does not require the Node Locked license to be locked. This falls under the general category "OK".
• "licensed other" - a program controlled by this license is installed, and this license is not locked to the computer. There is a non-Node Locked license which controls the same program, but it is unclear whether the computer has or could use the other license. This case is complex enough that the admin should look at the license configurations and decide which one is relevant to this computer. This falls under the general category "Unclear".
• "redundant lock" - a program controlled by this license is installed, this license is locked to the computer, and in addition, another Node Locked license controlling the same program is also locked to the computer. One or the other license should be unlocked since it is redundant. This falls under the general category "Optimize".
• "unlock" - the license is locked to the computer, but no programs controlled by the license are installed. Or, the license is locked but has not been used in over 90 days, and the computer is set to not audit, so it is not known whether or not the program is installed. If you are not going to install the programs in the near future (and you know the program is not being run off a network volume), you could unlock the license from this computer. This falls under the general category "Optimize".
• "unlock / uninstall" - the license is locked to the computer, programs controlled by the license are installed, but have not been used in over 90 days. Therefore, if you know the license is no longer needed on this computer, you should unlock the computer, and uninstall the software from the computer. This falls under the general category "Optimize".
• "uninstall" - a program controlled by the license is installed, but the license is not locked. The audit shows that the program has not been used in the last 90 days, so the software should probably be uninstalled. This falls under the general category "Reconcile".
• "lock" - a program controlled by the license is installed, but the license is not locked. The audit shows that the program has been used recently, so the license should probably be locked. You will generally only see this status if the program was recently changed to controlled, or if an admin has removed this computer manually from the node list for the license. This falls under the general category "Reconcile".
• "lock somewhere" - this is exactly like "lock", except that there are two or more Node Locked licenses that control the program - so you may want to lock a different license than the one you are looking at. This falls under the general category "Reconcile".

Summarize reports

These reports give an overall summary of configuration and usage statistics. Unlike the Usage reports, they do not show information about where licenses and programs were used, but they do give overall summaries like maximum Concurrent Usage.

• The first line of Summarize (LIC) says "KeyServer" and will show you a summary of "KeyServer usage" - that is, users logging on to the KeyServer, and logging off again.
• In Summarize (PROG), the programs are divided into two sections: first the Controlled programs are listed, then the Logged programs are listed. This is to emphasize the fact that the usage information for these two types of program is tracked slightly differently.
• The "Name" column shows the name of the program or license.
• The "Variant" column is only shown in Summarize (PROG) and shows the version of the program variant
• The "Type" column shows the type of the program or license.
• Summarize (LIC) has a "Limit" column which shows the license limit.
• The "In Use" column shows how many copies of the program or license are in use as of the end of the time range used for the report. If you selected a time range ending "now", this value in this column should match what you can see in the Licenses window or Programs (Controlled) window. However, it is only a "best guess" for logged programs, and may not be accurate.
• Summarize (PROG) has a "Deny" column which shows how many times a program launch was denied (controlled programs only).
• The "Max" column shows the Maximum number of copies that were in use at any particular time (Maximum Concurrent usage)
• The "Total" column shows the Total number of launch / license checkout events for the program / license
• The "Total Time" column shows the total amount of time (hours:minutes) the program or license was used for. If copies are still in use, this reflects usage up until the end of the time range for the report.
• Summarize (LIC) has four additional columns which show the current length of the waiting queue for the license, the maximum length of the queue, the total time spent on the queue, and the average time spent on the queue.

Usage reports

These reports all summarize usage information for licenses or programs (actually "program variants"). Each report pair presents the same information but with the summary and detail fields interchanged.

The division reports (DIV or div) aggregate together information from all the computers within each division.

The pool reports allude to the "pools" which can be set up in a custom license in order to enforce group membership requirements that restrict access to each pool. Pool reports show which group requirement allowed the usage of a license or program, either through a pool in a custom license, or through a group restriction for a license. Any usage which did not require group membership shows up as "unrestricted". If you have not set up groups, group restrictions on licenses, or custom licenses with multiple pools, these "pool" reports will not be very interesting since ALL usage would be detailed with a single line: "unrestricted".

• The "Name" column shows the name of the computer, division, license, pool, program, or user.
• The "Variant" column only appears in reports that show program usage, and contains the significant digits of the program variant (with the keyed symbol, if appropriate)
• The "Type" column shows the type of a computer, program, or license. It is blank for divisions, pools, and users.
• The "% Usage" column is only available in Usage reports where the primary group is a license or program. It shows what percent of the total usage time was contributed by each detail line. This could be useful for billback.
• The "Total Time" column shows the total usage time (hours:minutes). For a summary line, it is the total usage over all its detail lines. For a detail line, it is the total usage for that particular line.
• The "Total Count" column shows the number of usage events for each line. For a summary line, it is the sum of the counts for all the detail lines that appear below its expansion triangle.
• The "Avg Time" column shows the average usage time per week (hours:minutes). If the report is on less than half a week, this field shows "N/A", since an average would be misleading.
• The "Avg Count" column shows the average number of uses per week. If the report is on less than half a week, this field shows "N/A", since an average would be misleading.
• The "Last Used" column shows the last quit time for a program or license return time for a license within the time range of the report. This field will not reflect currently active usage of a program (or license) that has been launched but has not yet quit.

Related Topics