Acroprint AcroComm User Manual

AcroComm
Programming
Manual
AcroComm Programming Manual
March 5, 2001
- Section 2.2 Updated
- Section 2.3 Updated
- Appendix A updated with all new instructions…
- Appendix B updated with the new formulas.
- Section 1.5 updated according to the last ACROCOMM Version.
- Sections 4 and 5 updated according to the new ADCT firmware version.
2
AcroComm Programming Manual

License Agreement

Important
By using this software in executable form EXE or DLL’s and the Acroprint Data Collection Terminal (ADCT) utilizing ACROCOMM Firmware you accept the following terms of this License Agreement. If you do not agree with these terms, you should not use the software and promptly return it within 30 days.
Ownership
Acroprint retains the ownership of this copy of the enclosed software package. It is licensed to you for use under the following conditions:
Grant of License
You may only concurrently use the enclosed software on the number of computers for which this license grants (for example, single­user version licenses one concurrent usage; five-user network version licenses five concurrent usages).
Restrictions
You may not copy the documentation or software except as described in the installation section of this manual. You may not distribute, rent, sub-license or lease the software or documentation, including translating, decompiling, disassembling, or creating derivative works. You may not reverse-engineer any part of this software, or produce any derivative work. You may not make telecommunication transmittal of this software.
Termination
This license and your right to use this software automatically terminates if you fail to comply with any provision of this license agreement.
Rights
Acroprint retains all rights not expressly granted. Nothing in this license agreement constitutes a waiver of Acroprint's rights under the U.S. copyright laws or any other Federal or State law.
Limited Warranty
If you discover physical defects in the media, Acroprint will replace the media or documentation at no charge to you, provided you return the item to be replaced with proof of payment to Acroprint during the 90-day period after having taken delivery of the software.
Acroprint excludes any and all implied warranties, including warranties of merchantability and fitness for a particular purpose and limits your remedy to return the software and documentation to Acroprint for replacement. Although Acroprint has tested the software and reviewed the documentation, ACROPRINT MAKES NO WARRANTY OF REPRESENTATION, EITHER EXPRESSED OR IMPLIED, WITH RESPECT TO THIS SOFTWARE OR DOCUMENTATION, ITS QUALITY, PERFORMANCE, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. AS A RESULT, THIS SOFTWARE AND DOCUMENTATION ARE LICENSED "AS IS" AND YOU, THE LICENSEE, ARE ASSUMING THE ENTIRE RISK AS TO ITS QUALITY AND PERFORMANCE. IN NO EVENT WILL ACROPRINT BE LIABLE FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE OR DOCUMENTATION, even if advised of the possibility of such damages. In particular, Acroprint shall have no liability for any data stored or processed with this software, including the costs of recovering such data.
THE WARRANTY AND REMEDIES SET FORTH ABOVE ARE EXCLUSIVE AND IN LIEU OF ALL OTHERS, ORAL OR WRITTEN, EXPRESSED OR IMPLIED. No Acroprint dealer, agent, or employee is authorized to make any modifications or additions to this warranty.
Information in this document is subject to change without notice and does not represent a commitment on the part of Acroprint. The software described in this document is furnished under this license agreement. The software may be used or copied only in accordance with the terms of the agreement. It is against the law to copy the software on any medium except as specifically allowed in the license agreement. No part of this manual may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, for any purpose without the written permission of Acroprint.
Some states do not allow the exclusion of implied warranties or liability for incidental or consequential damages, so the above limitation or exclusion may not apply to you. This warranty gives you specific legal rights, and you may also have other rights which vary from state to state.
I have read the License Agreement and by using the software agree to comply will ALL aspects of the License Agreement.
3
AcroComm Programming Manual
4
AcroComm Programming Manual
L
ICENSE AGREEMENT...................................................................................................................................3
1. ACROCOMM.EXE WINDOWS -.....................................................................................................9
1.1. INSTALLING ACROCOMM .................................................................................................................9
1.2. ACROCOMM MAIN MENU ..............................................................................................................10
1.3. PARAMETERS MENU.......................................................................................................................10
1.4. TRANSACTION FILE ........................................................................................................................10
1.5. SOURCE FOR INSTRUCTIONS ...........................................................................................................11
1.6. COMMUNICATIONS SETUP ..............................................................................................................11
1.7. ACTIONS MENU..............................................................................................................................12
1.8. SELECT...........................................................................................................................................12
1.9. POLL...............................................................................................................................................13
1.10. PROGRAM ...................................................................................................................................13
1.11. INFORMATION.............................................................................................................................14
1.12. UPDATE TIME .............................................................................................................................14
1.13. RESET.........................................................................................................................................15
1.14. MODEM DIAL .............................................................................................................................15
1.15. MODEM HANG UP .......................................................................................................................16
1.16. CLEAR WINDOW .........................................................................................................................17
1.17. HELP MENU................................................................................................................................17
1.18. EDIT PROGRAM.CLK..............................................................................................................18
1.19. HELP - ABOUT............................................................................................................................19
2. USING ACROCOMM ........................................................................................................................20
2.1. CONFIGURATION.............................................................................................................................20
2.2. CONFIGFILE.INI ...............................................................................................................................21
2.3. ACROCOMM: COMMAND LINE...................................................................................................22
2.3.1. Considerations.......................................................................................................................23
2.3.2. Error Codes ...........................................................................................................................24
3. USING THE EXCEL/VISUAL BASIC MACRO POLLING..........................................................25
4. ACROPRINT TERMINAL CONFIGURATION.............................................................................26
4.1. CONFIGURATION THROUGH BADGE ................................................................................................26
4.1.1. Configuring Procedure for entering the Date and Time .......................................................26
4.1.2. Configuring Procedure for Selecting Ports...........................................................................26
4.1.3. Configuring Procedure for Selecting the READERS: ...........................................................28
4.1.4. Enabling Serial/Parallel Printing..........................................................................................28
5. ABOUT THE CLOCKS......................................................................................................................29
5.1. BADGE VALIDATION CRITERIA.......................................................................................................29
5.1.1. Messages................................................................................................................................29
5.1.2. Diagnostic Mode....................................................................................................................30
5.1.3. Functions ...............................................................................................................................30
5.1.4. Lockout ..................................................................................................................................31
5.1.5. Supervisor Procedures...........................................................................................................31
6. APPENDIX A: CONFIGURATION INSTRUCTIONS FORMAT ...............................................33
6.1. COMMAND LIST..............................................................................................................................33
6.2. COMMAND LIST FORMATS..............................................................................................................34
6.2.1. AC..........................................................................................................................................34
6.2.2. AD..........................................................................................................................................34
6.2.3. AO..........................................................................................................................................34
6.2.4. AT ..........................................................................................................................................34
5
AcroComm Programming Manual
6.2.5. AW .........................................................................................................................................34
6.2.6. AX ..........................................................................................................................................35
6.2.7. BC..........................................................................................................................................35
6.2.8. BL ..........................................................................................................................................35
6.2.9. BM .........................................................................................................................................35
6.2.10. BN..........................................................................................................................................35
6.2.11. BS...........................................................................................................................................36
6.2.12. CR..........................................................................................................................................36
6.2.13. DL..........................................................................................................................................36
6.2.14. DM.........................................................................................................................................36
6.2.15. DU .........................................................................................................................................37
6.2.16. EF..........................................................................................................................................37
6.2.17. EM .........................................................................................................................................37
6.2.18. FC..........................................................................................................................................37
6.2.19. FL ..........................................................................................................................................38
6.2.20. FP..........................................................................................................................................38
6.2.21. FS...........................................................................................................................................38
6.2.22. FT ..........................................................................................................................................39
6.2.23. FZ ..........................................................................................................................................39
6.2.24. Hx ..........................................................................................................................................39
6.2.25. IB ...........................................................................................................................................40
6.2.26. II ............................................................................................................................................40
6.2.27. IP ...........................................................................................................................................40
6.2.28. IS............................................................................................................................................40
6.2.29. Lx...........................................................................................................................................40
6.2.30. LB ..........................................................................................................................................40
6.2.31. LD..........................................................................................................................................41
6.2.32. LE ..........................................................................................................................................41
6.2.33. LF ..........................................................................................................................................41
6.2.34. LL...........................................................................................................................................41
6.2.35. MA .........................................................................................................................................42
6.2.36. MD.........................................................................................................................................42
6.2.37. MP .........................................................................................................................................42
6.2.38. MT..........................................................................................................................................42
6.2.39. OT..........................................................................................................................................42
6.2.40. PE..........................................................................................................................................43
6.2.41. PE..........................................................................................................................................43
6.2.42. PF..........................................................................................................................................43
6.2.43. PL ..........................................................................................................................................44
6.2.44. PM .........................................................................................................................................44
6.2.45. PR..........................................................................................................................................44
6.2.46. PX..........................................................................................................................................44
6.2.47. RA..........................................................................................................................................45
6.2.48. RL ..........................................................................................................................................45
6.2.49. RST ........................................................................................................................................45
6.2.50. SG..........................................................................................................................................45
6.2.51. SN ..........................................................................................................................................46
6.2.52. SOT........................................................................................................................................46
6.2.53. SP...........................................................................................................................................46
6.2.54. T#...........................................................................................................................................46
6.2.55. T1...........................................................................................................................................46
6.2.56. T3...........................................................................................................................................46
6.2.57. TA ..........................................................................................................................................46
6.2.58. TD..........................................................................................................................................47
6.2.59. TL...........................................................................................................................................47
6.2.60. TP ..........................................................................................................................................47
6
AcroComm Programming Manual
6.2.61. UF..........................................................................................................................................47
6.2.62. XF..........................................................................................................................................48
6.2.63. XN..........................................................................................................................................48
6.2.64. XS...........................................................................................................................................48
6.2.65. ZZ...........................................................................................................................................48
7. APPENDIX B: TABLE SIZE CALCULATIONS ...........................................................................49
7.1. FORMULAS TO CALCULATE TABLE SIZE .........................................................................................49
7.1.1. Fingerprint Table ..................................................................................................................49
7.1.2. Pin Table ...............................................................................................................................49
7.1.3. Access Table ..........................................................................................................................49
7.1.4. Profile Assignment Table.......................................................................................................49
7.1.5. Profile Definition Table.........................................................................................................49
7.1.6. Employee Messages Table.....................................................................................................49
7.1.7. Employee Messages Table.....................................................................................................49
7.2. REMAINING SPACE FOR TRANSACTION STORAGE ...........................................................................50
8. APPENDIX C: USING THE KEYBOARD TO EDIT DATA........................................................51
9. APPENDIX D: TRANSACTIONS OUTPUT FORMAT................................................................53
9.1. HEADER RECORD FORMAT.............................................................................................................53
9.2. CHANGE DATE RECORD FORMAT...................................................................................................53
9.3. NORMAL TRANSACTION RECORD FORMAT.....................................................................................53
9.4. SUPERVISOR TRANSACTION RECORD .............................................................................................53
9.5. TERMINAL MEMORY INFORMATION ...............................................................................................54
10. APPENDIX E: SAMPLE EXCEL/VISUAL BASIC TEMPLATES..........................................55
10.1. GETTING STARTED TERMINAL CONNECTIONS ............................................................................55
10.2. INSTALLING ACROCOMM & EXCEL MACRO SAMPLE .................................................................55
10.3. STARTING THE MACRO ..............................................................................................................55
10.4. MAIN MENU ...............................................................................................................................56
10.5. COMMANDS................................................................................................................................57
10.6. TESTING DATA TRANSFER..........................................................................................................57
10.7. VISUAL BASIC SOURCE CODE.....................................................................................................58
11. APPENDIX F: ASCII CODE LIST ..............................................................................................59
12. APPENDIX G: GLOSSARY .........................................................................................................60
13. INDEX ..............................................................................................................................................62
7
AcroComm Programming Manual
8
1. AcroComm.exe Windows -
The AcroComm program provides the Software Developer / System Integrator the necessary tools to integrate the data collection terminals with their application. AcroComm Windows Software provides the developer the GUI front end to easily customize, configure and program the Acroprint Data Collection Terminal. The software allows the developer to configure multiple input devices, such as Biometrics / Fingerprint Readers, Proximity readers, internal and external Bar Code readers, as well as Magnetic Stripe readers.
ACROCOMM is the program that allows the user to communicate with Acroprint terminals; without this program, the terminal cannot communicate with any other entity.
ACROCOMM performs the following tasks:
· Poll TRANSACTIONS stored in the clock,
· Poll information related to the transactions from the CLOCK,
· Initialize the CLOCK’s memory,
· Send configuration values to the CLOCK that it will use to function,
· Update the CLOCK’s Time and Date
This program may be used in two ways:
AcroComm Programming Manual
· As a Windows Menu, where the program displays a menu of the tasks it can perform and the user selects the option desired, and
· As a Command Line, where it receives parameters that represent the tasks that the user wants the program to perform.

1.1. Installing AcroComm

A self-extracting zip file SETUP.EXE that creates an ACROCOMM subdirectory containing the following files:
· ACRO.ICO Icon
· ACROCOMM.EXE Windows NT/95 Communications program
· ACROCOMM.INI AcroComm setup file
· ACROCOMM.TXT Installation text
· DATALOG.DAT Temporary data storage
· MCW16.DLL Dynamic Link Library
· POLL_CLK.5.3.4.XLS Excel Sample Macro
· PROGRAM.CLK Clock command list
· README.TXT Updated information
· SUPPORT.TXT Support Information
To use Acrocomm as a Windows Menu, parameters should not be passed to the program. From the RUN command, for example, it will be executed as follows: ACROCOMM.EXE
To use Acrocomm as a Command Line, refer to Command Line operation in this manual.
9
AcroComm Programming Manual

1.2. AcroComm Main Menu

The main menu provides an icon tool bar for polling/programming terminals, setting time, resolving transactions, setting terminal specifications, and clearing the screen.

1.3. Parameters Menu

The parameters pull down provides control of transaction storage, source of instructions keyboard or PROGRAM.CLK file and communications setup.

1.4. Transaction File

When transactions are polled, the program can send them to one of two places: to the screen or to a specific file. The current destination of transactions is shown on the menu. When this option is selected, the program will ask for the name of the Transaction Destination File. If a name is not given, it takes the default destination.
10
The Transactions will be replaced in the default transaction file, DATA.DAT, during each polling when the Replace Flag is checked. The DATA.DAT will be appended to if the Replace flag is NOT checked. When a file is not specified, they will be sent to the screen.
AcroComm Programming Manual
The transaction information can be displayed in the AcroComm window or saved as a file. For example: DATA.DAT.

1.5. Source for Instructions

The source of instruction can be entered one command at a time via the keyboard or from a text file. For example: PROGRAM.CLK.

1.6. Communications Setup

The communications setup allows for the standard comm port 1 through 4 communications and shared comm port through a network. Adjustable baud rate speed can be set from 1200 to 19200 on RS232 and RS485 communications. Modem communications can be set at 1200 and 2400 baud only. Terminal ID’s can be 1-9, A-Z, a-z, …
Wait for Answer, xx seconds is used for modem connections and allows the pc modem to connect to the Acroprint terminal modem.
Select all clock ID’s separated by a comma. Example: 1, 2, 4, A, Z
11
AcroComm Programming Manual
1.7. Actions Menu
The Actions Menu allows you to poll, program, obtain information, update time and date, reset transactions, dial and hang up modem terminals.
12
1.8. Select
Select terminal from list provided in the communications setup.
AcroComm Programming Manual
1.9. Poll
When selecting poll, the program will send the TRANSMIT instruction to the Current Selected Clock, the clock will transmit the transactions. The computer will read them and send them to the specified destination in Transactions Destination.
1.10. Program
When selecting program, the program will read the instructions or configuration values from the specified Instructions Source File, it will verify them and send them to the currently selected Clock. If an Instructions Source File is not specified, the program will request that it be keyed in. Either way, the instruction format must be followed. If there is an instruction the program does not recognize, it will ignore it.
13
AcroComm Programming Manual
1.11. Information
Terminal Information provides memory status parameters, such as transaction space available, and memory used by downloading tables, including access, lockout, validation, etc.
1.12. Update Time
This parameter updates the terminal’s date and time with the PC’s date and time.
14
AcroComm Programming Manual
1.13. Reset
Before this instruction is executed, the user must make sure that the transactions were successfully polled. This function tells the terminal to erase ALL transactions stored.
The program will ask for confirmation before sending the instruction to initialize.
1.14. Modem Dial
If you had selected “Communications via Modem” in Communications Setup, the following two fields will be available, “Modem Dial” and “Modem Hang Up.” Select Dial Mode and Phone Number to dial. Example: 9,, 5554222. The commas add a delay between obtaining an outside line and dialing the number. When communication with the modem terminal is achieved, a new menu will appear on the screen; it will have all the options described above.
15
AcroComm Programming Manual

1.15. Modem Hang up

This option allows the user to terminate the telephone connection and exit the program if desired. After ending communication, the main menu described at the beginning of this section will be displayed.
16
AcroComm Programming Manual
1.16. Clear Window
The Clear Window command erases all text in the AcroComm display window.
1.17. Help Menu
The Help Menu allows you to edit the program clock file and display version information.
17
AcroComm Programming Manual
1.18. Edit PROGRAM.CLK
The PROGRAM.CLK file is a list of programming commands that are used to configure the Acroprint terminals. Refer to Appendix A for command details.
18

1.19. Help - About

Version information.
AcroComm Programming Manual
19
AcroComm Programming Manual
2. Using ACROCOMM
To better understand the use of the programs in this SYSTEM, we will select certain terms to identify each logical entity in it.
The SYSTEM has two programs, one loaded into the Computer and the other into the Terminal (clock), and they will be identified as follows:
· The PROGRAM is the code loaded into the COMPUTER,
· The CLOCK is the code loaded into the CLOCK.
Other entities related to these programs are:
INSTRUCTIONS are the orders the PROGRAM sends to the CLOCK to perform a specific task.
· PARAMETERS are the instructions the user gives the PROGRAM to perform a specific task.
· CONFIGURATION VALUES are the values sent to the CLOCK to regulate its performance.
· TRANSACTIONS are the chained swipes that the CLOCK stores and later sends to the PROGRAM when it asks for them.
2.1. Configuration
Aside from the form of usage chosen, ACROCOMM needs to be configured for its use, due to the fact that it has to communicate with the clock connected in any of the following ways:
· One clock connected directly to the computer on a serial port,
· One clock connect to the computer through a modem,
· A network of clocks connected directly to the serial port of the computer,
· A network of clocks connected to the computer through a modem.
· One clock connected to a computer on a serial port through a network.
· A network of clocks connected directly to the serial port of the computer
through a network.
· One clock connected to a computer using a TCP/IP address.
20
Loading...
+ 44 hidden pages