Setup Guide. for Teachers, Instructors, Managers and Administrators. Letter Format for North America. Published by.

Transcription

1 This guide is designed to be used on-screen. Electronic guides save paper, save the environment, and provide ways to find information that printed manuals cannot provide. For tips on best use, see the next page. Setup Guide for Teachers, Instructors, Managers and Administrators Letter Format for North America Published by Copyright Bytes of Learning Incorporated. The UltraKey name and logo and the Bytes of Learning name and logo are registered trademarks of Bytes of Learning. All other trademarks in this guide are the property of their respective owners. Created in Canada Version

2 How to Use this Hyperlinked Guide Click the bookmarks at the left to go anywhere in the document. Click the + sign to expand the bookmark. Click the Contents bookmark and click any topic listed there to arrive at the subject you want. Look for key words using the Search function. Choose Search from the Edit menu or strike Ctrl-F on Windows (Cmd-F on Mac). Click See references when they are provided. Print too small? Too large? Choose a different display from the View menu. Explore all the other Reader functions.

3 Contents Introduction... 1 Think Green... 1 About this Setup Guide... 1 Manuals Installed with Software... 1 Understanding the UltraKey Client and the Server... 2 Communication Uses Internet Protocol... 2 Three Steps for UltraKey Implementation Set up a local or private data server (optional) Set up and configure one copy of the UltraKey client Disseminate the UltraKey client Setting Up the Data Server Choose a Computer for the Data Server Run the Server Software Setup Choose a Data Storage Location Start the Data Server Startup Application Activate the UltraKey Data Server Software Locate the Server Key and Note the Server Key Number Enter the Server Name Enter an External IP Address (Optional) Start the Data Server Service Enable the Necessary Firewall Port (If Necessary)... 7 Enabling a Firewall Port in Windows XP... 7 Enabling a Firewall Port in Windows 7 or later... 7 Enabling a Macintosh Firewall Port... 8 Enabling a Router Firewall... 8 Installing and Activating the UltraKey Client Install the UltraKey Client on One Station... 9 Windows Setup... 9 Macintosh Setup... 9 Upgrading from UltraKey Activate the UltraKey Client UltraKey Setup Guide Copyright Bytes of Learning Incorporated I

4 Contents Configuring UltraKey for Standalone Use Start the UltraKey Client Create a local administrator account Set a default host Set preferences (recommended at this time) Hide management access (Recommended) Configuring UltraKey for Use with the UltraKey Data Server Connect to the Server Enter the Server Key Complete the Server Setup Assistant a. Create the administrator password b. Enter the name of the first host c. Add host managers (optional) d. Set the backup schedule e. Set the Student IDs option f. Review Settings and Confirm Set a default host Set host preferences (optional at this time) Hide management access (Recommended) Configuring the UltraKey Client for the UltraKey Cloud Download a copy of the cloud manager connection key file to the desktop of the computer on which UltraKey is installed Start the UltraKey Client Create a Local administrator account Open the cloud manager connection key file from within UltraKey Log into UltraKey management on the cloud Change your password to something more secure Set a default host Set host preferences (optional at this time) Hide management access (Recommended) UltraKey Setup Guide Copyright Bytes of Learning Incorporated II

5 Contents Disseminating the UltraKey Client to Workstations or Servers About the Host Configuration File Local Records Directory Must Be Present Disseminating the UltraKey Client Using a Workstation Image Implementing the UltraKey Client on Application Servers Using the Network and Multi-computer Assistant (Windows) Installing the UltraKey Client on a Terminal Server Troubleshooting UltraKey Operation Logs Accessing the Data Server Operation Logs Common Topics (More in the Manager Guide) The Data Server Startup Application Cannot Locate the Server Software UltraKey or the Data Server Fails to Activate UltraKey Cannot Locate or Communicate with a Host Problems or Delays Occur while Contacting the Server We Cannot Find Our License Key UltraKey Settings Not Retained from Session to Session Access is Denied or Files are Not Found: UltraKey Access is Denied or Files are Not Found: Data Server UltraKey Reports Problems Creating or Updating Host-based Records Helping Yourself Helping Us Help You For Further Assistance Index... i UltraKey Setup Guide Copyright Bytes of Learning Incorporated III

6 Introduction Think Green Bytes of Learning supports green using the following techniques: Reducing the consumption of paper by providing manuals in electronic form. Reducing the weight of products and their carbon foot print. End users can also go green by using online resources and installed resources such as the electronic user guides provided with UltraKey. About this Setup Guide This guide provides condensed instructions to get UltraKey and the UltraKey Data Server software up and running. It assumes the reader has purchased a multi-station network license for UltraKey. When you read it, you will find the setup faster and easier than if you don t read it. More information is found in the UltraKey Manager Guide. Manuals Installed with Software Guides are installed with the UltraKey and UltraKey Data Server software. All guides are interactive. They can be searched or accessed by their tables of contents, indexes and reference links. All guides are accessible through The Windows Start Menu The Macintosh Applications Folder The Help menu The UltraKey Manager Guide provides detailed technical and instructional guidance. The UltraKey User Guide is an excellent resource to help students learn why they should learn to keyboard and how to best use UltraKey. The Network Assistant Guide details the use of the Network and Multi-computer Assistant that is part of the UltraKey setup program for Windows. The Assistant helps you efficiently disseminate configured copies of UltraKey for Windows to local workstations, application servers and terminal servers. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 1

7 Understanding the UltraKey Client and the Server UltraKey has two components. The client provides the instruction on Mac and Windows computers. The client can be installed locally on each workstation, centrally on an application server, or centrally on a terminal server. The data server software records and disseminates record data, option settings and custom content. Customers have the option of subscribing to cloud-based data management provided by Bytes of Learning or installing a private instance of the data server software. When the customer installs a private instance of the data server software, the data server software is installed on one computer for the school, site or enterprise. The data server software is a service (not an application) that runs in the background of the computer. It can be installed on any Windows computer or server with a static IP address or unique computer name. A teacher can install it on a PC in her class or technicians can install the server software at the central office. A single installation can serve a whole school district. The server software is not available for Mac OS X servers. However, since only one PC is needed to operate the server software, and it can serve a whole enterprise, many all-mac districts are using the UltraKey solution by utilizing an existing PC or server, or by operating the software on a Windows partition of a Mac. Other Mac districts are opting for cloudbased data management. Communication Uses Internet Protocol The UltraKey client communicates with the server software using TCP/IP shortened here to IP, which stands for Internet Protocol. All web browsers, programs, updating software, and virus protection programs use IP to communicate through local area networks (LANs), wide area networks (WANs), intranets, and the Internet. There are three main advantages to IP communication: IP communication occurs across any LAN, WAN or Internet. Nobody needs network permissions so IP reduces interruptions and maintenance costs. One service installation serves a whole district, reducing installation and upkeep cost. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 2

8 Three Steps for UltraKey Implementation Three main steps need to be executed to install, configure and disseminate UltraKey for use in the school, district or enterprise. 1. Set up a local or private data server (optional). 2. Set up and configure one copy of the UltraKey client. 3. Disseminate the UltraKey client. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 3

9 Setting Up the Data Server This section is for customers who are setting up their own installation of the UltraKey Data Server rather than using the cloud-based data service available from Bytes of Learning. 1. Choose a Computer for the Data Server If you have already installed a trial copy of the UltraKey Data Server software and the copy is current, you do not need to reinstall it. Go to Activate the UltraKey Data Server Software page 4. Any PC or PC server running Windows 2000 or later can accommodate the server software: Must have Internet access, or be connected to the LAN or WAN UltraKey clients are running on. Must have a static IP address so UltraKey clients can relocate it after first contact. The computer does not have to be dedicated to the server software. The server software can co-exist with other services on a central server. The server software can easily run on a teacher workstation with no appreciable slowdown. 2. Run the Server Software Setup Server software is not installed the same way as application software. However, installing it is not difficult as long as you follow the instructions. You must be at the server computer in order to install the server software or you must be remotely logged into the server computer. You cannot install server software to a server from a workstation. The setup program provides instructions for each step. 3. Choose a Data Storage Location The installation software asks where the server software data should be located. The default setting for data location should be accepted unless you have reasons for locating the data elsewhere. DO NOT locate the data directory in any shared user space on the server. The data directory is private to the Data Server. Only the server administrator and the Local System account require access to it. Putting the data in a shared space may interfere with its operation. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 4

10 Setting Up the Data Server Data can be located on any local drive. If you do not use the default location, make sure the Local System account on the computer or server, on which the server software is installed, has full permission to write to the selected location. 4. Start the Data Server Startup Application At the completion of setup or using the Start menu, choose the Data Server Startup application. Windows 7 or later Users: When starting the Data Server application, it is necessary to always right-click the application icon and choose Run as administrator. Do this even when you are logged on as the administrator. If you do not, the server software will not write its configuration file in the common user space. It will direct the information to a personal directory without the UltraKey Data Server software knowing. You cannot run the Startup Application from a remote workstation. Services can only be started at the computer or server, or as a user logged in through Terminal Services Client. 5. Activate the UltraKey Data Server Software Having run the data server startup as specified in step 4, click the Activate button. If you have been using the Server software on a trial license, click Stop Server and click Activate. License keys are provided by to the designated contact for the license. Enter the UltraKey Data Server license key. Case does not matter. Check accuracy, and click OK. If you have problems when you enter the key accurately, make sure you are not using the UltraKey client key. Also make sure you are using the correct Data Server edition (North America, UK, or Australia-New Zealand). 6. Locate the Server Key and Note the Server Key Number When the Data Server startup application presents a welcome screen, click Preferences. The Server Key panel is automatically presented. The server key must be supplied to whoever will complete the host setup using UltraKey. The server key is the backdoor admin account password so keep it secure. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 5

11 Setting Up the Data Server 7. Enter the Server Name On the Server Setting panel, enter the name of the data server as it will be presented to UltraKey users. This name should be relatively short and unique. The entered information is displayed to users of UltraKey when they log into management or log in as users until a default host is set. 8. Enter an External IP Address (Optional) The external IP address for a server is the public IP address for the site or enterprise that is mapped to the serving computer. This mapping might already be done for other uses such as VPN access. If you have a domain name for this IP address, such as UltraKey.mydomain.com, you can enter that here. If you intend to enable remote UltraKey login or UltraKey clients at remote sites will communicate with the UltraKey Data Server software from outside the present location, then the IP address or domain name must be entered now. If you intend to operate UltraKey and the UltraKey Data Server within the same local network with no communication from outside that network, you do not need to enter the external IP address now. You can enter this information later when you decide to use external communication. UltraKey clients request the external IP address from the UltraKey Data Server when managers create UltraKey connection keys. Connection keys are files containing encrypted information about communicating with the Data Server from remote locations. Opening a connection key causes UltraKey to start and automatically communicate with the UltraKey Data Server wherever it is located. To enter the external IP address or domain name, click the External IP tab on the Data Server Preferences panel. Click OK to apply the changes to the Preferences panels 9. Start the Data Server Service Click the button called Start Server. Then exit the Data Server startup application. The service remains running when the startup program is closed. The service re-starts whenever the server computer is restarted. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 6

12 Setting Up the Data Server 10. Enable the Necessary Firewall Port (If Necessary) If any firewall stands between the server computer and the operating client computers, port 5976 must be enabled for TCP/IP communication on the server firewall. If the site is firewalled and you intend to have UltraKey clients communicating through the site s public IP address, the same port must be opened on the site firewall. The UltraKey Data Server Software is engineered for security. All communication is encrypted, and the server software does not communicate with anything other than UltraKey. Enabling a firewall port does not compromise security. Certain firewall ports must be opened for any communications to occur between a computer and the outside world. Enabling a Firewall Port in Windows XP 1. Open the Windows Firewall control panel. Click the Exceptions tab and click Add Port. 2. Enter the suggested name, UltraKey Data Server. 3. Enter the port number, Click TCP. 5. Click Change Scope. 6. If the data server software will only serve a local network, click My network. For the data server software to communicate through a WAN, or Internet, click Any computer. 7. click OK to close the Change Scope dialog. 8. click OK again to apply the firewall settings. Enabling a Firewall Port in Windows 7 or later Firewall ports are configured using similar but differing methods in Windows Vista, 7 and Windows 8. The following instructions should be used more as guides than specific steps in the process: Open the Windows Security Center usually found in the Control Panel. Open the Windows firewall settings. Open Advanced settings. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 7

13 Setting Up the Data Server If this is a workstation, you need to enable the UltraKey client. If this is the server computer, you need to enable the UltraKey Data Server service, not the UltraKey Data Server Startup program. On Windows Vista, allow the application installed on the computer to communicate through the firewall. It is not usually necessary to enable a specific port. Enable inbound and outbound communication whenever the option is offered. On Windows 7 and Windows 8, look for an Advanced settings link. Create inbound and outbound rules that enable TCP/IP communication. Enabling a Macintosh Firewall Port 1. Open the Preferences panel. 2. Click Security. 3. Click the Firewall tab. 4. Unlock the Firewall panel. 5. Click Advanced. 6. A list of permitted applications is presented. Click the + sign below it. 7. Locate UltraKey and open it. This should add UltraKey to the list of applications permitted to communicate through the firewall. It is not normally necessary to enable a specific port. 8. Quit. Enabling a Router Firewall Internet routers will vary depending on the router manufacturer. See their instructions. Your objective is to enable inbound and outbound UltraKey TCP/IP communication on port UltraKey Setup Guide Copyright Bytes of Learning Incorporated 8

14 Installing and Activating the UltraKey Client This section applies regardless of whether the customer has opted for cloud-based data operation or a private server installation. 1. Install the UltraKey Client on One Station Log into the computer with installation rights so UltraKey can write the license information and other configuration data when installation is completed. If you have been provided a custom setup program for cloud access, you need to install it even if you have a previous trial copy. If you have already installed a trial copy of UltraKey and the copy is current, you do not need to reinstall it. Go to Activate UltraKey page 9. If you intend to place UltraKey on an application server or terminal server, we suggest you install it first on a local workstation and move it to the final location after you have configured a local copy. Windows Setup Download the UltraKey Windows setup program to the computer and open it. Follow the instructions displayed. Macintosh Setup Download the UltraKey Macintosh image file (.dmg) to the computer and mount it. Instructions are displayed. Upgrading from UltraKey 5 The Windows setup program automatically searches for UltraKey 5 files and records and transfers them for use by UltraKey 6 when you confirm the transfer. A script called Transfer Files is presented by the Macintosh installer when the image is mounted. Opening the script causes it to search and transfer UltraKey 5 files. No files are transferred after UltraKey 6 is configured and initialized. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 9

15 Installing and Activating the UltraKey Client 2. Activate the UltraKey Client Log into the computer with installation rights so UltraKey can write the license information and other configuration data. On Windows 7 or later users, right-click UltraKey and choose Run as administrator from the menu. This is necessary even when you are logged in to the computer as an administrator. If you have just installed UltraKey, the software will request the entry of a license key when you start it. A 4-part license key was ed to the designated contact for the site. Enter the client license key, striking Tab to move between fields. Case does not matter. Check accuracy, and click OK. If you have already installed a trial copy of UltraKey and do not need to reinstall, start UltraKey and click the Activate button presented on the trial license dialog. If you are reactivating UltraKey, start the software, enter the management section and choose Activate from the Help menu. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 10

16 Configuring UltraKey for Standalone Use Data Server and Cloud-service data users skip this section. Your purpose here is to configure UltraKey so it starts and saves its record locally. You are option not to have records stored centrally. 1. Start the UltraKey Client. Always log into the local computer with installation rights. Windows 7 or later Users: You must right-click the UltraKey application or its startup shortcut and choose Run as administrator. If you don t, then any configuration settings will be diverted to a virtual path for your user account and will not be available to other users of UltraKey. When other users operate the program, UltraKey will behave as if it has not been licensed or configured. Installation rights and right-clicking are only necessary to the configuration process, not to normal operation. 2. Create a local administrator account. At the UltraKey title screen, click Management. Highlight Local and click Connect or double-click Local. Unless a local UltraKey administrator account exists, UltraKey asks you to enter a name and password. Create a local account using a password that is secure. 3. Set a default host. Pull down the File menu and choose Set Local as Default. When the option is offered, save the host list with the program. In case you miss this step, choose Save Host List with Program from the File menu. 4. Set preferences (recommended at this time). Click Local Preferences. Explore and adjust as needed. Preferences you set now are distributed if you use the Network and Multicomputer Assistant. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 11

17 Configuring UltraKey for Standalone Use 5. Hide management access (Recommended). Management access is secured by manager names and passwords but management access can be made more secure by removing the Management button from the title screen. Choose Set Management Access from the File menu. Follow the instructions displayed. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 12

18 Configuring UltraKey for Use with the UltraKey Data Server Cloud-based data users skip this section. This section is part 2 of the process when you are setting up a private data server installation. The setup process described here is necessary to initialize the data server. Everything you do can be changed later. 1. Connect to the Server When UltraKey starts, it presents the UltraKey title screen. Click Management to access the management area. UltraKey presents a host list. If the server software is installed on a server on the local network, click Search Network. If the server software is installed on a server that is not on the local network, click Specify Server and enter the external IP address of the server. If you want to locate the server software by computer name instead of IP address, click Specify Server. The new server host should appear on the Host list. If not, the service is not running or the communication is being blocked by a firewall. Highlight the server and host name and click Connect. This starts the Setup Assistant. 2. Enter the Server Key When the manager login dialog is displayed, enter the server key. The server key is displayed in the data server software Preferences panel. The server key is a backdoor password for the admin account that can be used in the future if the admin password is forgotten. It is used here as an initial access password. 3. Complete the Server Setup Assistant The Assistant presents instructions for each step. Carefully read each dialog and respond according to your needs. Click Next as each step on the next page is completed. a. Create the administrator password. All other manager accounts will have names specific to the manager such as Bob Charles but the administrator account is always called admin. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 13

19 Configuring the UltraKey Client for Use with an UltraKey Data Server Click the Change button to enter an administrator password. It must be at least 4 characters long. Case does not matter. Enter the password twice so the dialog indicates a match. Click OK. Then click Next. b. Enter the name of the first host. This is usually the name of a school or a site. This host name will show on the host list when managers and students log in. Check the name and proceed by clicking Next. c. Add host managers (optional). If you are setting up several sites, click Add to enter the host managers for each site. Highlight the manager name and check the box beside the host that person manages. Multiple managers can manage multiple hosts. For a manager to log into a host, the manager must be assigned to that host. Click Next when you have created and assigned any necessary host manager accounts. d. Set the backup schedule. The UltraKey Data Server software makes a backup copy of the whole server database according to the frequency set at this time. The server data backup is a series of dated copies of the UltraKey data directory. Set the schedule and click Next. e. Set the Student IDs option. Student IDs are unique alphanumeric identifiers essential to using the UltraKey automated student transfer capability. The Student Record Management function determines the setting for all hosts on the server. Choose an option and click Next. f. Review Settings and Confirm. Review the entered settings. If you are satisfied, click the Next button to complete the Setup. Click Back to change any of the setup options 4. Set a default host. Click Host Management. This will display the host list with the initial host on it. Assuming this is the host to default to, highlight it and click Set as Default. When the option is offered, save the host list with the program. In case you miss this step, choose Save Host List with Program from the File menu. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 14

20 Configuring the UltraKey Client for Use with an UltraKey Data Server 5. Set host preferences (optional at this time). If you have time and would like to explore the preferences now, highlight the host and click Connect. Click Host Preferences. 6. Hide management access (Recommended). Management access is secured by manager names and passwords but management access can be made more secure by removing the Management button from the title screen. This is a host setting so it is not essential at this time but should be executed as soon as possible. Connect to the host. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 15

21 Configuring the UltraKey Client for the UltraKey Cloud This section assumes you are a cloud-based data subscriber. When customers purchase cloud-based data subscriptions, Bytes of Learning an UltraKey cloud manager connection key, which is a downloadable file. 1. Download a copy of the cloud manager connection key file to the desktop of the computer on which UltraKey is installed. 2. Start the UltraKey Client. Always log into the local computer with installation rights. Windows 7 or later Users: You must right-click the UltraKey application or its startup shortcut and choose Run as administrator. If you don t, then any configuration settings will be diverted to a virtual path for your user account and will not be available to other users of UltraKey. When other users operate the program, UltraKey will then behave as if it has not been licensed or configured. Installation rights and right-clicking are only necessary to the configuration process, not to normal operation. 3. Create a Local administrator account. At the UltraKey title screen, click Management. Highlight Local and click Connect or double-click Local. Unless a local UltraKey administrator account exists, UltraKey asks you to enter a name and password. Create a local account using a password that is secure. Once you are logged into Local, review Preferences and consider how you want UltraKey to behave in case the server is not accessible. Exit local management. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 16

22 Configuring the UltraKey Client for the UltraKey Cloud 4. Open the cloud manager connection key file from within UltraKey. At the UltraKey title screen, pull down the File menu and choose Open Connection Key. Navigate to the connection key file and open it. Assuming you are connected to the Internet and communication is not blocked, UltraKey will successfully communicate with the cloud and report a successful connection. Confirm this by reading the small text displayed below the Speak, Management and Login buttons on the title screen. If communication is not successful, See UltraKey Cannot Locate or Communicate with a Host page Log into UltraKey management on the cloud. At the UltraKey title screen, click Management. Enter the provided cloud manager account name and password. UltraKey should log you in. 6. Change your password to something more secure. Having logged in as the cloud manager, pull down the Edit menu and choose Change Name and Password. Enter a secure case-sensitive password with at least 4 characters. Note the password because you will have to ask Bytes of Learning to reset it if the password is forgotten. 7. Set a default host. Click Host Management. Highlight the host you want to be the default and click Set as Default. UltraKey presents a dialog that explains where default host settings are stored and how you can locate the configuration file. When the option is offered, save the host list with the program. In case you miss this step, choose Save Host List with Program from the File menu. 8. Set host preferences (optional at this time). If you have time and would like to explore the preferences now, highlight the default host and click Connect. Click Host Preferences. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 17

23 Configuring the UltraKey Client for the UltraKey Cloud 9. Hide management access (Recommended). Highlight the default host and click Connect. Management access is secured by manager names and passwords but management access can be made more secure by removing the Management button from the title screen. This is a host setting so it is not essential at this time but should be executed as soon as possible. Pull down the File menu and choose Set Management Access. Follow the instructions displayed. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 18

24 Disseminating the UltraKey Client to Workstations or Servers Having configured one copy of UltraKey, you are ready to disseminate or implement it in whatever way suits your needs. UltraKey is engineered so the client can be installed on local workstations, shared from an application server, or operated from a terminal server. Regardless of whether the client is operating from the local hard drive or being served from an application server, certain UltraKey files must be present on the local workstation hard drive. We call these local configuration files. We provide a tool in the UltraKey client setup program called the Network and Multicomputer Assistant, which will ensure that all files are gathered into a custom setup ready for you to use. For example, if you are serving the Windows format of UltraKey from an application server, the Assistant creates a server copy of the program with a setup program designed to easily set up all the workstations served by that copy of UltraKey. The Macintosh format of UltraKey is a slightly easier program to disseminate. You can gather and disseminate all the files or just disseminate the UltraKey program folder and let the program establish its local files on first run. In any case, make sure the UltraKey configuration file called UltraKey6.blidfh is present inside the Mac program folder. Then you need only disseminate the program folder itself. The same program folder can be placed on a Macintosh application server and UltraKey can be operated using aliases on the workstation desktops or docks. About the Host Configuration File The host configuration file named UltraKey6.blidfh (builds prior to name this file UltraKey6.config) contains the UltraKey host list and default host. This file must be present so UltraKey knows where remote hosts are located and which one to open as the default. New with UltraKey 6, the configuration file or host list file can be manually placed inside the UltraKey program directory. UltraKey now provides a friendly function for saving the host list file with the program, on the File menu when you are logged into management. When UltraKey 6 starts, it looks for the file UltraKey6.blidfh in its program directory and uses that file when it is found. When it is not found there, UltraKey looks for the file in its local location. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 19

25 Disseminating the UltraKey Client to Workstations or Servers All customer installers place the configuration file in the program directory at the outset. UltraKey creates the file UltraKey6.blidfh in the following paths: Windows 2000 to XP Windows Vista, 7 or later Macintosh Documents and Settings\All Users\Documents\UltraKey6 Users\Public\Public Documents\UltraKey6 Users:Shared:UltraKey6 When the configuration file is relocated to the program directory or program folder, UltraKey uses that copy of the file and updates it whenever an administrator reconfigures the program. Local Records Directory Must Be Present Even when UltraKey is operated from an application server, the UltraKey local records directory must be present. This directory houses the local preference settings. It also houses local records for users who save their records on the local workstation when UltraKey is operating in local mode. UltraKey does not require write permission to the local records directory except when managers need to change local settings or users need to save records. Local settings can be set so UltraKey always runs in Practice Mode during local operation, so no user records are created or maintained. There are three ways to ensure that a local records directory is present. One is to disseminate a local records directory to its appropriate location during the dissemination process. The second is to operate each disseminated copy of UltraKey once on each workstation with installation rights and running as administrator under Windows 7 or later. The UltraKey client automatically creates a local records directory when it is not present. UltraKey presents a First Run dialog to signal that the workstation is being initialized. Once this dialog is dismissed and UltraKey is able to create the local records directory, the First Run dialog is never presented again. The third, which we strongly recommend for Windows users, is to create a custom UltraKey installer using the Network and Multi-computer Assistant, which is part of the UltraKey UltraKey Setup Guide Copyright Bytes of Learning Incorporated 20

26 Disseminating the UltraKey Client to Workstations or Servers setup program for Windows. See Using the Network and Multi-computer Assistant (Windows) page 22. The local records folder or directory is named UltraKey6. It is located as follows Windows 2000 to XP Windows Vista, 7 or later Macintosh Documents and Settings\All Users\Documents\UltraKey6 Users\Public\Public Documents\UltraKey6 Users:Shared:UltraKey6 Disseminating the UltraKey Client Using a Workstation Image If your enterprise uses imaging processes to disseminate new applications, configure UltraKey on the computer used for image sourcing. Once UltraKey is completely configured, it does not need any write access to operate. So UltraKey workstations can be completely locked. Given access to a remote host, UltraKey can still maintain user records and adjust management settings by communicating with the remote host. To further eliminate any need for local writing, set the local operation to Practice Mode as recommended earlier in this guide. If ever the remote host is not available when users start UltraKey, UltraKey will ask users to enter their names for each session but will not keep any record of it. See Set UltraKey to Practice Mode page Error! Bookmark not defined.. Implementing the UltraKey Client on Application Servers When you place a copy of the file UltraKey6.blidfh in the UltraKey program directory for Windows or the UltraKey program folder for Macintosh, you can copy the whole program folder or directory onto an application server. UltraKey can then be operated from the application server without having to disseminate the file UltraKey6.blidfh to every workstation. UltraKey uses the host information found in the file UltraKey6.blidfh located in its program directory or folder. If you need to change the host configuration for UltraKey, run a locally installed copy of the UltraKey software, edit the host list, and copy the revised configuration file UltraKey6.blidfh file to the UltraKey program folder or directory located on the application server. Alternatively, you can operate the server-based copy of UltraKey and change the UltraKey Setup Guide Copyright Bytes of Learning Incorporated 21

27 Disseminating the UltraKey Client to Workstations or Servers configuration directly but you must have read-write access to the server-based program directory or folder for UltraKey to save the changes. Regardless of the location of the UltraKey configuration file, UltraKey still requires a Local records directory to be present on the workstation hard drive. When UltraKey starts and cannot locate a Local records directory, it automatically creates it. If the local settings are of less importance, UltraKey needs only to operate once under administrative rights so it can create a local records directory. Alternatively, a records directory can be distributed to the workstations. Windows users are encouraged to use the network and Multi-computer Assistant for the most complete and reliable Windows dissemination. Using the Network and Multi-computer Assistant (Windows) The UltraKey Windows installer software includes the Network and Multi-computer Assistant. This function has been specially prepared to reduce the amount of time and increase the certainty while disseminating UltraKey to multiple workstations, application servers and terminal servers. After configuring one copy of the UltraKey client, run the UltraKey setup program on that same computer. Choose Network and Multi-computer Assistant from the setup menu. A detailed guide is offered. The Assistant senses whether a copy of UltraKey is installed and whether or not it is configured and ready for dissemination. Installing the UltraKey Client on a Terminal Server UltraKey has been optimized for thin-client operation on servers such as Citrix, NComputing and Windows Terminal Server. If the server environment permits, set UltraKey up right on the terminal server. Alternatively, create a terminal server setup directory using the Network and Multi-computer Assistant. Then run the contained setup program to install UltraKey on the terminal server. Operation preferences are determined by the host in use. See the earlier section Set Local preferences page Error! Bookmark not defined.. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 22

28 Troubleshooting UltraKey is engineered for enterprise use, so it contains tools to facilitate troubleshooting and keep maintenance as efficient as possible. UltraKey Operation Logs Each UltraKey client and the UltraKey Data Server maintain logs of their activities. Operation conditions, tasks, and errors are recorded in them. When UltraKey is denied access to log writing folders, it ignores the error to avoid difficulties when computers are locked to users. To access the UltraKey operation logs, start UltraKey on a computer where the errors occur. Log into Management. Choose Operation Logs from the File menu. Click Open Log File. Scroll down the log to its end to see what UltraKey was doing the last time it stopped. To attach a copy of the log to an , click Open Log Directory. Attach the latest log file to an to: techhelp@bytesoflearning.com >> When you are finished reviewing any log, close the log file. If the log file is in use when UltraKey runs, UltraKey cannot update it. If no log files are present, run UltraKey while you are logged onto the computer as an administrator and replicate the problem you have observed. Then open the log. Accessing the Data Server Operation Logs For each main function, the server software records a separate log: Log Filename UKeyServer.log Location Documents and Settings\All Users\Application Data\UKeyServer [Windows 7 or later] ProgramData\UKeyServer UKeyBackup.log Documents and Settings\All Users\Application Data\UKeyBackup [Windows 7 or later] ProgramData\UKeyBackup UltraKey Setup Guide Copyright Bytes of Learning Incorporated 23

29 Troubleshooting Common Topics (More in the Manager Guide) The Data Server Startup Application Cannot Locate the Server Software This error occurs on Windows 7 or later systems when administrators initialize the software without running it as an administrator. Log into the computer with installation rights. If you are running the server startup application, exit. Search for the directory named UKeyServer. Make sure you search hidden directories. At least one instance should be found. Delete all such directories found. Re-start the UltraKey Data Server Startup by right-clicking the application and choosing Run as administrator from the context menu. Re-activate the software and conduct all other setup procedures. Review the preferences and other general settings. Then resume normal operation. UltraKey or the Data Server Fails to Activate Several conditions are required for activation to proceed successfully: Use the correct key for the application. The server key does not activate the client and the client key does not activate the server. Use the correct key for the edition. There are three editions of UltraKey: North America, UK, and Australia-New Zealand. As an example, a UK edition of UltraKey cannot be activated with a North American key. When the keys are accepted, UltraKey and the UltraKey Data Server must write the information to the local hard drive. If UltraKey reports it could not write the information, then you are not logged on with the rights you need. If you are using Vista, Windows 7 or later you must right-click the program and choose Run as administrator in order to have administration rights. Otherwise, the system writes new files to the virtual paths for your account rather than the common paths. Consequently, when other users run UltraKey, it will not be activated. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 24

30 Troubleshooting UltraKey Cannot Locate or Communicate with a Host UltraKey can only search for data server hosts on the local area network. If the server software is operating on a computer outside the local network, click Specify Server and enter the IP address or server name using the protocol //Server name. If UltraKey cannot find a host or communicate with it, then a firewall is probably blocking communication. See Trouble Shooting Firewalls page Error! Bookmark not defined.. Problems or Delays Occur while Contacting the Server Server contact is usually very rapid even when many students are logging into UltraKey. However, delays or failures can occur for the following reasons: The server software is stopped. A firewall is blocking communication. A security program is interfering with IP communication. The IP address of the server software computer (or its network name) has changed since the last time UltraKey contacted it. You have a slow Internet connection or Internet connection is lost. If you are working through a wireless connection, check to make sure the signal strength is strong and the speed is reasonable. Other network activity is bogging down the network or the computer is being bogged down by some background activity such as updating. Consult the UltraKey operation log for details about any errors UltraKey is encountering. We Cannot Find Our License Key All Bytes of Learning multi-station license keys are sent directly to the designated contact of the site by . Check archives and filtered folders such as Junk, Spam or Quarantine. Visit and choose Lost Access Keys from the Support menu. Schools must complete our lost access key application and forward the completed form to customer service. If a service charge applies, payment must be provided. We cannot accept purchase orders for this service. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 25

31 Troubleshooting UltraKey Settings Not Retained from Session to Session Local configuration settings such as default host selections have to be written to a configuration file on the local computer. UltraKey cannot write its configuration file unless the current operator is logged into the computer with permission to write to the computer s public directories. Users of Windows 7 or later: To configure UltraKey, you must log into the computer with administrator privileges. Then, you must right-click the application and choose Run as administrator. You must perform both actions in order for UltraKey to have the appropriate writing permissions. Otherwise, the system will redirect UltraKey configuration files to virtual paths for the logged in user regardless of the administrative authority of that user. Access is Denied or Files are Not Found: UltraKey UltraKey eliminates permission problems by adopting Internet Protocol as its communication platform. However, the UltraKey program and its configuration files must be accessible to UltraKey when students log on the computer. UltraKey does not need any write access while operated by regular users unless their records are stored locally. When UltraKey is operated by a manager, it needs certain writing permissions to the local computer to save any local settings that are changed. Access is Denied or Files are Not Found: Data Server If a person who has administration rights, logs onto the server computer and sets up the UltraKey Data Server software, the software might not be able to read its configuration files if the software is started under another user s account. This is because some systems are set to assign ownership and access exclusively to the person who creates the files. When the server software writes a file under a person s account, it is as if that person is saving the file. The system might assign exclusive access to that user account. To resolve this possibility, make sure the Local System account on the Windows computer has full read/write access to the UltraKey Data Server files and folders. Make sure no ownership rights, other than those of the Administrator and Local System account, are assigned to the UltraKey Data Server software or the files it writes. The files must not be shared. They just have to be accessible and writable by the server software. Primary data and backup data are stored in the default directory of the server software unless the location has been changed. UltraKey Setup Guide Copyright Bytes of Learning Incorporated 26

32 Troubleshooting UltraKey Reports Problems Creating or Updating Host-based Records The most common cause for this is the server hard drive is full. Depending on the server settings, the data server makes a backup copy of the whole data directory and dates it. It never deletes a backup copy. We have been contacted by some enterprises that have enjoyed such trouble-free operation from the UltraKey Data Server, they have not visited the server hard drive for several years. The hard drive has become filled with backups. Delete old backups and you should be ready to go for another few years! Helping Yourself In addition to this guide, the following resources are available at all times: Whenever you are logged in to the UltraKey management area, click the Help menu and choose the UltraKey Manager Guide. Most answers are found there. Visit and access FAQs in the Support area. You can also search for key words on the site. Helping Us Help You To solve any problem, you first have to know what the problem is and all the details about when it occurs. Carry out these steps: Record the error message in its entirety and precisely as stated. On a Windows computer, while the error is displayed, strike Alt-Prnt Scrn to copy the error dialog to the clipboard. Then start an and strike Ctrl-v to paste the capture into the . On a Macintosh computer, strike Shift-Cmd-3 to capture a copy of the screen to the desktop. Attach a copy of the screen capture to an . In the , write as many details as you know including answers to these questions: What happened just before the problem occurred? In what part of the program did the problem occur? What was the user doing when the error occurred? Are you able to make the problem occur again by repeating the same steps? More next page UltraKey Setup Guide Copyright Bytes of Learning Incorporated 27