AMANO MTX-15 Installation and Operation Guide

MTX-15
Software Development Kit (SDK)
Installation and Operation Guide
Version 1.1
for purchasing another fine product from
Amano Cincinnati, Inc.
Proprietary Notice
This document contains proprietary information and such information may not be reproduced in whole or in part without written permission from:
Amano Cincinnati, Inc.
140 Harrison Avenue
Roseland, New Jersey, 07068
Amano Cincinnati, Inc. reserves the right to make equipment changes and improvements that may not be reflected in this document. Portions of this document may have been updated to include the latest hardware or firmware version, if applicable.
We recommend that this document be read in its entirety before any attempt is made to operate the equipment.
For more information about Amano’s complete line of products, visit our web site at:
www.amano.com
Table of Contents
Chapter 1: Introduction & Installation....................................................................................1-1
How This Manual is Organized...............................................................................................1-1
Introduction – What is MTX-15 SDK?.....................................................................................1-1
MTX-15 SDK Installation Guide .............................................................................................1-1
Chapter 2: MTX-15 SDK General Operation ..........................................................................2-1
General Information................................................................................................................2-1
MTX-15 SDK Main View.....................................................................................................2-1
File Dropdown Menu...........................................................................................................2-1
Common Buttons................................................................................................................2-2
Chapter 3: Locations ...............................................................................................................3-1
Defining a New Location ........................................................................................................3-1
Deleting And Editing Locations ..............................................................................................3-4
How to Delete A Location ...................................................................................................3-4
How To Edit a Location.......................................................................................................3-4
How To Define Terminal Information .................................................................................. 3-5
Chapter 4: Employees .............................................................................................................4-1
Creating Employees ...............................................................................................................4-1
Deleting And Editing Employees ............................................................................................4-2
How to Delete an Employee ...............................................................................................4-2
How To Edit an Employee ..................................................................................................4-2
Chapter 5: Labor Levels ..........................................................................................................5-1
Defining a New Labor Id.........................................................................................................5-1
Deleting And Editing Labor Ids...............................................................................................5-2
How to Delete a Labor Id From a Labor Level....................................................................5-2
How To Edit a Labor Level Id .............................................................................................5-2
Chapter 6: Bell Schedules.......................................................................................................6-1
Defining a New Bell Schedule ................................................................................................6-1
Deleting And Editing Bell Schedules ......................................................................................6-1
How to Delete a Bell Schedule ...........................................................................................6-1
How To Edit a Bell Schedule ..............................................................................................6-2
How To Create or Edit an Event for a Bell Schedule..........................................................6-2
Chapter 7: Validation ...............................................................................................................7-1
Defining a New Validation ......................................................................................................7-1
Deleting And Editing Validations ............................................................................................7-3
How to Delete a Validation .................................................................................................7-3
How To Edit a Validation ....................................................................................................7-3
Chapter 8: MTX-15 IP Address................................................................................................8-1
How To Find The MTX-15 IP Address....................................................................................8-1
Chapter 9: MTX-15 Import CSV Specification .......................................................................9-1
Employee Import Record Format ...........................................................................................9-1
Labor Level Import Record Format.........................................................................................9-1
MTX-15 SDK v1.1 Installation and Operation Guide i
Chapter 10: Running from the Command Line ...................................................................10-1
Command Line Options Summary .......................................................................................10-1
Using the Command Line Options .......................................................................................10-1
Setting the Time................................................................................................................10-1
Polling terminal .................................................................................................................10-1
Downloading To The Terminal..........................................................................................10-2
Using a Command File.........................................................................................................10-2
ii MTX-15 SDK v1.1 Installation and Operation Guide
Chapter 1: Introduction & Installation
This manual [AMX-40430X] covers only the installation and operation of the Amano Software Development Kit (SDK) for the Amano MTX-15 Data Collection Terminal. For more detailed information about the actual installation and operation of the Amano MTX-15 Terminal please see Amano MTX-15 Installation Guide (AMX-30220X).
How This Manual is Organized
The installation and operation procedures in this manual are provided for user assistance.
Chapter 1 – Introduction & Installation: provides a brief overview of features and benefits of this application. Also described is the general installation guideline.
Chapter 2 – MTX-15 SDK General Operation: provides step-by-step procedures for general operation.
Chapter 3 – Locations: provides step-by-step procedures for general creation of new locations and/or modification.
Chapter 4 – Employees: provides step-by-step procedures for general creation of new employees and/or modification.
Chapter 5- Labor Levels: provides step-by-step procedures for general creation of labor levels and/or modification.
Chapter 6 – Bell Schedule: provides step-by-step procedures for general creation of new bell schedules and/or modification.
Chapter 7- Validation: provides step-by-step procedures for general creation of new validation templates and/or modification.
Chapter 8- MTX-15 IP Address: provides step-by-step procedure for using the diagnostics in the MTX-15 to dynamically obtain the network IP Address.
Chapter 9- MTX-15 CSV Import Specification: provides file CSV format for MTX-15 interface.
Chapter 10- Running From The Command Line: provides procedures (commands) for
running MTX-15 SDK from the command line.
Introduction – What is MTX-15 SDK?
The Amano MTX-15 Software Development Kit (SDK) provides the end-user compatibility with other vendors’ time and attendance systems and the Amano MTX-15. The Amano MTX-15 is a full-feature, scalable, menu-driven terminal that can be utilized for many applications, from basic time & attendance to job costing.
MTX-15 SDK Installation Guide
1. Turn on the Host PC and let Windows start up.
2. Be certain the operating system is running by itself with no additional applications running.
3. Insert the MTX-15 SDK disk in the CD-ROM drive.
4. The MTX-15 SDK install script will automatically start, and the following screen will appear.
Clicking on the Cancel installation.
MTX-15 SDK v1.1 Installation and Operation Guide 1-1
button anytime during the installation will abort the
Figure – InstallAnywhere Screen
5. The following Introduction screen will automatically appear.
Figure – MTX-15 SDK Introduction Screen
6. Click Next to continue the installation, and the Software License Agreement will appear to advise customers of their legal responsibilities. To continue the installation you must click the radio button to accept the terms of this agreement.
Figure – License Agreement Screen
7. Click Next to continue, and the following Choose Install Set screen will appear to choose between Server, or Client. It is recommended to select Server
for standard installations.
1-2 MTX-15 SDK v1.1 Installation and Operation Guide
Figure – Choose Install Set Screen
8. Enter the MTX-15 SDK serial number. Then click Next to continue with the setup, and the Destination Location screen will appear as shown in the following figure.
Figure – Enter Serial Number
9. When asked to Choose Destination Location, use the suggested Destination Folder (MTX­15 SDK). If the drive is not applicable to your system, click the Choose button to select a drive. Then click Next to continue, and the Select Program Folder screen will appear:
Figure – Choose Install Folder
10. When performing a server installation, the IP Address for the PC that the MTX-15 SDK is installed on will automatically appear. Click on Next to continue.
MTX-15 SDK v1.1 Installation and Operation Guide 1-3
Figure – IP Address for Server
11. Before installation, the MTX-15 SDK install script will check and display installation parameters, and the following screen will appear. Click Install to continue with the installation.
Figure – Pre-Installation Summary
12. Next an installation screen will appear showing a progress status bar for the MTX-15 SDK installation as shown in the following figure.
Figure – Installing MTX-15 SDK Screen
13. During installation, if desired, click Cancel to terminate the installation process for MTX-15 SDK, and the following Dialog will appear:
1-4 MTX-15 SDK v1.1 Installation and Operation Guide
Figure – Desktop Icon Dialog
14. While the InstallShield Wizard is installing MTX-15 SDK the following screens will appear:
Figure – Executing Installer, Etc.
15. After the MTX-15 SDK program has been successfully installed the following screen will appear. Click Done to finish the installation process.
Figure – Installation Complete
MTX-15 SDK v1.1 Installation and Operation Guide 1-5
16. The MTX-15 SDK program will go through a brief configuration process, and the following
screen will appear. Once complete, this screen will disappear. Click on the start the application (see Chapter 2).
Figure – Configuring MTX-15 SDK
icon to
1-6 MTX-15 SDK v1.1 Installation and Operation Guide
Chapter 2: MTX-15 SDK General Operation
General Information
After MTX-15 SDK has been initially installed on a PC, click on the
icon to start the
application and main screen will appear (see the following figure).
To setup the application:
Define locations (MTX-15 terminals).
Import or enter employees, and labor levels.
Setup bell schedules and validation.
MTX-15 SDK Main View
The following screenshot displays the default main view of MTX-15 SDK and identifies its sections. This view can be changed based upon the selection made from the common buttons, and/or the tree view selections on the left-hand side of the screen.
Menu Selections
Common Buttons
Tree
Status Display
Figure – MTX-15 SDK Main Screen
File Dropdown Menu
The File menu allows the user to: "Im
port Employees", "Import Labor Levels" (see Chapter 9
for additional information), get program information with "About", "Activate" the software, "Register" a new customer, and "Launch Manual" (open the PDF version of the included Installation and Operation Guide, while the "Exit" selection allows the user to quit the application.
The "About" selection will provide the user with the version of MTX-15 SDK that is running. This information is required when placing a support call. The Info tab on the About screen will display more detailed program information.
MTX-15 SDK v1.1 Installation and Operation Guide 2-1
Figure – File Menu Figure – About
Common Buttons
Certain common functions are performed using buttons. These buttons are shown below. In the text, the names shown are used to describe these buttons.
Button Description Button Description
Edit
Cancel
Clear status
Validation for clock &
bell schedules
Find terminal
New item
Poll terminals for
Delete item
received punch/transfer
records
Push time to terminal
from PC
Browse
To Communicate with
Terminals
Save
Create events
2-2 MTX-15 SDK v1.1 Installation and Operation Guide
Chapter 3: Locations
Defining a New Location
1. Click on the Locations icon in the tree view (see the following figure), and any previously defined locations will appear.
Figure – Locations Main Screen
2. To create a new location, click on the New shown in the following figure.
Figure – New Location Screen
button, and the screen will appear as
3. Enter the location Name [16 character limit].
4. Select a Time Zone Offset in hours from the dropdown list. Select 0 to use the time from your time zone.
5. Select the Type of location from the dropdown list. The choices are: Ethernet, Modem, and Serial. If selecting Ethernet the following Ethernet fields will appear:
MTX-15 SDK v1.1 Installation and Operation Guide 3-1
Loading...
+ 29 hidden pages