Table of Contents
- GENUS CLOCKS INITIAL SETUP
- Background
- Start Up the Clock, Retrieve the IP Address
- Prepare a Staging Directory for the Clock Files and Edit the File
- Download TFTP Software
- Upload the Newly Edited Clock File Using TFTP
- Clock Maintenance
- Clearing the Queued Punches
- Clearing the Saved Bio Templates
- Configuration Attributes
- Configuration Attributes (Application Configuration)
- Configuration Attributes (Terminal Configuration)
- Configuration Attributes (Web Configuration)
- Configuration Attributes (Database Configuration – NOT USED – INFORMATION ONLY)
- Other important files on the clock:
- Notes
GENUS CLOCKS INITIAL SETUP#
Background#
Genus clocks come pre-loaded with operating software, but the clock needs to be installed/configured for use with the application.Start Up the Clock, Retrieve the IP Address#
| Steps | Yes | No | Description |
|---|---|---|---|
| 1. Connect the clock to the network | When you connect the clock to the network it will initialize and immediately display the network IP address | ||
| 2. Write the IP address down | Write the IP address down. IP Adress: |
Prepare a Staging Directory for the Clock Files and Edit the File#
| Steps | Yes | No | Description |
|---|---|---|---|
| 1. Create a staging directory for the clock files on your local machine. | i.e. c:\clock | ||
| 2. Download the latest Genus clock files from the ReleaseWiki. | http://www.highlinecorp.com:8080/Release/Wiki.jsp?page=Genus | ||
| 3.Place the files in your staging directory. | |||
| 4. Extract the files there | Unzip/Extract the files within your staging directory. There will be 2 files: App.jar and app.conf. | ||
| 5. Edit the app.conf file | This is the configuration file for the clock. There are a number of configuration settings here and commented examples for each configuration setting. For testing purposes, replace the TITLE setting with a title of your choosing. i.e. “TESTING” By selecting a customized title, it will be easier to confirm changes have been uploaded to the clock. |
Download TFTP Software#
| Steps | Yes | No | Description |
|---|---|---|---|
| 1. To download/upload the configuration files, etc. to/from the clock, TFTP software will be needed | With an operating system of Windows Vista or higher, a TFTP client compatible with the operating system will be needed. | ||
| 2. Download TFTP | The following site which has an free TFTP software: http://tftpd32.jounin.net/tftpd32.html Unzip and install the software on the local machine where the clock files are located (c:\clock). |
Upload the Newly Edited Clock File Using TFTP#
| Steps | Yes | No | Description |
|---|---|---|---|
| 1. Start the TFTP app, click on the “Tftp client” tab | In the “Host” field, enter the IP address of the clock (recorded in step 2). The port can be null (app will select a default port). | ||
| 2. Upload (PUT) the app.conf file | In the “Local File” field, input or browse for the path of the local directory where the edited file, app.conf, is located. In the “Remote File” field, enter the following for the path within the clock: \ramdisk\app.conf Click “PUT”. This will upload the file to the clock. | ||
| 3. Upload (PUT) the App.jar file | In the “Local File” field, input or browse for the path of the local directory where the file, App.jar, is located. In the “Remote File” field, enter the following for the path within the clock: \flashdisk\App.jar Click “PUT”. This will upload the file to the clock. | ||
| 4. The clock will now reboot | When the clock finishes initializing it will display the customized title change created when the app.conf file was edited. | ||
| 5. The clock will now be ready for enrollment or further configuration | Depending on what level of configuration defined at the initial edit of the app.conf file, more settings may need to be edited prior to enrolling an employment. Review the section detailing the configuration attributes. Make needed edits to the app.conf file prior to enrolling the employee. Otherwise, the screen prompts on the clock can be followed to enroll an employee. Verification that the employee is enrolled is can be done by reviewing ITCC in the Personality. |
Clock Maintenance#
Clearing the Queued Punches #
- Press “F1”
- Password= “9” (or whatever you set in the app.conf)
- Select “CLEAR ALL” to clear all punches
- “9” needs to be pressed ten times
Clearing the Saved Bio Templates #
- Press “F1”
- Password= “9” (or whatever you set in the app.conf)
- Select “REMOVE ALL” to clear all saved bio templates
- “9” needs to be pressed ten times
Configuration Attributes#
| Attribute | Description |
|---|---|
| DEBUG = true | #DEBUG = true|false Toggle for debugging |
Configuration Attributes (Application Configuration)#
| Attribute | Description |
|---|---|
| TITLE = HL (Devel) Time Clock | #TITLE = High Line Time Clock Main screen title |
| WELCOME_MESSAGE = Welcome | #WELCOME_MESSAGE Idol page Welcome message Only referenced by a G2 application |
| PASSCODE = 9 | #PASSCODE = <passcode> Clock administrator passcode |
| ALLOW_KEYING = false | #ALLOW_KEYING = true|false Toggle for allowing keying of employee/badge numbers |
| VALID_KEYED_VALUES = 56,5000 | #VALID_KEYED_VALUES = Employee Badge or Person codes which are allowed to be keyed when ALLOW_KEYING = false (Spaces not supported) |
| USE_BADGE = true | #USE_BADGE = true|false Toggle for use of badge numbers (true= badge in ITCC, false=person_code) |
| MIN_BADGE_LEN = 2 | #MIN_BADGE_LEN = 4 Minimum length of badge/employee number |
| MAX_BADGE_LEN = 6 | #MAX_BADGE_LEN = 10 Maximum length of badge/employee number |
| ENTER_JOB = true | #ENTER_JOB = true|false Toggle for allowing a list of assignment Authorized jobs for selection during IN punches |
| ENTER_COST_CENTER = false | #ENTER_COST_CENTER = true|false Toggle for entering cost center information |
| VALID_COST_CENTERS = 1234,5678 | #VALID_COST_CENTERS = Comma delimited list of valid cost centers (Spaces not supported) |
| VALIDATE_PUNCHES = false | #VALIDATE_PUNCHES = true|false Toggle for validating punches on server (validation will occur regardless if keyed) |
| STORE_BIO = false | #STORE_BIO = true|false Toggle for storing biometric templates on server |
| QUEUE_FULL = Clock Out of Order Please advise your manager | #QUEUE_FULL|An "Out of Order" message displayed once the punch queue is full (G1 20 Characters Max.) |
| QUEUE_FULL2 = Advise your manager | #QUEUE_FULL2 Used in G1 applications for 2nd line text messages (G1 20 Characters Max.) |
| QUEUE_LIMIT = 200 | #QUEUE_LIMIT Used to define the MAXIMUM number of queued punches allowed to be in the queue IF less than the maximum physical limit |
| THAW_LIMIT = 0 | #THAW_LIMIT Used to define the number of queued punches allowed to be in the queue and automatically thaw the clock to accept punches |
Configuration Attributes (Terminal Configuration)#
| Attribute | Description |
|---|---|
| BIO_SENSITIVITY = 4 | #BIO_SENSITIVITY = 0 to 7 Biometric sensitivity level |
| BIO_QUALITY = 1 | #BIO_QUALITY = 0 to 2 Biometric quality level |
| MIFARE_POLL_INTERVAL = 10 | #MIFARE_POLL_INTERVAL Mifare Card reading interval in ms |
| MSG_TIME = 3000 | #MSG_TIME = 3000|<milliseconds> Milliseconds to wait for display messages |
| DELAY_TIME = 5000 | #DELAY_TIME = 5000|<milliseconds> Milliseconds to delay screens |
| IDLE_TIMEOUT 5000 | #IDLE_TIMEOUT 5000|<milliseconds> Milliseconds between idle screen refreshes |
| QUEUE_SLEEP_TIME = 50000 | #QUEUE_SLEEP_TIME = 50000|<milliseconds> Time between connections to the server |
| DATA_SERVER_TYPE = HTTP | #DATA_SERVER_TYPE = HTTP|ORACLE|WEB Data transfer method |
| PING_SLEEP_TIME = 0 | #PING_SLEEP_TIME = 30000|<milliseconds> Time between pings to the server storing device information |
Configuration Attributes (Web Configuration)#
| Attribute | Description | |
|---|---|---|
| HOST_URL = http://192.168.97.165:8988/selfService/clock.process | #HOST_URL = http://<host>:<port>/<webapp>/<process> Server connection string #HOST_URL = http://192.168.97.165:8988/selfService/clock.process | Example |
| WB_RETRY_INTERVAL = 60000 | #WB_RETRY_INTERVAL = 60000|<milliseconds> - retry frequency for invalid POST's |
Configuration Attributes (Database Configuration – NOT USED – INFORMATION ONLY)#
| Attribute | Description |
|---|---|
| DATABASE_DRIVER = oracle.jdbc.driver.OracleDriver | #DATABASE_DRIVER = oracle.jdbc.driver.OracleDriver Database driver class |
| DATABASE_URL = jdbc:oracle:thin:@NSI:1521:NSI | #DATABASE_URL = jdbc:oracle:thin:@<host>:<port>:<sid> Database URL |
| DATABASE_USER = P2K | #DATABASE_USER = <user> Database user name |
| DATABASE_PSWD = p2k | #DATABASE_PSWD = <password> Database password |
| DB_RETRY_INTERVAL = 60000 | #DB_RETRY_INTERVAL = 60000|<milliseconds> Retry frequency for invalid connection attempts |
Other important files on the clock:#
| File | Location on Clock |
|---|---|
| errors.txt | \ramdisk\errors.txt The location of the errors file on the clock This is a log used for troubleshooting enrollment, and clock punch issues You can download (GET) this file using the TFTP app |
| Genus | \config\g2_4_3_04 \flashdisk\Genus The location of the Genus files on the clock The version path will change depending on the release Accessed via TFTP |
| Classes | \config\G2-Classes-1.0.91.jar \flashdisk\Classes.jar The location of the latest classes on the clock Accessed via TFTP |
| terminal.conf | \ramdisk\terminal.conf Parameters and options will be maintained in a central configuration file that can be transferred to the terminals at any time This configuration information will initially be held in permanent memory on the terminal This information is loaded into memory only when the time clock is booted (application starts up) Accessed via TFTP |