Skip to end of banner
Go to start of banner

Adonis Time Clock Housekeeping

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Next »

The TimeClock Housekeeping


The Adonis Time Clock is an application designed to simplify the hourly registration onboard by using the principle of clocking in/out work hours.
For this, the crew members need their current pin and passcode, or they can use a swipe card that can identify the crew member.

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 Time Clock Web Service is a part of the Adonis Personnel Portal (APP).


In addition, the APP contains the Adonis Administrator Portal that allows the onboard administrator to centralize maintenance of time clocks, including schedule of upgrades and Time Zone changes.
See Configuration of the Adonis Time Clock Client Software section.
Example Service URL: http://server/AdonisWebServices/TimeClockWebService.svc

  • Where server is server name or server IP address where Time Clock Web Service is installed.


Minimum System Requirements for Installation/Using TimeClock
The Adonis TimeClock is installed on Panel PC that is located on strategical locations onboard.

  • Strategical location means location where crew members need to pass when going to and from their work location.


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


Before the Adonis Time Clock Client Software installation, you do not need to uninstall any previous version.
! Administrator rights are required when installing the Adonis Time Clock.
To install the Software run TimeClockInstall_v2017.xx.xx.xx.exe and follow the instructions.
Step 1: Welcome Screen

Click Next.



Step 2: Additional Network Settings

 

Enter URL of web service with correct server address.

http://server/AdonisWebServices/TimeClockWebService.svc



  • Where server need to be replaced by server name or IP address where Adonis Time Registration Service is installed.

Select folder where the program will store saved data (cache, logs, etc.)

  • User should have write access to this folder.

Input the location of a target panel PC.

Click Next.

Step 3: Run Mode

It's recommended to set Normal Mode option.
Kiost mode is used for security purpose (for panel PCs), in order the crew members do not run another program by chance.

  • So, this mode does not allow to start another application except Time Clock.


    If you set Kiosk Mode, please type password of a current windows user.
    It will allow Windows to make auto logon on startup and will not ask user for password.
  • If current user has no password, leave it empty.

Click Next.
Step 4: Define Install Location

Click Browse to choose destination folder to install the program.
Click Install.


Step 5: Finish

Click Next.

You can set Run the program option immediately after installation.

  • It's optional.


    Click Finish.


Upgrade


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

  • By manual run of TimeClockInstall_v2017.xx.xx.xx.exe file; see below steps


  • To upload special update file and schedule an automagical upgrade from APP, for details click here



Step 1: Save and run exe. file. Welcome Screen

Click Next.


Step 2: Select Update TimeClock option

Click Update.


Step 3: Completing upgrade process

Click Next.

You can set the option to Run the program immediately after upgrading.

  • It's optional.


    Click Finish.


Un-Installation

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.

  • Follow the on-screen instructions.


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

Configuration


After installation, Time Clock configuration can be done in 2 ways:

  • From panel PC (with admin credentials);
  • Via Time Clock Maintenance tool (in APP).


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

From the Panel PC


To access the Configuration screen (for administrators only), log in with pin number 0000 and default password: 1266472012

In Config Window you can see cache, HTTP Communication Log, Time Registration Queue and Program Settings.

  • It is also possible to change certain settings (general, network, card reader) from the Administrator Setup in the APP.


Once approved, the TimeClock displays the Сonfiguration screen, like below:

 

 

Configuration tabs.

Tabs display log and cache files.

See details in below sections.

General Settings

 

 

 

 

 

 

 

Available from Administrator
Portal

 

Use this option when displaying the application on a panel PC in Kiosk Mode.
You can remove the standard windows form. If you use the application on desktop, you can switch this off to display the standard windows border.
Default value: True

 

Description: Stay Config window on top.
It can be helpful to look at logs while using application.
If switched off, the Config window can disappear in the background. When using a panel PC, this window will disappear when the main application gets in focus.
Default value: False

 

Description: Hide mouse cursor when mouse is above application (for touch screens of panel PC).
Switch this on when running on a laptop.
Default value: False

 

Prevent the panel PC from disabling the screen or turning on sleeping mode.

 

Description: Path to folder where application data will be saved. Application must have write/read access to this folder.
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 up and running again.

  • You can check contents of the cache at Pin Cache, Work type Cache and Time Zones tabs.

 

To decide from where take time zones settings, from panel PC (Windows) or from time zones table.
When this option is switched on, it checks the server what time zone to use.
If switched off, the panel PC needs to be reset manually. The Time Clock uses local time onboard when registering the time clock transactions.
The time zone table contains the information when moving the clock back or forward.

 

Enable Gangway option allows Gangway registrations (sign on/ off or offshore visit).

For more details about Gangway Functionality, click the following link Gangway

 

You can select which skin to use.

  • Adonis can customize a skin if needed.
    Default value: 1

 

After entering the time, the system shows a confirmation or thank you screen.
Use this option to define how long this screen will be visible.

 

Location, free text field to identify the location of the Time Clock.
Admin Pin: This is the pin to access the configuration screen.
Default value: 0000

  • 0000 is a pin that is not used in the Adonis Personnel Manager.

    We recommend not to change this setting.
    Or this pin should begin with '0' not to intersect with APM.
    Description: Access code of Admin Pin to get access to Config window.
    Default value: 1266472012
    You can change password here.

 

To exit the Time Clock when running it on a panel PC.

 

 

Brings you to on-line User TimeClock Instructions.

 

 


Network Settings

 

 

 

 

 

Available from Administrator
Portal

Description: URL of Crew Portal web services.
URL, it is used to communicate with the Adonis Database.
Default value:

http://server/AdonisWebServices/TimeClockWebService.svc


  • You need to install the Adonis Personnel Portal to activate this web service.

Description: Specifies time (in milliseconds) the application waits for server reply before it starts using offline cache to update user interface and allow user to continue input on the next screen.
Default value: 500

Description: Time in seconds. Interval of cache refresh.
The Timeclock will wait between refreshing the cache. The cache exists out of currently onboard Crew Members (pin and passcode), time zone and work type settings.
Default value: 900

Description: Time in seconds. Interval of cache retries to refresh after update was failed.
Default value: 30

Description: Time in seconds. It is interval before the next attempt of queued requests will be send if previous attempt was failed.
If the Time Clock is used without any server connection, the system will try to send the queued or cached entries every x number of seconds.
Default value: 30

Description: Sync Settings interval. This sets the number of seconds the Time Clock checks the server for any configuration settings.

  • It is possible to change the configuration settings via the Adonis Personnel Portal administrator login.
    Default value: 60


Card Reader Settings


This screen allows you to set the various options:

  • how to communicate with Card Reader;
  • where the information is stored on the magnetic strip.

 

 

 

 

Available from Administrator
Portal

Card Reader Settings
Card reader debug mode
Description: All read data from card will be displayed on main screen if this parameter is True.
Debug mode allows you to see input string coming from the magnetic strip.
Default value: False

 


Require password if card used
Description: Application will ask for access code after card was read if this parameter is True. Otherwise, next screen will be shown without checking access code (allows the end user to swipe the card and skip the passcode selection screen).
Default value: False

Log card reader events to log
If set, all card reader events will be logged in the log file.

Pin extraction parameters

Line number
Description: Line on card where pin is.
Define what row of the magnetic strip (1 to 3) contains the pin number.
Default value: 0

Use start position and length to determine where in the line or row the pin number can be found.

Start Position
Description: Number of character on card where pin begins.
Default value: 4

Length
Description: Length of pin on a card.
Default value: 3

 

Serial Port Input Settings: If the card reader is connected to the panel PC via a com port, then this is the place where you can configure the com port.

  • Check with supplier of the card reader what com port settings to use.

Keyboard Input Settings. If the magnetic input is sent via the keyboard buffer, then switch this option on.
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:

  • Key A;
  • Key B;
  • MAD Application Identifier;
  • TimeClock Sector.

 

 

 

 

Available from Administrator
Portal

On the left you can find the MIFARE reader settings.

You can select between several card reader models:
1) Enable MIFARE Card Reader and choose the correct card reader below.

2) Enable MD150 MIFARE Card Reader and choose the correct Port name.

3) Enable ZCS100 MIFARE Card Reader (does not have option to Format TimeClock sector).
If you use this card reader, please note that when crew is swiping, it's needed that timeclock window will be in focus/active (it works like 'keyboard'; what window is active, where the data from card is inputted).

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.
The application identifier is used to find the sector used by the timeclock.
There is the card supplier, for example: LabelCraft, that needs to give the customer the application id that can be used by the time clock.
It is not required to use MAD/sector 0, in this case the Time Clock needs to know the sector to write and read the pin number from.
Again, it is the 3rd party supplier that needs to supply the free sector.

So,

  • If the MAD is used, then enable Look for TimeClock sector in MAD option and enter the MAD Application identifier in hexadecimal (it is needed to find the sector where the pin number is located).

    Read Key A, the security key is needed to access sector where PIN is stored (read the data).
  • Key A should be in hex format


    Data Prefix - the prefix is used to ensure that we are actually reading a pin number and not just 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 Time Clock sector and identify the sector that will be used (value from 1 to 16).


    Pin is in ASCII format
    Enable this option if pin is needed to be read in text format or clear it if in decimals.

MIFARE program settings
On the right side you can find the configuration settings needed to program the RFID card.
Set the Program Time Clock Sector check-box and enter 2 keys:
Key A (only with this key we can read information from sector where pin is stored)
Key B (this information is given by the 3rd party supplier).

Format TimeClock Sector (Use this only if the cards are not in use by any other supplier).
Each sector has 2 keys to be read (A, B)
You can format/change these access keys.

The keys in the Before Format A/B fields are used to write the sector for the first time.
It then will encode the sector with the keys found in TimeClock Sector A/B.


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 3rd party suppliers.
See Working with RFID Card section below.

Working with RFID Card


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 3rd 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:

Click Yes.


On the next screens, enter your PIN number and year of birth:


Follow instruction:

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:

Here we can find Pin and Name.
Access Denied:

  • If True – the crewmember could not manage to log in;
  • If Fasle - the crewmember logged in successfully.


    Crew Portal User:
  • If True – the crewmember has account in APP (record is in WEB_CP_ACCOUNT table);
  • If Fasle - the crewmember has account in APP.


    You can search by pin/name.
    We can see that now there are 410 pins (in Total) in the list with 4 wokrtypes; last/next cache update date/time.

    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 Portal.



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:

The active/in use Time zone is highlighted green.

  • 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'.

The queue contains Work Start Time, Pin, selected Work type, Status, number of Attempts and detailed information why the request was not uploaded to the server (with waiting Status) or if the registration succeeded after server became online (Sent status).

  • 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:



















Centralized Maintenance (APP)

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

  • You must have admin rights.

Start the Administrator Portal and go to tool:

 

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, Network Settings, 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.).
    Offline TimeOut – 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: Offline TimeOut 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).|



    TimeClock Update

    You have a possibility to schedule the upgrade of time clock(s) remotely via APP.
    You need:
  1. Save update file locally;
  2. Upload it into APP;
  3. Schedule an upgrade.


Step 1: Save the file
Go to FTP > UpdateViaMaintainTool folder, save the special update file like:

  • It differs from common exe. file by absence of 'install' part of the name:



Step 2: Upload the file
To upload an update file, please go to screen:

Click Browse to upload needed files (exe.), previously saved in your local folder.
Click Upload button.
This file will appear in the list.



Step 3: Schedule
The upgrade is scheduled using the Update function under Timeclock Overview > Update tab:



Update screen:

Enter the Date and time you want the TimeClock (selected on overview screen) to be upgraded.
Select the update file.

  • Special update file needs to be previously saved/uploaded to appear in the drop-down list.


    Click Update to save your settings.

    This day/time selected timeclock(s) will be silently upgraded.

  • Only if timeclock is on-line.


  • If it's offline for some reason, upgrade will be performed immideatly after it backs on-line.



  • No labels