OpenFox Desktop Guide Version

Transcription

1 OpenFox Desktop Guide Version Computer Projects of Illinois, Inc. 475 Quadrangle Drive, Suite A Bolingbrook, IL (630)

2 THIS PAGE INTENTIONALLY LEFT BLANK Pg. 2 Table of Contents Ver

3 TABLE OF CONTENTS Chapter 1 Introduction and Overview OpenFox Desktop Introduction Java Runtime Environment Relationship to the OpenFox Message Switching System Desktop Licensing OpenFox License Records Pool Licenses Restricted Use Licenses License Registration Registered License File License Management Desktop Communications and Device Identification Session Based Protocol Encryption Negotiation Device Identification Hardware Fingerprint Desktop Modules Definition of Terms Chapter 2 Initial Installation Client System Requirements OpenFox Requirements Station Configuration User Configuration Session Authority Local Directory Structure Desktop Application Code The \CPI Directory Installing from CD Installing the Java Runtime Environment Installing the Desktop Installing from the Desktop Web Portal Installing the Java Runtime Environment Product Registration The OpenFox Desktop Web Portal Launching OpenFox Desktop OpenFox Desktop External Log Viewer Download Java Runtime Appendix Running the Java Runtime Environment Installer Chapter 3 OpenFox Desktop Communications Session Establishment Ver Table of Contents Pg. 3

4 3.2 Device Identification Process User LOGON Desktop Architecture Desktop Window Title Common Desktop Menus Main Desktop Panel Desktop Status Icons Desktop Taskbar Common Window Controls Maximize the Window Restore the Window Minimize the Window Close the Window Window System Menu Multiple Window Management Temporary Screen Lock User LOGOFF and User Swapping Session Disconnect User Preferences Desktop General Preferences Desktop Appearance Preferences Terminal Preferences Desktop Accessibility Terminal Preferences Desktop Sound Terminal Preferences Vin Assist Desktop Log File Desktop Help System Navigational Tools Actions Contents Tab Index Tab Search Tab Search Within Help Pages Pg. 4 Table of Contents Ver

5 Chapter 1 Introduction and Overview This chapter introduces the OpenFox Desktop. It includes a general description of the software, how it works, and how to use it. The following topics are covered in this chapter: OpenFox Desktop Introduction o Java Runtime Environment o Relationship to the OpenFox Message Switching System Desktop Licensing o OpenFox License Records o License Registration o Registered License File o License Management Desktop Communications and Device Identification o Session Based Protocol o Encryption Negotiation o Device Identification o Hardware Fingerprint Desktop Modules Definition of Terms 1.1 OpenFox Desktop Introduction The OpenFox Desktop is a full fledged Java application that is deployed from the OpenFox Server via Java WebStart utilizing HTTP. Launching the OpenFox Desktop is as simple as clicking on a hyper-link on a web page. The OpenFox Desktop is managed as a central site application. When properly authenticated, Java Web Start automatically installs and updates the application upon launch. This design effectively eliminates costly application deployment to end user sites. The only prerequisite is the Java Runtime Environment which is available as a free download from Sun Microsystems Java Runtime Environment The OpenFox Desktop is written in the Java programming language. The Desktop runs within the Java Runtime Environment, a product of Sun Microsystems. The Java Runtime Environment is a platform independent application environment. Thus, the OpenFox Desktop may be run from any hardware platform that supports the Java Runtime Environment and is capable of displaying a desktop style graphical user interface (for example Microsoft Windows, Linux, and Macintosh ). Ver Chapter 2: Initial Installation Pg. 5

6 The Java Runtime Environment is available as a free download from Sun and is available at the following URL, Technical information regarding the Java programming language and the Java Runtime Environment is available from the same website Relationship to the OpenFox Message Switching System The OpenFox Desktop software application is tightly integrated with the OpenFox Message Switching System. The Desktop application is able to rely upon many of the proven features of the OpenFox Message Switch. OpenFox Desktop is configured and managed via the OpenFox Message Switch through the same toolset as any other client application that connects to the message switch. The Desktop also makes use of the strong security, logging, message routing, and message editing features present in the OpenFox Message Switch. OpenFox Desktop was designed to integrate all the various OpenFox client applications and tools. OpenFox Desktop provides one common environment in which all OpenFox Java client applications live. The Desktop environment provides client applications with a common communications pathway to the OpenFox Message Switch along with a universal look and feel. 1.2 Desktop Licensing Every copy of OpenFox Desktop that is distributed to a client workstation must be registered with the OpenFox Message Switching System in order to connect to the system. If a user tries to launch an un-registered copy of the OpenFox Desktop software, he or she is automatically directed to the Desktop Registration application, which guides the user through the registration process. For end user instructions on how to register a copy of the Desktop software, please consult the section titled Product Registration under the Initial Installation chapter OpenFox License Records An OpenFox license record contains all the information relevant to a licensed copy of the OpenFox Desktop software. These records are stored on the OpenFox message switch platform and are managed through the OpenFox Configurator. OpenFox Desktop license records are added to the OpenFox system by CPI staff when a customer purchases them. Pg. 6 Chapter 2: Initial Installation: Ver

7 A license record contains the following information. Product Key A unique code that identifies a Desktop license Purchasing Agency The agency that purchased the license from CPI Assigned Agency The purchasing agency may choose to delegate a license so that it may only be used from a specific agency. This field is optional. If this field is specified, this license may only be registered with a terminal mnemonic that is associated to the same agency. If this field is not specified then this field will default to the purchasing agency. Local Encryption Key An encryption key that may be used by different Desktop Modules. This key is intended for use by Modules that must store sensitive data on the workstation s local hard drive. OpenFox Desktop does not use this key for any other purpose. This key is generated by a cryptographically secure random number generator when a license is registered. Registered Station When this license is registered, it must be associated to an OpenFox station record (i.e. a terminal ID or mnemonic). When a Desktop session is established, the OpenFox Message Switching System will use this field to identify the device. Valid Modules A list of Desktop Module applications for which this license is valid Hardware Fingerprint An optional fingerprint of a workstation s hardware components. This feature may be used to restrict a particular registered copy of Desktop to a specific computer. Number of Stations If this license is a pool or a restricted use license (see below), this field holds the number of concurrent stations that may use this license. When the license records are initially added by the CPI staff, they will only contain the license s product key and purchasing agency. All other fields are initially blank Pool Licenses Pool licenses are OpenFox Desktop licenses that may be shared among any number, up to 255, of workstations. A pool license is registered to a LIST class station record in the OpenFox Message Switch. The LIST class station contains the list of MSNGR class station records. When a workstation connects to the message switch, it is assigned the first available terminal mnemonic in the station LIST. Ver Chapter 2: Initial Installation Pg. 7

8 1.2.3 Restricted Use Licenses Similar to pool licenses, restricted use licenses may be shared among any number, up to 255, of workstations. However, unlike pool licenses, a workstation that uses a restricted use license will always be assigned the same terminal mnemonic from session to session. This is accomplished by encoding the terminal mnemonic in the registered license file that is stored on the workstation hardware. The terminal mnemonic must still appear in the LIST class station to which the license is registered, and the OpenFox Message Switch will limit the number of concurrent sessions to that value in the Number of Stations field License Registration In order for a user to launch OpenFox Desktop and connect to the message switch, the user must first register a copy of the Desktop software. This process is explained in more detail in the Product Registration section in the Initial Installation chapter. In order to register a copy of the Desktop software, the user must be provided with the following information. The product key of a free license The agency ID to which this user belongs The terminal mnemonic with which this license should be associated --or The name of the LIST class station if using a Pool license When the user registers a copy of the Desktop software, the OpenFox Message Switching System will randomly generate the license s local encryption key, record the registered station or terminal mnemonic, optionally record the device s hardware fingerprint, and mark the license as registered Registered License File When a user registers a copy of the Desktop, the OpenFox Message Switching System will encrypt the license information and send this encrypted file back to the client workstation. The Desktop Registration application will save this encrypted file to the workstation s local hard drive. This is the registered license file. This file is encrypted with a key that is unknown to the OpenFox Desktop software, so there is no way to decrypt this file on the client workstation. The registered license file will be saved under the \CPI directory. For more information about Desktop s local hard drive access, please refer to the Local Directory Structure section in the Initial Installation chapter. Pg. 8 Chapter 2: Initial Installation: Ver

9 1.2.6 License Management The OpenFox Message Switching System provides the ability to manage purchased Desktop licenses through the use of OpenFox Configurator. Through the use of this tool, the system administrator may distribute licenses across many different sub-agencies or invalidate a current copy of the Desktop software by marking the license as un-registered. To manage a particular Desktop license record, the system administrator must first launch OpenFox Configurator. For more information regarding OpenFox Configurator, please consult the OpenFox Systems Guide documentation. Once the system administrator launches Configurator, he or she selects the license and modify options, and then clicks the OK button. Ver Chapter 2: Initial Installation Pg. 9

10 Configurator then displays the License Configuration screen, as seen below. The system administrator then enters the product key of the license that he or she wishes to modify. After tabbing out of the product key fields, Configurator retrieves the license s configurable information and populates those fields on the screen. The screen below shows a license that has been purchased by an agency named CPIAGENCY and registered by a station from CPIAGENCY. This screen also displays the Desktop Modules for which this license is valid, in this case Messenger, Form Configurator, Interceptor, and Archive. Pg. 10 Chapter 2: Initial Installation: Ver

11 1.3 Desktop Communications and Device Identification OpenFox Desktop communicates with the OpenFox Message Switching System via the FoxTalk Protocol. The FoxTalk Protocol represents an application-to-application protocol for use over a TCP/IP communications session. The protocol introduces a method for the client and server to negotiate session parameters at startup and specifies a formatting standard for delineating data within the TCP/IP data stream Session Based Protocol The FoxTalk Protocol specifies that an open TCP session is maintained at all times to allow the smallest possible delay in communications. The law enforcement environment involves unsolicited messages flowing at any time in either direction, from the client to the switch or viceversa. Frequently, these messages contain time sensitive information such as hit requests or dangerous weather notifications. Maintaining an open communications link insures that these messages flow immediately, inbound or outbound. Because FoxTalk specifies that an open TCP session exist at all times, when an application is ready and able to exchange data, a simple heartbeat mechanism is used to catch link or application failures in a timely fashion. The danger in not using heartbeats lies in the client s ability to detect when it is no longer connected to the switch. OpenFox Desktop exchanges a small heartbeat message with the OpenFox Message Switching System to ensure a lively and responsive communications session. OpenFox Desktop will automatically attempt to open a FoxTalk communications session to the OpenFox server when the application is launched. If the FoxTalk communications session is lost, the Desktop will attempt to open a communications session every 30 seconds Encryption Negotiation After OpenFox Desktop has successfully established a basic FoxTalk communications protocol, it negotiates the communications encryption with the OpenFox server. During this phase, the Desktop client and the OpenFox server exchange messages to negotiate a temporary session encryption key, utilizing RSA public key encryption. This encryption key is only valid for the duration of the FoxTalk TCP session. As soon as the FoxTalk TCP session is lost, the encryption key is invalidated. During this phase, OpenFox Desktop also performs server authentication to ensure that it is communicating to the proper OpenFox system. The Desktop encryption method also protects against replay and man-in-the-middle attacks. The communications package utilized between OpenFox Desktop and the OpenFox server is an implementation of the AES Rijndael encryption method. This package has been certified by NIST, and meets the FIPS 197 requirement. The OpenFox System may be configured to use an RSA encryption package that has been FIPS certified. Ver Chapter 2: Initial Installation Pg. 11

12 1.3.3 Device Identification A particular instance of the OpenFox Desktop application is identified by the contents of the Desktop registered license file. This file is downloaded to a workstation s local disk when the Desktop software is initially registered. OpenFox Desktop sends this encrypted file to the OpenFox message switch when a communications session is established. Due to this methodology, the same registered license file may be distributed to multiple different computers. When any one of these computers connects to the OpenFox Message Switch, they will be assigned the same terminal id or mnemonic. However, the OpenFox Message Switch will enforce that only one computer with the same registered license file is connected to the message switch at the same time. It is possible to change this behavior through the hardware fingerprint option. For more information, please see the section titled Hardware Fingerprint. After OpenFox Desktop has negotiated the communications encryption settings with the OpenFox Message Switch, it immediately enters the device identification phase. During this phase, OpenFox Desktop submits the registered license file to the OpenFox Message Switch. The message switch validates the registered license file against the OpenFox Desktop license database. If the license file is, for some reason, invalid, the OpenFox Message Switch immediately terminates the FoxTalk TCP session. If the Desktop registered license file is valid, the OpenFox Message Switch inspects the value of the Registered Station field embedded within the license file. At this point, the instance of the OpenFox Desktop is considered to be connected to the message switch. It may be identified on the OpenFox Message Switch by the terminal mnemonic within the Registered Station field Hardware Fingerprint OpenFox Desktop may be configured to use a hardware fingerprint, in addition to the standard device identification method, to provide physical device authentication. This method ensures that a particular Desktop license may only be used from a specific hardware platform. The hardware fingerprint is a snapshot of the hardware configuration of a computer. This fingerprint is a compilation of various properties of the hardware components present in a computer system. The fingerprint includes, but is not limited to, hardware component serial numbers, the central processing unit s ID, and the network controller s hardware address. When this option is enabled, the hardware fingerprint is when the OpenFox Desktop software is registered. This fingerprint is stored within the OpenFox Message Switch Desktop license database. Each time the Desktop attempts to establish a communications session with the OpenFox Message Switch, another hardware fingerprint is taken and submitted to the message switch along with the registered license file. The OpenFox Message Switch validates the fingerprint against the fingerprint stored in the license database. If the fingerprints do not match, the OpenFox Desktop session is terminated. Pg. 12 Chapter 2: Initial Installation: Ver

13 1.4 Desktop Modules OpenFox Desktop was designed to provide a common gateway for all OpenFox client applications, whether the client application is the OpenFox Messenger, OpenFox Configurator, OpenFox Interceptor, or some other application. An application that runs within the OpenFox Desktop environment is known as an OpenFox Desktop Module. All of the features provided by the OpenFox Desktop application are available to Desktop Modules. These features include the following. A secure and reliable communications pathway to the OpenFox Message Switch A common desktop environment in which all OpenFox client application windows live. Common controls for managing and arranging the application windows. The common desktop taskbar Application status icons And more All Desktop Module applications may make use of the above features. However, some Modules may not use all the features or may provide equivalent features, such as separate communications paths to the OpenFox Message Switch. For more information about what standard Desktop features a Module uses, please consult the documentation for the specific Module. Ver Chapter 2: Initial Installation Pg. 13

14 1.5 Definition of Terms AES Rijndael AES is an abbreviation for Advanced Encryption Standard. The AES Rijndael encryption method is an implementation of the FIPS 194 standard. For more information please visit the following website: Client Application A client application is a software application that is intended for distribution to multiple or remote computers. Client applications typically communicate to a main central computer or server. Communications Session -- A communications session is either a lasting connection using the session layer of a network protocol or a lasting connection between a user (or user agent) and a peer, typically a server, usually involving the exchange of many packets between the user's computer and the server. A session is typically implemented as a layer in a network protocol (e.g., telnet or FTP). Encryption Encryption is the method of altering data, by using a secret code (known as an encryption key), so as to be unintelligible to unauthorized parties Encryption Key An encryption key is a secret code used to render encrypted data unintelligible to unauthorized parties. FIPS FIPS is an abbreviation for Federal Information Processing Standards. Under the Information Technology Management Reform Act (Public Law ), the Secretary of Commerce approves standards and guidelines that are developed by the National Institute of Standards and Technology (NIST) for Federal computer systems. These standards and guidelines are issued by NIST as Federal Information Processing Standards (FIPS) for use government-wide. NIST develops FIPS when there are compelling Federal government requirements such as for security and interoperability and there are no acceptable industry standards or solutions. Graphical User Interface (GUI) A graphical user interface is an interface for issuing commands to a computer utilizing a pointing device, such as a mouse, that manipulates and activates graphical images on a display. Heartbeat A heartbeat is a signal emitted at regular intervals by software to demonstrate that it is still alive. IP IP is an abbreviation for Internet Protocol. This network layer is widely used on Ethernet networks, defined in STD 5, and RFC 791. Java Platform The Java Platform is any computer platform, which is capable of running the Java Runtime Environment. Pg. 14 Chapter 2: Initial Installation: Ver

15 Java Virtual Machine (JVM) The JVM is a specification for software which interprets Java programs that have been compiled into byte-codes. The JVM itself is written in the C programming language and so can be ported to run on most platforms. The Java byte-code is independent of the platform and is interpreted by the platform-dependent JVM. JRE JRE is an abbreviation for Java Runtime Environment. The JRE consists of the Java Virtual Machine, the Java platform core classes and supporting files. The JRE is the smallest set of executables and files that constitute the standard Java platform. Look and Feel Look and feel refers to the appearance and function of an application s user interface, mostly applied to graphical user interfaces. Look and feel includes such things as the icons used to represent certain functions such as opening and closing files, directories and application programs and changing the size and position of windows; conventions for the meaning of different buttons on a mouse and keys on the keyboard; and the appearance and operation of menus. Man-in-the-middle Attack A man in the middle attack (MITM) is an attack in which an attacker is able to read, insert and modify at will, messages between two parties without either party knowing that the link between them has been compromised. NIST NIST is an abbreviation for the National Institute of Standards and Technology. NIST is the government body responsible for issuing Federal Information Processing Standards (FIPS). OpenFox Message Switch The OpenFox Message Switch is the central component of the OpenFox Message Switching System. The message switch provides centralized control of the flow of messages through an information sharing system. OpenFox Message Switching System The suite of OpenFox products that relate to the flow of law enforcement and public safety messages in an information sharing system. This includes the OpenFox Message Switch, OpenFox client applications, OpenFox databases, and more. Physical Device Authentication Physical device authentication is the ability of a central server to reliably identify the actual hardware platform on which a client application is being run. Product Key An OpenFox Desktop product key is a unique, randomly generated, sequence consisting of twenty six characters. A product key uniquely identifies one license of OpenFox Desktop. Replay Attack A replay attack is a form of network attack in which a valid data transmission is maliciously or fraudulently repeated or delayed. This includes replaying a past connection sequence or message to deceive a party. Ver Chapter 2: Initial Installation Pg. 15

16 RSA RSA Security leads the industry in strong authentication and encryption. Public Key Encryption Public-key encryption is a form of cryptography which allows users to communicate securely without having prior access to a shared secret key, by using a pair of cryptographic keys, designated as public key and private key. Public key encryption implementations are known as asymmetric encryption algorithms, meaning that one must use a different key to decrypt data than was used to encrypt the data. Server A server is a computer software application that carries out some task (i.e. provides a service) on behalf of yet another piece of software called a client. Over the years, the term has adapted to also mean the physical computer on which the server software runs Server Authentication Server authentication is the process by which a client computer or application attempts to confirm the identity of a server computer or application. TCP The Transmission Control Protocol (TCP) is a core protocol of the Internet. Using TCP, programs on networked computers can create connections to one another, over which they can send data. The protocol guarantees that data sent by one endpoint will be received in the same order by the other, and without any pieces missing. It also distinguishes data for different applications (such as a Web server and an application server) on the same computer. Terminal A computer terminal is an electronic hardware device, almost always a desktop microprocessor computer. It is used for entering data into, and displaying data from, a computing system. This term may be used interchangeably with the term Workstation. Terminal Mnemonic In the law enforcement and public safety community, a terminal mnemonic is a unique name assigned to a particular terminal. This term may be used interchangeably with the term Terminal ID. Terminal ID In the law enforcement and public safety community, a terminal identifier is a unique name assigned to a particular terminal. This term may be used interchangeably with the term Terminal Mnemonic. Workstation A computer workstation is an electronic hardware device, almost always a desktop microprocessor computer. It is used for entering data into, and displaying data from, a computing system. This term may be used interchangeably with the term Terminal. Pg. 16 Chapter 2: Initial Installation: Ver

17 Chapter 2 Initial Installation This chapter contains information about the process of installing OpenFox Desktop on a client computer terminal. The following topics are covered in this chapter: Client System Requirements OpenFox Requirements o Station Configuration o User Configuration o Session Authority Local Directory Structure o Desktop Application Code o The \CPI Directory Installing from CD o Installing the Java Runtime Environment o Installing the Desktop Installing from the Desktop Web Portal o Installing the Java Runtime Environment Product Registration The OpenFox Desktop Web Portal o Launching the OpenFox Desktop o The Desktop External Log Viewer o Download Java Runtime Appendix Running the Java Runtime Environment Installer Ver Chapter 2: Initial Installation Pg. 17

18 2.1 Client System Requirements OpenFox Desktop is an application designed to be run on client workstation computers. In order for a workstation to be supported, it must either meet or exceed the following minimum system requirements. Common Requirements for All Windows Systems Microsoft Internet Explorer 5.5 (and higher), Mozilla 1.4 (and higher), or Firefox 1.0 (and higher) The Windows user profile must have write access to the directory paths as explained in the Local Directory Structure section Windows Operating System (Windows 2000 or earlier) Intel Pentium II Processor or equivalent (800 MHz or faster) Microsoft Windows 98 Second Edition, Microsoft Windows ME, Microsoft Windows 2000, 256 MB of System RAM 512 MB is preferred 20 GB Hard Drive, with 100 MB Available Windows Operating System (Windows XP) Intel Pentium III Processor or equivalent (1 GHz or faster) 1.5 GHz is preferred Microsoft Windows XP (Professional or Home), or Microsoft Windows Server 2003 (Web, Standard, Enterprise, or Data Center Edition) 512 MB of System RAM 1 GB is preferred 40 GB Hard Drive, with 100 MB Available Windows Operating System (Windows Vista or Windows 7) Intel Pentium IV Processor or equivalent (1.5 GHz or faster) 2 GHz is preferred Microsoft Windows Vista (Basic, Home Premium, Business, or Ultimate) 1 GB of System RAM 2 GB is preferred 80 GB Hard Drive, with 100 MB Available Support for DirectX 9 graphics with: o WDDM Driver o 128 MB of graphics memory (minimum) o 256 MB of graphics memory (preferred) o Pixel Shader 2.0 support in hardware o 32 bits per pixel Pg. 18 Chapter 2: Initial Installation: Ver

19 Windows Operating System (Windows 7) Intel Pentium IV Processor or equivalent (1.5 GHz or faster) 2 GHz is preferred Microsoft Windows Vista (Basic, Home Premium, Business, or Ultimate) 2 GB of System RAM 4 GB is preferred 80 GB Hard Drive, with 100 MB Available Support for DirectX 9 graphics with: o WDDM Driver o 128 MB of graphics memory (minimum) o 256 MB of graphics memory (preferred) o Pixel Shader 2.0 support in hardware o 32 bits per pixel Ver Chapter 2: Initial Installation Pg. 19

20 2.2 OpenFox Requirements There are several configurations that must be made in the OpenFox Message Switching System in order to support a new installation of OpenFox Desktop Station Configuration For each instance of OpenFox Desktop that connects to the OpenFox Message Switching System, there must be a corresponding OpenFox Station Configuration. This station configuration record must be a station of class MSNGR. This configuration can be added using OpenFox Configurator. Below is a screenshot that shows a sample station configuration. Pg. 20 Chapter 2: Initial Installation: Ver

21 If this workstation will be using a pool or restricted use license, a LIST class station record must also be configured. This station must contain a list of MSNGR class stations. Below is a screenshot that shows a sample LIST station. For more information about how to configure OpenFox Station Configurations, please refer to your OpenFox System Guide documentation. Ver Chapter 2: Initial Installation Pg. 21

22 2.2.2 User Configuration For each actual person that accesses the OpenFox Message Switching System via OpenFox Desktop, there must be a corresponding OpenFox User configuration record. This configuration can be added using OpenFox Configurator. Following is a screenshot that shows a sample user configuration. For more information about how to configure OpenFox User Configurations, please refer to the OpenFox System Guide. Pg. 22 Chapter 2: Initial Installation: Ver

23 2.2.3 Session Authority When OpenFox Desktop connects to the OpenFox Message Switching System and a certified user logs onto the application, the message switch generates what is known as the session authority. The session authority is a combination of the authorities configured in the station and user configuration records. A particular session will only have a specific police authority level if and only if both the station and user configuration have that level of police authority turned on. For example, looking at the two previous screenshots, if the user RYAN logged onto the terminal XMLDEMO then the session authority would only have the police authority levels 3, 4, 5, 13, 14, and 20 turned on. For more information about OpenFox Message Switch configurations, session authorities, and police authority levels, please consult your OpenFox System Guide documentation. 2.3 Local Directory Structure OpenFox Desktop requires access to the workstation s local hard drive for the following purposes: Storage of Desktop application code Storage of the Desktop registered license file Storage of the Desktop log Storage of locally cached Desktop resources (including Messenger forms and code lists) Storage of Module application data (including the Messenger mail file) The Desktop application code is stored in a location specified by the Java Runtime Environment. The Desktop registered license file, Desktop log file, Desktop resources, and Module application data will all be stored under the /CPI directory Desktop Application Code The OpenFox Desktop application code is stored in a directory specified by Java Web Start. In order for a workstation to receive updates to the Desktop application, the Windows user profile must have write access to this directory. On the Windows Platform, this directory will default to the following path: %User Profile%\Application Data\Sun\Java\Deployment\cache Where User ID is the Windows User Name, not the OpenFox User ID This is the default as of Java 1.5.0, and may change in future releases of Java Because the default directory includes the Windows User Name, the same update to the Desktop application will be downloaded to the same computer for each different Windows user profile that accesses the application. Ver Chapter 2: Initial Installation Pg. 23

24 This behavior may be changed by setting the Java Temporary Internet File location to a path that is the same for different Windows User Names. It is possible to change the location to a different directory by following the below procedure. (Note: this procedure will have to be repeated for each Windows user profile that access the Desktop application) 1. Open the Windows Control Panel 2. Open the Icon labeled Java 3. When the Java Control Panel opens, click on the General tab 4. Click on the Settings button in the Temporary Internet Files section Pg. 24 Chapter 2: Initial Installation: Ver

25 5. When the Temporary Internet Settings dialog opens, you will see the directory in the text box labeled Location 6. You may either type in a new directory path, or, by pressing the Change button, you may browse to a new directory path The \CPI Directory The \CPI directory holds all the Desktop and Module application data. On the Windows Platform, this directory is C:\CPI. This includes the Desktop registered license file, the local cache of Desktop resources, and any Module application data. For OpenFox Desktop and Modules to change any of this information, the Windows user profile must have write access to the \CPI directory. Under the \CPI directory, there is a \Desktop subdirectory. This directory contains the Desktop registered license file, which is a file called license.dat. This directory also contains the two files that comprise the Desktop log, and these files are called Index.log and Desktop.log. This directory also contains a \Cache subdirectory that holds the cached versions of Desktop resources (including Messenger forms and code lists). There may also be additional subdirectories under the \CPI directory. If a Desktop Module requires disk access to store application data (for example, the Messenger mail file), then this application data is stored in a directory under the \CPI directory. So, for example, OpenFox Messenger stores its application data under the \CPI\Messenger directory. For more information on the disk access required by a specific Desktop Module, please consult the User Guide for that Module. Ver Chapter 2: Initial Installation Pg. 25

26 2.4 Installing from CD This section contains instructions for installing OpenFox Desktop from a provided CD-ROM. If you are installing OpenFox Desktop without a CD-ROM, please go to the next section. The first step to install OpenFox Desktop from a CD-ROM is to place the provided CD-ROM into your computer s CD-ROM drive. After inserting the disk, a window should automatically display on your screen. If no window appears, then follow the below steps. Double-click the My Computer icon o If you are running Windows XP, you may have to open your Start menu to access this icon o If you are not running Windows XP, then this icon should be located on your Windows Desktop Double-click the icon for your CD-ROM drive. This is most likely the D: drive. Double-click the file titled autorun.exe After you have displayed the OpenFox Desktop Install window, you should see the following screen. If you do not see the above screen, and the first button is gray and the last two buttons are blue, you already have a compatible version of the Java Runtime Environment on your system. You may skip the following section and jump directly to the following section titled Installing the Desktop. Pg. 26 Chapter 2: Initial Installation: Ver

27 2.4.1 Installing the Java Runtime Environment To install the Java Runtime Environment from a provided CD-ROM, simply click on the Install Java Runtime button. Wait for the Java Runtime Environment installer to load. When the installation program has loaded, please refer to the appendix section located at the end of this chapter. After successfully installing the Java Runtime Environment, you will be directed back to the OpenFox Desktop Install window. Please wait while the installer recognizes that the Java Runtime Environment was installed. After a few moments, the screen should change to resemble the below picture. After you see this screen, you may proceed to the next section Installing the Desktop To begin the installation of OpenFox Desktop, simply click on the Install OpenFox Desktop button. This should be the middle button in the screen. If this button is gray, then you must first install the Java Runtime Environment. Please see the previous section for instructions. After clicking on the button, Java Web Start begins loading the Desktop application code from the CD-ROM. Please wait until Java Web Start has loaded and installed all of the Desktop application files. Ver Chapter 2: Initial Installation Pg. 27

28 After all of the application files have been installed, you should see the following confirmation. Click on OK to close the confirmation window. You may then click on the Desktop Web Portal button. This button will launch your internet browser and display the OpenFox Desktop Web Portal. You may then skip the next section and jump to the The OpenFox Desktop Web Portal section. 2.5 Installing from the Desktop Web Portal This section contains instructions for installing the OpenFox Desktop directly from your internet browser. If you have been provided with a CD-ROM, then please refer back to the previous section titled Installing from CD. The first step to install OpenFox Desktop is to view the OpenFox Desktop Web Portal in your computer s internet browser. Begin by launching your internet browser (this may be Internet Explorer, Netscape, Mozilla Firefox, or any other Java capable browser). At the top of your internet browser there should be an address bar. Enter the address of the OpenFox Desktop Web Portal into the address bar and press the Enter key. This address should have been provided to you by your IT contact or by your supervisor. Please wait while the Web Portal loads. When the Desktop Web Portal loads, you should see a screen similar to the one below. Pg. 28 Chapter 2: Initial Installation: Ver

29 You may want to bookmark the Desktop Web Portal so you may quickly access it in the future. In most browsers, you may bookmark a page by right-clicking on the page and selecting the Add to Favorites or Bookmark this Page option. Please refer to your browser s documentation for further instructions on how to bookmark a web page. If you see a scroll instead of the gray box on the screen, then you already have a compatible version of the Java Runtime Environment installed on your machine. You may skip the next section and jump to the section titled Product Registration Installing the Java Runtime Environment Begin by clicking on the Download Java Runtime Environment icon. This takes you to the Sun license agreement page. Ver Chapter 2: Initial Installation Pg. 29

30 Read through the license agreement. Then if you select the Accept check box and click on the Continue button, you will be prompted to either run or save the file. Click on the Run button. Your computer then downloads the file and runs it once the download has completed. Please wait while the file is downloaded. After the download has completed, the Java Runtime Environment Installation program automatically launches. At this point, please refer to the appendix section located after the Installing from the Web Portal section for further instructions. After successfully completing the installation of the Java Runtime Environment, you may proceed to the next section. Pg. 30 Chapter 2: Initial Installation: Ver

31 2.6 Product Registration This section contains instructions on how to register your copy of OpenFox Desktop. By this time in the installation procedure, you should have the OpenFox Desktop Web Portal opened in your internet browser, and you should see a screen similar to the one shown below. If you do not see this screen, then please refer to either the Installing from CD or the Installing from the Web Portal sections within this chapter. To register your copy of OpenFox Desktop, you must have the following information. A valid OpenFox Desktop Product Key The terminal mnemonic of your workstation --or-- The name of the LIST class station if using a pool or restricted use license Your OpenFox agency ID This information will be provided to you by either your IT contact or your supervisor. Please make sure that you have the above information and that it is correct, before continuing. After you have gathered the required information, click on the scroll icon to the left of the Launch the OpenFox Desktop text. You should receive a notification that you must register your copy of the Desktop software. Click on the OK button. Ver Chapter 2: Initial Installation Pg. 31

32 The OpenFox Desktop Registration Application will then launch. You will see Java Web Start begin loading. Java Web Start then downloads the application files. Please wait for this download to complete. After the download has completed, Java Web Start launches the registration application. You should see the below screen on your computer. Now, you must enter the following information in this screen. Product Key Enter your provided Desktop Product Key. Agency Enter the ID of your OpenFox Agency Default Station Enter the terminal mnemonic or terminal ID of your workstation --or Default Station Enter the name of the LIST station if using a pool or restricted use license Pg. 32 Chapter 2: Initial Installation: Ver

33 After entering the required information into the text boxes on the screen, click on the Submit button. The application then registers your copy of the Desktop software product. After a short delay, you should see the following confirmation appear on your screen. You may click on the OK button and continue to the next section of this chapter. If you receive an error notification from the registration application, then please double-check the information you entered into the three text boxes is correct. If the information is correct, and you continue to receive an error, please contact your supervisor. Ver Chapter 2: Initial Installation Pg. 33

34 2.7 The OpenFox Desktop Web Portal This section contains information regarding the OpenFox Desktop Web Portal. The first time that you view the OpenFox Desktop Web Portal, you may see a security warning appear on your computer screen. Simply click on the Always button. After you have successfully installed the Java Runtime Environment and registered your copy of the Desktop software, you should see a screen similar to the following: Pg. 34 Chapter 2: Initial Installation: Ver

35 If the icon to the left of the Launch the OpenFox Desktop is a little gray box, then you have not installed the Java Runtime Environment. Please refer to the Installing from CD or the Installing from the Web Portal section and carefully follow all the instructions. If you are sure you have successfully installed the Java Runtime Environment, you may have to enable Internet Explorer to use the Sun JRE. In an Internet Explorer window, go to the Tools Internet Options menu. Then click on the Advanced tab. Scroll down (about half way down) until you see a Sun (Java) entry. Make sure that the Use JRE for <applets> is checked. You may have to restart your browser for this change to take effect. Ver Chapter 2: Initial Installation Pg. 35

36 If the icon to the left of the Launch the OpenFox Desktop is a scroll, then you have not yet registered your copy of OpenFox Desktop. Please refer to the previous section titled Product Registration for instructions Launching OpenFox Desktop In order to launch OpenFox Desktop, you must see the following on the Desktop Web Portal. If you do not see the following icon, consult the Installing from CD, Installing from the Web Portal, or Product Registration sections. To launch OpenFox Desktop, simply click on the icon to the left of the Launch the OpenFox Desktop text. This will start Java Web Start, which will download any updates to OpenFox Desktop before running the application. If this is the first time you have run OpenFox Desktop, or if an update to the software has been released, you will see a progress window as Java Web Start downloads the latest copy of the software. Please wait for the files to download. Pg. 36 Chapter 2: Initial Installation: Ver

37 After any product updates have been downloaded, you will see the Desktop splash screen appear. This screen will be displayed while OpenFox Desktop is initialized. Please see the next chapter, titled OpenFox Desktop for information about running the application OpenFox Desktop External Log Viewer OpenFox Desktop External Log Viewer is an application designed to access the Desktop log without actually having to run the Desktop application. This application is most useful if you are having trouble launching the Desktop application. Support staff may ask you to launch the viewer for problem resolution. The Desktop External Log Viewer is launched by clicking on the icon to the left of the OpenFox Desktop External Log Viewer text Download Java Runtime The Java Runtime Environment (JRE) is available for download from the OpenFox Desktop Web Portal. Downloading the Java Runtime is the first step that you must complete in order to install OpenFox Desktop. For more information about installing the JRE, please refer to either the Installing from CD or the Installing from the Web Portal section. Ver Chapter 2: Initial Installation Pg. 37

38 2.8 Appendix Running the Java Runtime Environment Installer This section contains information about running the Java Runtime Environment Installation program. These instructions are the same whether you are installing from a provided CD-ROM or directly from OpenFox Desktop Web Portal. Please refer to those sections for instructions specific to your situation. When you first run the Java Runtime Environment Installer, you may see the following security warning. Simply click on the Run button to continue. At this time, you should make sure that all other applications running on your computer are closed. This is especially important for any anti-virus applications that you may be running. You must disable your anti-virus program and close any other applications running on your computer before continuing. The Java Runtime Environment Installer then loads and executes. After a short delay you will be presented with the License Agreement screen. Please read the license agreement carefully, and if you accept the agreement and click the Next > button, you may proceed to the next step. Pg. 38 Chapter 2: Initial Installation: Ver

39 You will then be presented with the Setup Type screen. Make sure that the Typical install type is selected, and then click on the Next > button. The Java Runtime Environment Installer then installs the application onto your computer. Please wait while the application is copied and setup. Ver Chapter 2: Initial Installation Pg. 39

40 After the installer has finished installing the Java Runtime Environment, you will be presented with the Installation Complete screen. This screen notifies you that you have successfully installed the Java Runtime Environment on your computer. At this time, it is now safe to reenable your anti-virus protection. Click on the Finish button to close the install program. After the install program has closed, you will have to restart your computer. Simply go to your Windows Start menu and choose the Turn off computer option. Then select Restart. When your computer finishes rebooting, you may continue the OpenFox Desktop installation procedure. Please go back to the proper section of this chapter for further instructions. Pg. 40 Chapter 2: Initial Installation: Ver

41 Chapter 3 OpenFox Desktop This chapter contains information about the operation of the OpenFox Desktop software product. The following topics are covered in this chapter: Communications Session Establishment Device Identification Process User LOGON Desktop Architecture o Desktop Window Title o Common Desktop Menus User Session Menu Window Menu Tools Menu Help Menu Module Menu o Main Desktop Panel o Desktop Status Icons Desktop Status Icon Communications Session Icon Encryption Status Icon Communications Activity Icon o Desktop Taskbar Common Windows Controls o Maximizing, Restoring, Minimizing, and Closing Windows o Windows System Menu Multiple Window Management Temporary Screen Lock User LOGOFF and User Swapping Session Disconnect Changing the Desktop Appearance Desktop Log File Desktop Help System 3.1 Communications Session Establishment When OpenFox Desktop launches, it will immediately attempt to open a communications session with the OpenFox Message Switching System. If the Desktop is able to establish a communications session, it will indicate this to the user through the Desktop s window title and the communications session status icon. Please see the below documentation for more information. Ver Chapter 3: The OpenFox Desktop Pg. 41

42 3.2 Device Identification Process After establishing a communications session with the OpenFox Message Switching System, the Desktop will enter the device identification phase. During this phase, the Desktop submits the registered license file for the particular workstation. If this license file is invalid, or if it has been corrupted, the OpenFox Message Switching System will terminate the Desktop communications session. The user will be unable to connect to the message switch until he or she successfully registers the software. Please see the section titled Product Registration for more information. 3.3 User LOGON After OpenFox Desktop has established a communications session to the message switch, and has successfully completed the device identification process, it automatically presents the user with a logon window. The user must enter his or her certified OpenFox user ID and password. This information will be submitted to the message switch and verified against the OpenFox user database. The user will be given three chances to enter a correct user ID and password, or the Desktop will exit. Pg. 42 Chapter 3: The OpenFox Desktop Ver

43 3.4 Desktop Architecture The OpenFox Desktop software package is constructed from many different components. These components are arranged in specific locations on the Desktop. Below is a screen shot of the basic OpenFox Desktop screen Desktop Window Title The OpenFox Desktop window title is used to display a variety of information to the user. With a quick glance the user can determine if the Desktop session is connected to the OpenFox Message Switch, the mnemonic of the terminal, the default ORI with which the terminal is associated, and the ID of the user that is currently logged on to the Desktop. Below are some sample screenshots of the Desktop window title and an explanation of what information is shown. This example shows the OpenFox Desktop in a state where it is not connected, or has lost the connection, to the message switch. This screen will be seen if there is a networking or firewall issue that is preventing the Desktop from connecting to the message switch. This text will also be seen during message switch down time. Ver Chapter 3: The OpenFox Desktop Pg.. 43

44 This example shows OpenFox Desktop in a state where it is trying to establish a basic TCP/IP connection to the message switch. Most of the time, this status will barely be visible. If the Desktop displays this message for a long time, then this may be indicative of network or firewall problems. This example shows OpenFox Desktop in the state where it is negotiating the communications encryption settings with the OpenFox Message Switch. This example shows OpenFox Desktop in the state where it is identifying the terminal device by exchanging the Desktop registered license file with the message switch. If there is a problem with the license file, or if another device is already connected with the same license, then the Desktop will notify the user with an error. This example shows OpenFox Desktop in the final stage of connecting to the message switch. During this stage, all the Desktop Modules are going through their own initialization phases. If this message is displayed on the screen for a long period of time, it is indicative of a problem with a specific Module. Pg. 44 Chapter 3: The OpenFox Desktop Ver

45 This example shows OpenFox Desktop in the state where it has successfully connected to the OpenFox Message Switching System. The screen shot shows that this instance of Desktop has connected to the message switch as the terminal XMLRYAN and that it is associated to an ORI of CP At this point, no user has logged onto the Desktop This example shows OpenFox Desktop after it has connected to the message switch as the terminal XMLRYAN, and the user RYAN has successfully logged onto the OpenFox Message Switching System. Ver Chapter 3: The OpenFox Desktop Pg.. 45

46 3.4.2 Common Desktop Menus OpenFox Desktop provides the user with a set of menu options that will always be available to the user, no matter which Module the user is actually working with at the current time. These menus are explained below User Session Menu The User Session menu allows the user to manage the Desktop session. This menu provides the ability to manually connect to or disconnect from the OpenFox Message Switching System. This menu also provides the ability for a user to log on or off of the system, and also this menu allows the user to lock the Desktop screen and hide any sensitive information Window Menu The Window menu gives the user the ability to arrange multiple windows within the main Desktop panel area. This menu also provides the user with a keyboard accessible method of cycling through all open windows, and an option to manually switch focus to any currently open window. In the above screenshot, the user has two open windows, the Messenger mailbox window and the Interceptor window. Pg. 46 Chapter 3: The OpenFox Desktop Ver

47 Tools Menu The Tools menu provides the user with the ability to change the Desktop appearance settings, to configure his or her preferences, configure the workstation s terminal preferences, access the Vin Assist utility, and to access the Desktop log file The Help Menu The Help menu allows the user to view version and licenses information regarding OpenFox Desktop and any Module application as well as view the online electronic help files. For more information regarding the Desktop Help System, please see section 3.14 of this document. Ver Chapter 3: The OpenFox Desktop Pg.. 47

48 The Module Menu The Module menu is located to the far right of all the other Desktop menus. This menu provides the user with the ability to switch between any of the currently running Desktop Module applications. This menu will also display, next to the word Modules, the icon of the currently active Module. A Module is active whenever one of its windows is the focused window (light blue border). The active Module may also provide additional menu choices besides those supplied by Desktop. For information on Module specific menus, please refer to that Module s documentation. In the above screenshot, the Module menu shows this instance of Desktop is running with two Modules, the Messenger and the Form Configurator, and it shows that the Desktop is the currently active Module. To switch between the two Modules, a user must simply click on the name of the Module that he or she wishes to work with Main Desktop Panel The main Desktop panel is the center area on the Desktop screen in which all the open windows will appear. The user is able to move windows to different locations on the screen, so that multiple windows may be viewed at once. The user may also resize any window within the main Desktop panel by dragging the border of the window to the desired size Desktop Status Icons The Desktop status icons are located in the lower-right portion of the Desktop screen. These icons represent the current state of OpenFox Desktop. There are three status icons that are provided by Desktop to notify the user about state changes, although individual Desktop Modules may add their own icons to this area. Pg. 48 Chapter 3: The OpenFox Desktop Ver

49 Communications Session Icon This icon represents the current state of the Desktop communications session with the OpenFox Message Switching System. The color of this icon indicates the status of the communications session. Green - The session is connected and functioning properly Yellow - The Desktop is trying to establish a connection Red - The session is not connected to the message switch Encryption Status Icon This icon represents the current status of the communications session encryption and security. Missing - The session is not connected or is not encrypted Unlatched - The session encryption is being negotiated Locked - The communications session is encrypted and secure Ver Chapter 3: The OpenFox Desktop Pg.. 49

50 Desktop Status Icon This icon represents the current operating status of OpenFox Desktop. While the application is running it is possible that the application, or one of the Desktop Module applications, encounters an error or a warning situation. When this event occurs, the Desktop, or Module, adds an entry into the Desktop log file, and this icon will change to represent the most severe entry in the log file. This icon will remain this way until the user views the Desktop log file. When the user notices an error in the log file, that user should contact his or her supervisor for problem resolution. Normal Icon - No new errors or warnings have occurred Exclamation Point - A new warning as occurred Red X - A new error as occurred Communications Activity Icon This icon indicates when the communication session with the OpenFox Message Switch is currently exchanging data. A series of blue lights will appear to move in a circle when the communication pathway is active. All the lights will remain grey when there are no ongoing communications. Pg. 50 Chapter 3: The OpenFox Desktop Ver

51 3.4.5 Desktop Taskbar The Desktop taskbar is located at the very bottom of the Desktop screen. The taskbar contains a button for each open window in the Desktop main panel area. The currently active window is denoted in the taskbar by having a dark gray color. In the below screen shot, the Messenger mailbox window is the current active window. When a window is opened it will be added after the last button in the taskbar. The user may switch between open windows simply by clicking on a different button on the taskbar. The user may also right-click on the buttons in the taskbar to access the system menu for the corresponding window. Ver Chapter 3: The OpenFox Desktop Pg.. 51

52 3.5 Common Window Controls No matter which window, in the Desktop s main panel area, the user is currently working with, there are several common controls provided by Desktop. These controls are located at the very top of a window and can be used to maximize, restore, minimize, and close the window. Every window will also provide access to the window s system menu Maximize the Window This icon allows the user to maximize the window so it grows to take up all the visible space in the Desktop s main panel area Restore the Window This icon allows the user to restore a window from the maximized state. The window will go back to the size it was before it was maximized Minimize the Window This icon allows the user to shrink the window down so it only appears in the Desktop taskbar Close the Window This icon allows the user to close and dispose of the window. Pg. 52 Chapter 3: The OpenFox Desktop Ver

53 3.5.5 Window System Menu Any window s system menu can be accessed by clicking on the icon in the upper left corner of the window. The system menu may also be brought up by pressing the F11 key while focused in a window. This menu provides keyboard access to the same actions made available through the window icons plus the Close All and Close Others actions. In addition, a Desktop Module may have additional actions available through a window s system menu Close All Choosing this action will close and dispose all the windows that have been opened in Desktop Close Others Choosing this action will close and dispose all the windows in Desktop with the exception of this window. This action can be very useful to clean up the display if too many windows have been opened. Ver Chapter 3: The OpenFox Desktop Pg.. 53

54 3.6 Multiple Window Management OpenFox Desktop provides the user with simple controls that he or she may use to arrange multiple windows on the Desktop screen. These controls are located under the Desktop Window menu. These controls provide the user with the ability to tile windows either vertically or horizontally. The user may also choose to cascade all the windows, which will pack the windows to their original size and stack them in the upper left corner of the Desktop main panel area. When the user selects one of these actions, the windows will be arranged in the same order in which they appear in the Desktop taskbar. The screenshot below shows an example of tiling windows horizontally. Pg. 54 Chapter 3: The OpenFox Desktop Ver

55 The screenshot below shows an example of tiling windows vertically. The screenshot below shows an example of cascading the windows. Ver Chapter 3: The OpenFox Desktop Pg.. 55

56 All the open windows in the Desktop main panel area may not change as a result of the user selecting one of these actions (for example the Messenger mailbox window in the screenshots above). Some Desktop Modules may choose to mark a window as special. Such windows will not be affected by these layout actions. However, a Module may offer the ability to switch off the special processing in the preferences. Please consult the specific Module documentation for more information. Pg. 56 Chapter 3: The OpenFox Desktop Ver

57 3.7 Temporary Screen Lock The user may choose to temporarily lock the Desktop screen to hide any sensitive information or prevent anyone else from using the terminal. This option is available both through the Desktop User Session menu and through the F12 keyboard key. When the Desktop screen is locked, the display will gray out and hide any windows that the user may have had open. It will also display a logon box that will only allow the same user back into the application. This logon box, however, will also have a logoff button in case the user is unable to return to the workstation. The screenshot above shows the lock display action in the User Session menu. The screenshot below shows the Desktop in temporary screen lock mode. Ver Chapter 3: The OpenFox Desktop Pg.. 57

58 3.8 User LOGOFF and User Swapping OpenFox Desktop provides the ability to hot-swap different users without closing and reopening the application. This feature is accessed through the Desktop User Session menu. When a user selects the Log Off option, that user will be logged off from the OpenFox Message Switching System. He or she will not be able to run any transactions. At that time, another user may log onto OpenFox Desktop by selecting the Log On option from the Desktop User Session menu. After a new user logs on to the Desktop, the OpenFox Message Switching System will compute a new session authority for this user s session. Please see the section titled Session Authority for more information. Pg. 58 Chapter 3: The OpenFox Desktop Ver

59 3.9 Session Disconnect OpenFox Desktop provides the ability to manually disconnect the communications session to the OpenFox Message Switching System. A user may choose this option from the Desktop User Session menu User Preferences The OpenFox Desktop user preferences dialog provides a uniform method by which the user may change many aspects of how OpenFox Desktop or one of the Desktop Modules behaves. User preferences are stored remotely on the OpenFox Message Switch server by a user basis. Thus a particular user s preferences will follow the user around, no matter which workstation the user signs on. Although OpenFox Desktop does not allow the user to modify its behavior through the preferences dialog, many OpenFox Desktop Modules may support a wide variety of options to the user. OpenFox Desktop merely provides the framework through which individual Modules may support user preferences. If you experience any problems with the preferences, the most likely cause is the Module. For more information on what preferences a particular Module supports, please consult the documentation for that Module. The user preferences dialog is accessed by choosing the User Preferences option under the Desktop s Tools menu. Individual Modules may also provide alternate methods of accessing the preferences dialog. For more information, please consult the documentation for the specific Module. Ver Chapter 3: The OpenFox Desktop Pg.. 59

60 Desktop then displays the preferences dialog. A screenshot of this dialog is shown below. Module List The Module List allows the user to change which Module s preferences are currently being displayed or edited. Selecting a different Module will change the list of preference categories. In the above example, the user may choose to change the preferences for Desktop, Messenger, Form Configurator, Interceptor, Configurator, and SOR Admin. The user has the Desktop Module selected. Preference Category List The Preference Category List allows the user to select which preference category is currently being displayed or edited. Selecting a different category will change the contents of the preference category area. In the above example, there are two preference categories for the Desktop Module: General, and Appearance. The user has the General category selected. Preference Category Area This area on the preference dialog is used to display the actual preferences for the currently selected category. For more information regarding the controls presented in this area, please consult the documentation for the specific Module. Pg. 60 Chapter 3: The OpenFox Desktop Ver

61 OK Button When the user presses the OK button, OpenFox Desktop accepts any changes to the preferences, saves a copy of the new preferences on the OpenFox Message Switch server, and closes the preferences dialog. Cancel Button When the user presses the Cancel button, OpenFox Desktop cancels any changes that the user may have made to his/her preferences and closes the preferences dialog. Revert to Defaults Button When the user presses the Revert to Defaults button, OpenFox Desktop informs the currently selected Module. This Module will then change the values of only the currently selected preference category back to the original out-of-the-box values. OpenFox Desktop will not close the preferences dialog Desktop General Preferences Show Window Contents While Dragging If this option is checked, then Desktop will display the contents of Desktop windows as the user moves or resizes the windows. If this option is not checked, then Desktop will show an outline of the window as the user moves or resizes it. Turning this option off may improve the performance or Desktop. Popup Notification Delay OpenFox Desktop allows the user to configure for how long the popup notification boxes that appear in the lower right hand side of the screen are displayed. Examples include logon notification and application errors and warnings boxes. Ver Chapter 3: The OpenFox Desktop Pg.. 61

62 Drop Down Key Press Delay Desktop allows the user to configure how long a drop down list will remember the last character typed. In most drop down lists, the user may select an item by typing into the drop down list as if it were a normal text box. If the user makes a mistake, then he or she is free to start typing over by either pressing the backspace key or by waiting a specific amount of time. This option allows the user to adjust this time. If users find that Desktop seems to be forgetting the first characters that they type into a drop down list, then adjusting this value upwards may help alleviate the issue. Date Time Format This option allows the user to specify the format in which the software should report date/time stamps. When choosing a format, Desktop will display how the current date and time would be displayed for each option. Please note that each individual Module must honor this setting. If you have changed this setting and a Module is displaying a time differently, please contact support for the Module with which you are working. Code Ordering This option allows the user to specify whether drop down code lists should be ordered by the code value or by the code s text description. For example, please see the two screen shots below. The screen shot on the left orders the codes by value and the one on the right orders the codes by meaning. Pg. 62 Chapter 3: The OpenFox Desktop Ver

63 Code List Search Highlight Color Desktop provides a method to perform a text search of drop down code list controls. The window that provides this functionality will highlight the portions of codes that match the search terms. This preference allows the user to modify this color. An example of this window is provided below Desktop Appearance Preferences Font Size This option allows the user to change all the fonts used in the OpenFox Desktop application, including all Modules operating within Desktop. The small font is provided for use on older systems that do not support higher, modern resolutions. The larger fonts are provided for accessibility, and for use on newer high resolution displays. Ver Chapter 3: The OpenFox Desktop Pg.. 63

64 Color Theme This option allows the user to customize the look and feel of OpenFox Desktop to their own particular taste. While most of the color themes are purely aesthetic in nature, this option allow provides access to a grayscale color scheme, a high contrast color scheme, and a low light color scheme. These color themes are provided to enhance the accessibility of Desktop. Window Icons This option allows the user to switch between normal, 3 dimensional looking icons and plain icons. The plain icons are provided for those users which have trouble differentiating between the normal icons. The normal icons are shown on the left screen shot below, and the simple icons are displayed on the right. Pg. 64 Chapter 3: The OpenFox Desktop Ver

65 3.11 Terminal Preferences Terminal preferences are very similar to user preferences except that they are stored on the local workstation s hard disk drive instead of the central message switch. Also, terminal preferences affect the behavior of the terminal when any user is signed on. The terminal preferences dialog box presented to the user is very similar to the user preferences dialog box, and interacting with this window is exactly the same. For more information on how to use this dialog box, please refer to the preceding chapter on user preferences. Any changes to the terminal preferences will not take effect until the user exits the OpenFox Desktop software and launches the application once again. The terminal preferences dialog is accessed by choosing the Terminal Preferences option under the Desktop s Tool menu. Individual Modules may also support terminal preferences, in which case the user will be able to modify those settings through this same window. For more information, please consult the documentation for the specific Module. Ver Chapter 3: The OpenFox Desktop Pg.. 65

66 Desktop Accessibility Terminal Preferences Enable Accessibility Mode When this option is selected, OpenFox Desktop will interface with accessibility software via the standard Java Accessibility API. This option also requires the installation of the Java Accessibility Bridge software, which is typically not included in the standard installation of the Java Runtime Environment. For more information, please see the following web site: Screen Reader Compatibility Mode This option allows the user to select the compatibility mode that should be used when OpenFox Desktop is executed in conjunction with screen reader software. The most common screen reader software is the JAWS software package. If you are using the JAWS screen reader software, then please be sure that this setting is set to Jaws Mode. If you are using some other screen reader software, then please select the Normal option. Pg. 66 Chapter 3: The OpenFox Desktop Ver

67 Desktop Sound Terminal Preferences Enable Sounds When this option is checked, OpenFox Desktop will play audio sounds are various times during execution. If this option is unchecked, then Desktop will not play sounds while the software is running. Audio Playback Device If sounds are enabled, then this setting will allow the user to choose the audio device that Desktop will use to play sounds. In the vast majority of locations, the default audio device will suffice for playback. However, certain workstations may use the default audio device for a purpose other than audio playback. These workstations may need to deselect the Use Default Audio check box and select the appropriate audio device from the drop down list Vin Assist OpenFox Desktop utilizes the Vin Assist software published by the National Insurance Crime Bureau (NICB) to decode Vehicle Identification Numbers (VIN). The Vin Assist tool will be available to a user regardless of what Modules they are authorized to access. This tool may be used to perform VIN decomposition into the make, model, style, and year fields. The user accesses this tool by selecting the Vin Assist option under the Tools menu. Ver Chapter 3: The OpenFox Desktop Pg.. 67

68 After selecting this option, Desktop will display the Vin Assist Tool window. The user may type a 17 character VIN code into the VIN field and then select the Decode VIN button by pressing the Enter key or by clicking on the button via the mouse. After choosing to decode the VIN, OpenFox Desktop will perform a look up against the Vin Assist database files provided by NICB. If a match is found, then Desktop will put the decoded information into the fields listed under the Decoded Information group. An example of this is shown below. In this case, the NICB database files have identified this VIN as an 87 Honda Accord, 2 door hatchback. Pg. 68 Chapter 3: The OpenFox Desktop Ver

69 3.13 Desktop Log File The Desktop log file keeps a record of note-worthy events that occur while the Desktop is running. The Desktop logs events: when a user logs on, logs off, when the communications session is established, or lost. Whenever an error occurs in the operation of OpenFox Desktop, an error message will be stored in the log file. In addition, individual Modules may also log note-worthy events in the Desktop log file. Please consult the documentation of a specific Desktop Module for more information. The user may view the Desktop log file by choosing the View Log File option from the Desktop Tools menu. When the user chooses this option he or she will see the Desktop log viewer window appear on the screen. This window displays a record of all the logged events in the order in which they occurred. The most recent events will appear at the top of the list. By selecting an entry in the top portion of the window, the user will be able to read the full text of the logged message in the bottom portion of the window. Ver Chapter 3: The OpenFox Desktop Pg.. 69

70 The user also has the option to clear the log file or to export a selected message to an XML format. This will generate an XML log report that can be ed to a support contact. Both of these options are located in the Desktop log viewer s Options menu. Pg. 70 Chapter 3: The OpenFox Desktop Ver

71 3.14 Desktop Help System The OpenFox Desktop help files provide the user with electronic access to standard law enforcement manuals. Additionally, your agency may have state specific documentation available via the same help file interface. The online help files are access by choosing the Help Files item from the Desktop Help menu. The Desktop Help System provides an easy to use graphical user interface that is used to view documentation concerning the usage of the OpenFox Desktop and Modules such as Messenger, Form Configurator, Archive Retrieval, Interceptor, etc. Below is an example screen shot of the Desktop Help System. Ver Chapter 3: The OpenFox Desktop Pg.. 71

72 Navigational Tools Many help files provide tools that allow the user to easily navigate the help files in a sequential fashion. These tools will typically be found in the upper right hand corner and lower right hand corner of the help page display. The tools are explained in the below table. Tool Description Returns to the previous page within the current section Returns to the index page for the current section Views the next page within the current section. If this is the last page of the current section, then this will return to the index page Actions The OpenFox Desktop Help System allows the user to perform various actions. These actions are available via the Actions pull down menu and via the toolbar at the top of the help window. These actions are explained in the below table. Icon Name Description Back Forward Reload Home Print Help Navigates to the previously displayed help page Navigates to the next help page that was displayed Reloads the currently displayed help page and looks for updates to this help page Navigates to the Help System home page Print the current help page Navigates to help pages on using the Desktop Help System Pg. 72 Chapter 3: The OpenFox Desktop Ver

73 Contents Tab The Contents tab provides an overall view of the folders and documents contained in the Desktop Help system. In this respect the Contents tab is very similar to the table of contents of a book. The user may expand or collapse a folder by double clicking the folder or by single clicking the plus or minus icon to the left of the folder. The user may view a help file item by single clicking on the title of the help page Index Tab The Index tab is designed to be similar to the index of a book. The Index tab contains an alphabetically ordered list of important words/topics contained in the Desktop Help System. Each word in this list in turn contains links to all the documents that discuss/contain that word. The Index tab also contains a Find text box at the top. This box may be used to quickly just to an entry within the Index tab. The user may type a word into the box and hit the Enter key or click the small blue arrow located to the right. If the entered word appears within the index, then the user will navigate to that help page. Ver Chapter 3: The OpenFox Desktop Pg.. 73

74 Search Tab The Search tab provides the ability to perform a text search of the pages in the Desktop Help System. To use the search tab, the user may enter a word, a phrase surrounded by quotations, or a combination of words and phrases in the text box at the top of the Search tab. Performing the search is accomplished by pressing the Enter key or by clicking the blue arrow to the right of the text box. While the search is being performed, a spinning arrow is displayed in the top right hand side of the help window. After the search has completed, the arrow disappears and the user is presented with a list of help pages that were found as a result of the search. The most relevant pages are displayed at the top of the list, and the least relevant pages are displayed at the bottom. Clicking on a page will navigate the view to that particular help page Search Capitalization Searches are not case sensitive. The results of a search will be the same regardless of whether a word (or letter in a word) is capitalized or not Choosing Search Terms Choosing the right search terms is the key to finding relevant topics. Start with the obvious, if you're looking for information on NCIC, try typing 'ncic' in the find box. It's often advisable to use multiple search terms. If you're looking for information on stolen vehicle records, you'll be better searching for 'ncic stolen vehicle' than just 'ncic'. Please note that the order of the search terms is irrelevant. For example, searching for 'ncic stolen vehicle' will return the same results as searching for 'vehicle stolen ncic'. The search will return pages that contain both the first term and pages that contain the second term and so on and so forth for each of the search terms. Thus, a page will be found by the search even if the page does not contain all of the search terms. However, the pages which contain the most search terms will appear at the top of the search results list. For example if you enter the search terms 'scars person' the search will return the pages which contain the term 'scars', the pages which contain the term 'person', and the pages which contain both 'scars' and 'person'. Pg. 74 Chapter 3: The OpenFox Desktop Ver