Kaba Door Lock - PDF document

Kaba Door Lock Server Integration in EB
Kaba Door Lock Server Integration in EBOIntegration GuideVersion 1EBOEWSHRCHRCOKDoor LockKaba APIKaba ServerSE8000Smart Connector FrameworkKaba PluginEcoStruxure Building OperationsSmartConnector2 Table of ContentsOverview Architecture Software Requirements Conguration Install SmartConnector Service runtime Purchase and Install the required licenses Install the Kaba door lock extension

Edit the Room Mapping le in Smart
Edit the Room Mapping le in SmartConnector folder Create a Kaba Processor in Smart Connector Kaba Processor Conguration Congure EcoStruxure Building Operation Create EcoStruxure Web Service Congure EcoStruxure Web Service in EBO Host EWS objects Import the XML bindings in EBO Generate EBO Binding XML Set the EWS Service path Congure the HRC to consume door status from Kaba door eventTest the co

nguration Congure Kaba LE
nguration Congure Kaba LENS server subscription Congure Door Ajar Timeout for each door lock Troubleshooting 3 OverviewDormaKaba is a 3rd-party company. It is the leading provider of access control solutions in hotel management. Integration of our Guest Room Management Solutions with the Kaba® Saok™ Door Lock System adds an additional level of intelligence to the Guest Room Management Sys-tem (GRMS) while si

mplifying the guest room architecture an
mplifying the guest room architecture and enabling enhanced capabilities to the GRMS.Door Lock integration tells the GRMS exactly who is entering the room (guest, maid, technical staff) so that the room responds accordingly with the appropriate lighting, temperature, and curtain settings. For example, the Restore Scene is activated when a guest returns to the room—restor-ing the exact conditions that were set when the guest left the room. Door Lock int

egration can be added to both the Limite
egration can be added to both the Limited Service Integrated Guest Room Management Solution and the Full Service & Luxury Integrated Guest Room Management Solution.Door Lock integration enables the following features:•Triggers Welcome Scene when the door is opened by the guest for the rst time. •Triggers Restore Scene when the door is opened by guest for the second time, and subsequent times.•Triggers Maid Service Scene when room is

accessed by cleaning staff. •Sets
accessed by cleaning staff. •Sets DND to ON when door is dead-bolted.•Reports door lock online status and triggers alarm in StruxureWare™ Building Operation (SBO) when door lock is ofine.•Reports door lock status at any time (opened, closed, or ajar).ArchitectureEBOEWSHRCHRCOKDoor LockKaba APIKaba ServerSE8000Smart Connector FrameworkKaba PluginEcoStruxure Building OperationsSmartConnectorPrerequisitesSoftwareVersion

SmartConnector2.2.130EcoStruxure Buil
SmartConnector2.2.130EcoStruxure Building Operation1.9Kaba Saok4.0DormaKaba processor1.2.1HRC application version1.4Licenses:SmartConnector’s framework is licensed. Commercial licenses can be obtained at www.smartconnectorserver.com.4 Conguration1.Install SmartConnector Service runtimeLog on the web page for smart connector conguration: URL: http://localhost:8082/ User: admin Passsword: Admin!23 (default)Y

ou will be prompted to change the defaul
ou will be prompted to change the default password. After changing the default password, navigating to any page of SmartConnector Portal will return the user to the Install License page where a runtime license must be installed.Purchase and Install the required licensesA license is required to operate the SmartConnector runtime and DormaKaba processor.Claim the license in the SmartConnector Portal (https://www.smartconnectorserver.com/license/claim) using

the following token:DormaKaba Processor
the following token:DormaKaba Processor:B9CF4D0E510346B7825DE6C5AA60CE9Install the Kaba door lock extensionCopy the door lock library into the install folder of SmartConnector. If windows is 32 bit, then folder is “C:\Program Files\Schneider Electric\SmartConnector” else, “C:\Program Files (x86)\Schneider Electric\SmartConnector” if machine is 64 bit.Then restart the SmartConnector ServiceEdit the Room Mapping le in Smar

tConnector folderEdit the “dormak
tConnector folderEdit the “dormakaba_room_mapping.csv” template located in the SmartConnector folder. Make sure to retain the naming convention of 3 numbers for oor name and 4 numbers for room name. Then restart the SmartConnector ServiceDoor ID, Floor Name,Room Name101,001,0101102,001,0102103,001,0103203,002,0203 5 Create a Kaba Processor in Smart ConnectorLog in to SmartConnector page and access the Congurations tab.Click

Add New to navigate to the Add Proces
Add New to navigate to the Add Processor Page. Add Processor Conguration The Add Processor Conguration Page provides a wizard interface for creating a Processor Conguration.SmartConnector will automatically analyze the SmartConnector install directory and display all possible assemblies and the number of available Processor candidates which could be congured.Select SchneiderElectric.DormakabaIntegration then click next.6 Assemb

ly Description – Extension Descrip
ly Description – Extension Description supplied by the Extension author. Assembly Company –Company which wrote the Extension Assembly. Assembly Copyright – Copyright information about the Extension Assembly. Assembly Version – Version of the Extension Assembly. The only class available for this processor is highlighted. Click next.Name Conguration The nal step in adding a Processor Conguration is to name the con&#

31;guration and provide an optional Desc
31;guration and provide an optional Description. The default values can be used as is or edited as needed.Name – Descriptive name for the Processor Conguration. Description – Free form text eld. Assembly File – The complete le path where the Extension Assembly is located. Class Name – The name of the Processor subclass congured. Click Finish then you will be brought to the Processor Conguration page. 7

Kaba Processor CongurationThe Pr
Kaba Processor CongurationThe Processor Conguration Detail Page allows the user to view and edit a Processor Conguration.Kaba ServerBase URL: Use the default value.Service Port: Default value is 8086. It must align with the Kaba LENS Server subscription conguration.EWS ServerEWS Address: Congure the host and the target port for server address. Select a port that is not blocked by rewall.Realm: Use the default value.Se

rver Name: This is the name for the EWS
rver Name: This is the name for the EWS service that will be hosted in EBO.User Name: Use the default value.Password: Select the password you will use to authenticate from EBO.8 Select the Control tab. Congure the processor to Run on SmartConnector Service start.Runs On Start: TrueRuns On Schedule: FalseManually Startable: TrueManually Stoppable: TruePress Save.After conguration is done, you can press Validate and then Start.T

he EWS Server will be created and the do
he EWS Server will be created and the door lock IDs, oor and rooms database will be generated.Validate – Click to validate the state of the Processor Conguration. All issues will be displayed to the user at the top of the page. This will conrm that all the conguration parameters are valid and the license is conrmed for this machine.Start – Click to start the Processor Conguration. If the Processor Conguration do

es not allow a manual Start, this button
es not allow a manual Start, this button will appear disabled. 9 Congure EcoStruxure Building OperationCreate EcoStruxure Web ServiceAdd new interface in the Enterprise server root folder. Select EcoStruxure Web Service and give it a relevant name.Click next and congure the connection information with the parameters set when the SmartConnector Processor was created. Click create.10 Congure EcoStruxure Web Service in EBONavigate to th

e EWS interface. Right click to con
e EWS interface. Right click to congure.Change value poll interval to 1 second.Disable Alarm polling 11 2.3Host EWS objectsBrowse to Server 1/System/Hardware/EcoStruxure Web Services/KabaServerRight click KabaServer and select Host EWS ObjectsImport the XML bindings in EBOIn EBO, import the generated binding XML le in the BACnet Interface/BACnet IP folder of the Automation Server. Make sure that you select the proper conict resoluti

on method to: Merge with existing objec
on method to: Merge with existing objects.12 Generate EBO Binding XMLExecute the EBO Binding Tool for Door Lock IntegrationThe rst view shows a logical binding between individual door database and hotel room controller.Click NextSet the EWS Service pathSpecify on EBO Enterprise Server where is the EWS interface hosting the door lock events.Enter the path then click Next 13 In the Binding Tool folder, Edit the room_mapping.csv le t

o match the door lock list. Make sure to
o match the door lock list. Make sure to be consistent with the Hotel congura-tion le.The rst column is the server where the HRC is hosted (Enterprise Server, Automation Server)Door ID must match the door mapping from the SmartConnector folder.Make sure to retain the naming convention of 3 numbers for Floor Name and 4 numbers for Room Name. Select the room mapping le you modied in the previous step. Click Next14 The pop up w

ill indicate the binding le is read
ill indicate the binding le is ready.Click nish to close the program. The last view is a reminder about how to import the le in EBO. 15 Congure the HRC to consume door status from Kaba door event.This procedure shows how to congure the HRC to acknowledge the door status from a Kaba door event. Therefore, the guest is not required to place his card inside an holder to activate the lights.Access the HRC conguration web pag

e and browse to the Congure tab. On
e and browse to the Congure tab. On the left side, go to Occupancy Control.Check the box Keycard less. The following conguration page will be shown.Sensor options:Door status: Select Door Status from KabaDoor Ajar Timer: The door ajar timer should align with the Kaba conguration for door ajar delay. See Section 6.6Staff Scene: Select the scene to execute when the Staff/Maintenance key is used.16 Test the congurationUsing the Kaba

LENS simulator, you can trigger door ev
LENS simulator, you can trigger door events to ensure correct integration with the HRC.Examples: * Send a “Deadbolt” message, check whether the event object in EBO is updated or not. * Check whether the DND status in HRC is updated or not. 17 Congure Kaba LENS server subscription Launch Kaba LENS web application and create a group permission.18 19 20 21 22 Log out. Restart the LENS Gateway service, wait for the

service to reconnect to the translator
service to reconnect to the translator service . 23 Create a subscription for the web service.24 25 Congure Door Ajar Timeout for each door lock Log in Saok Messenger server.26 Navigate to Conguration tab. Click the Hub View button.Navigate to each Hub and select each lock 27 Click Lock Parameters. For each lock, set Door Ajar parameter (Guest and Staff) Short Period to 1 minute. Click OK to apply changes for each lock.T

roubleshootingSmartConnector Logs can b
roubleshootingSmartConnector Logs can be accessed from: %programdata%/SmartConnector/LogsTechnical SupportFor any issues with EcoStruxure Solution or EcoStruxure Lite, contact Schneider ElectricTechnical Support according to your region.Schneider ElectricCS 30323F-92506 Rueil-Malmaison CedexNorth America (NAM) Product SupportBuilding Management Systems (BMS): productsupport.NAM-BMS@schneider-electric.comField Devices: productsupport.NAM-HVAC@schneide

r-electric.comGlobal Product SupportBu
r-electric.comGlobal Product SupportBuilding Management Systems (BMS): productsupport.BMS@schneider-electric.comField Devices: productsupport.HVAC@schneider-electric.com https://ecobuilding.schneider-electric.com/supportAbout Schneider ElectricSchneider Electric is leading the Digital Transformation of Energy Management and Automation in Homes, Buildings, Data Centers, Infrastructure and Industries.With global presence in over 100 countries, Schne

ider is the undisputable leader in Power
ider is the undisputable leader in Power Management – Medium Voltage, Low Voltage and Secure Power, and in Automation Systems. We provide integrated efciency solutions, combining energy, automation and software.In our global Ecosystem, we collaborate with the largest Partner, Integrator and Developer Community on our Open Platform to deliver real-time control and operational efciency.We believe that great people and partners make Schneider a

great company and that our commitment t
great company and that our commitment to In-novation, Diversity and Sustainability ensures that Life Is On everywhere, for everyone and at every moment.www.schneider-electric.comSchneider Electric | IG-KabaServerIntegration.01.2019.v1 www.schneider-electric.com/buildingsJanuary 2019Schneider Electric | IG-KabaServerIntegration.01.2019.v1 www.schneider-electric.com/bu