Program Details Window

Concept

The program details window displays the full configuration for any particular program variant selected from the programs window. For definitions of the terms "Program Version", "Program Variant", "Program Family" see the Programs Window Documentation.

KeyServer creates a default name for a new program family based on the internal properties within the first discovered executable file. Usually the program identifier is used, but when no internal properties are available, the first 8 characters of the executable's file name are used. This default name appears at the top of the Program Details window where it can be edited when you need to impose your own naming discipline for each program variant. The window also contains five panes with further information and configuration options. The default Program Details view exposes the Actions, Information, and Licenses panes. Other panes can be toggled in or out of view (and re-ordered) using the small icons at the top right of the window.

Actions Pane

This is one of the most important panes in the program details window but it is also can appear complex if many distinct versions of the selected program have been discovered . This pane lets you configure the KeyServer's basic actions concerning the selected program variant (gray highlight). Information about other variants in the same program family (if any) is also displayed in the Actions Pane - but this other information is not highlighted in gray and it cannot be changed in this window. The entire program family is displayed for contextual information purposes only - configuration changes have no effect beyond the gray highlighted item(s). If the program family has more than one variant, each must be configured from its own Program Details window. You can't open a second Program Details window by double clicking on a program name in the Actions pane - you have to go back to the Programs window (or to the Program Family window).

To the right of the actions drop down menu there is a version mask which looks something like: "x.x.x.x+size". This controls how many digits of version information are used to separate a program family into distinct variants. Regardless of how the program mask is set, keyed program versions (if any) must be managed as a distinct "singleton" variants within the program family. Therefore, if there are any keyed program versions, they will appear below a horizontal separating line and they will be unaffected by mask changes.

By default, the mask is all the way to the left (notice the gray vertical line to the left of the first x), meaning that all non-keyed versions of the entire program family are treated in the same way. Dragging the mask to the right will make the mask more specific, dividing the program family into multiple variants distinguished by one or more digits of version information. If you slide the mask to a new position and let go, the list of variants will show how the family is split - but the consequences of such mask changes won't actually take effect until you do a Save (or close the window). By default, individual program versions (that have been discovered by KeyServer) are hidden within each variant's disclosure triangle. Use the context menu "Expand All" if you want to see full detail showing all discovered versions and how the a particular mask setting aggregates them into variants. Use "Collapse All" to see just the variant names as they will appear in the Programs window (and in the Program Family window).

Remember, it is only the variant selected in gray that will be affected by options configured in the Actions pane:

• The first option is a drop down menu which lets you select Controlled, Logged, Audited, or Ignored. This determines how KeyServer treats usage of the program. Ignored means that KeyServer will entirely ignore usage of the program, and is useful for system utilities, such as screensavers. Audited means that KeyServer will show audits of the program in standard reports, but will not track usage of the program. Logged means that KeyServer will show audits of the program in standard reports, and will also log all usage of the program, but will never prevent it from running. Controlled means that KeyServer will show audits of the program in standard reports, and will also check the configured license policies before allowing the program to be used. If the program launch is successful, the usage is also logged. This menu is disabled for keyed programs, since the executable itself has been modified, and therefore can only be run as a controlled program.
  
  
• The Allow launch when KeyServer not available checkbox is only enabled for unkeyed controlled programs. It lets you configure whether the program launch will be allowed or denied if a client attempts to run it while it cannot contact the KeyServer. The default is to allow launch. This checkbox is disabled for keyed programs, since the executable itself has been modified, and therefore can only be run when connected to the KeyServer.
  
  
• The Current User List button is only enabled for controlled programs. Clicking it will bring up a window showing which computers are connected to the KeyServer and running the program currently.
  
  
• The list in the actions pane shows all the Program Variants in the same Program Family (programs sharing a common identifier). The variant corresponding to the current program (the one whose details are displayed in this Program Details window) is highlighted with a gray background.
• If you have moved the variant mask to the right, but have not yet saved, new variants which used to be part of the current variant, but will now be created as separate variants, are shown in a lighter gray. Other variants unaffected by configuration change in this Details window have a white background. If there are both keyed and unkeyed variants, the unkeyed variants appear on top, followed by a black horizontal line separating them from the keyed variants below.
• Clicking on the triangle to the left of the variant name and platform icon will expand the variant, revealing all known program versions within the program variant. If you expand the current variant (the dark gray line), you will notice a small arrow icon next to one of the versions. This indicates the particular version which currently has more details displayed in the Information pane. You can change this to any version within the current variant by clicking to the left of any of the versions, where the arrow would appear. Doing so moves the arrow, and updates the Information pane. (Note: to see information about a program version appearing outside of the gray selection, you will have to open the Program Details window for its enclosing variant separately.)

Information Pane

This pane shows general information about the program variant. The top few lines show information relevant to the entire variant (e.g. all versions within the variant have this information in common). Click the Variant Installs button to show all computers that have the program variant installed (e.g. some version included within the variant is installed).

Further details displayed at the bottom of the information pane are gleaned from a specific sample program whose version is included within the variant. In the Actions pane, when you use the expansion triangle to expand the gray selected item from the list of variants, notice the small black arrow pointing to a specific version within the variant - this is the specific “sample file” whose sample information is being displayed. Click to move the black arrow to a different specific version and you will see some details change in the bottom of the information pane - e.g. Version, Creation Date, Discovered date, or Sample Install information. The Version Installs button will show the computers that have the precise version (currently pointed out by the black arrow) of the program installed.

For a Windows application, our “Official Version” is text taken from an application's properties. It is the “File Version“ text from the “Other ...” section under the Version tab. Our “Version” is an abbreviated form (stored as a long integer) than comes from the top of the Version tab in properties, where it is labeled “File version”.

For a Macintosh bundled application (.app), the version information comes from the embedded info.plist. Our “Official Version” is the text from the CFBundleShortVersionString (or CFBundleVersion if the short version is undefined) - the Finder displays this string as the “Version’ in the application's Get Info window . Our "Version" is just an abbreviated form of the Official Version based on our attempt to parse out and remove verbose or extraneous data.

Licenses Pane

This pane only applies to controlled programs. It contains a list of distinct licenses which control the program. Often, this list will contain a single item. When there are multiple distinct licenses controlling this one program, then the one listed with the widest blue bar at the left will be searched first. That is, when a user attempts to launch the program, KeyServer will first attempt to grant permission to run from the widest blue bar. If this fails (e.g. perhaps all of these licenses are in use), it will move on and attempt to grant permission to run from the second widest, etc. When there are multiple licenses in the list, they can be dragged relative to one another in order to change the search order.

Licenses can be dragged directly from the licenses window into this list - this will expand the scope of the dragged in license to include control over this program. For each controlled program, you will rarely want more than a few licenses controlling it - just one controlling license is most typical.

Notes Pane

This pane contains a single item, which is a free-form text field. You can use it for any information you want. It can be seen here in the KeyConfigure interface, and can also be used in reports.

Custom Message Pane

This pane allows you to configure a custom message to be displayed on client computers when a controlled program is launched. You can choose to display the message on every launch or only once. Note: if the program is logged or ignored rather than controlled, Custom messages are not supported. If the license that allows the controlled program to launch also has a custom message defined, then only the message defined for the license will be displayed.

This pane allows you to configure a custom message that users will see at various times. You can choose if it is seen On Launch, On Deny, On Queue, or any combination of these three times. In addition, you can check the One-Time checkbox (in combination with On Launch) if you only want the custom message to be shown the first time a particular user runs the program.

The following macros may be placed in the custom message, and KeyAccess will replace them with the appropriate values:

^a

name of the currently running program

^d

date on active KeyServer

^D

date on local (KeyAccess) computer

^f

"KeyAccess" (name of client software at start up time)

^n

network name of active KeyServer

^t

time on active KeyServer, shown in local (KeyAccess) time zone

^T

time on local (KeyAccess) computer

^u

name of user

^w

name of program user is waiting for, if any

^^

single caret ("^")

Related Topics