Volume KRP DATA SYSTEMS. WebLEDS Client Guide. WebLEDS Client Guide

Transcription

1 Volume 3 KRP DATA SYSTEMS WebLEDS Client Guide WebLEDS Client Guide

2 WebLEDS Client Guide Revision 1.1 KRP Data Systems 257 Martha Drive PO Box 302 Winchester, Oregon Phone: (541) i

3 Table of Contents CHAPTER 1 - INTRODUCTION...2 OVERVIEW...2 CHAPTER 2 THE GUI INTERFACE...4 THE DESKTOP ICON...4 THE SIGN ON SCREEN...4 THE MAIN APPLICATION SCREEN...5 CHAPTER 3 THE STATUS BAR...7 STATUS BAR INFORMATION...7 CHAPTER 4 THE TOOL BAR...8 TOOL BAR OPTIONS...8 FILE Options- (File)...8 PREFERENCES Options- (Preferences)...8 ACTIONS Options- (Actions)...9 SHORTCUTS Options- (Shortcuts)...9 HELP Options- (Help)...10 CHAPTER 5 THE FONT BAR...11 FONT BAR OPTIONS...11 CHAPTER 6 TRANSACTIONS WINDOW...12 TRANSACTIONS WINDOW FORMAT...12 CHAPTER 7 RESPONSES WINDOW...13 RESPONSES WINDOW FORMAT...13 CHAPTER 8 FUNCTION KEYS...14 FUNCTION KEY SETTINGS...14 CHAPTER 9 NOTES & EXAMPLES...16 CONSIDERATIONS...16 EXAMPLE SHORTCUTS...17

4 Chapter 1 Chapter 1 - Introduction This manual covers the usage and operation of the PC client software WebLEDS Client. This software provides a graphical command line interface to the State LEDS system, and is a supplemental component of the WebLEDS Software package. Overview W ebleds Client is a standalone Graphical User Interface (GUI) program designed specifically with power LEDS users in mind those that are familiar with the free-formatted LEDS transaction formats, and who need speed of entry and quick responses when interacting with LEDS. WebLEDS Client is a supplemental program that is part of the complete WebLEDS Software package. WebLEDS Client is a small GUI application program that is loaded onto the end users PC. Thru the application, users can interact with the State LEDS system more quickly and efficiently than thru the standard WebLEDS browser interface. But, there is a trade-off for these benefits. The user must be familiar with the standard dot-formatted syntax of LEDS commands, as documented in the LEDS Operation Manual provided by the State LEDS agency. There are no preformatted LEDS Masks within WebLEDS Client. All entry supplied by the user must be in the native dot-formatted syntax. WebLEDS Client provides its power thru a split screen design. In a top window, users will enter their free-formatted LEDS requests, and in a bottom window responses will be automatically displayed as they are received back from LEDS. Once submitted, no switching of screens or pushing of buttons is needed to view your responses a great time saver. In addition, users are provided with the ability to create their own shortcut keys for any LEDS transactions, greatly enhancing the speed of entry. WebLEDS Client is also user customizable, allowing users to individually customize such things as screen fonts, screen colors, screen sizes, and bell notification. 2

5 And finally, WebLEDS Client also includes an Instant Messaging feature, which easily allows users of the system to send and receive instant messages to one another. For Administrators, WebLEDS Client integrates smoothly with your already existing WebLEDS installation. All user authentications from the client PC are validated against your existing WebLEDS host system, and all transactions sent and received via WebLEDS Clients are logged just like your existing host WebLEDS transactions. The built in auditing capabilities of WebLEDS also works on WebLEDS Client users, allowing you full audit control over these users as well. All of these Administrative feature are performed through the standard Administrative screens already provided in the WebLEDS browser application. In addition, all information sent to and from your WebLEDS Client PC s across your network is completely encrypted. Our Auto Update feature built into WebLEDS Client also automatically installs the latest version of WebLEDS Client for your end users whenever an updated version is loaded onto the system. No more needing to revisit workstations to keep them updated. As mentioned above, WebLEDS Client also contains a built-in Instant Messaging facility. This facility gives WebLEDS users a powerful way to interact with one another. Combined with Instant Messaging is a feature that allows users to see immediately what other WebLEDS Client s are online at that moment, or retrieve a complete list of all WebLEDS users. If a message is sent to a user who is logged in via WebLEDS Client, the message will appear instantly. If the user is not logged in, or is using the legacy Browser version of WebLEDS, the message will be placed in their response queue. These combined features, and ease of use, make WebLEDS Client a powerful tool to provide to your existing WebLEDS users. 3

6 Chapter 2 Chapter 2 The GUI Interface This chapter presents the steps necessary to sign onto WebLEDS Client, and gives an overview of the main application screen The Desktop Icon O once WebLEDS Client is installed on an end users PC, they will have a new icon located on their desktop. The icon will be labeled WebLEDS Client, and the icon will look like this: The Sign W On Screen hen the user clicks on the WebLEDS Client icon, they will be presented with the Log On screen for WebLEDS Client. Their username and password will be the same username/password combination they use to access the WebLEDS browser system. The first time they sign on, they will also be required to enter the DNS name of your WebLEDS server. Successive sign on attempts will pre-fill this field in for the user based on the value last supplied. 4

7 The Main Application Screen A fter the user has supplied a valid username and password, they will presented with the main WebLEDS Client application screen. This is the screen where they will input their transactions, and receive their responses. The screen is divided into 7 basic areas: Status Bar (Displays Title, Version, User ID, LEDS ID, and Printer ID) Tool Bar - (File, Preferences, Actions, Shortcuts and Help) Font Bar - (Font Style, Size, Color, Bold and Italics options) Transaction Window Here is where you will input your LEDS dotformatted transactions. 5

8 Responses Window Here is where the responses returning from LEDS will appear. This window will scroll, with latest information automatically inserted at the bottom. Function Keys Ten Function keys providing various functions. Blue Message Bar Here is where all status and error messages will appear. This window may be minimized when not in use, or may be resized using the standard Windows resizing techniques of grabbing the window borders and dragging. To exit the application, either click on File/Quit, or simply click on the standard Windows exit icon ( ) located in the upper right corner of the window. Each of the 7 areas of the screen are described fully in the following chapters. 6

9 Chapter 3 Chapter 3 The Status Bar This chapter describes the information displayed in the Status Bar at the top of the main application window. Status C Bar Information ontained at the top of the WebLEDS Client application window is the Status Bar. The Stats Bar contains the following information: Program Identifier Program Name WebLEDS Client. Software Version The version of WebLEDS Client that you are using. User ID The WebLEDS User ID that you have logged onto the system as. LEDS ID Your 4 character LEDS Mnemonic ID. Printer ID The default printer for your account. This is the printer location that WebLEDS Client will send your print to. As new versions of WebLEDS Client are loaded onto your server, your PC will automatically update itself if needed during the log in process with these new versions. Your Software Version listed in the Status Bar will be updated to reflect your new version. 7

10 Chapter 4 Chapter 4 The Tool Bar This chapter describes the information displayed in the Tool Bar near the top of the main application window. Tool Bar Options T he Tool Bar is a standard windows dropdown selection menu, containing the following options: FILE OPTIONS- (FILE) Send Message: Quit: This option will take you to the Instant Messaging screen, which allows you to send instant messages to other WebLEDS users. This option exits the WebLEDS Client Application. PREFERENCES OPTIONS- (PREFERENCES) Bell: Screen Size: Allows the users to enable or disable the chiming of the PC s bell whenever a response or message is received. Allows the user to establish the default number of rows to be used for the Transaction and Response windows when the application is first started. This controls how big your Transaction and Response windows are at application startup. 8

11 ACTIONS OPTIONS- (ACTIONS) Clear Transactions: Clear Responses: Print Transactions: Print Responses: Save Transactions: Save Responses: This option will clear the Transactions window of all input. This option will clear the Responses window of all input. This option will print all information listed in your Transaction window. Note, this will pop up the PC s Print dialog box, allowing the user to manually select their destination printer. This option will print all information listed in your Responses window. Note, this will pop up the PC s Print dialog box, allowing the user to manually select their destination printer. This option will allow the user to save all information in their Transaction window to a file. The standard Save As dialog box will pop up, prompting the user for the filename, and allowing them to browse their directories for file placement. This option will allow the user to save all information in their Responses window to a file. The standard Save As dialog box will pop up, prompting the user for the filename, and allowing them to browse their directories for file placement. SHORTCUTS OPTIONS- (SHORTCUTS) Add Shortcut: This option allows users to define their own shortcut keys for LEDS transactions. The user will be prompted to supply a shortcut key (Example P possibly for a license Plate inquiry) and then to supply the command to run, using the special variables $V1, $V2, $V3, as substitutes for the data fields. Example shortcut key: Example command: P QRS.LC.$V1 This would allow a user to enter P.ABC123 to run a license inquiry. The first data field ABC123 will be inserted into the first variable $V1 in the command. More examples can be found at the end of this document in Chapter 9 under the Example Shortcuts section. <shortcut name>: This option allows a user to Modify or Delete a previously defined shortcut. Once a shortcut is defined, it will appear here on the shortcuts menu. 9

12 HELP OPTIONS- (HELP) Version: About: Displays the version of WebLEDS Client that you are using. Displays contact information for KRP Data Systems. 10

13 Chapter 5 Chapter 5 The Font Bar This chapter describes the options available on the Font Bar located near the top of the main application window. Font Bar Options T he Font Bar is used to change the look and feel of the WebLEDS Client screen. Font size, color, and style may be changed, in addition to bolding or italicizing the text. The following options are available: Font: This option will allow the user to change the Font Style of the text that is displayed in both the Transactions and Responses window. Size: This option will allow the user to change the Font Size of the text that is displayed in both the Transactions and Responses window. Font Color: This option will allow the user to change the Font Color of the text that is displayed in both the Transactions and Responses window. Bold: This option will toggle the Font from normal to bold for the text that is displayed in both the Transactions and Responses window. Italic: This option will toggle the Font from normal to italics for the text that is displayed in both the Transactions and Responses window. 11

14 Chapter 6 Chapter 6 Transactions Window This chapter describes the Transactions Window, which is where the user will enter their dot-formatted LEDS Requests. Transactions Window Format T his is the window in which the user will type their free-formatted LEDS transactions. After inputting the transaction, the user will need to press the F1 key (or click on the F1-Submit button) to submit it. Pressing the ENTER key will NOT submit the transaction, as the ENTER key is needed to provide the functionality to go to the next line for multi-line inputs. Once the transaction is submitted, a dashed divider line will be inserted, and the cursor will be moved down to the next line. Within seconds your response(s) will automatically appear below in the Responses window. The system also has a built-in capability that will allow a user to re-submit a previously entered LEDS transaction. The user simply needs to reposition the cursor (using the UP arrow, or using the mouse) to anywhere on the line of a previous transaction they wish to resubmit, and press the F2 key (or click on the F2-Resubmit button). This will automatically re-submit this LEDS transaction. 12

15 Chapter 7 Chapter 7 Responses Window This chapter describes the Responses Window, which is where your returning responses from LEDS will automatically be displayed. Responses Window Format T his is the window in which your responses will be displayed. Note that all received responses will have blank lines removed from them before they are displayed in this window for space consolidation. A dashed divider line will be inserted between each response received. This is also the window in which you will receive any Instant Messages that have been sent from other users. These messages will arrive with a header line indicating who the message is from. This window is scrollable using the sliding scrollbar on the right side of the window. New responses will be inserted at the end of the window, with the system automatically scrolling the window to keep the last responses in view. 13

16 Chapter 8 Chapter 8 Function Keys This chapter describes the Function Keys located along the bottom of the main application window. Function Key Settings A long the bottom of the application window are the Function Keys available for use within WebLEDS Client. These function keys are programmed for various functions that are also available from the Toolbar Menu. Below is a description of each function key: F1=Submit This option will submit whatever transaction you have entered into the Transaction window. F2=Re-Submit This option is used to resubmit a previously entered Transaction. The user must position their cursor back to the line containing the transaction they wish to resubmit, and then press the F2=Re-Submit button. Note: This function will resubmit whatever transaction data is residing at the current cursor position up to end of that transaction (defined by the next dashed divider line). F3=Paste Pressing the F3 button will Paste whatever text has been saved to the Windows clipboard to the current cursor location. Note: Due to programmatic issues, ONLY pressing the F3 button works at this time. Clicking on the F3 button on the screen does not currently work. 14

17 F4=Print Trans This will print whatever text is currently residing in your Transactions window. Your printout will automatically be printed to whatever your default printer is set to within WebLEDS. No Print dialog box will be opened like is done when using the Actions/Print menu item. F5=Print Response This will print whatever text is currently residing in your Responses window. Your printout will automatically be printed to whatever your default printer is set to within WebLEDS. No Print dialog box will be opened like is done when using the Actions/Print menu item. F6=Clear Trans This will clear all text from your Transactions Window F7=Clear Response This will clear all text from your Responses Window F8=Show Log This will display to the user a log of all transactions they have sent to LEDS for that day. F9=Send Message This option opens a window allowing the user to send an Instant Message to another WebLEDS user. From the Instant Message screen, the user can click a button to see all currently logged in WebLEDS Client users, or to see ALL WebLEDS users. Messages can be sent to multiple users by separating the destination names by commas (Ex. Mary, Joe, Tom) F10=View Request Pressing this option opens a window showing the dotformatted transaction that will be sent to LEDS when the user presses PF1=Submit. This button is useful for testing out new shortcuts that have been defined, to verify that the correct command is being built. The user simply types their command into the Transaction window, and then presses F10. This does NOT submit anything to LEDS, but merely provides an interface to show the user what WILL be submitted when the F1=Submit command is pressed. 15

18 Chapter 9 Chapter 9 Notes & Examples This chapter list additional pieces of information that both the user and administrator should be aware of when using WebLEDS Client. Considerations T he following are further considerations which should be understood when using the WebLEDS Client application: If there are responses waiting in your response queue when a users logs into WebLEDS Client, these responses will be automatically displayed to the user after logging on, and will be deleted out of their WebLEDS host response queue. When first invoking WebLEDS Client, the user will be prompted for the name of their WebLEDS host, and their username and password. The WebLEDS host is typically something like leds.co.countyname.or.us. The username and password are your existing WebLEDS username and password, case sensitive. WebLEDS Client is NOT designed to work for users who have been setup within WebLEDS to use a shared LEDS Terminal ID and Mnemonic code. If your profile shares a common Terminal ID / Mnemonic with another WebLEDS sign-on, the moment you log into WebLEDS Client, ALL returning responses from LEDS with your Terminal ID will be routed back to you, irregardless if the other user using your shared ID sent the request. To avoid problems, verify with your WebLEDS administrator that your user signon has been assigned a unique LEDS Terminal ID and Mnemonic. Multiple users may use the same PC, and setup their own preferences. WebLEDS Client will uniquely save each individual users preferences, based on your WebLEDS sign-on username. 16

19 Multiple concurrent open windows of WebLEDS Client is not supported. The user may only have one WebLEDS Client open at any given time. Example Shortcuts B elow are some examples of possible shortcuts that a user may wish to define. The purpose of these examples are to better help the user in their understanding of the definition of shortcuts. The KEY field is the name of the shortcut that you are defining. The COMMAND field is the command that you will input for your shortcut. Notice the $V1, $V2, $V3 fields are the variable fields that will be filled in with your input data when you enter your transaction and submit it to LEDS. The USER ENTERS data is an example of what the user would enter to run the command using the shortcut you just created. Example Shortcuts: Key: Command: User Enters: Key: Command: User Enters: Key: Command: User Enters: Key: *Command: User Enters: P QRS.LC.$V1 P.abc123 RAPS RR.KRP.OR JUDGE SMITH.PUR/C.SID/$V1 RAPS RAPF RR.KRP.OR JUDGE SMITH.PUR/C.FBI/$V1 RAPF CRIM QWHD.KRP.OR JUDGE SMITH. NAM/$V1.RAC/W.SEX/$V2.PUR/C.DOB/$V3.INV CRIM.DOE, JOHN.M * - Command is shown wrapped on two lines, but is entered as one long line. 17

20 END OF DOCUMENT 18