KONE Elevator Integration

Overview

This guide explains how to configure the KONE Elevator Interface on the Integriti system. This high-level (HL) integration provides a connection to the KONE lift system using two APIs — the KONE Access Control Integration (ACI) API (RESTful web interface) and the Kaba Exos Push API (web socket protocol) — enabling user management, event logging, and live reporting from KONE terminals into Integriti review.

The integration has two major components:

• User Synchronization — One-way sync of Integriti users and their credentials to the KONE ACI API. Supports Site Code + Card Number cards, CSN cards, and other formats (may require Custom Enhancement).
• Review Logging — Push-based (Exos API) and poll-based (ACI API) live event reporting from KONE terminals into Integriti review, including access events, person changed events, badge assignments, and server messages.

The integration has been developed and tested against KONE ACI API version 8.5. Both APIs can use HTTP or HTTPS; HTTPS is recommended.

Important: User records should not be created directly in the KONE lift system. All user management should be done through Integriti.

Prerequisites

• Integriti System Designer with installer-level access.
• KONE ACI API host URL (HTTP or HTTPS) and credentials (username/password).
• KONE Exos Push API host URL and credentials.
• License: 996933 — Elevator Management Integration (Lift HLI).
• Both the KONE server and Integriti server configured to the same NTP server for accurate event timestamps.
• Use of HTTPS with SSL certificate validation enabled unless a valid exception exists.

Step-by-Step

1. Create the KONE Communications Handler

1. In Integriti System Designer, open the Communications panel from the Design tab.
2. Click the Add New button to create a new communications handler.
3. Choose a Handler Type of KONE Elevator Integration.
4. Give the handler a name (e.g., “KONE Elevator”) and add any necessary details in the Notes field.

2. Configure Basic Connection Settings

5. Expand Basic Configuration.
6. Enter the Host URL of the KONE ACI API, starting with Http:// or Https://.
7. Configure the Username and Password to match your KONE system settings.
8. Disable SSL Certificate Validation — NOT recommended as it puts the entire system at risk. Only check this option if absolutely necessary.
9. Enter the Host URL of the Exos Push API, starting with Http:// or Https://.
10. Configure the Username and Password for the Exos Push API to match your KONE system settings.

3. Configure KONE Custom Fields

11. Expand KONE User Custom Fields.
12. For each required custom field, click the New button next to the dropdown to open the Custom Field Editor. Set the Name, Key Name, Item Type, Field Type, Mandatory status, Default Value, and set Category Name to KONE. Save and close.

Configure the following required custom fields:

Custom Field	Item Type	Field Type	Purpose
Is KONE User (Required)	User	Check Box	Determines whether a user is synced to KONE. Checked = synced; unchecked = removed from KONE.
KONE Person Phone Number	User	Text	The user’s phone number synced to KONE.
KONE Person Email Address	User	Text	The user’s email address synced to KONE.
KONE Person Category ID	User	Drop Down Box	Maps to the Person Category in the KONE system. Values must match KONE configuration.
KONE Person Call Type ID	User	Drop Down Box	Maps to the Person Call Type ID in the KONE system. Values must match KONE configuration.
KONE Person Home Floor ID (Deprecated)	User	Drop Down Box	Legacy field for home floor. Use KONE Person Home Floor (Entity Link) instead.
KONE Floor Name (Deprecated)	Lift Floor	Drop Down Box	Legacy field for lift floor name.
KONE Person Home Floor	User	Entity Link (Lift Floor)	Links the user to a Lift Floor entity for their home floor.
KONE Person Profile	User	Drop Down Box	Maps to the access right profile in KONE. Integriti supports up to 5 person profiles.
KONE Media Definition ID	Card Format	Drop Down Box	Maps to the Media Definition ID in the KONE system. Values must match KONE configuration.
KONE Media Application ID	Card Format	Editable Drop Down Box	Maps to the Media Application ID(s) in the KONE system. Example: [ 1, 2, 3].
KONE Card Format	Card Format	Text	References a Card Format of type “Custom Software Codec” used to convert credentials to KONE’s format (e.g., “CF30”).
KONE Person ID	User	Text	Automatically populated by Integriti with the KONE user ID. Do not edit manually.

4. Configure User Synchronization

13. Expand User Sync Configuration.
14. Check the Enabled option.
15. Optionally check Persist Login Token if the number of concurrent connections to the KONE APIs is limited.
16. KONE Person Disambiguator — must be unique if there are multiple KONE Elevator integrations linked to your KONE system.
17. Card Codec — can be customized via a Custom Enhancement code snippet. Leave blank for the default card codec.

5. Configure Review Logger (Live Event Reporting)

18. Expand Review Logger Configuration.
19. Check the Enabled option.
20. Configure polling and batch settings:
    • Poll Rate — the polling period in seconds when no push notification is received (minimum 1 second).
    • Batch Size — number of access events to process per batch (1–1000).
21. Check each event type you wish to log:
    • Non-IR User Activities — logs KONE user activities even if not associated with Integriti users.
    • Entity Change Events — logs create, update, replace, and delete actions (may be redundant if User Sync is enabled).
    • Badge Assignment — logs badge assignment events.
    • Access Events — logs user access events.
    • Plain Text Events — logs unstructured string data from the KONE server.
    • Unsupported Events — logs raw data for troubleshooting purposes only.

6. Save and Set Run Mode

22. Save and close the Communications Handler.
23. Change the Run Mode to Automatically Run on Any Single Server.
24. Save changes and close.

7. Configure Lift Cars

25. Navigate to the Lifts tab.
26. For each Lift Car associated with the KONE system:
    • Lift Mode — select High Level / EMS.
    • Software HLI Handler — select the KONE communications handler created earlier.
    • Lift Group — select a Lift Group with the EMS Group number configured under Settings.
    • EMS Lift ID — program the EMS Lift Number to identify this Lift Car with the corresponding KONE lift car.
27. Tip: To configure the same handler for multiple lift cars, multi-select the cars, right-click, and use multi-edit.
28. After all lift cars are configured, restart the KONE communications handler to automatically load and populate lift floors.

8. Configure Card Formats

29. The supported card formats are: CSN cards, Site Code cards, and other formats (custom enhancement required — contact Inner Range).

NOT supported: Direct entry cards, cards with data longer than 64 bits, cards with expiry date in card data, site code cards with more chunks than Site Code + Card Number + Issue Number, and cards with complex check digits (XOR, CRC, etc.).

30. Import the Card Format preset:

    • Navigate to Administration > Import Data.
    • Browse to C:\Program Files\Inner Range\Integriti Pro\Resources\Helpers\.
    • Import Kone datasync.irentities. This adds:
      • A Custom Enhancement named KONE Card Codec.
      • A Card Format named Kone datasync format with type Custom Software Codec pointing to the codec.

31. Configure the Custom Codec for your KONE system:

    • Find KONE Card Codec under Administration > Custom Enhancement.
    • In Settings, select the card format matching your KONE system (e.g., HID FARPOINT H10304 37Bit).
    • Adjust the Format Specifier for KONE’s Medium Wiegand format (remove parity checks, add _RAWDATA, align to byte positions).
    • Example result: L:40_SC:1-16_CN:22-40_RAWDATA.

32. Configure the KONE Card Format:

    • Select the KONE Media Definition from the dropdown matching your KONE system.
    • Configure the KONE Media Application Definitions — either select a preset or enter IDs in format [ 1, 2, 3].
    • Leave KONE Card Format empty on this card format.

33. Link the Integriti Card Format to the KONE Card Format:

    • Edit the site’s card format under Access Control > Card Formats.
    • Set the KONE Card Format custom field to the Card Format ID configured in step 32 (e.g., “CF99”).

34. For multiple card types, duplicate the custom enhancement, configure each format, create corresponding Card Formats, and link them.

9. Configure Users for KONE

35. Navigate to Home > Users.
36. For each Integriti user to be synced to KONE, set the following custom fields:
    • Is KONE User — checked.
    • KONE Person Phone Number — the user’s phone number.
    • KONE Person Email Address — the user’s email address.
    • KONE Person Category — select from dropdown.
    • KONE Call Type — select from dropdown.
    • KONE Person Home Floor — select the corresponding Lift Floor entity.
    • KONE Profile — select from dropdown (up to 5 profiles supported).
    • KONE Person ID — leave this field alone; it is auto-populated by Integriti.

10. Populate Custom Field Presets (If Needed)

37. If KONE system configuration changes or presets need refreshing:
    • Open the KONE communications handler settings.
    • Change Run Mode to Disabled and save.
    • Expand Service Data by clicking Show / Hide Service Data.
    • Tick Populate Custom Fields.
    • Change Run Mode back to Automatic and save.

Verification

• After saving the Communications Handler, check that its status shows a successful connection to KONE.
• Navigate to the Lifts tab and verify Lift Cars and Lift Floors have been automatically created/loaded after restarting the handler.
• In Integriti review, verify access events from KONE terminals appear (e.g., “Kone HLI - Access Event: Access authorized”).
• Assign a test user with Is KONE User checked and required fields populated. Verify the user appears in the KONE system with the correct credentials.
• Check that KONE Person ID is auto-populated on the user after sync.

Troubleshooting

Problem	Resolution
Communications Handler shows disconnected	Verify the ACI API host URL and credentials are correct. Ensure network connectivity between Integriti and the KONE server. Check that Run Mode is set to Automatically Run on Any Single Server.
Users not syncing to KONE	Verify User Sync Configuration is enabled. Ensure Is KONE User is checked on the user. Confirm the user has an active credential with a properly configured card format linked via KONE Card Format.
Card data not recognized by KONE	Verify the Card Codec format specifier matches KONE’s expected format. Ensure KONE Media Definition ID and KONE Media Application ID match the KONE system configuration.
Review events have incorrect timestamps	Ensure both the KONE server and Integriti server are configured to the same NTP server.
Custom field presets not populating	Set the Communications Handler Run Mode to Disabled, save, expand Service Data, tick Populate Custom Fields, then set Run Mode back to Automatic and save.
SSL certificate errors	Verify the KONE server’s SSL certificate is valid. Only disable SSL certificate validation as a last resort — this puts the system at risk.
Lift floors not loading	After configuring Lift Cars, restart the KONE communications handler to trigger automatic floor loading.

Related Pages

• KONE 1000 Elevator Integration
• Schindler Lift Interface
• UniBus 16 Floor Lift Interface
• IAC Overview
• Integriti System Configuration
• Integriti Communication Handlers