Web UI Extras

Multiple plugins extend functionality in the Web UI

The web interface offers an ever expanding library of add on "applets" that extend functionality beyond the tools in KeyConfigure. This page details the current offerings and describes their functionality.

All of these plugins are included in the AllSight tier of the product. You simply need to activate the ones you want to use in the Settings of the Web UI under Extras. Check off the ones you wish to have available, and the Extras main navigation item will appear on a browser refresh. The Extras page has a widget style dashboard much like the One Click Reports. In fact, you can add these Extras widgets to your own Dashboard just as with one click Reports.


Loaner Checkout

This Extra is designed to assist in processing and tracking loaner equipment, be it Computers or other Devices. While each record detail has a field for loan person and return date, this Extra offers a number of enhancements to that simple idea. You can view all available systems marked as being for loan, see what is available and checked out, view return date information, process mass checkouts, send email confirmations to the user, and more.

     Loaner Checkout

Before using this Extra, you need to configure it using the gear in the upper right. There are 4 tabs of configuration options to consider.

Basic settings include what Lifecycle stage should be used for Available and On Loan considerations. Note you may be interested in using Custom Values for these, or use the Filters below. You can also set the default loan timeframe and time of day returns are due by.

The Terms tab can be used to link to custom T&C on another site, and/or include a summary. These are used as part of the confirmation email and receipt functions below.

For confirmation E-mails you can set the default Subject and copy fields if you want copies sent to another address for internal records. As of there are also options to send Reminder and Overdue emails.

When using the default lifecycle stages, you may want to Filter which items are actually used for loaners. You can do this by Divisions as well as Tags, as well as an advanced Filter.

     Loaner Checkout Configuration

Once you have set up the configuration options, the big buttons on the main screen reflect how many Computers and Devices are available for or currently on loan. Clicking one of these buttons will show a list of the relevant objects. For Available items, you can then check off one or more that you want to loan out, and click the Check Out button to start the process.

     Loaner Checkout Devices

On the Check Out screen you can fill out who you are loaning the items to and when they are due back. Note the User field does a lookup in the Users table so you can select a person by their previously seen ID per their Computer logins. This will fill in the relevant fields in the Details of each computer/device. A confirmation E-mail will be sent to the address specified, and you can put in a Phone number and Notes as desired for record keeping. Note that if you select a User based on the search and enter email and phone information, those items will be written back to the User record as well.

Once you complete the checkout you will be shown a summary screen where you can Print the "receipt". You can also check on items assigned to a user by Loan or as the assigned Owner using the User Assets Extra detailed below.

     Loaner Checkout Process

User Assets

     User Assets Extra

A simple but very useful Extra for those managing inventory, especially when also managing Loaner equipment. As it indicates on load, simply type in a user in the Search, and choose a match from the drop down. You will then be shown a list of all the assets associated with that User. These associations can be due to being set as the Owner in the details, a Loan, or simply that they were the Last person to log in to the computer. It will reflect Computers, Devices, and Products (the latter by way of User based Policy assignments or Purchase Install Codes).

Buttons at the bottom of the screen allow you to quickly generate reports related to this information, or print it out as needed.

You can click on the gear in the upper right to configure some optional settings for the Extra.

     User Assets Configuration

Pivot Table

     User Assets Extra

Pivot Tables allow you to choose different parameters to visualize data by groupings. You can choose from Computers, Devices, or Purchases as your data source Table. We implement standard pivot table options and will not fully document the topic of pivot tables here. We will however offer a few simple thoughts for those not versed in them.

Choose fields for Rows (what data do you want to see) and Columns (how to group the data). Values is set to "theta" by default meaning it's not used, and the results of setting this depend on your aggregation choice. For simple count, choosing something here will only show results in the table for items that contain a value in that field. Aggregation by default is set to Count and in simple cases should stay that way. Advanced data analysts may have use for the other options. For Style the simple choices are Bar Chart or Table depending on if you want a graphic or raw numbers.

Contact Tracing

     Contact Tracing Extra

The usage data collected by session logins/logouts in conjunction with computers being organized into room based Divisions allows for contact tracing to occur. We hope you never need to use this Extra, but if needed it is available. Simply choose a User Name and set the Date Range of contact analysis. You can also alter the threshold of contact overlap time, as well as narrow to a given location if needed. The results of the trace will show every other user that was in the same location as the user and for how long, based on the computer session events.

     Contact Tracing Results

Policy Allocations

     Policy Allocations Extra

Originally created to assist users of Bentley products with detailed usage charts, this can be useful to anyone with Node, Leased, User, or User Leased policies who wants more detailed visualisation of Usage. Simply chose a year, month, and Policy. Only compatible policies will be listed when using the Search bar. Once selected the Extra will gather data and show results for the month. You can then click on a Day and show details for that day, and in turn click on an hour and see details for that hour.

     Policy Allocation Month

     Policy Allocation Day

     Policy Allocation Hour

User Affinity

     User Affinity

Using session data to determine which user has utilized a computer most in the last 30 days, this extra shows that user for each computer with the option to copy the user to the Owner field of the computer record. If you'd like to see the affinity percentage, you can use the Primary User of Computers Extra. The primary function of this extra however is the copy function. If you click the copy button in the column header, it will copy ALL users shown on the page into the corresponding Owner field of the Computer Details. You can also click the copy button on each row to do select systems. If the copy button is in Red, it will replace a value that already exists. If it's black, the owner is currently blank. If the button is gray, that value is already the same.

There is also a Download button in the ribbon if you want to get a copy of this information.

If you were to use this extra to populate all owner fields by mistake, there is an Admin Script available that will blank the owner field of all selected computers you can use to "reset"

Primary Computer for Users

     Primary Computer Extra

Related to but rather opposite of the Primary User extra, you can use this applet to find the single computer used most by every user in the last 30 days. To start, enter a tag if desired to narrow the results, and then click Run. You can then use the Search bar at the top to filter the display to one particular user.

Primary User of Computers

     Primary User Extra

A very simple extra that uses session information to show computers where the primary user in the last 30 days is a given account name. Simply type in the name in the Search at the top to find results that match. Each computer is shown with the matching user account(s) and a % of time that user utilized the computer compared to all other use on the system. Note this is shown as "Affinity". This is the measure that is used to show results in the User Affinity Extra. There is no other function to this extra, it is for simple information only.

Mail Report

     Mail Report Extra

This extra is a very simple utility for emailing completed reports to users. Simply select the desired report from the list, put in a recipient, and click Send. The user will receive an email with a link to view the report in the Web UI.

KSQL Console

     KSQL Extra

Primarily used for troubleshooting or those who dive deep into the data structure for custom purposes. This allows you to direct query the server database with sql style commands. It is highly recommended this only be used after consulting with Sassafras Software Support for assistance and direction. Type "help" to get a full list of available commands. Syntax becomes complex so again please consult with Support for your use case.