About Humanforce.LocalService (HFLS)
Humanforce.LocalService is a Humanforce software component which can be installed on PCs which need to use vein scanning and/or badge printing functionality. Throughout this document, Humanforce.LocalService will be referred to as HFLS.
HFLS runs as a Windows service on client machines, and acts as a bridge between the web browser and the local system hardware (i.e. Hitachi scanner device and local printers, and any other hardware integrations in the future).
Installation
To install the software, run the version specific HFLS Setup file provided by Humanforce Support. This setup package contains everything required to configure the hardware for use with Humanforce. The software is compatible with all Windows-based operating systems starting from Windows XP. Note that Administrator-level access may be needed by the installer for some steps of the process.
NOTE: Never install this software on the web server, or any machine which will not have a vein scanner or badge/wrist band printer directly attached physically. It serves no purpose on a these types of machines.
During installation of HFLS you have the option to download and install the following pre-requisite components:
- The Hitachi device drivers
- The Hitachi SetPin utility
The Installation process is straight forward, run the .exe you have downloaded and you will be prompted with the following: (Please note that the version number may vary)
Click Next >
Choose Full Installation from the drop down box and select Next > then Install.
If you now open Services.msc, you will find HFLS. This should be show in the status of running. The service startup type will be set to Automatic to ensure that when your device is restarted, the service starts alongside it.
Creating the Start-up Shortcut
- Open the start-up directory
- Hold windows key + R
- Type the following without quotation marks: ‘shell:startup’
- Right click and create a new shortcut in the start-up folder
- For Chrome (version 72.0.3626.109):
- Please use the following as the target of the shortcut, replacing ‘humanforce.com’ with your instance of HumanForce:
"C:\Program Files (x86)\Google\Chrome\Application\chrome.exe" --chrome --fullscreen --kiosk humanforce.com - Please keep in mind that you may need to alter the target to correctly reference the local chrome installation
- Please use the following as the target of the shortcut, replacing ‘humanforce.com’ with your instance of HumanForce:
- For Chrome (version 72.0.3626.109):
- Save the shortcut (normally called ‘Humanforce Start-up’)
- For IE:
- Please use the following as the target of the shortcut, replacing ‘humanforce.com’ with your instance of Humanforce:
"C:\Program Files\internet explorer\iexplore.exe" -k humanforce.com
- Please use the following as the target of the shortcut, replacing ‘humanforce.com’ with your instance of Humanforce:
- For IE:
- Open the shortcut and ensure the webpage opens in full screen mode.
Note: If Chrome is already running, Chrome may not start in kiosk mode.
Machine Registration
For security purposes, each remote machine which performs biometric identification must be registered with the server.
- Log in to Humanforce as an admin user (user must have the TimeTarget Online \ HFLS Machine Registration permission enabled in their Access Level)
Go to Admin > Admin Config > HFLS Machine Registration
If you are unable to see or access the HFLS Machine Registration option contact TimeTarget Support to enable access.Enter a comment to describe which machine is being registered, then click Submit.
Make sure you receive the green “Registration successful” message. Return to the login screen and check that the vein scanning service is functional.
HFLS Usage in Humanforce
The HFLS service is used from the following Humanforce pages:
- Login screen, both Kiosk and ESS (Hitachi automatch)
- Finger vein registration screen (from both the dedicated registration screen and also employee management)
- System settings page (for configuration and testing of the badge / wrist band printers)
- Clocking screen (for printing of badges / wrist bands)
HFLS Troubleshooting
HFLS works on a local connection created via the Windows Host file, creating a local connection for humanforce.local directed to 127.0.0.1 and the default port connection is on port 16665.
Proxy configuration and firewalls may cause issues connecting to humanforce.local on port 16665 so firewalls and proxy configuration must be reviewed if errors are received when starting Humanforce (example below).
The below error will occur if the browser is unable to contact the local service on port 16664. The possible causes for this are: -
- HFLS is not installed
- The humanforce.Local is not running
- Firewall/Proxy rules on the machine are preventing the port 16665 connection to humanforce.local (127.0.0.1). Note that 3rd party anti-virus/firewalls may also cause this connection to be blocked.
In addition, the installer can fail where kiosks have been joined to a domain and the domain user account does not have permission to install software. You can quickly check the domain by running the below command in command prompt:
If the domain is anything other than the local PC name, it is joining a domain and may cause future issues.
Additional Information for Proxy Servers
If your network uses a proxy server that requires authentication, further configuration may be required to ensure the HFLS has the ability to authenticate on the user account under which is it running. To achieve this:
- Ensure the PC is logged on (and will continue to be logged on with) a user account that is authenticated for the proxy
- In Windows, open the Local Security Policy
- Go to Local Policies -> User Rights Assignment -> Log on as a service
- Add the user which the PC is logged on as into the list of users and groups allowed to logon as a service
- In Windows, open the Services
- Find HFLS and double click to edit
- Go to the Log On tab
- Set to `This account’ and configure the user account & password the PC is logged on as
- Restart the PC to ensure all settings are applied, and check HFLS has started in Services
IP Mapping & Location Override
In order for Kiosk mode to start by default, it must be configured to a location and this can be achieved by either mapping the static IP Address or with a location override. IP Mapping is the default (and preferable option) as it is more reliable. Creating an IP Mapping instructs the Humanforce server that requests coming from a particular IP are mapped permanently to a specific location.
IP Mapping
In Humanforce, under the Admin settings, select Admin Config, then IP Mappings.
The IP you should map is the IP that the Humanforce server will receive web requests from. In most cases this is the external / public IP of the internet connection. This IP can be obtained by visiting whatismyip.com or another IP provider website.
If mapping an external IP, for example, 131.181.251.21 to 131.181.251.21 would be used as the From and To IP, and then the location of that connection would be selected. Click Add once completed. All requests from that IP will now be in kiosk mode.
Sometimes you may require mapping of an IP range, when devices are on a business LAN/VPN/WAN. If you are unsure please contact your IT Department or Humanforce Support.
Please note that when using IP Mapping, all devices that on the network accessing Humanforce will open in Kiosk mode. If you have a dynamic IP address, IP Mapping will not work; a location override will then be required.
Location Override
An alternative to IP Mapping, or in conjunction with, you can override the current location, which stores the location information in the web browser cache. This is machine specific and allows you to access Humanforce in kiosk mode or ESS mode on devices using the same IP address. This method offers more flexibility but will reset when browser cache is cleared.
In Humanforce, under Admin settings, select System Config, then Override Current Location Selection.
This will inform you of the current configured location and allow you to change the current location for the terminal.
Please note that as this information is stored in the web browser cache, it is specific to that browser. If multiple web browsers are potentially used on the machine, all browsers must be set independently, and if the cache is cleared the location override must be completed again.
Once the HFLS service is running, and the mapping is complete, log off Humanforce and you should be ready to use in kiosk mode. For any assistance, please contact Humanforce support.