RM ServiceInterface 202002 en

Service Interface
Reference Manual
04045682 - 02/2020
EN
dormakaba EAD GmbH
Albertistraße 3
78056 Villingen-Schwenningen
Germany
T: +49 7720 603-0
www.dormakaba.com
Company headquarters: Villingen-Schwenningen
Copyright © dormakaba 2020

All rights reserved.
No part of this document may be reproduced or used in any form or by any means without prior written permis-
sion of dormakaba Schweiz AG.
All names and logos of third-party products and services are the property of their respective owners.
Subject to technical changes.
04045682 - 02/2020
Reference Manual Table of contents
Table of contents
1 About this document 5
1.1 Validity 5
1.2 Target group 5
1.3 Contents and purpose 5
1.4 Additional documentation 5
1.5 Orientation in the document 6
1.6 Notes 6
2 Service interface 7
2.1 Purpose and function 7
2.2 Use of the service interface 7
3 Access to service functions 8

3.1 Access via the network 8
3.2 Direct access 8
3.3 Supported browsers 8
3.4 Opening the service interface 9
3.5 Login 10
3.6 Basic structure 10
3.7 Selecting the language 10
4 Service functions 11
4.1 Overview of the service functions 11
4.1.1 ‘System’ menu group 11
4.1.2 ‘Settings’ menu group 11
4.1.3 'Firmware' menu group 12
4.2 Basic operation 12
5 System functions 13
5.1 Information/System Information 13
5.2 Information/Statistics 13
5.3 Licence 14
5.3.1 Extension of the licence 16
5.3.2 Adjustment of the licence when service is required 16
5.4 Licence/Test Licence 16
5.5 Diagnosis 17
5.6 Administration 17
5.6.1 Terminal restart 17
5.6.2 Resetting SSH key 17
5.7 Reboot 17
6 Settings 18
6.1 Network settings 18
6.1.1 Requesting an IP address from the DHCP server 18
6.1.2 Requesting an IP address from the DHCP server on the basis of
the terminal name 19
6.1.3 Assigning a permanent IP address 19
6.2 WLAN Settings 20
6.3 Host settings 21
6.3.1 Communication via Ethernet/UDP 21
6.3.2 Encryption 22
6.3.3 Host registration 22
6.3.4 Communication via Ethernet/XML 22
6.3.5 Basic Authentication 23
6.3.6 Group identification and device identification 23
04045682 - 02/2020 Service Interface 3

Table of contents Reference Manual
6.3.7 Proxy server 23

6.4 FTCS host settings 24
6.5 CardLink host settings 24
6.6 Reader settings 25
6.6.1 Reader type 25
6.6.2 Interface 26
6.6.3 Guard time 26
6.7 Add-On 26
6.8 Biometric settings 27
6.8.1 Preset Enroll 27
6.8.2 Preset Booking 27
6.8.3 Biometric mode 28
6.8.4 Sensor sensitivity (Proximity Scale) 28
6.8.5 Standalone mode 28
6.9 Date and time 29
6.10 User management 29
6.11 Screen settings 30
6.11.1 Display management 30
6.11.2 CBM proximity sensor 31
6.12 HR-Client 32
Index 33
4 Service Interface 04045682 - 02/2020

Reference Manual About this document
1 About this document

1.1 Validity
The service interface is part of the BaseApp of android-based terminals and of the B-Client
AC30 terminal software of access managers.
This documentation describes the functions of the service interface from the following ver-
sions:
• BaseApp version 771-07-X-K00

• B-Client AC30 version 669-04-X-K00
1.2 Target group

This documentation is addressed to specialists for start-up and service of dormakaba devices.
The descriptions are intended for already trained personnel. They cannot replace product
training.
1.3 Contents and purpose

All service functions and their parameters are described in detail. The descriptions are de-
signed to ensure correct start-up of the relevant dormakaba products.
1.4 Additional documentation

For information on the respective device, please refer to the technical manual and the refer-
ence manual of the terminal software.
Additional documentation is available on the Internet at the dormakaba website. The tech-
nical manuals are located in a protected area. They can be accessed via the user account of
trained professionals. However, you can also create a temporary account.
https://www.dormakaba.com/extranet-emea-en

About this document Reference Manual
1.5 Orientation in the document

This document contains the following features to help find specific topics:
• The table of contents at the beginning of the document offers an overview of all topics.
• The header contains the associated main section.
• Cross references indicate the number of the section containing additional information.
Example [ 5.7].
• An index in alphabetical order is given at the end of the document.
1.6 Notes
Notes marked with symbols must be observed in particular.
Application tips, useful information

They allow optimum use of the product and of their functions.
NOTICE
Important information on the correct use of the product.
Failure to comply with these instructions could lead to malfunctions. It is possible to damage
the product.

Reference Manual Service interface
2 Service interface
2.1 Purpose and function
The service interface provides the functions that are required for start-up, maintenance, and
diagnostics of the device.
The service interface is provided by the web server integrated into the device. Access takes
place via the network connection of the device, either directly or via the network. For direct
connection, an Ethernet cross-over cable (crossed RJ45 cable) or an Ethernet patch cable 1:1
can be used (Auto MDIX).
The service interface can be accessed from a service PC via a web browser by typing the
device IP address into the address box.
2.2 Use of the service interface

The service interface is used in different devices of the current product series. Some functions
can only be applied in combination with appropriate hardware. The descriptions of these
functions are provided with notes to that effect.
The service interface is part of the BaseApp. It is used in the following android-based termin-
als.
• Terminal 96 00
• Terminal 97 00
The Web server service on the terminal can be be enabled- disabled by settings of the ter-
minal software (TA command record). Access to the service interface is only possible if the
Web server is active.
The SFTP server (SSH server service) on the terminal can be enabled- disabled by settings of
the terminal software (TA command record).
The service interface is part of the B-Client AC30 terminal software

from version 669-01-X-K00 used in the following access managers:
• Access manager 92 00

Access to service functions Reference Manual
3 Access to service functions

3.1 Access via the network
Communication can take place via any system (service PC) within the network.
The device must already have a valid network configuration, and it must be possible to access
it via the network.
If the IP address of the device is unknown, the following measures can be taken.
Devices equipped with display (terminals)

Option 1: Switch device off and on again, the IP address will be displayed during the starting
phase on the display, for example.
Option 2: Display the settings of the terminal software by pressing the menu key. The IP ad-
dress will be shown on the display, for example.
Devices without display (access manager)

Option 1: Set device to the default IP address 123.0.0.2.
Option 2: Determine or assign IP address using the Device Discovery Tool. This is only possible
if the device is waiting for host registration, indicated by red/green flashing LEDs.
The Device Discovery Tool is available for download at the dormakaba site in the secured
area.
3.2 Direct access

For initial start-up, the service PC can also be connected to the device directly via an Ethernet
cable. The following cables can be used:
• Ethernet cross-over cable (RJ-45 cross-over cable)

• Ethernet 1:1 patch cable
3.3 Supported browsers

The function of the service interface is secured when using the following web browsers:
• Internet Explorer from version 8

NOTE: Under Tools/Developer tools, set the mode to Edge or 10.
• Firefox from version 42
• Google Chrome from version 37

Reference Manual Access to service functions
3.4 Opening the service interface

Enter URL in the address window of the browser:
Format Example
https://<IP address>:8443 https://10.10.14.240:8443
The browser may report that the certificate is not trustworthy after the first call. In this case,
confirm that the page is trustworthy and can be displayed.

Access to service functions Reference Manual
3.5 Login
After loading the service interface, your are prompted for your user name and password.
The following users have been stored as standard:
User name Password
admin admin
root root
For security reasons, the standard passwords should be changed.
After login as user ‘root’, both passwords can be changed using the ‘User management’ func-
tion.
3.6 Basic structure

After successful login, the service functions are available.
1 Display of the respective device type (HR) or terminal software (AC)

2 Main menu for selection of the desired function
3 Dialog area of the respective function
3.7 Selecting the language

The desired language can be selected via the globe icon.

Reference Manual Service functions
4 Service functions
4.1 Overview of the service functions
4.1.1 ‘System’ menu group
Chapter Function/Description
5.1 Information/System Information

Information about device hardware and software and display of IP address and
MAC address
5.2 Information/Statistics
Time since last system start and memory usage.
5.3 Licence/Licence
Displays the software licence.
5.4 Licence/Test Licence
Generates a temporary test licence.
5.5 Diagnosis/Log Overview
Access to current logfiles
5.5 Diagnosis/Current Logs
Reading of the current log stream
5.5 Diagnosis/Support Information
Downloads support information
5.6.1 Administration/Terminal Restart
Restarts the device.
5.6.2 Administration/Reset SSH Key
Resets SSH key to Kaba default.
4.1.2 ‘Settings’ menu group

6.1 Network/Ethernet Settings

Settings for communication via network.
6.2 Network/WLAN Settings
Settings for communication over wireless networks.
6.3 Netzwork/Host Settings
Definition of the host computer.
6.4 Netzwork/FTCS Settings
Definition of FTCS (Finger Template Control Server).
6.5 Netzwork/CardLink Settings
Definition of the CardLink host.
6.6 Reader/Reader
Configuration of the connected readers.
6.7 Add-On
Activation of Add-On 9600-K6 (only terminal 96 00)
6.8 Biometrics/Biometrics
Settings in connection with a biometric reader.
6.9 Date and time
Date and time settings.

Service functions Reference Manual
6.10 User Management/Change Passwords

Changing user passwords.
6.11 Display Management/Screen Settings
Settings for controlling the display brightness and the proximity sensors.
6.12 HR-Client
Functions for devices with B-Client HR30 terminal software
4.1.3 'Firmware' menu group

Firmware download
Update of the Add On 9600-K6 firmware (accessory of terminal 96 00).
4.2 Basic operation

Accessing individual service functions
The individual service functions are accessed via the menu on the left.
Buttons within the functions
Cancel function, discard entries
Empty input fields
Apply entries and quit the function
Set to default values

Reference Manual System functions
5 System functions
5.1 Information/System Information
In this function, important system information, such as device type, versions of the software
used, MAC address and IP address of the device, is displayed.
Example:
5.2 Information/Statistics
Displays the runtime since last system start and the usage of the internal memory.
Example:
Explanations:
up time = total runtime of the device since last system start

idle time = time during which the processor was idle
sleep time = time during which the device was in Standby mode

System functions Reference Manual
5.3 Licence
Display of the current terminal software licence
Example:
The usable range of functions of the device is given by the options activated in the sop.ini li-
cence file by means of the corresponding licence key.
The licence file is only valid on the device having the entered MAC address. Any manual
change to the contents of the file will render the licence void.
From the parameters, you can determine which functions are enabled.
Depending on the device, the licence file can contain the following entries:
Sections
Section Meaning
[B-Client HR15] Section of the corresponding terminal software Each of these

[B-Client HR20] section contains the entries of the corresponding software op-
[B-Client HR30] tion.
[B-Client AC15]
[B-Client AC30]
[Licence] The parameters of this section define the validity of the licence.
[TestLicence] The parameters of this section refer to a temporary test li-
cence.
Parameters for the terminal software

The following parameters show which terminal software has been licensed on the device.
Each parameter has the value true or false.
Entry Meaning
BClientAC15Enabled= Licence for the B-Client AC15 terminal software.

BClientAC30Enabled= Licence for the B-Client AC30 terminal software.
BClientHR15Enabled= Licence for the B-Client HR15 terminal software.

Parameters for the software options
Entry Meaning
BufferConfiguration= Memory option
Defines the disk space for the individual data re-

cord types.
Possible values: 0-4 depending on device
For details, please refer to the technical manual

of the device.
Subterminals= Number of supported subterminals
Possible values: 0-16 depending on device
The following parameters each have the value true or false.
Entry Meaning
CardLinkEnabled= CardLink function

EncryptionEnabled= Data encryption via UDP and HTTPS
AccessControlEnabled= Door control (in time and attendance terminals)
LocalEnrollmentEnabled= Registration of new fingerprints via the biometric
reader locally at the terminal.
PartnerInterfaceEnabled= Supports partner applications.
NativeAppEnabled= Start of native apps by the terminal software
Browserenabled= Browser start by the terminal software
AVISOEnabled= AVISO extensions
Other parameters
Entry Meaning
ReplacementEnabled=true Replacement device supplied by Kaba
This device must be commissioned via the 1-click

replacement method.
Licence-related parameters
Entry Meaning
ExpiryDate= Validity date

Key= Licence key
MAC= MAC address
CreationDate= Date on which it was created
Test-licence-related parameters
Entry Meaning
TmpLicKeyCnt= Indicates how many times a test licence can still

be created on this device.
TestLicenceEnabled=true This licence file is a temporary test licence.

System functions Reference Manual
5.3.1 Extension of the licence

The range of functions can be extended by purchasing a terminal software update. In this
case, the existing licence file must be replaced with the newly purchased licence file via SFTP.
The sop.ini licence file is located in the following directory:
Terminal software Directory path
B-Client AC15/HR15/HR20/HR30 /data/data/com.kaba.apps.hr/files/init

B-Client AC30 /home/admin/Program/Share/Init
5.3.2 Adjustment of the licence when service is required

If the CPU of the device is replaced when service is required, the existing licence file becomes
void. In this case, the old licence file must be replaced with a licence file adjusted to the new
MAC address.
The adjusted licence file can be generated online in the dormakaba Extranet.
.
After entering the old and new MAC addresses, the adjusted licence file can be downloaded.
The range of functions is taken from the old licence, only the licence key is adjusted to the new
MAC address.
Condition:
The replaced component must be received by the dormakaba Repair Department for repair
within 4 weeks, otherwise you will be invoiced for the new licence file.
5.4 Licence/Test Licence

This function allows you to generate a temporary licence key. This test licence allows you to
use all options.
The licence key will be valid for 7 days. After the validity has expired, the terminal software
can no longer be started.
An already existing unlimited licence file will be backed up as ‘sop.bak’.
A total of five time-limited licence keys can be generated. By using an unlimited licence file,
this counter will be reset.
This function is only available for access managers equipped with B-Client AC30 terminal
software. If no licence file is available, android-based terminals will automatically generate a
test licence that is valid for 20 days.

5.5 Diagnosis
The diagnosis functions allow access to system logfiles.
For problem solution, logfiles must in many cases be evaluated by the dormakaba Support.
When service is required, logfiles must be made available to the dormakaba Support upon re-
quest.
Logs overview
Overview of the logfiles generated by the terminal software
Current logs
Logfiles generated by the operating system
Support information
Generates a zip file containing all logfiles and configuration files.
This support information is usually requested by the dormakaba Support for problem solution.
5.6 Administration
Android-based devices only.
5.6.1 Terminal restart

This function can be used to restart the device, for example in order to apply changed network
settings.
5.6.2 Resetting SSH key

This function can be used to reset the SSH key to default.
If required, the current SSH key can be downloaded by the device.
The SSH key is required for access via SFTP.
The default SSH key (SFTP security file) can be downloaded from the dormakaba Extranet.
5.7 Reboot
Devices with B-Client AC30 terminal software only
This function can be used to perform a restart or cold start of the device.

Settings Reference Manual
6 Settings
6.1 Network settings
6.1.1 Requesting an IP address from the DHCP server

1. ‘Activate DHCP’ option
2. ‘Send’ button
3. Performing a restart [} 5.6.1]
ð The network parameters are displayed.
ð If no DHCP server can be reached, an auto IP address is generated and assigned.

Reference Manual Settings
6.1.2 Requesting an IP address from the DHCP server on the basis of the
terminal name
Not possible with android-based devices.
1. ‘Activate DHCP’ option

2. Enter terminal name and terminal domain name according to RFC 1123.
3. Enter the IP address of the DNS server in the ‘DNS Server Address 1’ input field. Enter
0.0.0.0 if no DNS server should be used in the network.
4. Enter the IP address of the second DNS server in the ‘DNS Server Address 2’ input field.
Enter 0.0.0.0 if no second DNS server should be used in the network.
5. Press the ‘Send’ button
6.1.3 Assigning a permanent IP address

1. Activating ‘Static Network Configuration’ option
2. Enter the desired IP address of the device in the ‘Terminal IP Address’ input field.
3. Enter the network mask in the ‘Net Mask’ input field.
4. If device and host are located in different network segments, the IP address of the gate-
way connecting the network segments must be entered in the ‘Gateway’ input field. Enter
0.0.0.0 if no gateway is present.
5. Enter the IP address of the DNS server in the ‘DNS Server Address 1’ input field. Enter
0.0.0.0 if no DNS server should be used in the network.
6. Enter the IP address of the second DNS server in the ‘DNS Server Address 2’ input field.
Enter 0.0.0.0 if no second DNS server should be used in the network.
7. Press the ‘Send’ button

6.2 WLAN Settings

This function is only available for terminals with optional WLAN module.
Set up Wi-Fi connection

1. Enter the name of the WLAN network in the SSID field.
2. Enter the network key in the Passphrase field.
3. Select DHCP or Static network configuration.
ð For static network configuration, also enter the network parameters.
4. Apply entries with 'Submit'.

6.3 Host settings

Setting the communication type and defining the host computer
6.3.1 Communication via Ethernet/UDP

This is the default communication type in connection with the B-COMM communication soft-
ware.
1. Set the communication type ‘UDP’.

2. Enter the IP address of the computer you want to communicate with the terminal soft-
ware in the ‘Host Name or IP Address’ field. If a DNS has been configured, it is also pos-
sible to enter the host name in this field.
3. Enter the UDP port to be used for communication in the ‘Port’ field. Hexadecimal values
must be prefixed by ‘0x’. Possible values are 0x7700 to 0x77EF.

6.3.2 Encryption
This function is used to activate or deactivate data encryption via Ethernet.
Using this function requires the presence of a suitable licence.
6.3.3 Host registration

This function allows start-up of the terminal to take place largely automatically. After switch-
on, the device reports cyclically to the B-COMMs that are active in the network and is re-
gistered by them.
6.3.4 Communication via Ethernet/XML

This type of communication is used by HTTP/HTTPS based applications, such as b-comm erp5
from version 5.2 or EACM.
1. Set the communication type "http/XML".

2. Enter the IP address of the computer you want to communicate with the terminal soft-
ware in the ‘HTTP Server’ field.

6.3.5 Basic Authentication

Only possible with terminal 97 00.
These settings are required if the terminal is logged on to the host using Basic Authentication
in accordance with RFC 2617.
User and password for Basic Authentication. Leave fields empty if Basic Authentication is not
used.
6.3.6 Group identification and device identification

Addressing of a device takes place via the group identification and device identification. This
identification is part of each parameter record and data record.
1. Enter the group identification in the ‘Group ID (GID)’ input field.

2. Enter the device identification in the ‘Device ID (DID)’ input field.
Value ranges: GID: 00 to 29, DID: 00 to 59.
In connection with the B-COMM communication software, the following must be observed
when assigning the device identification GID:
For devices with connected subterminals, the device identifications must be assigned in steps.
The device identifications in-between are reserved for subterminals.
• Assign device identifications for access managers with up to 4 subterminals in steps of 5,

i.e. 0/5/10/15, etc.
• Assign device identifications for access managers with up to 8 subterminals in steps of 10,
i.e. 0/10/20, etc.
• Assign device identifications for access managers with up to 16 subterminals in steps of
20, i.e. 0/20/40, etc.
6.3.7 Proxy server

If a proxy server is used:
1. Activate ‘Use system proxy server’.

2. Enter proxy server name or IP address and port.

6.4 FTCS host settings

Definition of FTCS (Finger Template Control Server).
These settings are required if subterminals with biometric reader have been connected (ac-
cess manager) or if the device has an internal biometric reader.
The FTCS service can be made available by the host server defined under’Host Set-
tings’ [} 6.3] or by a separate host server. The settings are required in both cases.
1. Enter IP address of the computer on which you want the FTCS service to run (B-COMM
server). If a DNS has been configured, it is also possible to enter the FTCS host name in
this field.
2. Select the UDP port to be used for communication in the ‘Port’ field. Hexadecimal values
must be prefixed by ‘0x’. Default=0x7800.
6.5 CardLink host settings
This function is not available in android-based devices.
Definition of CardLink Host.
The settings are required if a separate host server is used for distributing the CardLink-spe-
cific parameters and registration records. The settings are not required if the host server
defined under ‘Host Settings’ [} 6.3] is also used for distributing the CardLink-specific para-
meters and registration records.
1. Enter IP address of the host providing the CardLink data. If a DNS has been configured, it
is also possible to enter the CardLink host name in this field.
2. Select the UDP port to be used for communication in the ‘Port’ field. Hexadecimal values
must be prefixed by ‘0x’. Default=0x7700, possible values: 0x7700-0x77EF.
Encryption
The function UDP encryption is optional. Using this function requires the presence of a suit-
able licence.
The ‘Enable Encryption’ check box can be used to enable or disable encryption via Ethernet
UDP.

6.6 Reader settings
This function is not available for access managers.
Configuration of the internally and externally connected readers.
These reader settings correspond to the device configuration at the time of delivery. The func-
tion is usually only required if an external reader is connected at a later stage or if LEGIC is
switched over to MIFARE in connection with an MRD reader.
6.6.1 Reader type

Depending on the device, up to three readers can be configured. The reader type connected to
the respective interface is set under ‘Type’. If no reader is available, ‘NONE’ must be set as
reader type.
Type Supported readers
NONE No reader connected

LEGIC MRD reader in LEGIC mode
MIFARE MRD reader in MIFARE mode
BIOMETRIC_CBM Biometric CBM reader
HID_ICLASS_SE_PROX HID iCLASS SE / prox reader
BARCODE Barcode, CCD barcode scanner
MAGNETIC Magnetic swipe, Baltech MIFARE, Hitag
SPECIAL2 Reader with serial FLI2/FLI3/FLI4
SPECIAL Reader with serial FLI
TRANSPARENT Special applications
LEGIC_4200 (deprecated) MRD reader in LEGIC mode (see note below)
MIFARE_4200 (deprecated) MRD reader in MIFARE mode (see note below)
Devices with MRD reader (multi-reader device)

Devices with MRD reader support LEGIC or MIFARE media, depending on the reader type set.
For LEGIC media, the ‘LEGIC’ reader type has been factory-preset.
For processing MIFARE media, the reader type must be changed to ‘MIFARE’.
LEGIC media are configured via the files ‘mediaact.ini’ and ‘mediadef.ini’.
MIFARE media are configured via the ‘system.ini’ file.
When using older B-COMM versions < 4.1.0, the reader types LEGIC_4200 (deprecated) or
MIFARE_4200 (deprecated) must be used.

6.6.2 Interface
To set the interface the reader is connected to.
Terminal 96 00
Internal COM interface = COM3
Interface for substructure swipe reader = USB1 (9600-K5)
Interface for substructure swipe reader = ADDON (9600-K6 with Add-On)
Terminal 97 00
The device supports up to three readers. Depending on options, the reader assignment of the
COM ports is as follows:
First internal reader Second internal reader External reader
COM2 (RFID) - COM4 or COM3 via FLI4

COM2 (reader in add on - COM4 or COM3 via FLI4
housing)
COM2 (RFID) COM1 (reader in add on COM4 or COM3 via FLI4
housing)
COM1 (CBM) - COM4 or COM3 via FLI4
COM1 (CBM) COM2 (RFID) COM4 or COM3 via FLI4
COM1 (CBM) COM2 (reader in add on COM4 or COM3 via FLI4
housing)
6.6.3 Guard time

The guard time is used to avoid accidental double bookings. After a booking, the next badge
will not be read until the guard time has expired.
The time is given in ms. Presetting = 2000 ms.
6.7 Add-On
This function is used to enable the external inputs/outputs.
As an optional accessory of the terminal 96 00 external inputs/outputs (Add on 9600-K6 and

remote IOs 9600-K6) are available.
Type Meaning
IO_MODULE To enable the external inputs/outputs

NONE To disable the external inputs/outputs

6.8 Biometric settings

These settings are used in connection with a biometric reader
6.8.1 Preset Enroll

This parameter is used for the function ‘LocalEnrollment’. This allows new fingerprints to be
registered via the internal reader of the device.
Preset Enroll is a preset value for supporting the entry of the template ID during the Enroll
and Unenroll procedures.
The preset value defines a character string displayed in the ‘Template ID’ field. When entering
the template ID, the character string is overwritten from the right. This makes it unnecessary
to enter leading zeros or leading constants, so that the template ID has a constant length in
all templates.
The length is limited to 15 digits maximum.
The parameter is stored in the system.ini configuration file, section [Reader1CBM].
6.8.2 Preset Booking

This parameter extends the template ID or the template ID entered on the keypad by a preset
value. The template ID is added to the preset value right-justified.
When entering the template ID manually, the entry of leading zeros is omitted. The presetting
generates a LEGIC-compliant booking record.
The parameter is stored in the system.ini configuration file, section [Reader1CBM].
Allowed values are the characters ‘1’ to ‘9’, ‘A’ to ‘F’ and the special characters ‘:’, ‘;’, ‘<’, ‘=’, ‘>’
and ‘?’. There is no limit to the length of the preset value.
Example:
[Reader1CBM]
PresetBooking = 0000000002000000000000
Result:
Template ID 12345
Badge data 0000000002000000012345
The PresetBooking preset value is used in the following two cases:

• Alternative badge entry via keypad

– Extension of the data to the length according to the badge definition, for example by
a customer number
– No necessity to enter leading zeros
• ID from the CBM template
– Extension of the data to the length according to the badge definitions, for example by
a customer number
6.8.3 Biometric mode

Operation is possible in 5 authentication modes:
1 Identification
2 Verification
3 Verification by ID comparison
4 Combination of modes 1 and 2
5 Combination of modes 2 and 3
The authentication mode cannot be changed during operation.
6.8.4 Sensor sensitivity (Proximity Scale)

Sensitivity of the proximity sensor in the biometric reader.
This setting can also be made under the menu item Sensors [} 6.11.2]. For a description, see
Sensors/Biometric Proximity Sensor [} 6.11.2].
6.8.5 Standalone mode

For devices with biometric identification, a biometric software containing the Finger Tem-
plate Control Service (FTCS) is required for managing the finger templates.
Alternatively, operation without biometric software is also possible. In this ‘Standalone mode’,
all fingerprints of persons must be registered by the reader of the terminal. In this case, the
finger templates are only saved in the reader’s internal database. If they get lost, all persons
have to be registered again at the terminal.
This is why the Standalone mode without biometric software is only recommended for very
small solutions (max. 20 persons).
The ‘Standalone mode’ check box defines whether a standalone mode without FTCS is pos-
sible (activate) or not (deactivate).
If operation in standalone mode once enabled is reset, all locally enrolled fingerprints will be
deleted.
The Standalone parameter is stored in the system.ini configuration file, section [Reader-
1CBM]. Possible values 0 (not active) or 1 (active).
The finger templates of the reader-internal database cannot be read for security reasons.

6.9 Date and time

To display date and time and set them if required.
If an NTP server is available in the network, ‘NTP’ (Network Time Protocol) can be selected un-
der ‘Use Network Time’.
Enter the IP address of the NTP server in the NTP Server field.
If no NTP server is available, ‘Disabled’ must be selected. In this case, date and time can be set
manually.
NOTE: NTP is not supported by B-Client AC30.
6.10 User management

This function can be used to change the passwords for the users ‘admin’ and ‘root’.
The length of the password is limited to 16 alphanumeric characters.
The users ‘admin’ and ‘root’ are permanently stored. The user names cannot be changed, and
no further users can be added.

6.11 Screen settings

Settings for controlling the display brightness and the proximity sensors.
6.11.1 Display management
Brightness (in %)
To set the display brightness in the range from 30% to 100%.
Presetting = 70%
Reduced brightness
After a defined time without user activity, the display brightness can be automatically re-
duced.
The function is enabled or disabled via the ‘Timeout use reduced brightness’ check box.
The time until this energy-saving mode is initiated can be set in a range between 30 and 3600
seconds. Presetting = 120 seconds.
The reduced brightness can be set in a range from 10% to 100%.

Presetting = 20%
Standby
After a defined time without user activity, the terminal can be switched to the Standby mode.
In Standby mode, the display is completely dark.
To signal that the terminal is in the Standby mode ready-to-operate, the reader lighting can
be activated in a pulsed manner
The function is enabled or disabled via the ‘Use Standby’ check box.
The time until the Standby mode is initiated can be set in a range between 60 and 14,400
seconds. Presetting = 0 seconds (disabled).
By activating the ‘Pulse Lighting’ check box, the reader lighting (RFID light ring) is activated in
a pulsed manner.
The lighting duration can be set in a range between 1000 ms and 5000 ms.
Presetting = 1500 ms.

Between the individual lighting signals, a pause twice the lighting duration takes place. At a
presetting of 1500 ms, the reader lighting will be lit every 3 seconds for 1.5 seconds each.
Resetting to the normal operating state

The terminal is reset to the normal operating state each time one of the following action oc-
curs:
• A person approaches the terminal (detected by the proximity sensor)

• Touch activity
• Reader entry
6.11.2 CBM proximity sensor
Sensitivity of the proximity sensor in the biometric fingerprint reader. Possible settings:
• Disabled
• Low sensitivity
• Medium sensitivity
• High sensitivity
The proximity sensor enables the biometric reader. If the proximity sensor is disabled, the
reader must be enabled by touching a function key.
In most cases, the presetting ‘Medium Sensitivity’ ensures an optimum function of the sensor.
However, certain environmental conditions can make it necessary to adjust the sensitivity.
The setting ‘High Sensitivity’ takes up a high percentage of the system resources and may
lengthen the time of execution of background activities (e.g. downloads).

6.12 HR-Client
For android-based terminals, the following functions are available.
Restoring the last backup of B-COMM.

This function deletes the registration file. After the next system start, the terminal will be re-
gistered by B-COMM as being known. The configuration and parametrization backed up last
will be transmitted to the terminal.
Resetting the terminal software to the delivery state

The device configuration is reset to the default values. The layout is reset to the delivery state.
Customized layout adjustments will bet lost.
Resetting the terminal software to the basic state

The device configuration is reset to the default values.
Switching the terminal software to the Registration mode

This function causes the registration file to be deleted, followed by an automatic system
start.
Following the system start, ‘Waiting for registration” appears on the display.
Start-up can be effected by Automatic registration via B-COMM.
Delete diagnosis data

This deletes the logfiles for system diagnosis.

Reference Manual Index
Index
B I
Basic Authentication 23 IP address 19
Biometric mode 28
Biometric proximity sensor 31 L
Biometrics 27 Licence 14
Brightness 30 Licence extension 16
Logfiles 17
C Login 10
CardLink host settings 24
Change password 29 M
Communication via Ethernet/UDP 21 MRD reader 25
Communication via Ethernet/XML 22
N
D Network settings 18
Data encryption 22
Date and time 29
P
DHCP server 18, 19
Password 10
Diagnosis functions 17
Password for Basic Authentication 23
DID 23
Preset Booking 27
Display brightness 30
PresetEnroll 27
DNS server 19
Proximity Scale 28
Proximity sensor 30
E Proxy server 23
Enabling Add-On 26
Enabling inputs/outputs 26
R
Encryption 22
Reader settings 25
Extension of the licence 16
Reader type 25
Reboot 17
F Resetting SSH key 17
FTCS host settings 24
S
G Selecting the language 10
GID 23 Sensors 30
Globe icon 10 Software licence 14
Group identification and device identification 23 sop.ini 14
Guard time 26 SSID 20
Standalone mode 28
H Support information 17
Host registration 22 Supported browsers 8
Host settings 21
HTTP/HTTPS 22 T
Terminal restart 17
Terminal software licence 14

Index Reference Manual
Test licence 16
U
User for Basic Authentication 23
User management 29
User name 10
W
WLAN Settings 20

RM ServiceInterface 202002 en

Uploaded by

Document Informationclick to expand document informationqwqw

Document Informationclick to expand document information

Copyright:

Available Formats

RM ServiceInterface 202002 en

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

RM ServiceInterface 202002 en

Uploaded by

Copyright:

Available Formats

Service Interface

Copyright © dormakaba 2020

Subject to technical changes.

3 Access to service functions 8

04045682 - 02/2020 Service Interface 3

6.3.7 Proxy server 23

4 Service Interface 04045682 - 02/2020

1 About this document

• BaseApp version 771-07-X-K00

1.2 Target group

1.3 Contents and purpose

1.4 Additional documentation

04045682 - 02/2020 Service Interface 5

1.5 Orientation in the document

Application tips, useful information

6 Service Interface 04045682 - 02/2020

2.2 Use of the service interface

The service interface is part of the B-Client AC30 terminal software

04045682 - 02/2020 Service Interface 7

3 Access to service functions

Devices equipped with display (terminals)

Devices without display (access manager)

3.2 Direct access

• Ethernet cross-over cable (RJ-45 cross-over cable)

3.3 Supported browsers

• Internet Explorer from version 8

8 Service Interface 04045682 - 02/2020

3.4 Opening the service interface

https://<IP address>:8443 https://10.10.14.240:8443

04045682 - 02/2020 Service Interface 9

The following users have been stored as standard:

User name Password

For security reasons, the standard passwords should be changed.

3.6 Basic structure

1 Display of the respective device type (HR) or terminal software (AC)

3.7 Selecting the language

10 Service Interface 04045682 - 02/2020

5.1 Information/System Information

4.1.2 ‘Settings’ menu group

6.1 Network/Ethernet Settings

04045682 - 02/2020 Service Interface 11

6.10 User Management/Change Passwords

4.1.3 'Firmware' menu group

4.2 Basic operation

Buttons within the functions

Cancel function, discard entries

Empty input fields

Apply entries and quit the function

Set to default values

12 Service Interface 04045682 - 02/2020

up time = total runtime of the device since last system start

04045682 - 02/2020 Service Interface 13

[B-Client HR15] Section of the corresponding terminal software Each of these

Parameters for the terminal software

Each parameter has the value true or false.

BClientAC15Enabled= Licence for the B-Client AC15 terminal software.

14 Service Interface 04045682 - 02/2020