Acroprint AcroComm Programming Manual Download

Page: 1 / 64

AcroComm

Programming

Manual

06-0285-001 Rev. B

Summary of Contents for AcroComm

Page 1: ...AcroComm Programming Manual 06 0285 001 Rev B ...

Page 2: ...n 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 ...

Page 3: ...rpose 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 ...

Page 4: ...AcroComm Programming Manual 4 ...

Page 5: ... 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 Paral...

Page 6: ... 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 ...

Page 7: ...ORAGE 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 EXCE...

Page 8: ...AcroComm Programming Manual 8 ...

Page 9: ...emory 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 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 Ac...

Page 10: ...n 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 The Transactions will be replaced in the default transaction file...

Page 11: ...ons 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 t...

Page 12: ...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 1 8 Select Select terminal from list provided in the communications setup 12 ...

Page 13: ...nsactions 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 instructio...

Page 14: ...formation 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 ...

Page 15: ...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 ap...

Page 16: ...ual 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 ...

Page 17: ...ogramming 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 ...

Page 18: ...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 ...

Page 19: ...AcroComm Programming Manual 1 19 Help About Version information 19 ...

Page 20: ...S 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...

Page 21: ...k the ACROCOMM will initially connect with Default address of the clock is 192 168 0 254 TCPPORT number Indicates the TCP IP port of the clock the ACCROCOMM will initially connect with This must be a number greater than 10000 and MUST coincide with the number set in the CLOCK Default for this value in the clock is 10001 WAIT number It indicates how long in seconds it should wait for a response fro...

Page 22: ...ogram will look for the file ACROCOMM INI and if it does not find this file it will take the default values 2 3 ACROCOMM Command Line ACROCOMM can also work as a command line The tasks that it is to perform are given at the command line from DOS windows as parameters The format is as follows ACROCOMM configfile ini parameters Where configfile may be a set of the following commands configfile The c...

Page 23: ...rminal Memory Information For Example 1 To update a clock s Time and Date using the system defaults See Example 1 use the following command lines ACROCOMM U Since there was no configuration file specified the system defaults will be used 2 To update and program a network of 5 clocks connected through a modem configuration file See Example 2 use the following command line Acrocomm configfile ini U ...

Page 24: ...ey exist 2 3 2 Error Codes ACROCOMM feeds back the following error codes to the operating system 0 Successful execution 1 Instruction not executed 2 Transmission cancelled 3 Communications error 4 Transmission aborted 5 Did not receive response 6 Connection unsuccessful 8 Invalid format on commands 9 Invalid instruction 10 Not configured for modem 11 Cannot open file 13 Execution aborted 24 ...

Page 25: ...ctions into an Excel spreadsheet The application is configurable allowing the user to turn on off columns not required pair punches subtotals totals etc This software application can be used out of the box and is intended to be an example of the capabilities of AcroComm the Acroprint terminal and Visual Basic within Excel 97 The source code for this example may be copied used altered modified and ...

Page 26: ...Select Option 1 Date 2 Ports 3 Readers 4 Test 5 Initialization 6 FIU Reset To select the key with the number chosen must be pressed Enter is not required A beep will sound to acknowledge the reception of the entry The program will wait up to 10 seconds to receive an entry If this does not happen it will return to normal execution 4 1 1 Configuring Procedure for entering the Date and Time Swipe the...

Page 27: ...e NETMASK PART BITS NUMBER press ENTER Your network administrator will obtain this information The Default Subnet Mask IP number contains 4 segments of numbers separated by To determine the NETMASK VALUE obtain your Subnet Mask IP number from the Network administrator XXX 125 125 125 for you server convert EACH 125 your numbers will be different to binary and count the number of zero s in the bina...

Page 28: ...the IN then the OUT and then the ENTER key within 1 second The terminal will go into a testing mode Press the Clear key followed by Press the IN then the OUT and then the ENTER key within 1 second or before the time is displayed 4 1 4 Enabling Serial Parallel Printing Select option no 2 and the terminal requires you to enter the communications port the speed of transmission needed for the port the...

Page 29: ...numeric number up to 10 characters in length may be displayed Entries must be made through a valid source determined with parameter IS These can be a magnetic stripe readers keyboard barcode readers or proximity readers Any badge different from the Configuration badge will be processed as a normal badge The memory capability is variable according to the partitions made to the memory due to the fac...

Page 30: ...ction allows the recollection of one piece of data The functions are Swipe Go It is automatically executed when the badge number is within the range defined in the parameter SG In Mostly used to indicate the start of the workday Out Mostly used to indicate the end of the workday 0 9 These are used for specific purposes defined by the user In the definition of each function it is specified if the L...

Page 31: ...t find a schedule it executes error message number 1 4 If it retrieves the message it displays it and executes the first instruction in the function executed At this point it is determined if the swipe is allowed or not depending on the message s characteristics 5 1 5 Supervisor Procedures Transactions may be added or erased with the Supervisor Badge For a badge to be a Supervisor Badge it must be...

Page 32: ...ute as when a badge is swiped It will ask for the function and will execute it The transaction searches are only done to transactions for the current day and it stops with the first transaction it finds When a function to check lockout is executed and the lockout message does not allow the swipe but in the same message it allows the supervisor to allow the swipe while the message is displayed if t...

Page 33: ...ode RST Transaction Memory Initialization FL Function Definition SG Maximum Number for Swipe Go FP Programming Function Instructions SF Fingerprints Supervisor Prefix FS Enable Disable Finger Sensor SN Clock Message on the Second Line FT Fingerprint Reading Waiting time SOT Start on line transactions FZ Total Memory Allocated for the FIU SP Supervisor Badge Prefix H1 Transaction Printing Headers T...

Page 34: ...use 6 2 3 AO Access Only Clock Format AO X where X can be Y or 1 for Yes or N or 2 for No When the clock is access only the transactions are not stored 6 2 4 AT Update Date and Time Format AT NNN where NNN can be the time difference between the computer and the clock in hours If NNN 0 then AT is enough This instruction retrieves the date and time from the computer adds the time difference and send...

Page 35: ...hen they have a length equal to the value specified in BL See BM below Every time BL is issued then BN is reset to BL 6 2 9 BM Maximum Badge Length Format BM NN F where NN Maximum length of badge allowed 1 40 F Offset of the starting character within the badge number to start reading the NN characters The terminal will store BL characters of the total badge length BM starting at the offset positio...

Page 36: ...e X can be Y or 1 for initializing the terminal to all default values and to erase all transactions and tables X can be N or 0 to simulate turning the unit off and on automatically 6 2 13 DL Indicates Summer Energy Daylight Savings Format DL X where X can Y or 1 to accept it or N or 0 to not accept it The Energy Savings Program contemplates the time adjustments on the first Sunday of April and the...

Page 37: ...es for DLS or N or 0 to use the International Standard of the DLS See DL DDMM is the starting date of the Daylight Savings Program DLS and ddmm is the ending date of the DLS NNN is the offset in minutes to be added subtracted from the time on the dates 6 2 16 EF Enter Function Message Format EF XXXXXXXXXXXXXXXXXXXX where XXX string up to 20 characters The default is ENTER FUNCTION 6 2 17 EM Messag...

Page 38: ... 2 20 FP Programming Function Instructions Format FP FLMMMMMMMMMMMMMMMMSSSTDNNVT where F Function to which the instruction belongs 0 9 L Number of instruction 1 6 according to the function s definition MMM Message to be displayed in this instruction 16 characters SSS Data Entry Source allowed in this instruction SKWP or blank if data entry not allowed T Type of data to collect 1 Alphabetic 2 Numer...

Page 39: ...r is used the default will be only 1 fingerprint per badge to store on the table If you need to save 3 fingerprints per badge then A should be set to 2 This will mean that only 333 people badges can be registered in the FIU reader When the FIU is set to store 2 or 3 fingerprints the primary finger should be registered first that means the finger that you intend to use the most When you attempt to ...

Page 40: ... first line 6 2 28 IS Badge Entry Sources Allowed Format IS XXXX where X may be one or any combination of the following S if the entry is through a Magnetic Stripe Reader K if the entry is through the keyboard W if the entry is through a Bar Code Reader P if the entry is through a Proximity Reader 6 2 29 Lx Error Messages Format L0 MMMMMMMMMMMMMMMMMMMM L1 MMMMMMMMMMMMMMMMMMMM L2 MMMMMMMMMMMMMMMMMM...

Page 41: ...e validation is successful Can be null 6 2 33 LF Line Feeds after transaction printing Format LF NN where NN A number between 0 and 30 When a transaction is printed the printer will advance the paper NN lines before printing the next transaction 6 2 34 LL Length of data Format LL 00 11 22 33 YYYY where 00 Length of data for validation table no 0 11 Length of data for validation table no 1 22 Lengt...

Page 42: ... AAAAA Bytes for the Access Table PPPPP Bytes for the Profile Assignment Table MMMMM Bytes for the Employee Messages Table 00000 11111 22222 33333 Bytes for the Validation Tables 0 3 SSSSS Bytes for the Profiles Table the default is 640 NNNNN Bytes for the PIN Table This parameter must have all positions filled each number must have 5 characters When this instruction is executed all tables and all...

Page 43: ...ocess this instruction the terminal reads the first badge assignment on the profile table and if this corresponds to the letter A it will be processed according to the profile assigned for that day If it is not the letter A the normal process applies Please see next PE option 6 2 41 PE Also Format PE FGGG NNNNNNN where F Flag 1 First entry 0 Subsequent GGG Badge Number NNN Number of profile assign...

Page 44: ... Message index Valid characters 1 9 MMM 16 character message A Allow the check Y Yes N No S Allow access supervisor B Emission bell A Accepted R Rejected N None T Displayed message time Up to 16 messages can be defined 6 2 45 PR PIN Register Format PR FBBBB NNN where F Flag 1 First 0 Subsequent BBBB Badge number NNN PIN assigned to BBBB badge number The terminal searches for the badge swiped in th...

Page 45: ... read does not match the one stored for the badge 7 mark The badge that is swiped does not have a PIN assigned or the PIN entered is incorrect 8 mark A proximity card was detected with an incorrect facility code 9 mark 6 2 48 RL Printer Reset line Format PX MMMMM where MMM up to 30 Characters After a transaction is printed the reset line is sent to the printer This string accepts any control chara...

Page 46: ...fferent than 0 See OT for more details 6 2 53 SP Supervisor Badge Prefix Format SP XXXX where XXXX is the prefix that a badge must have to be considered a Supervisor Badge 6 2 54 T Clock s Logical ID Format T X where X is the character that identifies the clock 6 2 55 T1 General Data Entry Time Format T1 NNN where NNN are the tenths of second the clock will wait for an entry Default is 30 3 second...

Page 47: ... an environment other than Windows such as UNIX 6 2 59 TL Communication Timeout Format TL NN where NN is the time in milliseconds the terminal will wait to receive a communication response when it is communicating with the computer Default value 750 This value is used when the connection is made with a very segmented link such as Internet or Cellular Modems 6 2 60 TP Display Idle Prompt Time Durin...

Page 48: ...s 6 2 64 XS FIU Security Format XN XXXXXXXXXX where XXXXXXXXXX is the security code assigned to individual FIU 6 2 65 ZZ Terminal Locked Format ZZ F where F Y or N 1 or 0 When set to 1 or Y the terminal rejects all transactions received If a badge is swiped or a key is entered the terminal will show the message TERMINAL LOCKED TRANSACTION REJECTED When F is set to N or 0 this function is deactivat...

Page 49: ...nt Table To calculate the size of the Profile Assignment Table use the following formula Size of Table Badge Length 7 Number of Badges 7 1 5 Profile Definition Table By default the system reserves 640 bytes for the Profile Definition Table which is 16 profiles If you need more space use the following formula to determine the size of the Profile Definition Table Size of Table 40 Number of Profiles ...

Page 50: ...es Table Size Total of Level Validation Table Sizes Remaining Space for Transaction Storage To calculate the approximate number of transactions that can be stored in that space let s consider that the majority of transactions stored will be normal that is Swipe Go In Out Then the transactions that will be able to be stored will be Space for Transactions Transactions to be Stored Badge Length 6 0 7...

Page 51: ...LPHA ALPHA ALPHA D 3 ALPHA E 3 ALPHA ALPHA F 3 ALPHA ALPHA ALPHA G 4 ALPHA H 4 ALPHA ALPHA I 4 ALPHA ALPHA ALPHA J 5 ALPHA K 5 ALPHA ALPHA L 5 ALPHA ALPHA ALPHA M 6 ALPHA N 6 ALPHA ALPHA O 6 ALPHA ALPHA ALPHA P 7 ALPHA R 7 ALPHA ALPHA S 7 ALPHA ALPHA ALPHA T 8 ALPHA U 8 ALPHA ALPHA V 8 ALPHA ALPHA ALPHA W 9 ALPHA X 9 ALPHA ALPHA Y 9 ALPHA ALPHA ALPHA Q 1 ALPHA Z 1 ALPHA ALPHA 1 ALPHA ALPHA ALPHA h...

Page 52: ...hen there is a badge entry with a length larger than the length allowed in the edit mode a beep will sound and the entry will be rejected Editing as data entry has a wait period determined in the company s data configuration If that time elapses without a data entry a rejection beep will sound and data edition will be cancelled The time counter is initialized when a key is pressed or a badge swipe...

Page 53: ...ord Format This represents a normal badge transaction it contains the information polled through the execution of a function It has the following format Indicator 1 à HHMMSS S BBB F X4 X3 X2 X1 X0 S D1 where HHMMSS Time of transaction S Source of transaction BBB Badge number variable length F Function executed X4 X3 X2 X1 X0 Reserved for further use 40 will appear in each position S Source of data...

Page 54: ...the following information Every datum is separated by a comma v4 This is constant Terminal Id Reserved memory for Profile Definitions Available Memory for Access Table Actual count of Access Table Entries Available Memory for Profile Assignation Table Actual count of Profile Assignation Table Entries Available Memory for Message Table Actual count of Message Table Entries Available Memory for Tran...

Page 55: ...needs to be modified with a phone number and AcroComm cfg file within the Visual Basic Code Refer to sample VB code in this section for location details 10 2 Installing AcroComm Excel Macro Sample A self extracting zip file SETUP EXE creates an ACROCOMM subdirectory containing the following files ACRO ICO Acroprint Icon ACROCOMM EXE Windows NT 95 Communications program ACROCOMM INI Acrocomm setup ...

Page 56: ...AcroComm Programming Manual 10 4 Main Menu The main menu provides the means to poll select data viewed pair punches totals and subtotals append data to a standard excel sheet 56 ...

Page 57: ...minal data will be displayed below the main menu in Excel sheet 2 If you need to collect Job Costing information the terminal keys can be customized to meet your specific needs by simply changing the PROGRAM CLK file and reprogramming the terminal via Acrocomm In the example provided function key 1 F1 was set up to collect 4 data elements Department Job Step and Operation The Main Menu diagram sho...

Page 58: ...D As Single Dim ID As Variant WORKBOOK_NAME ActiveWorkbook Name Application ScreenUpdating False If Validate_Paths False Then MsgBox There are invalid path file names Chr 13 Chr 13 _ They must be corrected before execution can continue vbExclamation INVALID PATHS Exit Sub End If Range a31 Select Application DisplayAlerts False If IsMissing Clock_Num Then Clock_Num 1 ID Clock_Num If Range Back_Up_D...

Page 59: ...l other codes must be programmed via Acrocomm exe command line For example to program terminal ID type T 33 from the command line and reboot the terminal ASCII Code Character 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 to 57 0 to 9 58 59 60 61 62 63 64 65 to 90 A to Z 91 92 93 94 95 _ 96 97 to 122 a to z 123 124 125 126 59 ...

Page 60: ...rogram to recognize the CLOCK In A function used to indicate the start of the work day Initializing Clock Memory A function to erase all stored transactions Messages A text field of up to 16 characters to be assigned to a badge Messages to Employees Table MODEM An instruction indicating the connection will be made through a modem Out A function used to indicate the end of the workday Poll Clock He...

Page 61: ...AcroComm Programming Manual WAIT number An instruction indicating how long in seconds the program should wait for a response from the CLOCK after sending an order 61 ...

Page 62: ...chedule Record 36 MA 42 BL 35 Maximum Badge Length 35 BM 35 Maximum Number for Swipe Go 45 BS 36 MD 42 Change Date Record Format 53 Memory Partition 42 CLOCK 20 Message Display Time 46 Clock s Logical ID 46 Messages 29 Command Line 9 Messages Assigned to Badges 37 Command List 33 Mnumber 23 Command List Formats 34 MODEM 21 Configuration 20 MP 42 Configuration Through Badge 26 MT 42 CONFIGURATION V...

Page 63: ...visor Procedures 31 Supervisor Transaction Record 53 T 46 T1 46 T3 46 Table Size Calculations 49 Terminal Locked 48 Transaction Destination 10 11 12 13 14 15 16 17 18 19 Transaction Dump Templates 55 Transaction Memory Initialization 45 Transaction Printing Headers 40 TRANSACTIONS 20 Transactions Output Format 53 U 23 UF 47 48 Update Date and Time 34 Use of External Light Box 40 Using the Resident...

Page 64: ...AcroComm Programming Manual 64 ...

Search results

Summary of Contents for AcroComm

Reviews:

Related manuals for AcroComm

Brands by name

Popular brands

Acroprint AcroComm, Programming Manual

Search results

Summary of Contents for AcroComm

Reviews:

Related manuals for AcroComm

Brands by name

Popular brands