Professional Documents
Culture Documents
Important Information Technical Support Introduction System Requirements Alternate Scheme Recommendations Pre-Installation Setup 1 2 3 4 7 8 10 16 19 26 29 31 32 34 35 36 37 38 42 46 53 56 60 64 68 71 74 76 77 78 79 81 84 86 87 88 90 92 95 96 97 98 99
Installing LabStats
Installing the Server Accessing LabStats
Product Settings
LabStats AppUse JuicePress Trouble Tickets LabGrab LabMaps PrinterStats
Reports
Data Options LabStats Reports AppUse Reports JuicePress Reports PrinterStats Reports Report Manager Custom Data Import
Administration
LabStats Users Backup and Restore Notification Center Permissions Manager Client Settings Licensing Site Settings API Settings Activity Log Public Page Mobile Page Uninstalling LabStats
Page |1
PREFACE
This user guide explains how to install and use LabStats and its associated modules.
Important Information
This section contains important information about your LabStats Product.
About LabStats
LabStats is a suite of software products that helps administrators manage computer labs. LabStats makes it easy to track computer usage, application data, and manage power usage. Designed specifically for computer lab environments, LabStats uses a lightweight client to send usage data to a streamlined database and a single web server to generate reports on computer lab usage.
Product Documentation
The following documents form the LabStats documentation set: LabStats User Guide - This document guides you how to use the product. LabStats Release Notes - This document lists the new features, known issues, and closed issues.
Page |2
Technical Support
Every effort has been made to design this software for ease of use and to be problem free. If problems are encountered, contact Technical Support.
Email: support@computerlabsolutions.com Phone: 1-208-473-2222 or 1-877-299-6241 Option 2 Hours: 8:00am to 5:00pm MST
Contact Information
Web: www.labstats.com Email: sales@labstats.com Phone: 1-801-939-3312 or 1-877-299-6241 Option 1 Fax: 1-801-823-2210 Hours: 8:00am to 5:00pm MST Address: LabStats 255 B St Suite 201 Idaho Falls, ID 83402 USA
Page |3
Introduction
How LabStats Works
LabStats 5 has two main parts: the client and the server. The client is a small, background program that runs on your computers. The client gathers information on how the machine is being used and sends that data to the server. The LabStats Server Portion consists of three parts. The processing agent for clients (Remoting Server), the web interface (IIS + Asp.net) and the database back end. (MSSQL) For LabStats to function all three parts are needed. The LabStats Remoting Server acts as a gateway for client communication. When clients talk over their intended port (by default 8080 for Windows, 8083 for Mac or Apple based clients and 8081 for Linux distributions) the LabStats Remoting server "picks" up those clients from network based communication. The Remoting Server also takes the client information and sends it off to the database so it can be displayed in the web interface. Without the Remoting Server the clients would not have a way to talk to the LabStats server. Thus it would not process the login, application, power, or printer statistics.
Page |4
System Requirements
Server Component
SOFTWARE:
Operating System: (either 32 or 64 BIT) Windows 7*, 2003 SP2, 2003 R2 SP2, 2008 SP2, 2008 R2 Web Server: IIS 6, 7, 7.5, Cassini* Database Server: SQL Server 2008 SQL Server 2008 R2 Express Other Software: .NET 4.0 Framework **Extended Edition For IIS 7 or greater Installations: ASP.NET IIS 6 Management Compatibility For IIS 6 Installations: ASP.NET *Demo purpose only, not meant for product environment. **Extended Edition of .NET is required
Client Component
SOFTWARE:
Operation System: (either 32 or 64 BIT) Windows: XP*, Windows 7*, 2003, 2003 R2, 2008, 2008 R2 Mac: 10.4 Linux: Ubuntu 9 or higher, Fedora 14, Red Hat Enterprise 6 (Ubuntu 11 requires a different version on Mono) Other Software: .NET 3.5 Framework Mono Framework for Linux:.2.10.2
HARDWARE:
Enough processing power, RAM, and hard drive space to run the OS in its recommended configuration.
Page |5
IIS 6, 7, 7.5 Database Server: SQL Server 2008 R2 Express SQL Server 2008
HARDWARE:
2.5 GHz Dual Core Processor 4Gb RAM 10Gb Hard Drive Space above whats needed for the OS.
HARDWARE:
2.5 GHz Dual Core Processor 4Gb RAM 20Gb Hard Drive Space above whats needed for the OS.
HARDWARE:
2.5 GHz Dual Core Processor 4Gb RAM 30Gb Hard Drive Space above whats needed for the OS.
Page |6
SOFTWARE:
Operating System: (either 32 or 64 BIT) Windows 2003 SP2, 2003 R2 SP2, 2008 SP2, 2008 R2 Web Server: IIS 6, 7, 7.5 Database Server: SQL Server 2008 R2 Express SQL Server 2008 Highly Recommended
HARDWARE:
2.5 GHz Quad Core Processor 6Gb RAM 40Gb Hard Drive Space above whats needed for the OS.
Page |7
Scheme Setup 1
Standard LabStats setup with website, Database, and Remoting Server residing on the same server.
Scheme Setup 2
LabStats website and Remoting Server on one machine and the Database on another.
Scheme Setup 3
LabStats website, Database, and Remoting Server on separate machines.
Scheme Setup 4
If you have an IIS and SQL Server cluster environment, you can host the LabStats website and DB hosted on existing servers. You then can dedicate a machine to host the Remoting Server.
Page |8
Pre-Installation Setup
Please make sure the following is setup prior to installing or upgrading to LabStats 5. This will help to ensure a smooth installation.
10. Click Next 11. Click Install 12. After installation, run the .NET registration for IIS instructions below.
Page |9
7. 8. 9. Click to check ASP.NET (This will check others, this is OK) Click OK to install After installation, run the .NET registration for IIS instructions below.
.NET IIS Registration (If .NET was installed prior to installing IIS)
In order for .NET applications to run properly under IIS, .N ET needs to be registered. If you arent sure, please run the following regardless. 1. 2. 3. Open an Admin Command Prompt and execute 32 BIT OS: C:\windows\Microsoft.NET\Framework\V4.0.30319\aspnet_regiis.exe iru 64 BIT OS: C:\windows\Microsoft.NET\Framework64\V4.0.30319\aspnet_regiis.exe iru
P a g e | 10
INSTALLING LABSTATS
This chapter describes how to install LabStats.
2.
For this user guide we will review the Easy installation. You will be given the choice to use Cassini or IIS for the Web server.
P a g e | 11
Cassini is a lightweight web server which is a great choice for testing or if you have less than 100 computers and you want a web server that requires little management. We do not recommend using Cassini for more than 30 client machines. IIS is a powerful web server created by Microsoft. It can handle a high number of computers quite well and is highly customizable to meet your organizations needs. To use IIS, you will need to manually install it before continuing the installation.
Setup Guide
Walking through this guide will make it a simple matter to: Choose a password for the default LabStats account Enter your license key Add groups (and choose a default group) Download the needed client installers.
P a g e | 12
1.
The first step of the setup guide is to set the password for the default admin user LabStats. In previous versions the default password was preset to labstats.
Please Note: Though you are provided the option to skip entering a password we do not recommend doing this. There is a known issue with certain versions which fails to revert to the default labstats password. If you have skipped the password setup and cannot login, contact support for help resetting the password via the database. 2. In the next step you will need to input a license key. If you are just testing the product for the first time you can enter your school information and request a demo key.
3.
If you already have an account with LabStats you can retrieve your current license by selecting Retrieve Your Key and entering your Account ID (your schools Customer ID Number) and your server address. It is important to enter the same information that you provided to LabStats for our records.
P a g e | 13
4.
Alternatively you can enter an existing key (we typically send these by email. You will want to double click on the key within the email before copying to ensure the full key is selected). Select Enter a Key and paste the key into the box provided then select Submit Key.
5.
Once the license key has been entered you will see a notification that the license has been applied along with a list of the products you are licensed for. If everything looks correct, hit next.
6.
The next step of the setup guide will allow you to add groups and set a default group. This will be the group that stations will automatically be assigned when they check in unless they meet the requirements of a definition associated with another group.
P a g e | 14
7.
If you click on the gear beside the groups, you can set definitions which will help stations to be assigned to the correct groups as they check in.
8.
The hostname definitions can be set using wildcards, and multiple definitions can be entered by separating them with a comma.
9.
The next step in the setup guide allows you to download the Client Installers that you will need. From here you can also see the number of stations that have checked in to each group.
P a g e | 15
10. Once you have completed the setup guide you can click the button to take you to the home page.
P a g e | 16
Accessing LabStats
Web Interface
When logging into the web interface directly (rather than through the setup guide), follow these steps. Keep in mind this applies only to the default IIS settings. If you have altered your default settings the path to log into LabStats may have changed: 1. 2. 3. Open your web browser and navigate to http://localhost/LabStats or http://[ServerAddress]/LabStats from another computer Click on the Sign In link on the upper right hand corner of the page. Enter LabStats for the user name and the password that you set during the setup guide.
Help
The LabStats Web Interface is designed to be intuitive to use, however if you are not certain how to use a page, you can click on the ? (help) icon at the top right of most panels and a popup box will appear with more information about the options on the page. Below is an example of the help box from the LabStats Settings Page:
Search
Another useful tool of the LabStats Web Interface is the search feature. On most pages of the web interface you can click on the search icon, to bring up search boxes within any searchable field. Here is a search within the Manage Groups and Stations page. Please Note how the station that matches the search criteria now displays in light blue to make it easier to find.
P a g e | 17
Installing Clients
The client is a small executable that runs as a service on your machines. The client for Windows, Mac, and Linux can be downloaded from the web interface. In order to run the client on Linux, you will need to install the Mono framework before installing the LabStats client.
P a g e | 18
Upon connection from a zero thin client, the CLS Client Service starts & detects a vdi.dat file and doesnt check in until it finds the hkcu mac address.
P a g e | 19
Creating Groups
Once you have installed the client on your stations, you may want to create additional groups, or make changes to groups you created through the setup guide. Groups give you a convenient way of organizing your stations. One possible way to organize your groups is to have each group consist of the computers in a particular room.
To create a group:
1. 2. Navigate to: Groups and Stations -> Manage Groups and Stations. Click on the Add Group button.
P a g e | 20
3. 4.
You will now be able to enter the name and description you want for the group. Click the OK button to save your changes.
You set your default group during the setup guide. New stations will automatically be assigned to the default group unless you setup definitions within the other groups. To change the default group select the group that you want to set as default and at the bottom of the info tab click on Make Default Group.
Now that you have created your groups, you need to manage your stations. You can change the name of your stations by selecting the station that you want to change:
1. 2.
Click on the info tab and click the pencil next to Station Name. Press OK to save your changes.
P a g e | 21
Stations can be assigned to a group automatically through definitions, rules that associate a station to a group based off of common hostnames, IP addresses, or MAC addresses. If you do not have definitions set up (or if a station does not fit into the definitions) it will automatically be assigned to the default group.
5.
Once the desired stations are selected, click the OK button to add the stations to the group. They shou ld now appear in the Assigned Stations list.
Setting up a Schedule:
Schedules allow you to tell LabStats when a group is open, closed, etc. The schedule helps you in two different ways. 1. 2. It allows you to easily run reports on your groups for only certain periods of time. For example, you may only want to figure out the usage percent for a Lab during its open hours. It allows students to have an idea of when a lab is available.
Schedule Options:
Title: Start Time: End Time: Status: Information relative to the event being scheduled. The time in which the event starts. The time in which the event ends. An open status signifies that the groups computers are available for use during the event. Close means the groups computers are unavailable. Correctly setting this status helps you easily set reports to only run on groups during their open times.
P a g e | 22
Publish Level: This option allows you to control what event details are published to the server. Status Only will only cause the status of open or closed to appear on the published scheduled. Choosing All Details causes the subject to appear on the published schedule. Recurrence: By checking this checkbox you will be given options to have this event repeat.
To Create a Schedule:
1. 2. 3. 4. Navigate to: Groups and Stations -> Manage Groups and Stations. Select the group you want to set a schedule for. Click on the Schedule tab. Double click on the day and the time you would like to start the schedule on.
5. 6.
To edit an event:
1. 2. 3. 4. 5. Navigate to: Groups and Stations -> Manage Groups and Stations. Select the desired group. Click the Schedule tab. Click on the event in the calendar that you want to edit. Make the necessary changes and press OK to save your changes.
To delete an event:
1. 2. 3. 4. Navigate to: Groups and Stations -> Manage Groups and Stations. Select the desired group. Click the Schedule tab. Click on the event in the calendar that you want to delete.
P a g e | 23
5. 6. Click the Delete button. Click OK to confirm that you want to delete the event.
6.
On each of the definition tabs you will find a button that says Assign Stations Now. This button will allow you to automatically move any existing stations into your group that match the definition. Note: This applies only to stations that are in the Unassigned Group.
IP Address Definitions:
IP address definitions cause stations to be automatically added to a group based on an IP address. For example, if you set the IP address as 192.168.1.0 and the Netmask as 255.255.255.0, any IP address between 192.168.1.0 and
P a g e | 24
192.168.1.255 would automatically be added to the group. The Exclusion checkbox prevents stations with a matching IP address from being added to the group. Use the Netmask Calculator to calculate the needed values for the IP Address and Netmask fields.
MAC address definitions cause stations that meet certain MAC addresses to be automatically added to a particular group. The exclusion checkbox will prevent a computer with a matching MAC address from being added.
7.
Unassign: Select the stations you wish to unassign, then click this button.
P a g e | 25
8. Hide Selected: Select the station you wish to hide, then click this button. This will remove the station from the group, but keep its Machine association and data history.
Welcome Message
Here you can set the Group's Welcome Message. 1. 2. 3. 4. Input the text you wish to display to all stations in the group. Adjust the Display Time Accordingly, then click save. The message will display whenever a user logs into a station in this group. For changes to the Welcome Message you may need to restart the CLS Remoting Service on the server.
P a g e | 26
3. Provide a name and a description. 4. Click on the button to bring up a file browser. 5. Using the file browser, select the appropriate image you would like to upload. 6. Press the OK button.
P a g e | 27
4. Click OK to confirm the deletion.
1. Navigate to: Groups and Stations -> Station Types. 2. Click the Add New Station Type link. This will bring up a dialog box. 3. Provide a name and a description. 4. Click on the button to bring up a file browser. 5. Using the file browser, select the appropriate image you would like to upload. 6. Press the OK button.
P a g e | 28
P a g e | 29
Group Status
The default group statuses are opened and closed. However, you can add your own custom statuses that can be used on the calendar and reports.
Status Options:
The following information details what the options are there are for the statuses: Status Name: Status Description: Status Color: Availability: Display Message: A name representing the status. A description used to help identify what the status is used for. The color you want the status to appear as on the schedule. This represents whether or not the group is available for use while this status in effect. If you set a display message, then the message will appear instead of the status name for schedules. For example, by default the Open status does not have a display message. This means that on schedules where this status is assigned, the word Open appears. If you assign a display message of The Lab is Open, the phrase The Lab is Open will appear on schedules in place of Open.
P a g e | 30
P a g e | 31
Station Merge
Eventually youll run into the situation where you have replaced the computers in one of your labs with new computers. LabStats has mechanisms to merge the information from the old computers into the new computers.
P a g e | 32
Machines Assignments
A station is basically a container linked to a physical machine. As time goes on, you will probably replace your old machines with new machines. As you replace the old machines, youll change your stations to point to the new machines. This allows you to keep historical information for several machines as if they were always one machine.
Please Note: Once you disable this setting new clients that check in can be found here: Groups and Stations-> Machine Assignments under the Unassigned Machines list.
P a g e | 33
1. 2. 3. 4.
Navigate to: Groups and Stations -> Machine Assignments. Click on the Create New Station link. Select an appropriate Station name and choose a group to assign it to. Click the Create Station button.
P a g e | 34
The Upload Client Bundle button brings up a dialog box that allows you to upload a bundle containing updated client installers. Note: If you want to downgrade the version you will need to uncheck the Disable Client Downgrade option at Administration >> Client Settings. This option is checked by default, you will want to keep it checked if you want to avoid downgrading clients by mistake.
P a g e | 35
Lab Alerts
LabAlerts will show a message to selected stations.
Title: Message:
The title that shows up in the caption of our popup. The message (which can contain html) that will be displayed.
Click on Preview to see how it will look. Set the Message Duration and decide if the message can be dismissed by checking the allow dismissal box. Click Send Message when ready.
The message will pop up on each client in the group for the selected period of time. If Allow Dismissal was checked the user will be able to press the X to close the message.
P a g e | 36
Station Management
Hiding Stations:
1. 2. Select the station you wish to hide. Click "Hide Selected".
Unhiding Stations:
If you have hidden stations on the Groups and Station's "Stations" tab or from Station Management
1. 2. Click "Show Only Hidden Stations" to view them. Select the stations that you want to unhide and press "Unhide Selected".
Deleting Stations:
Deleting selected stations will delete the station and its history. Doing so is irreversible. If the client software is still installed, the station will be recreated once it checks in again.
Deleting History:
This will delete UserTracker, AppUse and JuicePress history for the selected stations.
P a g e | 37
4.
Once all MAC addresses are selected (except for the real one) you can then click on the button entitled Delete Selected MAC Addresses
5.
After this is done all you need to do is wait for the other machines to check in with their actual MAC address (usually within the next 5 minutes based on client check interval).+
P a g e | 38
PRODUCT SETTINGS
This chapter explains how to use the Product Settings menu in LabStats.
LabStats
LabStats provides the core functionality of the server. Every other module such as LabMaps, AppUse, JuicePress, PrinterStats and LabAlerts expand upon the capabilities of LabStats. With LabStats alone, you can track how often your computers are being used along with who is using them.
LabStats Settings
Under the LabStats settings page, Product Settings -> LabStats -> LabStats Settings, there are three different sections that control the LabStats settings.
P a g e | 39
Report Remote User As In Use: Anonymize Usage Statistics: Remove Old Login History Data: Remove Logins Older Than: Show Offline Clients as Available:
"Tracking Exception Settings" allows you to specify which user names shouldn't be tracked. You can either enter specific user names or you can use regular expressions to control which user names shouldn't be tracked. The two text boxes at the top allow you to filter the list so you can find the specific exceptions you are looking for. The following information details how to complete common tasks.
Adding an Exception
1. 2. 3. 4. Click the + button at the bottom of the page to add a new exception. Type in the user name you want to exclude or a regular expression in the "Exclude Pattern" text box. Type in an appropriate description for the exclusion in the "Description" text box. Click "Submit to save the exception.
Removing an Exception
1. Select the exception you want to remove and then click the trashcan at the bottom of the section to delete the exception.
Editing an Exception
1. 2. Select the exception you want to edit. Click the trashcan at the bottom of the section.
P a g e | 40
3. Click "Submit to save the changes.
Purge Data
This section allows you to remove old data from the database. To remove old data:
1. 2. 3. Click the calendar beside the Date text box. This will bring up a calendar in which you c an select a date. Data prior to the selected date will be deleted. Click the checkboxes for the types of data you wish to remove. Click the Remove History button.
You can also set how often the public page will refresh by selecting an appropriate value from the Page Refresh Interval dropdown list.
Ignored MACs
This page allows you to enter MAC addresses that arent unique from computer to computer. Ex. VMware Workstation uses common MAC addresses for their VMNET adapters. This will cause your clients to mimic each other, to prevent this add the common MAC address to the Ignored MACs list.
P a g e | 41
The tracking type helps LabStats know where it should gather user name information from. By default, the
Standard tracking type will be used. The following information details what the different tracking types are used for:
Standard: Novell: Environment Variable: Inactivity: The standard tracking type will base user information of the windows user name. If you are using local user accounts or Active Directory, then this is the preferred method. The Novell tracking type gathers user information from the Novell NetWare client. The Environment variable tracking type gathers user information from an environmental variable. If you choose this type, then a text box will show up where you can enter what variable is supposed to be used. The inactivity setting allows you to track usage settings for computers where users don't log in and out with their own user names. If you choose this setting, then LabStats will consider the computer as available when it's been idle for a specified amount of time. If you choose this type, then a text box will show up where you can enter how much idle time counts the computer as available.
P a g e | 42
AppUse
AppUse is an optional add-on to LabStats that allows you to track application usage. With AppUse, you will be able to see how often various applications are used on your machines.
AppUse Settings
The AppUse Settings page allows you to control the basic settings of AppUse. You can reach this page by logging in to LabStats and navigating to: Product Settings -> AppUse -> AppUse Settings.
Minimum Record Length: Auto Delete Old App Data: Delete App Data Older Than: Ignore New Apps by Default: Track New Apps by Default:
The shortest amount of time an application can be used and still have its usage recorded in the database. If this box is selected, then data older than the specified amount of time will be deleted. This option specifies how long data should be kept for when the Auto Delete Old Application Data box is checked. When this box is checked, new applications will show up as ignored. If this box is checked, new applications that are reported to AppUse will be tracked automatically. If this box isn't checked, then you will have to manually set applications to be tracked.
P a g e | 43
To delete an exception:
1. Highlight the exception row and select the Trash Can icon at the bottom of the page.
To edit an exception:
1. 2. 3. Highlight the exception row and select the pencil icon at the bottom of the page. Make the desired changes. Click the "Submit" button to save the changes.
Known Applications
AppUse keeps a list of all applications that have been launched on your various stations. This list is automatically populated based off of the applications that have been launched on your machines. From this list, you can choose which applications are tracked.
P a g e | 44
Application Groups
Here you can group your applications. Example groupings are suites like Microsoft Office, Adobe CS5, Internet Browsers, etc.
P a g e | 45
You can filter for groups you've created by clicking on the magnifying glass.
P a g e | 46
JuicePress
JuicePress is a power management utility that allows you to better control how much electricity your computers use. With JuicePress, you can do the following: 1. Assign power schedules to your computers to optimize when they are on, off, and in standby. 2. Run reports to get an idea how much electricity your computers are using. 3. See how efficiently electricity is being used.
Power Schemes
Power Schemes specify what power options should be used when the scheme is in effect. Once the Power Schemes are created, you can then assign certain Power Schemes to be used during certain parts of the day.
P a g e | 47
Display Color: This is the color that will display in the Power Schedules when this scheme is selected. You can assign various colors to each scheme. Use the drop down menu to select the color of your choice. Description: Client behavior is driven by: Show message after: A short description that explains when this scheme is supposed to be used. The User Inactivity option causes the effects of the scheme to only take place after a user has been inactive for a period of time. The Schedule option causes the effects of the scheme to take place even if a user is actively using the machine. This setting will determine how soon after the scheme starts that you want the message to appear on the users screen. Log user out after: Sleep monitor after: Action to take: Take action after: Message body: How long to wait before logging out the user of the station. How long to wait before putting the monitor to sleep. What action to perform on the station. How soon the action will take place after the scheme starts or after the user has been inactive. The actual message you want to appear on each station effected by the power scheme.
Power Schedules
JuicePress allows you to assign Power Schedules to your computers. Power Schedules detail when the computer is to be on, off, and in standby.
P a g e | 48
7. Provide a start time and end time. 8. Choose the scheme you want to use. 9. If you need your computers to wake up, choose Wake Up as the start action. 10. Click the Recurrence checkbox if you want this scheduled item to be repeated for other days. Once you check the box, youll be given option to specify how often you want the event to reoccur. 11. Click the Save button to save the changes. 12. Repeat steps 7-12 to schedule more schemes. 13. Select the groups/stations you want the schedule to apply to.
14. Click
JuicePress Settings
You can access the JuicePress Settings page by navigating to: Product Settings -> JuicePress -> JuicePress Settings.
P a g e | 49
The following information details what settings you can change for JuicePress.
If a computer is in a particular power state for less than the time specified in this setting, no records will be created to reflect that. For example, if computer A was in sleep mode for 30 seconds and this setting is set to 1 minute; no entry record will be created to show that the machine was in sleep mode for 30 seconds.
Power Usage When On: Power Usage When in Standby: Power Usage When Off: Default Baseline: Default Electricity Rate: Wake On Lan Retries: Wake On Lan Retry Interval:
The amount of watts a computer uses when it is fully on. The amount of watts a computer uses when it is standby mode. The amount of watts a computer uses when it is turned off. Most computers will still use some electricity even when they are turned off. The amount of KWh used per day in a lab. The cost of power per kWh where your organization is located. The number of retries when attempting a wakeup. The duration to wait between Wake on LAN retries in minutes.
P a g e | 50
P a g e | 51
JuicePress Exceptions
You can access the JuicePress Exceptions page by navigating to: Product Settings -> JuicePress -> JuicePress Exceptions. User exception settings keep JuicePress from logging out or shutting down the computer when certain users are logged in.
P a g e | 52
Application exception settings keep JuicePress from logging out or shutting down a computer when certain applications are in use.
P a g e | 53
Trouble Tickets
Trouble Tickets is a feature included with LabStats. Trouble Tickets allows you to keep track of problems your machines are experiencing.
P a g e | 54
These settings allow you to choose what categories tickets can be assigned to.
To remove a category:
1. 2. 3. Select the category you wish to remove. Press the trashcan at the bottom of the page. Click Delete to confirm Deletion.
To modify a category:
1. 2. 3. 4. Select the category you wish to edit Click on the pencil icon at the bottom of the page. Change the description and name as needed. Click Submit to confirm changes.
Edit Severity:
Navigate to: Product Settings -> Trouble Tickets -> Trouble Ticket Settings -> Edit Severity.
P a g e | 55
Edit Statuses:
Navigate to: Product Settings -> Trouble Tickets -> Trouble Ticket Settings -> Edit Statuses.
These settings allow you to choose what statuses can be assigned to a ticket. A status represents the standing of a ticket. For example, a status of open would mean that the work is being done to resolve the issue whereas a status of closed would mean the issue is resolved.
To remove a status:
1. Click on the x next to a status name.
To modify a status:
1. 2. 3. Click on the pencil icon next to the status name. Change the description and name as needed. Click on the green checkmark to save changes.
P a g e | 56
LabGrab
LabGrab is an optional add-on to LabStats that allows users to reserve labs and allows administrators to manage user reservation requests. To select LabGrab Settings navigate to Product Settings -> LabGrab -> LabGrab Settings.
When this is checked, users will have to login to the LabStats interface in order to submit a Reservation Request. Once this is checked, users that are logged in will see a "My Reservations" link in the Reservation System
When this is checked, users will be able to create their own accounts for requesting reservations.
*When LDAP is enabled, user accounts will be created per the LDAP settings. If you are not allowing LDAP user accounts to be created automatically, you will need to create user accounts manually (matching LDAP user names) and give the relevant permissions (public user).
Class Settings
Here you can add a class list for users to choose from in their Reservation Request
Class Code:
This code will appear under the "Class" dropdown in a Reservation Request.
Name:
P a g e | 57
Reservation System
To access the reservation system, navigate to the Public Page and click on the Reservation System button.
Select the labs you wish to see a schedule for. If you do not see a highlighted block of time, then there are no reservations for that lab. Click here to open a Reservation Request. Click this to see a list of all reservations you have submitted.
P a g e | 58
Reservation Request
Requested Room: Reason: Class: Additional Requests: Start/End times: Allow Public Use of Lab:
The room/lab you wish to reserve. If necessary, explain why you need to reserve this lab. Select the class code for which you are affiliated. Any further information you need to supply for your reservation. The starting and ending date and time for your desired reservation. If this is checked, then LabMaps and the public page will reflect available stations. If it is unchecked, all stations will be shown as In Use or Unavailable.
When the user clicks the Request Reservation button, they will see a confirmation that their reservation system had been submitted.
By clicking on the My Reservations button a user can view, edit, or cancel their reservations:
P a g e | 59
The name of the group for reservation. The name of the person desiring the reservation. The time block that is being requested by the user for reservation. The date and time that the reservation was submitted from the Reservation System. Clicking either of these will prefill the "Approval Status" in the Reservation Approval dialog box with their respective Approve/Deny choice.
P a g e | 60
LabMaps
LabMaps is an optional add-on to LabStats that allows you to visually show the availability of a lab. A lab map shows each computer in the lab with a color representing the availability of the machine.
Map List
Navigate to Product Settings -> LabMaps -> Map List This section lists the various LabMaps that have been created.
To create a LabMap:
1. Click on the "Create New Map" button at the bottom. This will open the Map Creator.
Note: You must have Microsoft Silverlight installed in order to create a LabMap
To publish a LabMap:
1. 2. Select the check box for the appropriate map. Click on the "Publish Selected Maps" button at the bottom of the page.
To Unpublish a LabMap:
1. 2. Select the check box for the appropriate map Click on the "Unpublish Selected Maps" button at the bottom of the page.
To Delete a LabMap:
1. 2. Select the check box for the appropriate map Click on the "Delete Selected Maps" button at the bottom of the page.
To Embed a LabMap:
You can embed LabMaps within your own website.
1. Click on the View HTML link next to the desired LabMap to bring up the HTML code you need to use.
P a g e | 61
Map Creator
A basic LabMap can be created by following these steps:
1. 2. 3. 4. Navigate to: Product Settings -> LabMaps - > Map Creator. Click on a group from the Group Hierarchy box. Drag stations from the stations box. Enter a title for the LabMap in the Title box.
The following information below describes the controls and features of the LabMap editor.
Description:
This text field allows you to enter a description that will help users better understand what this LabMap is for.
Background Color:
This control allows you to select what you want the background color of the map to be. If you want to use a background image instead of a color, read about Custom Icons below.
Display Options:
You can choose to have the stations host name or IP address appear next to every computer icon depending on which of the three bubbles you select.
Size Controls:
The size controls allow you to control the size of your icons, station labels, and map dimensions. For Station Size and Station Label Size, simply drag the slider from left to right to make the icon and label smaller or larger. The left Map Dimensions box specifies the width of the map and the right box specifies the height.
P a g e | 62
My Images:
The My Images section allows you to use a background image and place special icons on your map. To get to this section, click on the My Images tab on the left hand side of the map editor. To use an icon, select the appropriate image from the drop down box and drag it onto the screen. If you have the Background bubble checked, the icon will be used as the background image. To add a custom icon, click on the add icon. This will bring up a file browser for button. This makes the icon
you to select which file you want to upload. Once you have selected the icon you want, simply provide a name and click the save available for use.
P a g e | 63
5. 6. 7. 8. Click the Upload button to upload the PNG or GIF picture you created. Click each corner of the transparent section. You will start to see how the status color will appear on your custom icon as you are clicking the corners. Provide a name and description. Click the Save button. button to exit out of the editing tool.
9. Click the
Map Settings
This section allows you to control what color your LabMaps icons will be when the computers are on, off, and in use, as well as which types of maps to display on the Public Page (HTML or Map List).
Please Note: The Silverlight Viewer is no longer available as of version 5.2.30303.134
P a g e | 64
PrinterStats
PrinterStats is an optional add-on to LabStats that allows you to track printer usage. With PrinterStats, you will be able to see how often individual printers are used as well as information about that usage.
3. Click on the + button at the bottom left corner of the window to bring up the Add/Edit Printer page.
4. On the Add/Edit Printer page, enter the IP Address of the printer that you would like to add and click on
the Query Printer button.
P a g e | 65
Printer Name:
The printer name generally matches the hostname by default but can be changed to specify who owns the printer or where it is located. is gathered from the printer and can be edited.
Manufacturer: The Manufacturer is the name of the manufacturer which Model: Printer Type: Color: Duplexing: HostName: IP Address: Subnet: MAC Address:
The Model is the model name and number that is gathered from the printer and can be edited. The printer type such as Ink Jet or Laser is gathered from printer and can be edited Color indicates whether the printer has the ability to print in color Duplexing indicates whether the printer has duplexing ability The host name is gathered from the printer and cannot be edited The IP address will match the IP that you entered when querying for the printer information The subnet will be gathered from the printer and cannot be edited. The MAC address is gathered from the printer and cannot be edited. If the printer does not provide the MAC Address information it will be listed as Undetermined The Description is gathered from the printer. If the printer does not provide this information, it will show as Null The Serial Number is gathered from the printer. If the printer does not provide this information, it will show as Null
P a g e | 66
View the status information by highlighting the printer and selecting the Status tab.
P a g e | 67
Here you can set how often the printer is checked for errors. The default is set to 1 Minute.
Here you can choose what printer notifications you want sent.
P a g e | 68
REPORTS
LabStats and its add-on modules have a variety of useful reports. This chapter explains how to use the
Reports menu in LabStats.
Data Options
The following table lists all the possible data options you might see in a report. Some options only appear on certain reports. This list has been placed in alphabetical order for convenience purposes.
Average: This option only appears on the Average Usage report. Selecting Day causes the report to show the average amount of logins or users for each day during a week. Selecting Hour causes the report to show the average amount of logins or users for each hour of the day. The Day & Hour option causes the report to generate average usage information for each hour of the entire week. If this box is checked, you will see the average information for each interval. For example, lets say that you have the date range covering three days and also have this box checked. In this scenario you also have the Interval set to Hour of the Day. With these options selected, you will only get 24 data points on the graph (one for each hour of a day). Each time point on the graph will represent the average usage for that time interval for all three days. So for the 1:00 PM point, youll have the Average information for 1:00 PM to 2:00 PM for the three days. Comparison Type: If group is selected, then there will be separate bars for each group for each time interval. If combined is selected, then all the groups will show up as one bar for a given time internal.
P a g e | 69
Exclude Existing Sessions: Filter By Group Status: Historical Perspective: This option excludes logins from being counted if the user is still logged in. This dropdown menu allows you to only include time intervals in the report in which a status takes places. For example, if you choose the Open option, then only d ata will be included in the report for times in which the groups were scheduled as open. When you select the Current perspective, the report will be run based on your current group and stations assignments. The report will assume that the stations and groups have always been organized in their current setup. When you select the Timeline perspective, LabStats will take in account to how the stations and groups were assigned for each time interval in the report. Interval: Limit Days: Limit Hours: Limit Results to Extremes: Operating System: Report Type: The interval represents what time units will be used on the graph. This option allows you to only include information for certain days. This option allows you to only include information for certain hours. This feature allows you to only show information for groups with the most or least usage. For example, if you were to select Most and 1 for the Usage History report, you would only have one bar under each time interval. This bar would be for the most used group. These checkboxes allow you to select what operating systems will be included in the report. For example, if you only have the Windows checkbox selected, then only stations with Windows as their operating system will be included in the report. Some reports can show different types of information based off what you select for Report Type. For the Login History report, you can choose between the Report Type of total logins or total unique users. The total logins option shows the total amount of logins for each time interval. This will count logins in which a user has logged in multiple times in the time interval. The total unique users option shows the total amount of users that have logged in during each time interval. For the Login Summary report, you have three different Report Type options. The User Summary option shows information about each different user name. The Group Summary option shows information for each group. The Station Summary shows in formation for each station. For the Average Usage report, you have two different options. The Logins option will cause the average amount of logins for a time interval to be displayed. If a user has logged in and out several times during the time interval, each login will count towards the average. The Unique Users cause the average number of unique users for a time interval to be displayed. For the Application Usage History report, you have five options. Total Usage Time shows the total time the selected applications have been used for each time interval. Utilization Percentage shows the percentage of time that the selected applications have been used while users have been logged on. Application Launches shows then number of times the selected applications have been opened. Typical Usage Duration shows how long an application is used for on average. Peak Concurrent Usage shows the highest number of running instances of the application for a given time. For example, lets say that there is a point in a time interval where Photoshop is opened on 60 different computers. During other points, only 30 instances of Photoshop are opened. 60 would represent the peak concurrent usage amount for that time interval.
P a g e | 70
For the Power Usage History report, you have four options. Power Used shows the raw amount of power (kw) that has been used. Power Wasted shows how much power has been used when no one was using the machine. Power Saved shows how much power you have saved by having computers go in to off or standby when they are not in use. Power efficiency shows how efficient your computer labs are based off your power baseline. A positive percentage means you are using less electricity then the baseline. A negative percentage means you are using more than the power baseline. Time Period: User Name: This drop down box gives you a lot of different time periods you can run the report for. If you need to choose a custom date range, select the Custom Dates option. This option allows you to limit certain information to a specific user name.
Display Options
These options control how the graphs are presented to you. The Display Type option allows you to choose what type of graph you would like (line, bar, area, spline, point, or pie).
Export Options
On tabular reports, you have the option of exporting the data to a file. Simply click on the button that matches the type of export you wish to complete.
P a g e | 71
LabStats Reports
LabStats has several useful reports. With these reports you can find out historical usage information and login history. You can access the Reports page navigating to: Reports -> LabStats.
Usage History
The Usage History report allows you to see how often your stations are being used. The graph will show the in-use percentage.
Login History
This report displays a graphical representation of the number of logins or unique users.
Search Logins
This report displays a summary of login data for the searched for user (or if no user is selected a breakdown of data for all users) for a selected time period.
P a g e | 72
Login Summary
This report allows you to find out the following information:
1. 2. 3. The total number of times a user has logged in during a certain time period. The total number of logins that have happened in a particular group for a specified time period. The total number of logins that have occurred for certain stations for a specified time period.
Average Usage
This report generates a table giving an average of how many logins have occurred during each hour of a day, each day of a week, or both.
Login Counts
This report displays a graphical representation of the number of logins that started during each selected interval.
P a g e | 73
P a g e | 74
AppUse Reports
Application Usage History
For the Application Usage History report, you have five options that will determine what data the report will provide.
1. Total Usage Time shows the total time the selected applications have been used for each time interval for the selected stations during the given time frame.
2. 3.
Utilization Percentage shows the percentage of time that the selected applications have been used while users have been logged on for the selected stations during the given time frame. Application Launches shows the number of times the selected applications have been opened for the selected stations during the given time frame.
P a g e | 75
4. Typical Usage Duration gives a comparison of application run times based off of the average used times.
5.
Peak Concurrent Usage shows the number of application sessions running at the same time during the selected interval over a given time period.
P a g e | 76
JuicePress Reports
Power Usage History
This report displays a graph representing the power utilization of resources over a selected period of time by power used, power wasted, power saved or power efficiency (depending on the report type selected).
P a g e | 77
PrinterStats Reports
This report provides a count of the number of pages printed during each interval over a selected time frame.
P a g e | 78
Report Manager
Each report has a section to save a custom report.
Once you have saved a custom report, you can run it again by Navigating to Reports -> Report Manager
P a g e | 79
Next upload the spreadsheet that the data is stored in. You can browse for the file and click upload.
P a g e | 80
Now you can run reports using one of your custom fields as the comparison type. This report was run using School as the custom comparison type, this runs the report and sorts and compares the data based on what users were in each school as defined in the custom data we uploaded. Only one school is listed in this case because all of the users that have used computers in group 2 are in the school of Technology.
P a g e | 81
ADMINISTRATION
This chapter explains how to use the Administration menu in LabStats.
LabStats Users
User List
The user management section can be found by logging in to LabStats and navigating to: Administration -> LabStats Users.
Adding Users
To add a new user, click on the Add User button. This will bring up a dialog box where you can enter the appropriate information for the new user.
P a g e | 82
Deleting Users
To delete a user follow these steps: 1. Tick the checkbox next to the user name. 2. Click Delete Selected Users at the bottom of the page.
Edit Users
1. Navigate to: Administration -> Site Management -> LabStats Users. 2. Click on the Edit link next to the appropriate user.
3. Click on the User Information tab. 4. Make appropriate changes. 5. Click Save to save changes.
User Roles
Roles allow you to control which LabStats features users have access to. You assign certain permissions to roles then assign roles to the users. The users permissions will then be based upon the roles that are assigned to them.
P a g e | 83
User Permissions
LabStats permissions are controlled by roles. Users will have permissions that match the roles that are assigned to them. The Permissions Manager, located at: Administration -> Site Management -> Permissions Manager, controls the permissions assigned to roles. On this page you can control what features, pages, and groups a role has rights to.
P a g e | 84
Manual Backups
You can manually create a backup by clicking on the Create Backup button. After doing this, the backup will appear in the list. You can delete the backup by clicking on the X icon next to the backup name. You can also rename a backup by clicking on the pencil icon next to the backup name. One practice we generally recommend is to save some of your backups to external locations. You can download one of your backups by clicking on the Download link next to the backup name. If you want backups to be stored in a certain directory, provide the full path to the directory in the Location text box.
Scheduling Backups
On the backups page, there is a section called Scheduled Backup Settings. This section allows you to control when backups are automatically created. All you need to do is provide the appropriate information and hit the Save button. The options for this section are explained below:
Backup Interval:
This setting controls how often a backup is created. For example, a setting of 3 would cause LabStats to create a backup every three days. A setting of 0, keeps LabStats from making automatic backups.
P a g e | 85
Time to Perform Backups: Backups to Keep: This is the time a backup will occur when a backup is supposed to be created for that day. The time entry needs to be in 24 hour format (i.e. 1:00 PM should be 13:00). This is the number of backups that will be saved. When a new backup is created and this number has already been met, the oldest backup is deleted. If you set this to 0, LabStats will have no limit on how many backups it creates.
Restoring Backups
To restore a backup, click on the Restore link next to the backup name. If you need to restore a backup that is saved externally, follow these steps: 1. Click the Browse button and choose the appropriate backup file. 2. Click the Upload button. Once the backup is done uploading, it will appear in the backup list. 3. Click on the Restore link next to the backup entry that appeared in the list. 4. Confirm that you want to use the backup database.
P a g e | 86
Notification Center
You can configure LabStats to send notifications to users on certain events. Notification settings are controlled through the Notification Center. You can access the Notification Center by logging in to LabStats and navigating to: Administration -> Site Management -> Notification Center.
Managing Notifications
To control who receives certain types of notifications you need to follow two simple steps: 1. Select the Notification type from the dropdown box. 2. Add roles to the Roles list, users to the Users list, and email addresses to the Email Addresses list. If you have a role assigned to a notification, then every user assigned to that role will receive an email notification.
To delete Role:
1. 2. Tick the box next to the Role Click Remove Selected Roles
To delete User:
1. 2. Tick the box next to the User Click Delete Selected Users
P a g e | 87
Permissions Manager
Roles are controlled by the Permissions Manager which can be accessed by logging in to LabStats and navigating to: Administration -> Site Management -> Permissions Manager.
When you select a role from the drop down list, all the permissions for that role are shown in section below.
To modify a role:
1. Select the role you want to modify from the drop down list. 2. Change the name and permissions as necessary. 3. Click the Save button.
To delete a role:
1. Select the role you want to delete from the drop down list. 2. Click the Delete button. 3. Press OK to confirm that you want to delete the role.
P a g e | 88
Client Settings
These settings are used to configure the software that will be installed on your clients (machines, computers) that you wish to track. Typically, the default settings should work just fine. If you discover that you need to change these settings, use caution and verify that the changes are set to addresses and ports that exist, and are not restricted or blocked. Incorrect configuration may disrupt your ability to track the clients. Note: If you do make changes, you will need to restart the Server Remoting Service before the changes will take effect.
Client Check in Address : Linux Client Check In Port: Windows Client Check In Port: Mac Client Check In Port: Client Listen Port:
IP or DNS address of your LabStats server. Port in which your Linux clients will use to communicate with the server. Port needs to be open on the server. Port in which your Windows clients will use to communicate with the server. Port needs to be open on the server. Port in which your Mac clients will use to communicate with the server. Port needs to be open on the server. Port in which the server will use to communicate with your clients. Port needs to be open on the client. Server initiates communication with the client for client updates and desktop messages. Number of minutes the server will wait for the client to check in before marking it as Offline. Size in Megabytes the client log files are allowed to grow to. How often the client is instructed to check in and deliver updated Information. Please note that because the client communicates login/logout information independent of this value, changing this interval in most cases will not result in
P a g e | 89
more or less accurate usage data. Changing this number to a smaller value could have a negative impact on performance. This is checked by default. This is useful when manually updating clients. Uncheck this if you find you need to downgrade a client to a previous version. This is based off of the "Desired Version" on the Client Update Manager page.
P a g e | 90
Licensing
Licensing is mainly controlled through the licensing page found by navigating to: Administration -> Licensing.
2. Copy and paste the license key in to the Input License Key section. 3. Click the Save button in the Input License Key section.
P a g e | 91 3. Enter the Server IP or Hostname (This needs to match the information in our records).
2. Click Choose File 3. Browse to the directory where your key file is stored 4. Select the key file and click OK Please note: As of version 5.2.30303.134 all groups will be licensed automatically. This currently includes retired groups. In order to not use licenses on retired groups you will want to either remove the stations from these groups or hide the stations in these groups (this can be done on the station management page).
P a g e | 92
Site Settings
LDAP Settings
LabStats 5 has the ability to authenticate users through the use of an LDAP server. To adjust your LDAP settings do the following:
1. 2. 3. 4. 5.
Navigate to: Administration -> Site Management -> Site Settings -> LDAP Settings. Check the box for Use LDAP for Authentication. Provide the appropriate information (each option is explained below). Click Save. If your settings are incorrect, a warning will appear and the changes you made will not be saved.
Please note: Enabling LDAP will effectively disable local account authentication, you will need to create a LabStats user using the credentials of your LDAP user and assign the admin role to it. Log out of the default role and log in as the new admin user you just created with your LDAP credentials before enabling LDAP.
P a g e | 93
LDAP Root/Base DN (Example xx=yy): LDAP User DN Key: (typically uid, cn, or samAccountName) The root to begin a user search. This can be left blank or may be something like "ou=dew,dc=mountain,dc=com". If you are using Microsoft's Active Directory, then you will need to use "cn" as the key. If you are using an open source LDAP server, then you will most likely need to use "uid" as the key.
Mail Settings
In order for the notification emails to be sent out, you must point LabStats towards a working SMTP server. You can control the email settings by logging in to LabStats and navigating to: Administration -> Site Management -> Site Settings -> Mail Settings.
Security Settings
Allow Password Retrieval? Requires Question and Answer? Minimum Password Length: Require SSL on All Pages:
If this box is checked, then users will be able to retrieve their lost passwords. If this box is checked, then users will be required to answer their security question before they can retrieve or reset their passwords. This setting controls the minimum amount of characters a password must have. If this setting is set to enabled, then all of your LabStats pages will be forced to use SSL.
P a g e | 94
Exclude Public Pages with SSL? Public pages will not be forced to use SSL.
Site Preferences
Change this to customize your site title (ex. University of ...) You can choose to have the "Sign In" link present on the public page (when not logged in).
Site User:
The site user is used to stop/start the LabStats services when performing a database backup/restore. 1. Site User Domain (. is local user): (ex. Computerlabsolutions.com for domain or. for local user account). 2. Site User Name: user name of an administrator to the LabStats server (ex. Administrator). 3. Site User Password: password of the user name entered above.
P a g e | 95
API Settings
Some of the LabStats web services calls require an authentication token. Click on the Generate New Token button to generate a secure token for use with your web services.
We recommend that you use HTTPS when accessing web services and limit access to authenticated web service calls to specific IP addresses.
Please refer to our Knowledge Base article regarding utilizing the API.
P a g e | 96
Activity Log
The activity log can be reached by logging in to LabStats and navigating to: Administration -> Activity Log.
This log contains records about events that have taken place in LabStats such as changing settings and changes to station assignments. You can search for specific activities by clicking the magnifying glass and entering the search criteria in the appropriate column.
P a g e | 97
Public Page
This is the page that can be accessed without a LabStats User. It can be used to display the current status of stations in selected groups. You can also display a list of LabMaps for real time information about available computers.
P a g e | 98
Mobile Page
This is the page that can be accessed without a LabStats User from either a computer or any mobile device. It can be used to display the current status of stations in published groups. You can also view LabMaps for real time information about available computers.
P a g e | 99
Uninstalling LabStats
Uninstalling LabStats Server
LabStats can be uninstalled via Control Panel\Programs and Features. Select LabStats Server and press Uninstall/Change
You will be prompted to confirm your decision and then you will be asked if you want to leave your database and custom content.
Once the uninstallation is complete, you will want to verify that all LabStats files have been removed. The following folders should be removed to ensure complete uninstallation. C:\ProgramData\Computer Lab Solutions C:\Program Files (x86)\Computer Lab Solutions
P a g e | 100