...
...
...
...
Contents
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
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. 
System Architecture
To enable the Time Clock to communicate with Adonis Personnel Manager database, the Time Clock Web Service (AdonisTimeRegSrv) needs to be installed.
...
The Adonis Personnel Portal
See separate documentation.
Aspect ratio
This is important for the readability of the time clock application, it not responsive and the following Aspect Ratio are supported.
...
Most panel pc are delivered with these ratio, if the ratio is not listed let development know we can modify the skin to fit the new ratio
Skins and resolution
Skin | Resolutions/Aspect Ratio | |||
|---|---|---|---|---|
Modern | 1024 x 600 (WSVGA) | 1024 x 768 (4:3) | 1366 x 768 (~16:9) | 1368x923 (3:2) |
Default | 1024 x 600 (WSVGA) | 1024 x 768 (4:3) | ||
CCI | 1024 x 600 (WSVGA) | 1024 x 768 (4:3) | 1366 x 768 (~16:9) | |
Adonis | 1024 x 600 (WSVGA) | 1024 x 768 (4:3) | ||
Classic | Any resolution |
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 | ||||
|---|---|---|---|---|
|
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.
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.
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
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:
...
Enable Card Reader input from Keyboard. Select the checkbox if the magnetic input is sent via the keyboard buffer.
"End of input" card key time out (ms). Specify the time in milliseconds after which the application clears an input buffer and starts processing the received card data if no key has been received within the specified time interval. The default value is 200.
| Anchor | ||||
|---|---|---|---|---|
|
Before getting started, make sure the following information is provided to you by the card supplier:
...
Below you can find the description of the settings.
MIFARE reader settings
Select one of the card reader models:
...
All 3 models can read and initialize the pin codes.
MIFARE Application Directory (MAD) vs TimeClock Sector
The application directory on Sector 0 contains the overview of the sectors used by the various applications that can program the card.
...
Read Key is a security key required to access the sector where the PIN is stored (read the data). The key must be specified in the hex format.
Data prefix is used to ensure that a pin number is read (not a random number that can be interpreted as a pin number). Data prefix prevents from reading unprogrammed or wrongly programmed cards.
How to store the pin number on RFID card:
2bytes that is the prefix that is placed in front of the pin number.
It uses 2 bytes. The remaining 4 bytes are used for the PIN number.If this prefix is not used (it is only pin on the card) please input '0'
If the MAD is not used, then select Specify TimeClock sector and identify the sector that will be used (a value from 1 to 16).
Pin is in ASCII format. Select the option if pin is needed to be read in text format or clear it if in decimals.
MIFARE program settings
Set the Program Time Clock Sector check-box and enter 2 keys:
...
From Release 2018.2.1, it has become possible to program the RFID card directly from Adonis TimeClock, without any need to address the third party suppliers.
For more information, see Working with RFID Card.
| Anchor | ||||
|---|---|---|---|---|
|
From Release 2018.2.1, it has become possible to program the RFID card directly from Adonis TimeClock, without any need to address the third party suppliers.
When the Time Clock cannot detect the crew members pin number when scanning the RFID card, it will prompt the end user to initialize the card.
The system will then guide the crew member through the process to program the card:
...
Initialization is finished.
Cache, Log Files
The following tabs list the contents of the cache, local log files and registrations:
...
Click Update Cache Now button to perform refresh immediately.
Work Type Cache
The work types an employee can select during registration:
...
Work types can be added in the Adonis Administrator Porta
Action Cache
Is used for Gangway functionality:
...
Is visible only if Enable Gangway option is ON at General Settings tab.
Time Zones
Here we store the various time zones and local onboard time changes:
...
Time zones can be added/managed in the Adonis Administrator Portal.
Operation Log
All communication between the server and the TimeClock is logged, as well the communication with the com port or card reader:
...
Here you can check Date/Time, Action description, Status, Duration (in sec.) and actual Result of any operation.
Time Reg Request Queue
Contains all the cached time entries made in the Time Clock/panel PC during the time the server was unavailable.
It means that even if Panel PC is off-line, crew members can continue swiping and making registrations.
We can call them 'pending registrations'.
...
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 | ||||
|---|---|---|---|---|
|
From the Administrator Portal, you can maintain various Time Clock installations onboard.
...
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.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:
...
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.Refreshes the overview screen.
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.Displays the settings screen for one or more timeclocks (depends which you tagged in the list).
The following tabs are available: General Settings, NetworkSettings,Card Reader Settings and RFID Card Settings:
For all details: see From the Panel PC section.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.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.Click to restart tagged panel PC record(s) in the TimeClock overview list.
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 | ||||
|---|---|---|---|---|
|
You have a possibility to schedule the upgrade of time clock(s) remotely via APP.
You need:
...
If it's offline for some reason, upgrade will be performed immideately after it backs on-line
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 choose to select the Run Adonis TimeClock checkbox to open the application immediately after the installation.
Upgrade
There are two ways you can use to upgrade your current version of Adonis TimeClock to a higher version:
...
Click Finish to close the setup wizard.
Uninstallation
There are two ways you can use to uninstall the Adonis TimeClock application:
...