The document provides an overview and user guide for the TranCollector software which is used to collect and transmit data from collection devices to a host application as part of the dcLINK Data Collection System.
The purpose of the document is to provide a user guide for using the TranCollector software to collect data from collection devices like barcode scanners and transmit the data to a host application via the dcLINK Data Collection System.
The main components of the dcLINK Data Collection System mentioned are the host computer, a personal computer server, and the collection devices. The personal computer runs the client/server component and acts as a server to the collection devices.
Data Collection System
TranCollector Users Guide
For Telnet Collection Devices Version 5.0 August 2009 Data Systems International, Inc. 7801 W. 110th Street Overland Park, Kansas 66210 Telephone: (913) 696-4000 Website: http://www.dsionline.com The client/server component of dcLINK Data Collection System runs in the Microsoft Windows Server 2003 or Win- dows 2000 operating system. DSI has completed testing of this application and has officially become a member of the IBM Netfinity ServerProven program. This documentation contains confidential and proprietary trade information of Data Systems International (DSI) and may not be copied, distributed, or disclosed without prior written permission. This documentation is subject to change without notice and does not represent any express or implied commitments by DSI. The software described in this documentation is furnished under a License Agreement and may be used or copied only in accordance with the terms and conditions of the agreement. Many of the company and product names referenced in this documentation not belonging to DSI are claimed as trademarks by their respective companies; it is not the intention of DSI to claim any such names as its own. Throughout this documenta- tion, trademarked names may be used. Rather than put a trademark ( or ) symbol in every occurrence of a trademarked name, DSI states that it is using the names only in an editorial fashion, and to the benefit of the trademark owner, with no intention of infringement. Printed copies of this documentation are uncontrolled and do not represent the most current information. The controlled doc- umentation is maintained online and released as online books or online help. 1997 2009 Data Systems International, Inc. All Rights Reserved. All applicable company and product names are trade- marks or registered trademarks of their respective owners. Product names, logos, designs, titles, words or phrases within this publication may be trademarks, service marks or trade names of Data Systems International, Inc. or Unibar Inc. a sub- sidiary of Data Systems International, Inc., or other entities, and may be registered in certain jurisdictions. The following are trademarks of Data Systems International, Inc.: Data Systems International, dcLINK, TranPrint. The following are trademarks of Unibar Inc.: Unibar, Unibar Enterprise Labeling Software, Unibar ELS, Unibar ELS Standard, Barcode 2000. Oracle, J.D. Edwards, and PeopleSoft are registered trademarks of Oracle Corporation and/or its affiliates. Microsoft and Windows are registered trademarks, and NT, CE, SQL Server, Access, FoxPro, and Terminal Server are trade- marks of Microsoft Corporation. IBM, AS/400, and Netfinity are registered trademarks of International Business Machines Corporation. DB2 Universal Database (UDB) is a trademark of International Business Machines Corporation. 8i and 9i are trademarks or registered trademarks of Oracle Corporation. MySQL is a trademark of MySQL AB. Loftware, Loftware Label Manager, and Loftware Print Server are trademarks of Loftware, Inc. BarTender is a registered trademark of Seagull Scientific, Inc. NiceLabel is a registered trademark of Euro Plus d.o.o. iii Welcome The dcLINK
Data Collection System is the information bridge from your
plant or warehouse floor to your host application data files. This systems multi-tiered architecture streamlines the data collection process and runs the system components under their own environments: One for the host computer One for a personal computer One for the collection devices The personal computer becomes a server to the data collection devices and a client to the host computer. Each component works cooperatively to provide you with a full-featured data collection system. Information is captured at the source from a variety of input devices, then passed directly to the data collection server. This information is then sent to your host computer where it is formatted and routed to the appropriate appli- cation data files. You can integrate the data collection system with the following systems: PeopleSoft
Enterprise
JD Edwards
EnterpriseOne
or World
Oracle
E-Business Suite SAP
R/3
Lawson Enterprise Management System
iv For Your Information This section provides the following information: About the Documentation How to Contact DSI About This Guide About the Documentation Your data collection system comes with a set of manuals and a comprehen- sive Help system. Manuals You receive the manuals appropriate for your data collection system environ- ment. All manuals are available electronically as online books and are shipped on the same CD-ROM as the dcLINK
Data Collection System software.
The documentation set includes the following manuals for all enterprise sys- tems: Client/Server Installation Guide Explains how to install the data collection system and module programs and how to implement the basic data collection sys- tem. TranCollector Users Guide Explains how to run the scripts created in the TranBuilder program on data collec- tion devices and how to use the menus of the TranCollector program. v If you use the World system, the documentation set also includes the follow- ing manuals: If your data collection system includes a module, such as TranPrint, an addi- tional manualthe setup guide for that moduleis also included. Each setup guide describes the features and functionality of the module and explains the implementation process. You can distribute any or all of the online books to each data collection sys- tem computer using the Client Setup utility. Help System In addition to the manuals that you receive with your software, DSI provides a comprehensive Help system. Online Help Online Help refers to the window- or field-level Help that DSI provides. This type of Help gives you comprehensive information about the entire program, including procedures (How To) for completing specific tasks. The Help system consists of multiple online Help files accessible at the sys- tem, program, and component levels. From the Start menu, you can view the entire Help system by selecting Help from the dcLINK program group. Selecting the Help command button located on a program window opens Help Host Installation Guide Explains how to install the data collection system programs that run on your host computer. TranConnect Administrators Guide Explains how to maintain your data col- lection system in your host environment. TranConnect Setup Guide Explains how to set up your data collec- tion system in your host environment. vi specific to each system software component. You can also open Help for the active window by pressing the [F1] key. Help is also available for each software component of each data collection system module, such as TranPrint. Help is also provided for each standard data collection system component affected by the module. The Help system gives you several ways to find information about different topics: table of contents, index, or search options. Search performs a full-text search. Customized Language Settings If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. How to Contact DSI Product support is available to all DSI clients through our help desk. Clients who subscribe to DSI maintenance support also may access product support from a special Web site dedicated to answering client questions. This Web site provides an easy way to access account information, monitor outstanding service requests, and open new service requests. Business hours are Monday through Friday, 8:00 A.M. to 5:00 P.M. (central time). Support hours are 7 days a week, 24 hours a day. vii Contacting the Global Support Center Please provide the following information when contacting Global Support: Company name Contact name Telephone number Product name and version number Program that you are running Exact wording of any messages that appeared on your display What you were doing when the problem occurred What steps you have taken to solve the problem, if any Phone Americas-Based Clients (North, Central, and South America) +1 (913) 696-4040 EMEA-Based Clients (Europe, Middle East, Africa) +44 (0) 2033181584 AP-Based Clients (Asia Pacific) +613 9001 5749 24 hours a day/7 days a week for support Fax +1 (913) 696-4002 E-mail Global Support Center: [email protected] Web extranet.dsionline.com Mail Global Support Center Data Systems International, Inc. 7801 W. 110th Street Overland Park, KS 66210 United States viii Exact wording of any messages that appeared on your display What you were doing when the problem occurred What steps you have taken to solve the problem, if any About This Guide This guide assists users who use TranCollector menus. This guide also assists people who support the data collection product, such as customer support per- sonnel and technical support personnel. As a user, you should have a comprehensive understanding and a working knowledge of the following: The data collection process as it pertains to your business operations The menus and functions on your collection device Suggestions and Comments DSI wants to provide you with the best documentation possible and values your feedback. Please contact our writers with any comments, corrections, or suggestions for the documentation at any of the addresses below. We will respond. . E-mail [email protected] Fax +1 (913) 696-4002 Mail Writers, Wireless Systems Group Data Systems International, Inc. 7801 W. 110th Street Overland Park, KS 66210 United States Contents Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii For Your Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv About the Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv Manuals. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv Help System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v How to Contact DSI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi Contacting Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii Suggestions and Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 What Is in This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Icons and Typography . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Keyboard Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2 TranCollector Basics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Understanding TranCollector Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Function Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Keypad Keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 3 Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Understanding the TranCollector Program. . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Logging On. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Title Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 x Contents Logging Off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Understanding Collection Device Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Informational . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Reading Collection Device Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Status Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Making Menu Selections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Choosing a Menu Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 4 Main Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Understanding the Main Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Running Scripts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Reviewing Script IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Transmitting Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 5 Configuration Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Understanding the Configuration Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Updating System Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Updating Script Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Synchronizing Time and Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Updating the Script Set File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Getting Available Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Changing the System Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Changing Script Sets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Changing User Zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Changing Communications Time-Out Limits . . . . . . . . . . . . . . . . . . . . . 53 Changing Display Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Working with Miscellaneous Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Resetting the Main Output File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Displaying System Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Contents xi Changing the Time Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Changing the User Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 A Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Reading System Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Understanding System Message Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Loading Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Execution Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Error Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Error: Error opening file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Error: Error reading file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Error: Error writing file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Error: File already open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Error: File not found . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Error: Invalid data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Error: Invalid data match . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Error: Invalid extraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Error: Invalid file open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Error: Invalid format mask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Error: Invalid params . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Error: No master record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Version Compatibility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Corrupted Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 Error: Output truncated. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 Error: Version error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Warning Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Warning: Screen limits exceeded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 *dsii 1 Introduction This chapter provides information about the content of this guide and describes the conventions and terms used. This chapter will help familiarize you with the special visuals and typographical conventions that help you nav- igate through the printed documentation. The chapter contains the following sections: Organization Conventions 2 Chapter 1 Introduction v5.0 TranCollector Users Guide Organization This guide is divided into chapters generally by function. Each chapter has an overview, an introduction to the function, and instructions for performing the related procedures and tasks. What Is in This Guide Chapter 1: Introduction Describes the purpose, organization, and conventions used in this guide. Chapter 2: TranCollector Basics Explains the purpose of the TranCollector program and describes its menu structure and how to use the menus. Chapter 3: Overview Describes how to log on and log off the TranCollector program and how to use the screens and menus. Chapter 4: Main Menu Describes the functions in this menu and how to use them. In addition, it includes information pertaining to collecting trans- action data. Chapter 5: Configuration Menu Describes the functions in this menu and how to use them. Appendix A: Troubleshooting Describes system error messages and how to correct the condition that causes them. Chapter 1 Introduction 3 TranCollector Users Guide v5.0 Conventions The following are descriptions of typographical conventions used in this guide to help you identify different types of information. Icons and Typography Note: Indicates additional information or a suggestion. Example: Note: If an error appears after the Terminal selection prompt, click OK or Cancel as is appropriate.
Indicates step-by-step instructions for performing a
task. Example: To run Setup 1. Insert the CD or diskette into the applicable drive. Important: Indicates critical information that you should read before continuing. Example: Important: The data collection system must run on a Windows NT 4.0 environment. 4 Chapter 1 Introduction v5.0 TranCollector Users Guide Indicates an adverse condition, related to software or hardware, that can occur while performing a particular function. For software-related issues, this symbol des- ignates a caution. For hardware-related issues, this symbol designates a warning. You should stop and read before continuing. Example: Collection devices with the same name can lead to problems with duplicate transactions or out-of- order records. Courier Font Indicates names of programs, directories, folders, and files. Example: The data collection system resides in the DSI\dcLINK folder. Courier Font (Bold Type) Indicates data that you type. Example: If the instruc- tions are to type username, the text looks like this: Type username. Instructions for typing data always appear in the appro- priate case format, that is, uppercase or lowercase. Italic type Indicates special terms and titles. Example: A refer- ence to a topic, section, or chapter in a guide would look like this: See Conventions earlier in this chapter. ! ! Chapter 1 Introduction 5 TranCollector Users Guide v5.0 Keyboard Functions Terms [Key Name] Indicates a key on the keyboard. The names of all keys are typed as they appear on a keyboard and are enclosed in square brackets. Example, when the instructions want you to press the Enter key, you see press [Enter]. Arrow keys A collective term for the Up, Down, Left, and Right arrow keys. These keys are indicated as follows: [], [], [], []. [Fn] Indicates a function key where n represents the number of a function key. All function keys are indicated by the letter F followed by the appropri- ate number and enclosed in square brackets, that is, [F1], [F2], and so forth. Enter To type information and press [Enter]. Select To make a selection, highlight a line in a selection list or click in the option, such as a check box or radio button. Type To input information in a field by typing. 6 Chapter 1 Introduction v5.0 TranCollector Users Guide TranCollector Program For reference purposes, this guide uses the term TranCollector program to describe the functional- ity of the TranCollector program. In Telnet terminal emulation, the functionality of the TranCollector program is contained in the Tran- Server Telnet service and not in the actual TranCol- lector program. *dsii 2 TranCollector Basics This chapter describes the common elements of the TranCollector program, such as screen features, function keys, and keypad keys. This chapter also describes the types of messages that you might see while operating the collec- tion device. Use this chapter to become familiar with navigating in the Tran- Collector menu system. The chapter contains the following section: Understanding TranCollector Features 8 Chapter 2 TranCollector Basics v5.0 TranCollector Users Guide Understanding TranCollector Features This section provides a description of the following features in the TranCol- lector program: Menus Function Keys Keypad Keys Messages Menus The TranCollector program is made up of menus from which you make selec- tions for performing functions. The following is an example of the Main Menu and its elements. Input Field is used to enter data. User/Device displays user logon and device ID. Header Information contains screen title. Work Area displays prompts and their input fields, menu selections, and messages. Status Line displays current time, record count, and battery status. Chapter 2 TranCollector Basics 9 TranCollector Users Guide v5.0 Note: If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. From the collection device, you can use the function keys to make menu selections that enable the collection device to collect transaction data, review script IDs, and transmit records. Function Keys You use the following types of function keys to perform tasks within the Tran- Collector program: system-defined and user-defined. System-defined function keys are defined as part of the TranCollector pro- gram and perform the same function from screen to screen. These function keys cannot be redefined. The function keys that appear on the TranCollector programs Main menu are system-defined function keys. User-defined function keys are defined in the TranBuilder program by your data collection system administrator. These keys are soft-coded, which means that your system administrator has defined a function key to perform a certain task. For example, typically you use [F4] as the exit key. Your system admin- istrator has the ability to change this key assignment and its function. You can obtain a list of these keys from any input field by using the [Esc] key. See Running Scripts in Main Menu. Function keys that perform special functions (for example, function keys, arrow keys, and page up/page down, home, and end keys) must be mapped for the Telnet emulation protocol. The TranServer Telnet service comes with these keys mapped for the VT220 emulation protocol. If you are running a Telnet emulation protocol other than VT220, you must map the keys that per- form special functions. See Mapping Keys in Client/Server Installation Guide. 10 Chapter 2 TranCollector Basics v5.0 TranCollector Users Guide Keypad Keys When a function requires you to press two keys at the same time, it is referred to in this guide as a key combination, for example, [Ctrl] + [Q]. The following is a description of the system-assigned keys: Key Description [Ctrl] + [Q] This key combination is a safeguard exit key. All scripts should have a defined function key for exiting the script. If a safeguard exit key is not assigned through the TranBuilder program, you can use this key combination to exit any field prompt in a script. This key combination does not work from a menu. Chapter 2 TranCollector Basics 11 TranCollector Users Guide v5.0 Note that the term page refers to the entire display area. The following keypad keys are used when working with either a download or table selection list. Key Description [Enter] From a TranCollector menu: Displays the next page of options when more than one page of options exist. Takes you back one level when the menu options appear on a single page. From a list: Selects the highlighted item in the list. For example, when you are reviewing a list of valid scripts, press [Enter] to select the script and then run the script. Key Description [Esc] Exits out of a selection list and returns you to the previ- ous location in the script. When a function key is assigned to a prompt, press [Esc] to display a list of the available function keys or to return to the prompt. Press [Esc] from any menu to return you to the previ- ous menu. [PgUp] or [F] (Page Up) Moves the selection bar up one page at a time. [PgDn] or [B] (Page Down) Moves the selection bar down one page at a time. 12 Chapter 2 TranCollector Basics v5.0 TranCollector Users Guide For more information about working with a particular collection devices key- pad, refer to the manufacturers user manual for your collection device. Messages Special programs perform edits at different points in the TranCollector pro- gram. Different types of messages appear based on the situation: system mes- sages and user-defined messages. System messages come from the TranCollector program. This type of mes- sage might appear when the program detects an error while downloading a script. See Troubleshooting for a description of these messages. User-defined messages are contained in the script and defined in the Tran- Builder program by your data collection system administrator. An example of this message might be Duplicate item number. Re-enter item number. When you encounter this type of message, consult with your system administrator. Key Description [Home] or [H] Moves the selection bar to the first selection in the list and positions this selection in the first line of the dis- play. [End] or [E] Moves the selection bar to the last selection in the list and positions the selection in the last line of the dis- play. Arrow Keys Scrolls through a selection list. Use the [] or [U] key to move the selection bar up one position. Use the [] or [D] key to move the selection bar down one posi- tion. The list adjusts accordingly either by moving the first selection up and displaying another at the bottom of the list or by moving the last selection down and dis- playing the previous selection at the beginning of the list. Chapter 2 TranCollector Basics 13 TranCollector Users Guide v5.0 Note: If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. You might encounter other types of messages while working in the TranCol- lector program. When these messages occur, write down the message and call WSG Product Support. *dsii 3 Overview This chapter describes the TranCollector program and how to log on and log off the program. It also describes the different types of screens that you might encounter while working in the TranCollector program, the parts of a screen, and the menu structure. This chapter contains the following sections: Understanding the TranCollector Program Understanding Collection Device Screens Reading Collection Device Screens Making Menu Selections 16 Chapter 3 Overview v5.0 TranCollector Users Guide Understanding the TranCollector Program The TranCollector program provides the means for collecting transaction data through the use of bar code technology. The TranCollector program runs on Windows 2000, Windows NT, or Windows CE operating system, or an emu- lated MS-DOS operating system, depending on which TranServer service you use. Note: The Windows and Windows CE versions of the TranCollector program include procedures and information in online Help, which you can access through the Help menus when running the TranCollector program. The emulated MS-DOS operating system requires a Telnet client emulation program (for example, VT220 or VT100) and runs on the data collection server. The TranServer Telnet service runs the TranCollector program using the Telnet terminal-emulation protocol. This users guide provides procedures and information for the Telnet version. Multiple languages can be supported in the TranCollector program through localization settings specified in the Configuration Utility program. For lan- guage translations to take effect, translation dictionaries must be published through the Configuration Utility program. See Understanding Localization in Configuration Utility Help. Chapter 3 Overview 17 TranCollector Users Guide v5.0 The TranCollector program creates script records by interpreting scripts writ- ten in the TranBuilder program. In addition to the translation dictionaries gen- erated through the Configuration Utility program, the TranCollector program uses the following files that are generated through the TranBuilder program: Published Script Set Published Script Permissions The script set file contains the collection of scripts that perform business transactions unique to your business environment. The script determines what you see on the collection device display during the collection process. See Publishing Script Sets and Scripts in TranBuilder Help. The script permissions file contains the permissions of authorized users for running scripts. Script permissions consist of user ID, password, permissions to the scripts, and access to the functions within the TranCollector program that the user can perform. Several security settings in the dcLINK system con- trol user access to the TranCollector program: The Application Security Mode setting in the Configuration Utility program establishes the level of security to be used for the entire data collection system, including the TranCollector program. When no application security is set, data collection users can run the TranCol- lector program, unless there is program-level security. Permissions to perform functions in the TranCollector program, set in the Configuration Utility program, authorize data collection device users to complete tasks while collecting data through scripts. The Disable device security option in the TranBuilder program deter- mines whether users are required to log on to data collection devices. When this setting is not selected, every device user must have a user profile, which includes general information, such as user ID and pass- word, group membership, and individual script permissions. Script permissions established in the TranBuilder program control the authority users and/or groups have for running scripts. For more information, see Understanding Security Settings in Configuration Utility Help and Understanding TranBuilder Security in TranBuilder Help. 18 Chapter 3 Overview v5.0 TranCollector Users Guide For questions concerning your user authorization, refer to your system admin- istrator. When a TranCollector session starts, the TranCollector program goes through a series of program checks. Initially, the program checks for the script set file and the script permissions file. If the TranCollector program does not find one or both of these files, it requests a copy of the applicable file from the appro- priate TranServer service. Both files must be published through the Tran- Builder program prior to running the TranCollector program. Each time a session starts after the initial startup, the TranCollector program runs a comparison check of the versions of the script set and script permission files that it is running. For the script set file, the TranCollector program compares the ver- sion it is running to the published version of the script set file on the data collection server. If the version of the script set file on the data collection server is newer, the TranCollector program displays a prompt requesting you to download the newer version of the script set file. For the script permissions file, the TranCollector program compares the date of the file it is running to the published date of the script per- missions file on the data collection server. If the published date on the data collection server is later than on the file that the program is run- ning, the TranCollector program automatically updates the script per- missions file it is running. You can manually update these files through the Update Data option in the TranCollector program. See Updating System Data in Configuration Menu. Note: If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. Chapter 3 Overview 19 TranCollector Users Guide v5.0 Logging On Note: Access to this TranCollector function may be restricted. To perform a restricted option, security settings must be properly set up for your user pro- file, or you must use the system-provided user profile (DSI). Refer to your system administrator for more information. Your logon information in the TranCollector program depends on your user profile. If your user profile requires a user ID and password, the program prompts you. Note: If the device security option is turned off, logging on is not necessary. The password prompt will not be displayed. 20 Chapter 3 Overview v5.0 TranCollector Users Guide To log on 1. (required) Type your user ID and press [Enter]. If your profile requires a password, continue with step 2. If a password is not required, the title screen briefly appears followed by the Main menu. 2. Type your password and press [Enter]. You are now ready to begin collecting data. Note: If authorized, you can change your logon password from the collection device, using the Change Password option on the Miscellaneous menu. This option is available only when device security is enabled and application secu- rity is set to Advanced Security. For more information, see Changing the User Password on page 62. Title Screen The title screen shows the version of the TranCollector program that you are running and the name and version of the script set that is currently selected. Chapter 3 Overview 21 TranCollector Users Guide v5.0 Logging Off You use the [F3]-Log Off option from the Main menu. Note: The [F3]-Log Off option does not appear if the device security option is turned off. See Understanding TranBuilder Security in TranBuilder Help. A script can also be specified to run when a user logs off the TranCollector program. If a logoff script has been specified in the users profile, the script will initiate automatically before the current program session ends. Note: If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. F3 logs you off the current session. 22 Chapter 3 Overview v5.0 TranCollector Users Guide To log off Note: You must exit the script before you can log off. You can only issue a log off command from the Main menu. Begin at the Main menu. 1. Press [F3]. The TranCollector program issues a logoff command. A logoff script will run if one has been specified for the user profile. When the process is complete, the User Logon screen appears. Chapter 3 Overview 23 TranCollector Users Guide v5.0 Understanding Collection Device Screens The TranCollector program contains screens that display menu selections, static information, and bar code data. An input screen, which contains a prompt and input field, is frequently used during the data collection process. The screen-size parameters for the collection device are defined through the Device Loader program. The information that appears on your screen is deter- mined by the scripts and script sets that are unique to your business environ- ment. As scripts are run, the prompts and input fields for that script are displayed on your collection device screen. The following are examples of screens in the TranCollector program: Informational Menu Input Note: If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. 24 Chapter 3 Overview v5.0 TranCollector Users Guide Informational Informational screens display system information and error or warning messages. Chapter 3 Overview 25 TranCollector Users Guide v5.0 Menu Menus display actions that you can take on the collection device. The Main menu contains four actions and the Configuration sub-menu. The Configura- tion menu contains sub-menus with additional actions. Note: The [F3]-Log Off option does not appear if the device security option is turned off. See Understanding TranBuilder Security in TranBuilder Help. 26 Chapter 3 Overview v5.0 TranCollector Users Guide Input Input screens contain prompts and fields that you use to enter data collection information. Input screens are the most frequently used screens in the Tran- Collector program. Chapter 3 Overview 27 TranCollector Users Guide v5.0 Reading Collection Device Screens The collection device screen contains a work area but can also contain header information and status information. The screen size and line information is determined by your collection device type. You define the screen display area in the Device Loader program. See Device Loader Help. The header information contains the screen title and script title. The work area contains the prompts and input fields defined in the script, along with any additional information, such as messages and menu selections. The status lines contain static information, which is time, record count, and battery sta- tus. The header information and status lines appear only if specified in the Device Loader program. Note: If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are Input Field is used to enter data. User/Device displays user logon and device ID. Header Information contains screen title. Work Area displays prompts and their input fields, menu selections, and messages. Status Line displays current time, record count, and battery status. 28 Chapter 3 Overview v5.0 TranCollector Users Guide shown or described in this documentation. Consult with your system adminis- trator for specific language information. Status Line Status Description Time The current time in hours and minutes (hh:mm). The time is synchronized with the data collection server, unless the time zone was changed on the collection device. Record Count The number of collected records that are stored in the main output file. Records are stored in this file until they are sent to the data collection server. After the records are transmitted, the record count is cleared. Battery Status The remaining amount of charge in the collection device battery. It is very important that you monitor this status regularly. The information displayed depends on the collection device type. The following list shows the valid values for each supported collection device: Intermec The status is displayed as a percentage from 100 to 0 (zero). 100 to 70 percent Indicates that the battery is running at its optimum level. 70 to 30 percent Indicates that the battery is running at a moderate level. Chapter 3 Overview 29 TranCollector Users Guide v5.0 30 to 20 percent Indicates that the battery is low. 20 to 0 percent Indicates a serious condi- tion and that the battery must be replaced. The col- lection device will not accept additional input entries until the battery is replaced. Percon The status value is OK. Symbol The status value is OK. Telxon The status value is OK. Status Description 30 Chapter 3 Overview v5.0 TranCollector Users Guide Making Menu Selections The TranCollector program contains menus that are used to perform func- tions. You carry out functions by choosing the corresponding function key on the collection device keypad. The TranCollector program contains the Main menu and a secondary menu, Configuration. Access to some menu options may be restricted. To perform a restricted option, security settings must be properly set up for your user profile, or you must use the system-provided user profile (DSI). Refer to your system admin- istrator for more information. Note: If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. Chapter 3 Overview 31 TranCollector Users Guide v5.0 The Configuration menu contains the following sub-menus: Each sub-menu provides access to specific functions. Access to some func- tions may be restricted. To perform a restricted option, security settings must be properly set up for your user profile, or you must use the system-provided user profile (DSI). Refer to your system administrator for more information. The restricted functions are noted in this guide. Also, the [F4]-Change Pass- 32 Chapter 3 Overview v5.0 TranCollector Users Guide word option in the Miscellaneous Menu is available only when device security is enabled and application security is set to Advanced Security. See Under- standing TranBuilder Security in TranBuilder Help. Choosing a Menu Option Menu options perform specified functions or display a prompt and its input field when data is required. You choose a menu option by using its associated function key. To choose a menu option 1. From the applicable menu, press the function key for the function that you want to perform. 2. Complete the operation by supplying the appropriate information as it is requested. *dsii 4 Main Menu This chapter describes the functions that you can perform from the Main menu. The Main menu contains functions for collecting transaction data, reviewing script IDs, and transmitting records. The chapter contains the following sections: Understanding the Main Menu Running Scripts Reviewing Script IDs Transmitting Records 34 Chapter 4 Main Menu v5.0 TranCollector Users Guide Understanding the Main Menu The Main menu provides access to all functions in the TranCollector program. If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. Input Field is used to enter data. User/Device displays user logon and device ID. Header Information contains screen title. Work Area displays prompts and their input fields, menu selections, and messages. Status Line displays current time, record count, and battery status. Chapter 4 Main Menu 35 TranCollector Users Guide v5.0 Menu Option Description Select Script This input field is used to enter the script that you want to run. To choose a script, type the script ID in the input field. If you do not know the ID, you can review a list of valid script IDs by selecting [F1]- Valid Codes. [F1]-Valid Codes Lists the valid script identification numbers in a script set. [F2]-Transmit Transmits stored records to the data collection server. [F3]-Log Off Ends the current TranCollector session. If a logoff script has been specified in the users profile, the script will initiate automatically before the current program session ends. [F4]-Configuration Opens the Configuration menu, which is used to perform system functions. 36 Chapter 4 Main Menu v5.0 TranCollector Users Guide Running Scripts You collect data for your business transactions by running the scripts that were created for your business operations. The TranCollector program inter- prets the scripts and displays the prompts that instruct you on the type of data to collect. You can enter data by scanning a bar-coded label or using the col- lection device keypad to input the data. The following example illustrates the progression of an Inventory In script, beginning with a request for a branch/plant location entry and ending with a request for a unit of measure entry. In this example, the first prompt for an Inventory In script that you see is the branch/plant. You continue working through the script by entering the infor- mation for each prompt as it is presented. Chapter 4 Main Menu 37 TranCollector Users Guide v5.0 After you enter the branch/plant information, the following prompts appear on progressive screens: Enter Item Enter Location Enter Lot Number Enter Quantity Enter Unit of Measure After you enter the unit of measure, the Inventory In script returns to the Enter Item prompt. This progression allows you to continue with the data collection process for subsequent items. To exit the script, press [F4]. Note: Your script processing might be different, based on your defined script set. If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. Use the following procedures for running a script and reviewing the valid function keys within a script. To run a script Your system administrator defines the actions contained in the scripts for your business operations. Consult with your system administrator for procedures for operating in your data collection environment. Begin at the Main menu. 1. Type the script ID. If you do not know the script ID, choose [F1]-Valid Codes. A list of script IDs appears. See Reviewing Script IDs. 38 Chapter 4 Main Menu v5.0 TranCollector Users Guide 2. Complete the script by scanning or keying the requested data. For each entry, the collection device sends an audio signal to alert you that your entry has been received. Depending on the collection device, if the entry was not received or the bar code was invalid, you receive a rejection signal, which is a different sound. Depending on the script you are running, several different conditions can apply. For example, some scripts are defined to exit automatically and return you to the Main menu. Other scripts end the current session by exiting the script and logging you off from the TranCollector program. To review valid function keys You can obtain a list of valid function keys from any input field within a script. Certain function keys perform the same function from any location in the script, while other function keys can only be used from the current field. 1. From any input field, press [Esc]. A list of the valid function keys for the script or prompt appears. In the example above, [F1] returns you to the previous field. [F4] exits the script and returns you to the Main menu. Chapter 4 Main Menu 39 TranCollector Users Guide v5.0 You can review the list by using the following chart: 2. Find the condition that applies and take the appropriate action. Condition Action:key to press Scroll through the list. [PgUp], [PgDn], [ ], [ ],[End], or [Home] Return to the input field from a selection list. [Esc] Select a function. [Enter] (Function must be highlighted.) or the respective function key of the function you want to perform, for example, [F1] or [F2] 40 Chapter 4 Main Menu v5.0 TranCollector Users Guide Reviewing Script IDs To review a list of script IDs, use function [F1]-Valid Codes from the Main menu. Note: If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. Chapter 4 Main Menu 41 TranCollector Users Guide v5.0 To review script IDs Begin at the Main menu. 1. Press [F1]. A list of all valid scripts in the chosen script set appears. 2. To review items not in the viewable area, use the [PgUp], [PgDn], [ ], [ ], [End], or [Home] buttons. See the following chart: 3. Continue this process until you find the script that you want to use. Condition Action:key to press Scroll through the list. [PgUp], [PgDn], [End], [Home], [ ], or [ ] Return to the Main menu. [Esc] Choose an item [Enter] (Item must be highlighted.) 42 Chapter 4 Main Menu v5.0 TranCollector Users Guide Transmitting Records The Transmit function sends stored records from the collection devices main output file to the data collection server. You use this option primarily for batch processing, such as a cycle count, or for recovery purposes after the data collection server has been unavailable. Note: If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. To transmit records Begin at the Main menu. 1. Press [F2]. Records are sent in the order in which they are placed into the main output file. The TranCollector program processes and sends all stored records to the data collection server. When the process is complete, the record count is set to zero. *dsii 5 Configuration Menu This chapter describes the functions of the Configuration menu and how to update system data, edit configuration settings, and perform miscellaneous functions. This chapter contains the following sections: Understanding the Configuration Menu Updating System Data Changing the System Configuration Working with Miscellaneous Functions 44 Chapter 5 Configuration Menu v5.0 TranCollector Users Guide Understanding the Configuration Menu Use this menu to maintain system parameters specific to your data collection environment. Note: If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. Access to some menu options may be restricted. To perform a restricted option, security settings must be properly set up for your user profile, or you must use the system-provided user profile (DSI). Refer to your system admin- istrator for more information. In the following list, restricted options are indi- cated by an asterisk. Chapter 5 Configuration Menu 45 TranCollector Users Guide v5.0 Menu Function Description [F1]-Update Data Performs the following functions: Updates script permissions* Synchronizes the collection device date and time with the data collection server Updates the script set file* Gets available script sets (changes sets)* [F2]-Edit Config Performs the following changes to the collection device parameters: Changes the script set file* Changes the user zone* Changes the communications time-out limit* Changes the display size (TranServer Telnet only)* [F3]-Miscellaneous Performs the following functions: Initializes the main output file* Displays system information Changes time zone on device* Changes user logon password (avail- able when device security is enabled and application security is set to Advanced Security)* 46 Chapter 5 Configuration Menu v5.0 TranCollector Users Guide Updating System Data The Update Data menu provides access to functions that are used to update the TranCollector program. Use this menu to do the following: Update script permissions.* Synchronize the time and date. Update the script set file.* Get available script sets.* Access to some menu options may be restricted. To perform a restricted option, security settings must be properly set up for your user profile, or you must use the system-provided user profile (DSI). Refer to your system admin- istrator for more information. In the list above, restricted options are indicated by an asterisk. Chapter 5 Configuration Menu 47 TranCollector Users Guide v5.0 Note: If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. Updating Script Permissions Note: Access to this TranCollector function may be restricted. To perform a restricted option, security settings must be properly set up for your user pro- file, or you must use the system-provided user profile (DSI). Refer to your system administrator for more information. Use this function when a change is made to a user or group profile in the Tran- Builder program. For non-supervisory profile log ons, the TranCollector program checks for new scripts during startup. See Understanding TranBuilder Security in Tran- Builder Help. To update script permissions Begin at the Update Data menu. 1. Press [F1]. If changes are found in the script permissions file, the new information is downloaded to the TranCollector program. 48 Chapter 5 Configuration Menu v5.0 TranCollector Users Guide Synchronizing Time and Date Use this function to synchronize the clock in the collection device with the data collection server. To synchronize time and date Begin at the Update Data menu. 1. Press [F2]. The collection device time and date synchronizes with the data collection server. Updating the Script Set File Note: Access to this TranCollector function may be restricted. To perform a restricted option, security settings must be properly set up for your user pro- file, or you must use the system-provided user profile (DSI). Refer to your system administrator for more information. Use this function when changes are made to a script or after you have chosen a different script set. To update the script set file Begin at the Update Data menu. 1. Press [F3]. If you did not enter a valid script set ID, an error message appears. Chapter 5 Configuration Menu 49 TranCollector Users Guide v5.0 Getting Available Sets Note: Access to this TranCollector function may be restricted. To perform a restricted option, security settings must be properly set up for your user pro- file, or you must use the system-provided user profile (DSI). Refer to your system administrator for more information. Use this function to choose a new version of the script set that is currently run- ning or a different script set from the one currently loaded and running. This function simplifies the process of selecting a script set and downloading it to the TranCollector program. Instead of having to use two different menus, you can use this function to select the script set and update the script set file. If a new version of the script set file or new script set is found, the script sets are downloaded, and the script set file is updated in the TranCollector program. To get available sets Begin at the Update Data menu. 1. Press [F4]. The TranCollector program sends a request to the TranServer service. If a newer version of the script set than is currently running is found, a message appears prompting you to download the newer version. You have these choices: Yes: The newer version downloads to the TranCol- lector program. No: The TranCollector program displays a list of available script sets on the collection device screen that have already been downloaded. 50 Chapter 5 Configuration Menu v5.0 TranCollector Users Guide If the TranServer service locates other script set files, it downloads them to the TranCollector program, which displays a list of the avail- able script sets on the collection device. If the TranServer service does not locate other script sets, you receive the following message at the collection device: No script sets avail- able. 2. Scroll up and down the list to choose the script set with which you want to work and press [Enter]. The TranServer service downloads the script set file to the TranCollector pro- gram. When complete, the script set ID and version appears on the collection device screen. Chapter 5 Configuration Menu 51 TranCollector Users Guide v5.0 Changing the System Configuration The Configuration menu provides access to parameters for operating the Tran- Collector program. Use this menu to do the following: Change script sets.* Change user zones.* Change communications time-out limits.* Change display size.* Access to some menu options may be restricted. To perform a restricted option, security settings must be properly set up for your user profile, or you must use the system-provided user profile (DSI). Refer to your system admin- istrator for more information. In the list above, restricted options are indicated by an asterisk. 52 Chapter 5 Configuration Menu v5.0 TranCollector Users Guide Note: If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. Changing Script Sets Note: Access to this TranCollector function may be restricted. To perform a restricted option, security settings must be properly set up for your user pro- file, or you must use the system-provided user profile (DSI). Refer to your system administrator for more information. Use this function to enter the name of another script set. You use the Get Avail Script Sets function on the Update Data menu to start using the named script set. This set becomes the default script set. To change a script set Begin at the Edit Config menu. 1. Press [F1]. An input screen appears. 2. Type a script set ID and press [Enter]. 3. Press [Esc] or [Enter] until the Configuration menu appears. 4. From the Configuration menu, press [F1] to update the new script set changes. The Update Data menu appears. 5. From the Update Data menu, press [F3]. For additional information, see Updating System Data. Chapter 5 Configuration Menu 53 TranCollector Users Guide v5.0 Changing User Zones Note: Access to this TranCollector function may be restricted. To perform a restricted option, security settings must be properly set up for your user pro- file, or you must use the system-provided user profile (DSI). Refer to your system administrator for more information. Use this function to choose another zone within your branch/plant. A zone is a defined area in your workplace and is assigned to each user, if applicable. This function only applies when zones are defined in a users profile. To change the user zone Begin at the Edit Config menu. 1. Press [F2]. An input screen appears. 2. Type a user zone and press [Enter]. The Edit Config menu appears. Changing Communications Time-Out Limits Note: Access to this TranCollector function may be restricted. To perform a restricted option, security settings must be properly set up for your user pro- file, or you must use the system-provided user profile (DSI). Refer to your system administrator for more information. The communications time-out limit is the length of time that a collection device waits for a response from the server. Communications between the col- 54 Chapter 5 Configuration Menu v5.0 TranCollector Users Guide lection device and the server or controller become inactive for the following reasons: The TranServer service is stopped. The hardware components are disconnected. The serial collection device is not in its docking station when the device tries to transmit records serially. The data collection network has heavy RF traffic. The collection device is receiving RF interference. The collection device is too far away from an access point antenna. Chapter 5 Configuration Menu 55 TranCollector Users Guide v5.0 The default communication time-out limit is 30 seconds. If conversation between the collection device and its server does not occur within 30 seconds, the TranCollector session remains at the current menu or field until an IP con- nection is re-established. To change the communications time-out limit Begin at the Edit Config menu. 1. Press [F3]. An input screen appears. 2. Type the number of seconds for the communications time-out limit and press [Enter]. Note: Do not set the limit to less than 10 seconds. The collection device will time out too quickly. The Edit Config menu appears. Changing Display Size Note: Access to this TranCollector function may be restricted. To perform a restricted option, security settings must be properly set up for your user pro- file, or you must use the system-provided user profile (DSI). Refer to your system administrator for more information. Use this function to change the display size by changing the number of screen columns and rows. 56 Chapter 5 Configuration Menu v5.0 TranCollector Users Guide To change the display size Begin at the Edit Config menu. 1. Press [F4]. An input screen appears showing the default number of screen columns for the display. 2. Type the new number of columns and press [Enter]. Another input screen appears showing the default number of screen rows dis- played. 3. Type the new number of rows and press [Enter]. The Edit Config menu appears. Chapter 5 Configuration Menu 57 TranCollector Users Guide v5.0 Working with Miscellaneous Functions The Miscellaneous menu provides access to system information and special functions. Use this menu to do the following: Reset the main output file.* Display system information. Change the time zone of the collection device.* Change the user password.* Access to some menu options may be restricted. To perform a restricted option, security settings must be properly set up for your user profile, or you must use the system-provided user profile (DSI). Refer to your system admin- istrator for more information. In the list above, restricted options are indicated by an asterisk. 58 Chapter 5 Configuration Menu v5.0 TranCollector Users Guide Note: The [F4]-Change Password option is only available when device security is enabled and application security is set to Advanced Security. See Understand- ing TranBuilder Security in TranBuilder Help. Note: If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. Resetting the Main Output File Note: Access to this TranCollector function may be restricted. To perform a restricted option, security settings must be properly set up for your user pro- file, or you must use the system-provided user profile (DSI). Refer to your system administrator for more information. Use this function to clear the main output file and to change the record counter from its current setting to 0 (zero). Note: The [F4]-Change Password option is only available when device security is enabled and application security is set to Advanced Security. See Understand- ing TranBuilder Security in TranBuilder Help. To reset the main output file Important: This process cannot be reversed. All records already stored in the main output file will be deleted. To transmit stored records, use the F2-Transmit function from the Main menu. Chapter 5 Configuration Menu 59 TranCollector Users Guide v5.0 Begin at the Miscellaneous menu. 1. Press [F1]. When the process is complete, the Miscellaneous menu appears. Displaying System Information Use this function to review the following system information: TranCollector program version Communications type Collection device type Current script set version Script version User ID Collection device ID Date/Time 60 Chapter 5 Configuration Menu v5.0 TranCollector Users Guide To display system information Begin at the Miscellaneous menu. 1. Press [F2]. The following information appears: 2. Press any key on the keypad. The following information appears: Version: Indicates the version of the TranCollector program currently running. Comm: Indicates the communications type used between the collection device and the data collection server. Compile: Indicates the collection device type for which the TranCollector program has been compiled. Some examples of the device types might be Janus, Symbol, or PC. Script Set: Indicates the script set currently running. Script Ver: Indicates the version of the script currently running. Chapter 5 Configuration Menu 61 TranCollector Users Guide v5.0 3. Press any key on the keypad. The following information appears: 4. Press any key on the keypad. The following information appears: 5. Press any key on the keypad. The Miscellaneous menu appears. Changing the Time Zone Note: Access to this TranCollector function may be restricted. To perform a restricted option, security settings must be properly set up for your user pro- file, or you must use the system-provided user profile (DSI). Refer to your system administrator for more information. Use this function to assign a specific time zone to the collection device. When a collection device is used in a time zone different than the data collection server, you can use this option to assign the devices time zone. Assigning the collection devices time zone allows for the reporting of the devices date and User: Indicates the user logged on to the collection device. Device: Identifies the collection device by its assigned ID. Date: Indicates the collection devices current date. Time: Identifies the collection devices current time. 62 Chapter 5 Configuration Menu v5.0 TranCollector Users Guide time as well as the data collection servers date and time when a transaction is run. To change the time zone Begin at the Miscellaneous Menu. 1. Press [F5]. The TranCollector program sends a request to the TranServer service. A list of time zones, as registered in the data collection servers operating system, appears on the device screen. The numbers displayed to the left of the time zones identify the difference in hours from 00:00 Greenwich Mean Time (GMT). 2. Find the time zone you want to assign to the device. To review items not in the viewable area, use the [PgUp], [PgDn], [ ], [ ], [End], or [Home] buttons. 3. After highlighting the correct time zone, press [Enter]. The Miscellaneous Menu is redisplayed. The adjusted time appears on the collection device. When necessary, the date on the device is also adjusted according to the difference in time zones. Changing the User Password Note: Access to this TranCollector function may be restricted. To perform a restricted option, security settings must be properly set up for your user pro- file, or you must use the system-provided user profile (DSI). Refer to your system administrator for more information. Chapter 5 Configuration Menu 63 TranCollector Users Guide v5.0 Use this function to assign a different password for your user logon.This option is available only when device security is enabled and application secu- rity is set to Advanced Security. See Understanding TranBuilder Security in TranBuilder Help. To change the user password Begin at the Miscellaneous menu. 1. Press [F4]. The Enter old password screen appears. 2. Type the password currently used to log on to the collection device and press [Enter]. The Enter new password screen appears. 3. Type the new password for the user logon. This password must meet password requirements set up in the Configuration Utility program. See Configuring Application Security Modes in Configura- tion Utility Help. Confer with your system administrator for specific password requirements. As you enter the new password, asterisks appear so the pass- word is not readable. 4. Press [Enter]. The Re-enter new password screen appears. 5. Type the new password to confirm the change and press [Enter]. Your password is changed throughout the entire data collection system. *dsii A Troubleshooting This appendix contains information about system messages that you might see when operating the TranCollector program and instructions for correcting most errors. This appendix contains the following sections: Reading System Messages Understanding System Message Types Error Messages Warning Messages 66 Appendix A Troubleshooting v5.0 TranCollector Users Guide Reading System Messages System messages appear in ASCII format and contain the following informa- tion: Date and time when the error occurred Source file where the error occurred Line number in the source file where the error occurred Error message Type of error and where the error occurred in the script Additional error information Note: C Source refers to the programming language used to develop the TranCol- lector program. This information is required when reporting an error to WSG Product Support. System messages are listed in alphabetical order based on message type. Error Informs you that a critical condition has occurred. The following happens on the collection device: A message appears on the collection device screen. The message is recorded in the ERRLOG file, which resides in the TranCollector programs data drive. The TranCollector program returns you to the Main menu on the collection device. Appendix A Troubleshooting 67 TranCollector Users Guide v5.0 Warning Indicates caution, but does not interrupt any work being performed. The following happens in the TranCollector program: The warning message does not display at the collection device screen, but the error is recorded in the ERRLOG file. 68 Appendix A Troubleshooting v5.0 TranCollector Users Guide Understanding System Message Types Two types of system messages appear when specific conditions occur: load- ing and executing. Loading errors occur when the TranCollector program detects an error while the script is being read to the collection device. Execut- ing errors occur when the TranCollector program detects an error when run- ning source elements during the data collection process. Note: The default display language for the TranCollector program is English. If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. Loading Errors The following is an example of a loading error message that is written to the ERRLOG file and that appears on the collection device screen. In this example, the error occurred while the TranCollector program was load- ing scripts. Identifies the data that caused the error to occur. Identifies the error as an invalid data option. Appendix A Troubleshooting 69 TranCollector Users Guide v5.0 Execution Errors The following is an example of an executing error message that is written to the ERRLOG and that appears on the collection device screen. In this example, the error occurred while the TranCollector program was exe- cuting an action (A7) containing mixed data types (string/numeric, data/ numeric, or date/string). Identifies where the error occurred in the script. Identifies the error as invalid mixing of data types. 70 Appendix A Troubleshooting v5.0 TranCollector Users Guide Error Log The TranCollector program contains an error log, which consists of five files for logging errors: ERRLOG.001 through ERRLOG.005. If an error occurs, it is logged in ERRLOG.001. If the error log contains files with errors, the program deletes the oldest one first and renames the others by incrementing them by one. For example, ERRLOG.001 becomes ERRLOG002, ERR- LOG.002 becomes ERRLOG.003, ERRLOG.003 becomes ERRLOG.004, ERRLOG.005 is deleted, and ERRLOG.004 becomes ERRLOG.005. Note: If an error occurs and you are not able to correct it, make sure you write down the error before calling WSG Product Support. Appendix A Troubleshooting 71 TranCollector Users Guide v5.0 Error Messages Most system messages are detected while loading the script set file into mem- ory (loading process). When the TranCollector program requests the script set file from the TranServer service, the file is copied to the TranCollector pro- gram, either on the collection device or data collection server, depending on the TranServer service you use. During the transfer, the file name is changed from TRANSXXX.DCL, where xxx stands for the script set ID, to TRANS- ACT.DCL. These errors can be corrected by changing the script in the TranBuilder pro- gram, re-publishing the script or script set, and repeating the loading process on the collection device. For information about how to identify errors in a script, see Reading System Messages. For information about correcting problems in the script, see the topic for the appropriate source element in TranBuilder Help. Note: If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. Error: Error opening file Cause: The TranCollector program is unable to open a data file. Solution: Call WSG Product Support. 72 Appendix A Troubleshooting v5.0 TranCollector Users Guide Error: Error reading file Error: Error writing file Error: File already open Error: File not found Cause: The TranCollector program is unable to read a data file. Solution: Call WSG Product Support. Cause: The TranCollector program is unable to write data to a data file. Solution: Call WSG Product Support. Cause: The TranCollector program attempts to open a file that is already open. Solution: Call WSG Product Support. Cause: The TranCollector program is unable to locate a file on the data drive. Solution: Call WSG Product Support. Appendix A Troubleshooting 73 TranCollector Users Guide v5.0 Error: Invalid data Error: Invalid data match Cause: The TranCollector program detects an error while loading the script. This error occurs when a source element has been deleted in the script, but its refer- ence in the script has not. For example, a field is assigned to an action in the script. The field is deleted, but the reference to the field is not. Solution: Review the script in the TranBuilder program and either delete the reference or create a new source element for the reference. Cause: The TranCollector program detects an error while running a script during the collection process. This error occurs when a source element contains any of the following invalid data type combinations: String and numeric Date and numeric Date and string. Solution: Review the ERRLOG file and locate the item in the TranBuilder program. From the Formula Editor, use a function in a formula to convert one of the data types or redefine the item from one type to the other. 74 Appendix A Troubleshooting v5.0 TranCollector Users Guide Error: Invalid extraction Error: Invalid file open Error: Invalid format mask Cause: The TranCollector program is unable to retrieve data from a formula. Solution: Review the formula of the particular source element in the script and make the necessary corrections. Cause: The TranCollector program is unable to open the file using a valid method. Valid methods are Read, Read/Write, Append, and Write. Solution: Call WSG Product Support. Cause: The mask specified for the FORMAT function is an invalid format or contains invalid characters. Solution: Review the script in the TranBuilder program. Ver- ify that the formula is using the correct syntax for formatting data and contains only valid special mask characters. Appendix A Troubleshooting 75 TranCollector Users Guide v5.0 Error: Invalid params Error: No master record Version Compatibility Cause: A command line in the script file does not contain the minimum number of required parameters. Solution: From the TranBuilder program, review the script and change the number of parameters for the com- mand line. Re-publish the script set file and down- load the file to the collection device. Cause: The first record in the script set file is not a valid master record. The following condition can cause this error: The version of the TranCollector program currently running on the collection device is not compatible with the version of the TranBuilder program that created the script. Solution: Confirm the version numbers of both the Tran- Builder and TranCollector programs. Convert the TranBuilder database using the TranBuilder Script Converter program. Publish the script set and re- download the file to the device. 76 Appendix A Troubleshooting v5.0 TranCollector Users Guide Corrupted Data Error: Output truncated Cause: The first record in the script set file is not a valid master record. The following condition can cause this error: The script set file is not reaching the collection device intact because the data is corrupted through direct communications (RS-232 or RS-422). Solution: 1. In the TranServer Telnet service, locate the script set file (TRANSXXX.DCL) and delete it. 2. From the TranBuilder program, re-publish the script set and download the file to the TranCollector program. Cause: The data being formatted for output to the host exceeds the space available. For example, the field length is 10 characters, but the Output definition contains less than 10 characters. Solution: Review the Output definition of the script in the TranBuilder program. See Understanding Outputs in TranBuilder Help. Appendix A Troubleshooting 77 TranCollector Users Guide v5.0 Error: Version error Cause: The version of the TranCollector program is not compatible with the version of the TranBuilder pro- gram that created the script. Solution: Confirm the version numbers of both the Tran- Builder and TranCollector programs. Convert the TranBuilder database using the TranBuilder Script Converter program. Publish the script set and then copy the script set file to the TranCollector program. 78 Appendix A Troubleshooting v5.0 TranCollector Users Guide Warning Messages A warning message indicates caution during data collection, but does not interrupt any work being performed on the collection device. The warning message does not display at the collection device screen as does an error mes- sage, but the error is recorded in the ERRLOG file. Note: The default display language for the TranCollector program is English. If alternate language settings have been specified for your data collection sys- tem, screen text and system messages may appear differently than they are shown or described in this documentation. Consult with your system adminis- trator for specific language information. Warning: Screen limits exceeded Cause: A screen is outside of the defined screen area. For example, a screen has a defined screen area of 20 and a screen element or input field is positioned in a row greater than 20. Solution: Review the ERRLOG file to identify the screen or field on which the error occurred. From the Tran- Builder program, correct the display row and col- umn in the position area. See Understanding Screens in TranBuilder Help. A access Help system v available sets, get 49 B batched transaction 42 C changing communications time-out limit 53 display size 55 inactive time-out limit 56 IP address 55 script permissions 47 script set 52 system configuration 51 system data 46 time zone 61 user password 62 user zones 53 choosing, menu options 32 Client Setup utility distributing online books v collection device screens reading 27 understanding 23 communications time-out limit, changing 53 Configuration menu 44 contacting DSI vi suggestions and comments viii technical support vii conventions icons and typography 3 keyboard functions 5 terms 5 current time 28 D data 73 collecting 36 data match 73 display size, changing 55 displaying system information 59 documentation iv Help system v online Help v online books v printed iv DSI product support vi E error File already open 72 File not found 72 Invalid data 73 Invalid data match 73 Invalid extraction 74 Invalid file open 74 Index 80 Index Invalid format mask 74 Invalid params 75 No master record 75 Opening file 71 Output truncated 76 Reading file 72 Version error 77 Writing file 72 error messages execution errors 69 loading errors 68 extraction 74 F field-level Help v file already open 72 invalid open 74 not found 72 format mask 74 function keys 9 G getting available sets 49 script file 48 script permissions 47 time and date 48 H Help system accessing v field-level v Online Help v window-level v how to change communications time-out limit 55 IP address 56 script set 52 time zone 61 user password 63 user zone 53 choose a menu option 32 contact DSI vi display system information 60 get available sets 49 log off 22 log on 20 reset the main output file 58 review script IDs 41 valid function keys 38 run a script 37 synchronize time and date 48 transmit records 42 update script permissions 47 script set file 48 I icons and typography Caution 4 caution 4 Courier 4 Courier Font, Bold Type 4 fonts 4 Important 3 Italic type 4 Note 3 step 3 Index 81 Important 3 Informational screen 24 Input screen 26 Intermec devices 28 Invalid data 73 data match 73 extraction 74 file open 74 format mask 74 params 75 K keyboard functions 5 Arrow keys 5 Fn 5 Key Name 5 keypad, keys 10 L logging off 21 logging on 19 M Main menu, understanding 34 main output file, resetting 58 menus Configuration 44 Edit Config 45 Main 8, 25 menu options 30 Miscellaneous 45 selections 30 Update Data 45 Message Types Error 66 Warning 67 message types error 71 warning 78 messages 12 error Error opening file 71 Error reading file 72 Error writing file 72 File already open 72 File not found 72 Invalid data 73 Invalid data match 73 Invalid extraction 74 Invalid file open 74 Invalid format mask 74 Invalid params 75 No master record 75 Output truncated 76 Version error 77 system 12 user-defined 12 warnings 78 Screen limits exceeded 78 miscellaneous functions 57 main output file 58 system information 59 time zone 61 user password 62 module setup guides v 82 Index N No master record 75 note 3 O online books distributing to computers v online Help v opening file 71 Output truncated 76 P params 75 Percon Collection Device 29 permissions, script 47 product support vi R reading file 72 recovery 42 running scripts 36 S Screen limits exceeded 78 screens Informational 24 Input 26 Menu 25 Title 20 script 68, 73, 75 permissions, updating 47 reviewing IDs 40 script set changing 52 updating file 48 scripts, running 36 setup guides documentation v status line 28 stored records 42 suggestions and comments viii Symbol 29 synchronizing time and date 48 system displaying information 59 messages 71 system configuration changing 51 communications time-out limit 53 IP addresses 55 script sets 52 user zone 53 system data available sets 49 changing 46 script permissions 47 script set file 48 synchronizing date and time 48 T technical support, contacting vii Telnet terminal emulation 9 Telxon Collection Device 29 Index 83 terms 5 Enter 5 Select 5 TranCollector Program 6 Type 5 time and date, synchronizing 48 title screen 20 TranCollector menus 8 program 6 understanding 16 transaction collecting data 36 script 68, 73, 75 TranServer Telnet service 9 transmitting records 42 Troubleshooting 65 U understanding collection device screens 23 Configuration Menu 44 Main Menu 34 TranCollector 16 TranCollector features 8 updating script permissions 47 script set file 48 system data 46 user-defined, messages 12 V Version error 77 W warning, Screen limits exceeded 78 welcome iii about the documentation iv about this guide viii suggestions and comments viii for your information iv how to contact DSI vi about this guide viii contacting technical support vii window-level Help v writing file 72 Z zone, changing 53