Important changes 6.0 -> 6.1

There are many new features in K2 6.1, but only a handful which will be immediately apparent. This document is intended to describe those changes which a 6.0 admin will notice right away, and will have to understand in order to use KeyConfigure 6.1. If you are simply looking for instructions on how to upgrade to 6.1, they can be found on the Upgrade page.

KeyAccess client — 6.0 versus 6.1

KeyAccess version 6.1 is required for Mac OS X running on Intel processors. KeyAccess 6.1 is recommended for all platforms in order to take advantage of the latest feature enhancements and bug fixes. In particular, enhanced computer hardware profiles (including display resolution and manufacturer) and better protection against duplicate computer records require KeyAccess 6.1. Except for these caveats, the older client versions are compatible with KeyServer version 6.1.

Computer Login Types

In KeyConfigure 6.0, computers were either set to login Allowed or login Prohbited. In addition, allowed computers could either be set to audit or not to audit. In KeyConfigure 6.1, these settings have been combined in order to simplify the interface. There are now three types of Login: Full, Basic, and Prohibited. The following table describes how settings in 6.0 correspond to settings in 6.1:

6.0 settings6.1 settings
"Allowed", "Audit" "Full"
"Allowed", "Don't Audit" "Basic"
"Prohibited" "Prohibited"

Program Actions

In KeyConfigure 6.0, programs were either set to Controlled, Logged, or Ignored. In addition, programs could either be set to be audited or not to be audited. In KeyConfigure 6.1, these settings have been combined in order to simplify the interface. There are now four Program Actions: Controlled, Logged, Audited, and Ignored. The following table describes how settings in 6.0 correspond to settings in 6.1:

6.0 settings6.1 settings
"Controlled" (blue square), "Audit" "Controlled" (blue square)
"Controlled" (blue square), "Don't Audit" Not supported
"Logged" (yellow triangle), "Audit" "Logged" (yellow triangle)
"Logged" (yellow triangle), "Don't Audit" Not supported
"Ignored" (green circle), "Audit" "Audited" (green circle)
"Ignored" (green circle), "Don't Audit" "Ignored" (gray diamond)

Note that in 6.0, setting a program to Don't Audit would mean that KeyServer would not keep track of where it was installed. In 6.1, KeyServer always keeps track of where all programs are installed, but setting a program to Ignored will prevent it from being shown in standard audit reports. However, if you select "Show Installs" for an Ignored program, you will still be able to bring up a window showing where that one program is installed. Also, if you change the program to Audited, it will immediately start showing up in Audit reports.

There are two things you should notice about this reclassification. First, any programs set to Ignored in 6.0 will still be called "Ignored" in 6.1 provided they were also set to "don't audit". Usage will not be logged nor will those programs show up in Audit reports. On the other hand any Ignored programs that were set to Audit will be converted to the new 6.1 category of "Audited" -- usage of these programs will not be logged but the programs themselves will appear in audit reports. Note that in both cases there is no change in behavior, just a reclassification of one category into two. You should not be surprised if most of your "Ignored" are called "Audited" in 6.1.

Second, if you did happen to have any 6.0 programs which were Logged or Controlled and which were set to "Don't Audit", they will still be called "Logged" or "Controlled" in 6.1, but they WILL be audited and will show up in standard Audit reports. That is, any "Logged" or "Controlled" programs in 6.1 are always audited.

Discovered items

In KeyConfigure 6.0, Discovered programs and Discovered computers were drawn in pink. The feature was the same for both Programs and Computers, so to simplify the rest of this paragraph, we'll discuss Programs in particular, but everything applies to Computers as well. The purpose of showing discovered Programs in pink was to allow adminstrators to quickly see what new programs had been found since the last time they had looked at the list of programs. They could then choose what action to assign these programs, and the idea was they should acknowledge them after looking through them, so that the next time they saw Discovered programs, only new ones would be included. This system helped administrators categorize programs as they were discovered, but still required them to look through thousands of items. KeyConfigure 6.1 has an interface where "Rules" can be set up. This allows programs to be automatically categorized according to whatever rules you have configured - such as filters on program path or software company name. Administrators will still have to manually configure licenses for programs they wish to control, but Rules should eliminate much of the work of deciding between Ignored and Logged. Rules are applied to discovered programs only. Therefore, normal behavior is for rules to categorize discovered programs, and administrators may never have to look at these programs, or explicitly acknowledge them. Since it is expected that many many more programs will remain "Discovered", these items are no longer drawn in pink. They are indicated by a much more subtle pink filter icon in the Folder column of the Programs window. Rules are shown on the left hand side of the Programs window, in the filters section. KeyConfigure 6.0 had a default "Discovered" filter, which was followed by any user defined filters. KeyConfigure 6.1 shows rules in the filters section, in order of precedence, followed by a horizontal line, followed by user defined filters which have no rule attached. The "Discovered" filter is always the final rule, which gets applied to new programs which don't match any of the other rule filters. See the Programs Window Documentation for more about rules.

Custom Columns

In KeyConfigure 6.0, each window contained the columns which seemed the most useful to the most number of users. However, we often got requests for certain columns which were not shown, but which certain administrators wanted to be able to see, for one reason or another. In 6.1 KeyConfigure, there is a new feature which allows administrators to customize what columns are shown in each window. There are many columns which are not shown by default, but which can now be added to the display. Likewise, any default column which an adminstrator is not interested in can be hidden. Columns can also be re-ordered. Any window can have columns customized - just right-click in a column header within the window, and select "Customize Columns". Most standard windows have additional columns which can be added to the default display. Some reports (but not all) also have additional columns. This feature makes the information presented in KeyConfigure windows much more flexible and extensive. If you STILL feel that there is a column missing, let us know by emailing, since we may be able to add it in a future release.

Custom Reports Menu

The Reports menu in K2 version 6.1 groups reports by category and uses sub-menus to list individual reports. This makes the menu easier to use and the reports easier to find. You can revert to the 6.0 menu style where all reports appear in a single long list just by deleting (or re-naming) the ”reportmenu.xml“ file which is located in ”../Sassafras K2/Admin/Report Modules“. Use a text editor to customize this file in order to change the order or hidden attributes of Reports menu items.

Report Changes

There have been a variety of changes to KeyConfigure's internal reports. The most noticeable and important ones are briefly described below:

  • Enhancements to the way KeyServer and KeyAccess track logged-only program usage make the Histogram (PROG) report much more meaningful in 6.1. Note: all clients (as well as the KeyServer) must be upgraded to KeyAccess version 6.1 in order to take full advantage of these enhancements.
  • Usage reports have two average columns - an average time and an average count. In 6.0, these averages were per computer per week. In 6.1, they are simply per week - e.g. Average Count = Total Count / Number of Weeks.
  • Reports may have optional columns, as described in the previous section. In particular, all grouped reports have an optional column called "Count Details". This column only has a value for group lines, and shows the number of detail lines displayed within that group.
  • Compliance (COMP x lic) and Compliance (LIC x comp) have been renamed to Node Locked (COMP x lic) and Node Locked (LIC x comp) to more accurately reflect what they report on.
  • New chart reports: Histogram Logins (DIV), Daily Logins (DIV), Weekly Logins (DIV). These reports are similar to existing chart reports, but show concurrent logins within each division, instead of concurrent usage of programs or licenses.
  • The old KeyServer 5.2 ”Legacy Reports“ (based on old format text log files) are supressed by default from the Reports menu. Edit the ”reportmenu.xml“ as described above in order to include legacy reports in the Reports menu.

KSR file format

KeyConfigure 6.1 can save reports in the ksr file format, in addition to html or text. A ksr is a file which can be opened by KeyConfigure. It contains all information from the original report which was run, so when opened, will present a window that looks almost exactly like the original window. The ksr window can still be sorted by different columns, etc. This is the best way to view a saved report.


K2 6.1 has a new component named KeyReporter. Read more about it here.