...

...

...

...

Anchor
_Hlk517692644 _Hlk517692644

...

Description

Adonis Time Clock is an application designed to simplify the hourly registration onboard by using the principle of clocking in/out work hours.
To access the Adonis Time Clock working area, crew members can either enter their current pin and passcode or use a swipe card.

...

Requirements:
•CPU 1.6 GHz or better recommended.
•512MB of RAM minimum (1GB or more recommended).
•50MB of available hard-disk space.
•Windows XP Service Pack 3, Windows Vista, Windows 7/8/10.
•.Net Framework 4.0 or higher.
•Display resolution (1024x600, 1024x768, 1366x768) with Touch Screen (optional).
Continues Operation when Server is Unavailable
The Time Clock application uses a local cache and will function even if the database or the Time Clock Web Service is not online.
The moment the Time Clock Web Service is back online, the Time Clock will upload the cached information back to the server.
Together with a proper UPS on the panel PC, 99% uptime can be reached.
The Adonis Personnel Portal
See separate documentation.

Installation

To start the installation, go to the download area of our web site or to your ftp area and download the latest version of Adonis Time Clock.
Once the download is complete, go to the downloaded path and double-click the installation file to launch a setup wizard.

...

You can set Run the program option immediately after installation.

Click Finish.

Upgrade

You have two ways how to upgrade the Time Clock to higher version:

...

1. Click Next.
   
   
   
2. You can set the option to Run the program immediately after upgrading.
   
3. Click Finish.

Un-

...

Install

If you need to uninstall the Time Clock, click Start from the Windows task bar, go to All Programs->Adonis TimeClock->Uninstall.
Alternatively, click Start from the Windows task bar, go to Control Panel > Programs and Features and click Adonis TimeClock item.

...

To disable Kiosk Mode, you need to uninstall Adonis Time Clock Software.

Housekeeping

After installation, Time Clock configuration can be done in any of the ways:

...

Configuration parameters are stored in the Settings.xml file in the folder where the application is installed.
See details in below sections.

Anchor
_From_the_Panel _From_the_Panel

From Panel PC

To access the Configuration page specifically intended for administrators, log in using the following data:

...

Now, let us examine the configuration settings as well as cache and log files in more details.

General Settings

Switch to the General Settings tab to view the settings:

...

• Remove border from main screen. Select the checkbox to remove the standard windows border. It is recommended to use this option when displaying the application on a panel PC in the Kiosk Mode.
• Stay "Debug" window on top of main window. Select the checkbox to display the Config Window on top of other windows.
  
• Hide mouse cursor (for touch screens). Select the checkbox to hide a mouse cursor. The option is intended for touch screens of a panel PC.
  It is recommended to clear the checkbox when running the application on a laptop.
  
• Disable display dim, turn off and sleep mode while application is running. Select the checkbox to prevent the panel PC from disabling the screen or going into sleep mode.

• Data folder. The field contains the path to the directory where the application data is to be saved. The data folder is used to store the local cache. When the server is unavailable, the Time Clock registrations are stored locally and transferred to the server once it is running again.

  Tip
  Make sure the application has the read/write folder permissions.

  
  

• Use Time Zone table. The setting is used to determine the time zone. When selected, the application checks the time zone on the server. If the option is not selected, the panel PC is to be manually reset. Adonis Time Clock then uses local time onboard when registering the time clock transactions.
  
• Enable Gangway. Select the checkbox to enable the Gangway registrations (sign on/off or offshore visit). For more information on the Gangway functionality, switch to Gangway.
• SignOff button visible only on Estimated End Date. Select the checkbox to make the Sign Off button available on the panel only on the estimated end date. If the checkbox remains unselected, the Sign Off button is available if a crew member is onboard.
• Location. Enter the location of Adonis Time Clock.

• Main window skin. From the drop-down menu, select the skin you want to be displayed to the main page.

• Confirmation screen visible time. Set the number of seconds after which the Confirmation dialog will autoclose.

• Admin pin. The default pin number that allows accessing the Config Window is set to 0000.
  

  Info
  We do not recommend changing the pin number. In case you do, make sure that: the pin does not intersect with APM pin numbers    or the pin starts with 0

  
  

• Admin password. The default access code that allows accessing the Config Window is set to 1266472012. To change the password, clear the fields with the current password and enter a new password twice. Once done, select the Show Password checkbox and verify that the entered passwords match. To reset the password to the default value, click the Default button.

• Exit Application. Click the button to exit Adonis Time Clock when running it on a panel PC.
• Help. Click the button to get redirected to the Adonis Time Clock user guide.

Network Settings

Switch to the Network Settings tab to view the settings:

...

• Web Service URL is the path to the TimeClock web service. It is used to communicate with the Adonis Database

  Info
  To activate the web service, make sure you have Adonis Personnel Portal installed.

  
  

• Allow untrusted certificate. Select the checkbox to allow connecting to the Web Service with an untrusted certificate. For example, self-signed certificate.

• Offline cache timeout (ms). Specify a time interval (in milliseconds) the application waits for the server to reply before it starts using offline cache to update user interface. The default value is1000.
• Cache refresh interval (sec). Define the time period in seconds for refreshing cache. The default value is 900.
• If cache refresh time fails, retry in. Enter the time period (in seconds) in which the application makes an attempt to refresh cache in case the update fails. The default value is 30.
• Try to send queued item every. Enter the interval (in seconds) between the attempts of queued requests to be sent in case the previous attempt has failed. The default value is 30.

• SyncSettings interval (sec). Specify the number of seconds Adonis Time Clock checks the server for any configuration settings. The default value is 60.

• Remove Registration from queue in. Enter the number of days after which the failed registrations will be removed from the queue. The default value is 15.

Card Reader Settings

Switch to the Card Reader Settings tab to view the settings enabling you to define:

• how to communicate with Card Readera card reader
• where the information is stored on the magnetic strip

...

Below you can find the description of the settings.

Card Reader Settings:

• Enable card reader debug mode. Select the checkbox to display all the card data on the main screen. The debug mode allows you to see an input string coming from the magnetic strip.
  
• Require password if card used. Select the checkbox to ask for an access code after a card is used. Otherwise, the next screen will be shown without checking an access code.
• Log card reader events to log. Select the checkbox to store all card reader events in the log file.
• Pin extraction params:
  Line number is a line on a card where the pin number is located. Define the magnetic strip row that contains the pin number.
  Start Position
  Description: Number of character on card where  is a character number from which the pin number begins on a card. Use the start position and length to determine where in the the location  of the pin number in a line or a row the pin number can be found.
  Default value: 4
  Length
  Description: Length of pin . The default value is 4. 
  Length is the length of a pin number on a card.
  Default The default value : is 3.
  

...

Serial port input settings. Select the Enable Card Reader input from Serial Port checkbox to configure a com port in case a card reader is connected to the panel PC via

...

the

...

com port.

...

 Check with

...

the card reader

...

supplier about the com port settings to

...

be used.

Keyboard

...

input settings:

• Enable Card Reader input from Keyboard. Select the checkbox if the magnetic input is sent via the keyboard buffer

...

• .
  Use the end of input card key time out.
  Description: Time in milliseconds. If there are no keys received during specified time interval than application clears input buffer and starts processing received card data.
  Default value: 200

RFID Card Settings

This section describes the settings needed in the time clock configuration.
Before setting up the system, we need the following information from the card supplier:

...

From release 2018.2.1, it became possible to program the RFID card directly from the time clock, without any need to interface to the 3^rd party suppliers.
See Working with RFID Card section below.

Working with RFID Card

...

Press OK
Initialization is finished.

Cache, Log Files

The following tabs list the contents of the cache, local log files and registrations:
Pin Cache
All crew members that are currently onboard (employees with an onboard activity) are cached:

...

• This queue is empty when the server is available (no current pending registrations).
  
  
  
• From here you can remove unneeded registration by right-clicking the record:
  
  

Anchor
_Working_with_RFID _Working_with_RFID

Centralized Maintenance (APP)

From the Administrator Portal, you can maintain various Time Clock installations onboard.

...

1. Displays the overview screen (TimeClock Status).
   From this screen, you can then modify the various configuration settings for one or more panel PCs.
   
   See TimeClock Overview section.
2. Upload update files. This gives you the possibility to upgrade time clock(s) remotely.
   
   See TimeClock Update section.

TimeClock Overview

Displays the overview screen listing all installed Time Clocks onboard.
From this screen, you can modify various configuration settings for one or more panel PCs, set notifications and schedule automatic upgrades:

...

1. The list of Time Clocks installed onboard with Location, Status (online or offline), Version, IP address and Notification Status data.
   Here you can tag needed one(s) to work with.
2. Refreshes the overview screen.
3. Here we can enable notifications to inform if any of the Time Clock is offline:
   
   
   For this, Notification Service needs to be previously installed.
   If we set the checkbox, the following Notification Task Form appears: 
   
   
   
   Please define:
   Notification Interval (in min.) – Notification Service checks if any panel PC is offline for the set period, if so - sends the list of offline PCs. 
   Recipient email (s); 
   Email Subject and Body (instead of {OFFLINE_TIMECLOCK_TABLE} will be the list of PCs with Offline status). 
   
   Click Save.
4. Displays the settings screen for one or more timeclocks (depends which you tagged in the list).
   The following tabs are available: General Settings, Network Settings, Card Reader Settings and RFID Card Settings:
   
   
   
   
    For all details: see From the Panel PC section. 
5. Update screen
   This allows you to schedule the upgrade.
   
   
   
   Enter the date and time you want to upgrade the TimeClock and select the update file.
   
   File needs to be previously uploaded to appear in the drop-down list.
   
   See TimeClock Update section below.
6. Here we can disable offline notifications for one/several tagged PCs:
   
   
   
   For example, this can be useful if the administrator knows about a breakdown/problem with some panel PC, and while it is being fixed, he does not want to receive offline notifications.
   For this, set the checkbox and define the Date/Time from or choose from Now. 
   Also set duration period Disable for (in min.). 
   OfflineTimeOut – if during this period the system does not receive SyncSettings request from the TimeClock(s), the TimeClock state/status becomes offline in the Timeclock Maintain Tool – TimeClock Overview screen. 
   Please pay attention: OfflineTimeOut value must be set more or equal to Sync Settings interval (the number of seconds the Time Clock checks the server for any configuration settings) set on Network Settings tab. 
   Default value: 2 minutes.
   
   When you're done, click Save.
7. Click to restart tagged panel PC record(s) in the TimeClock overview list.
8. If you want to remove unneeded records (panel PCs that are not used any more), tag records in the list and click Delete
   If you deleted some real/online record by chance, the system returns it in the list after refreshing (TimeClock is run on this panel PC).| 
   
   
   
   

Anchor
_Upload_Update_Files _Upload_Update_Files

TimeClock Update

You have a possibility to schedule the upgrade of time clock(s) remotely via APP.
You need:

...