C4 DRIVER DOCUMENTATION
eCLIQ Integration Manual
ASSA ABLOY electronic locking with CLIQ Web Manager
ARYKA.C4.Driver.eCLIQ | C4 SDK Framework4 (Access)
Field |
Content |
|---|---|
Document reference |
ARYKA-C4-ECLIQ-IM |
Document owner |
ARYKA IN-WEST a.s. |
Prepared by |
Egor Červinka |
Version |
v02 |
Issue date |
2026-11-22 |
Applies to |
C4 2026 SP4 | Driver 1.0.0.4 | CLIQ Web Manager Web Service v2 (hosted and on-premise) |
Language |
English |
Classification |
Public |
Revision history
Revision / date |
Changes and impact |
|---|---|
0.1 / 2026-11-03 |
First draft, written from the driver as of version 1.0.0.4. |
1.0 / 2026-11-04 |
First release, for driver version 1.0.0.4. |
1.1 / 2026-11-12 |
Revision of Integration manual, driver version 1.0.0.4 |
v02 / 2026-11-22 |
Applied the blue production layout and sequential vNN naming; updated document controls and Contents; clarified commissioning and test setup; preserved technical scope, identifiers, limits and the existing revision record. |
This manual applies only to the combinations and capabilities identified in its compatibility and supported-functionality sections.
Integration Overview and Supported Functionality
Purpose and scope
This manual describes the integration of the ASSA ABLOY eCLIQ electronic locking system with C4 through the ARYKA.C4.Driver.eCLIQ driver. It defines supported functionality, prerequisites, configuration, operating behaviour, restrictions and the integration tests that validate it, for the versions listed in this document.
The manual is intended for system integrators, commissioning engineers, C4 administrators, technical support and integration testers. Installation of cylinders and programming devices, and administration of CLIQ Web Manager, are outside the scope of this manual.
The integration covers access control with eCLIQ keys and cylinders managed through one CLIQ Web Manager tenant, hosted or on-premise. Cylinder programming, CWM administration and remote door control are outside this scope.
Terminology and conventions
C4 labels, device types, property names, commands, statuses and event identifiers are written exactly as they appear in C4. CWM is the CLIQ Web Manager, the ASSA ABLOY server the driver talks to. A key is an eCLIQ electronic key and appears in C4 as a credential of type Key 128; a cylinder is an eCLIQ lock and appears in C4 as a door (eCliQCylinder). Driver texts quoted in this manual are shown in quotes; '...' stands for a value filled in at run time. Further terms are listed under Terminology.
Device Category
Category |
Selection / scope |
|---|---|
ACS |
Yes. Persons, keys and cylinder access are managed from C4; cylinder audit trails are imported as access events. |
IAS |
No |
FPS |
No |
CCTV |
No |
DVR |
No |
Perimetry |
No |
Building |
No |
Other |
No |
Integration boundary and operating modes
C4 does not talk to cylinders or keys. The driver connects to one CLIQ Web Manager tenant through its SOAP Web Service (v2) over HTTPS with a client certificate. CWM may be the ASSA ABLOY hosted service or an on-premise installation; for the driver both are the same operating mode.
Keys and cylinders are offline devices. A change written to CWM reaches a key only when the key is updated at a programming device (a wall or remote PD), and a cylinder decides access on its own from what is stored on the key. Access decisions therefore never need a running C4 connection; only programming and audit-trail collection do.
The integration is one-way per object. C4 owns persons, key assignment, key status (lost / broken) and time restrictions. CWM owns the cylinders, cylinder groups, remote PDs, keys and the cylinder authorisations of E1 and E2 keys. The driver reads those back from CWM but never writes to them.
Flow |
Direction |
When |
|---|---|---|
Device tree (groups, cylinders, remote PDs) and key list |
CWM → C4 |
Load Configuration command |
Persons, key hand-out, validity, schedules, E3 cylinder access, key status |
C4 → CWM |
Full, Selective and Incremental upload |
Audit trails (accesses recorded by E2 / E3 keys) |
CWM → C4 |
Every AuditTrailTimer |
Remote PD online state |
CWM → C4 |
With every health check (Timeout) |
Supported Functionality
S = Supported | P = Partially supported | N = Not supported by this driver | NA = Not applicable to eCLIQ.
Each supported function names its test.
Functionality catalog
ID |
Functionality |
State |
Scope / test |
|---|---|---|---|
F01 |
Import From File |
N |
|
F02 |
Combined Credentials |
NA |
eCLIQ has keys only. |
F03 |
Lift |
NA |
|
F04 |
Encrypted Communication |
S |
HTTPS with client certificate, plain HTTP is refused. T-SEC-01 |
F05 |
Load Configuration |
S |
Groups, cylinders, remote PDs and key credentials. T-CFG-03 |
F06 |
Time Synchronization |
NA |
Keys and cylinders take their time from the eCLIQ system, not from C4. |
F07 |
Time Zone Support |
P |
Audit-trail times are converted to UTC; schedules are weekday wall-clock times. T-EVT-02 |
F08-F18 |
Video and audio functions |
NA |
|
F19 |
Person Data Read |
N |
|
F20 |
Fire Panel Networking Mode |
NA |
|
F21 |
Card Learning |
N |
Keys are read from CWM by Load Configuration instead. |
F22 |
Dynamic Upload |
N |
Full, Selective and Incremental uploads only. T-UPL-01, T-UPL-04, T-UPL-05 |
F23 |
Access Time Restrictions |
S |
E2 and E3 keys; C4 calendars become weekly eCLIQ schedules. T-ACL-01 |
F24 |
Holidays Support |
N |
Holiday time frames are ignored. |
F25 |
PIN Management |
NA |
|
F26 |
Card Management |
P |
eCLIQ keys as Key 128 credentials, one key per person. T-ID-01, T-ID-02 |
F27 |
Fingerprint Management |
NA |
|
F28 |
Reserved Memory Zones |
N |
|
F29 |
Anti-passback Forgiveness |
NA |
|
F30 |
Handicapped Flag |
NA |
|
F31 |
Alarm Suppression |
NA |
|
F32 |
Fire Alarm Counter |
NA |
|
F33 |
Device Audit Log Retrieval |
S |
Audit trails, including accesses recorded offline. T-EVT-01A-C, T-EVT-02 |
F34 |
Remote Device Control |
NA |
eCLIQ cylinders cannot be opened remotely. Communication and upload commands: T-CON-01, T-UPL-02 |
F35 |
Wiegand Biometric Support |
NA |
|
F36 |
Discovery |
N |
|
F37 |
Sending Configuration |
N |
Only access data is written, through uploads. |
F38 |
Migration to C4 Transformers |
NA |
Additional modes and exclusions
Function ID / mode |
Conditions or exclusions |
Tests |
|---|---|---|
Key types |
E1, E2, E3 and CKey keys behave differently; see Technology-Specific Functionality. |
T-KEY-01 to T-KEY-04 |
Lost / broken keys |
Set in C4 only; the upload declares them in CWM. |
T-KEY-05 |
Key hand-in and reassignment |
Revoke or Assign the card in C4, then upload. |
T-KEY-06 |
Remote PD status |
Online / offline state of remote programming devices. |
T-STS-01 |
Memory usage |
Credential and calendar positions reported against the access panel capacity. |
T-MEM-01 |
Profiles (extended properties) |
N - not implemented. |
- |
Upgrade and migration |
N - no migration path is documented for this release. |
- |
Compatibility, Dependencies and Licensed Devices
Supported and validated combinations
Combination ID |
C4 / driver / framework |
Device / protocol |
Evidence / limits |
|---|---|---|---|
COMP-01 |
C4 2026 SP4 Driver 1.0.0.4 Gamanet.C4.SDK.Framework4 4.1.0.598, Framework4.Access 4.1.0.291, SimpleInterfaces 2026.4.0.58 |
CLIQ Web Manager, hosted Web Service v2 (query, work, import endpoints) |
Validated in operation. |
COMP-02 |
As COMP-01 |
CLIQ Web Manager, on-premise Web Service v2 |
Supported; the context path is given in ApiUrl. |
Prerequisites and dependencies
Field |
Content |
|---|---|
C4 prerequisites |
C4 with the access-control upload framework, the driver package installed and registered. The credential type Key 128 must exist, if it is missing, download it in the C4 client under Settings > Packages > Credentials > Show Available (package "Card, Assa Abloy Key, Key 128"). |
Manufacturer prerequisites |
A CLIQ Web Manager tenant with the Web Service enabled, and a client certificate file (for example .p12) with its password issued for the integration. Cylinders, cylinder groups and keys are created and marked in CWM. |
External dependencies |
Outbound HTTPS from the C4 server that runs the driver to CWM; DNS resolution of the CWM host name. |
Unsupported combinations |
Plain HTTP endpoints. More than one eCLIQ bus controller in one driver process. |
Licensed Devices
Licensed element / unit |
Counting rule and exclusions |
Required entitlement |
|---|---|---|
eCliQCylinder |
One licence per eCliQCylinder node (C4 door). CliQBusController, eCliQAccessPanel, Group and RemotePD are not licensed. |
C4 licence for the eCLIQ driver covering the number of cylinders. A CWM Web Service licence from ASSA ABLOY. |
When the driver starts, C4 counts the device instances carrying the Licensed attribute and requests that number from the installed licence. Example: the tree under Device tree and addressing has five eCliQCylinder nodes and therefore consumes five licences, its groups, access panel and remote PD consume none. See T-LIC-01.
During first run, create a custom cylinder (the cylinder does not need to physically exist) so the driver can start and you can issue a "Load Configuration" command.
Restrictions and Important Notes
Capacity and functional restrictions
Object / operation |
Limit and counting rule |
Impact / verification |
|---|---|---|
Keys per person |
At most one eCLIQ key per person (cards and other credential types do not count; CKeys do). Driver rule. |
A person with more is not uploaded and nothing is sent for them. T-ID-02 |
Credential positions |
One position per access entry. Hosted CWM (CloudSolution = True): 10000. On-premise: CredentialCapacity (999 when unset). Driver-managed. |
The upload reports "Credential out of memory" when exhausted. T-MEM-01 |
Calendar positions |
Hosted CWM: 256. On-premise: CalendarCapacity (256 when unset). |
Reported against the configured capacity. T-MEM-01 |
eCLIQ systems per driver process |
One. A second eCLIQ bus controller in the same process is refused at start. Driver limit. |
ConfigurationFailure on the second bus controller. T-CFG-01 |
Web Service rate limits |
The driver paces each SOAP operation based on ASSA ABLOY documented limits. |
Large uploads take longer, nothing is rejected. |
Audit-trail query window |
At most 28 days per query (ASSA ABLOY limit of one month). |
After a long outage the backlog is caught up 28 days per poll. T-EVT-02 |
Operational warnings
A Full upload deletes every eCLIQ person who is not in C4 (orphan clean-up) and takes back every key C4 does not assign. Do not run a Full upload against a CWM that holds people who must be kept outside C4.
A Full upload is needed before any other upload in a fresh installation.
Revoking access resets the key to validity NEVER, clears its schedule and, for an E3, its cylinder access. The person stays in CWM.
Key status belongs to C4. A key declared lost or broken directly in CWM is declared found / operational again by the next upload that includes its holder.
Changes made by hand in CWM (validity, schedules, holders) are overwritten by the next upload that includes the key, and are not noticed at all for a key C4 assigns to nobody. Make such changes in C4 and upload.
Nothing reaches a key until the key is updated at a programming device. An upload that succeeds in C4 has changed CWM, not yet the key.
Restart the bus controller after Load Configuration so that the new devices are initialised.
Security and safety boundaries
All traffic to CWM is HTTPS with mutual TLS: the driver presents the configured client certificate. An ApiUrl that is not HTTPS is rejected at start. The certificate password is a protected property. The driver stores no personal data of its own; to detect a change of a person's name or e-mail it keeps only a SHA-256 hash of what it last sent.
No setting of the eCLIQ system has to be weakened for the integration. The driver cannot open or unlock a cylinder.
The client certificate is issued for the tenant by ASSA ABLOY or the CWM administrator. Store the file on the C4 server with read access for the C4 service account only, and keep the password in the approved secret store. To renew it, replace the file (or point CertPath to the new one), update Password and Restart the bus controller.
Known limitations
ID / affected versions |
Limitation |
Workaround / resolution |
|---|---|---|
LIM-001 / 1.0.0.4 |
E1 and E2 keys cannot be given cylinder access through the Web Service; the cylinders must be programmed in CWM to accept them. |
Program cylinder authorisations in CWM; the upload reports any mismatch with C4. |
LIM-002 / 1.0.0.4 |
E1 keys ignore time restrictions; they are only ALWAYS or NEVER valid. |
Use E2 or E3 keys where time restrictions are needed. |
LIM-003 / 1.0.0.4 |
Validity date ranges (DATES) are not supported; C4 ValidFrom / ValidTo are not carried to eCLIQ. |
Withdraw access in C4 and upload when it should end. |
LIM-004 / 1.0.0.4 |
Holiday calendars are not written to eCLIQ. |
None. |
LIM-005 / CWM |
A person deleted from CWM cannot be created again with the same identity for about 10-15 minutes (for example after two Full uploads in quick succession). |
Upload again after 15 minutes, or recreate the person in C4 (new identity). |
LIM-006 / CWM |
A person holding a CKey cannot be deleted from CWM; a CKey cannot be handed in through the Web Service. |
Hand the CKey in from CWM if the person must go. |
LIM-007 / 1.0.0.4 |
Cylinder group names must be unique; the cylinder search is filtered by group name. |
Keep group names unique in CWM. |
LIM-008 / 1.0.0.4 |
The first Full upload on a large tenant reads every unassigned key once (about 0.4 s per key). |
Later Full uploads skip keys already in stock and NEVER. |
LIM-010 / CWM |
eCLIQ identifies audit entries by marking only. Keys are matched by the name of their C4 credential; a credential renamed by hand in C4 loses its events. |
Run Load Configuration, which restores the name from CWM. |
LIM-011 / CWM |
E1 keys have no clock; their audit entries carry no usable time and are not collected. |
Use E2 or E3 keys where access events are needed. |
LIM-012 / 1.0.0.4 |
One eCLIQ bus controller per driver process. |
Serve further CWM tenants from separate driver instances. |
How to Connect Device to C4
Topology and communication flows
Field |
Content |
|---|---|
Operating mode |
One mode: C4 driver → CLIQ Web Manager Web Service (hosted or on-premise). |
Connection endpoints |
C4 server running the driver → ApiUrl + /ws/query/v2/, /ws/work/v2/ and /ws/import/v2/. |
Data paths |
Query endpoint: all reads, audit trails and the health check. Work endpoint: key programming. Import endpoint: person creation. |
C4 server - eCLIQ driver |
HTTPS (SOAP) |
CLIQ Web Manager (hosted / on-premise) |
|---|---|---|
ApiUrl, CertPath, Password Device tree: bus controller, access panel, groups, cylinders, remote PDs |
Driver initiates; outbound only |
Persons, keys, cylinders, groups, remote PDs, audit trails |
- |
ASSA ABLOY protocol (not part of this integration) |
Wall / remote PD ↔︎ CWM; keys updated at the PD carry access to the cylinders and bring audit trails back |
Source → destination |
Protocol / port |
Initiator / direction |
Protection / purpose |
|---|---|---|---|
C4 server → CWM |
HTTPS (SOAP), TCP port explicitly configured in ApiUrl |
Driver; outbound only |
Mutual TLS; all programming, reads and audit trails |
Remote PD → CWM |
ASSA ABLOY |
Remote PD |
Not part of this integration; C4 only reads the PD state from CWM |
Device preparation and secure access
Obtain from ASSA ABLOY (or the CWM administrator) the CWM URL, a client certificate file for the Web Service and its password.
Copy the certificate file to the C4 server that runs the driver, in a location readable by the C4 service account (for example C:\Certificates\ecliq-client.p12).
Allow outbound HTTPS from that server to the CWM host, and make sure the host name resolves.
ApiUrl forms: include the tenant's actual TCP port explicitly. For the hosted service or a default on-premise installation, the server address is enough (https://cliq.example.com:8989), and the driver appends /CLIQWebManager. Including the context path also works (https://cliq.example.com:8989/CLIQWebManager). For another path or port, supply the full address (https://intranet.local:8443/cliq); everything after the host and port is used as the context path.
Connection and initial commissioning procedure
Step |
Action |
Verification |
|---|---|---|
1 |
Confirm the versions (COMP-01 / COMP-02), the C4 licence and the CWM Web Service access. |
Combination and licence match. |
2 |
Install and register the driver package in C4, make sure the Key 128 credential type exists. |
The CliQBusController device type is available. |
3 |
Add a CliQBusController and eCliQAccessPanel, then the temporary eCliQCylinder required for initial licensing. Use the allowed device parents shown under Device tree and addressing. |
The required nodes are present in the device tree and the temporary cylinder is included in the licensed count. |
4 |
Set ApiUrl, CertPath, Password and SupportedCredentialTypes (Key 128), review Timeout, AuditTrailTimer, RetryAttempts and RevalidationTimerInDays. |
Start the driver: bus controller Idle. ConfigurationFailure and a ConfigurationErrorInvalidPropertyValue event name the faulty property. |
5 |
Set CloudSolution on the access panel (or the capacities for on-premise). |
Memory usage is reported against the right capacity. |
6 |
Run Load Configuration on the bus controller, then Restart. |
Groups, cylinders, remote PDs and key credentials appear; all Idle (groups Activated). |
7 |
Assign keys to persons and grant doors in C4, then run a Full upload. |
Persons uploaded, keys handed out in CWM. |
8 |
Update a key at a PD and use it at a cylinder. |
Access event on the door in C4 within one AuditTrailTimer. |
Device Configuration
Create the CliQBusController and eCliQAccessPanel manually. For the first start, also create the temporary eCliQCylinder required under Licensed Devices so that the driver can start and Load Configuration can be issued. Groups, cylinders and remote PDs are then retrieved from CWM by Load Configuration; cylinders can also be created manually as described below. Name and Description are standard C4 properties of every device and are not repeated in the property tables below.
Device tree and addressing
C4 device type |
Represents / allowed parent |
Creation / addressing / licensing |
|---|---|---|
CliQBusController |
One CWM tenant. Root; one per driver process. |
Manual. Connection settings. Not licensed. |
eCliQAccessPanel |
Upload target for the tenant. Under the bus controller; one per bus controller. |
Manual. Not licensed. |
Group |
An eCLIQ cylinder group. Under the access panel. |
Load Configuration; addressed by GroupID (the eCLIQ group number). Not licensed. |
eCliQCylinder |
An eCLIQ cylinder (C4 door). Under its group. |
Load Configuration (or manual); addressed by Marking, unique within the bus controller. Licensed: one per cylinder. |
RemotePD |
An eCLIQ remote programming device. Under the access panel. |
Load Configuration; its C4 device ID is its eCLIQ identity. Not licensed. |
Example tree:
Device |
Type |
Parent |
|---|---|---|
cliq |
CliQBusController |
Root |
eCLIQ |
eCliQAccessPanel |
cliq |
Building A (GroupID 1) |
Group |
eCLIQ |
DC.N316, DC.N320 |
eCliQCylinder |
Building A |
Building B (GroupID 2) |
Group |
eCLIQ |
DC.N531, DC.N532, DC.N534 |
eCliQCylinder |
Building B |
Wall PD |
RemotePD |
eCLIQ |
Every eCLIQ cylinder belongs to a group, so there is no "ungrouped" node. Groups only structure the tree; access is granted per cylinder. Two cylinders with the same Marking are both set to ConfigurationFailure and the driver does not start (T-CFG-02). Changes to the device tree or to bus controller properties take effect after Restart.
CliQBusController
Field |
Content |
|---|---|
Meaning / placement |
One CWM tenant reached through its Web Service. Root of the eCLIQ tree; parent of the eCliQAccessPanel. |
Creation and identification |
Created manually. Identified by ApiUrl; only one per driver process. |
Lifecycle and licensing |
Start / Stop / Restart / Load Configuration commands. Stopping it stops all communication with CWM. Not licensed. |
Property |
Definition |
Default Value |
Range |
|---|---|---|---|
ApiUrl |
Communication settings. CWM base URL. Default port 8989, validated at start. |
Not set |
https:// only |
CertPath |
Communication settings. Full path to the client certificate file (for example .p12). Required, existence checked at start. |
Not set |
Existing file |
Password |
Communication settings. Certificate password. Protected; required. A wrong password is reported at start. |
Not set |
Text |
SupportedCredentialTypes |
Communication settings. C4 credential types treated as eCLIQ keys. Select Key 128. Checked at start. |
Not set |
Key 128 |
RetryAttempts |
Communication settings. Consecutive failed connection checks tolerated before CommunicationFailure; communication then stops until Start or Restart. |
3 |
1 or more |
Timeout |
Time settings. Interval of the connection health check, which also polls remote PD states. |
00:05:00 |
hh:mm:ss; 00:00:00 = 5 min |
AuditTrailTimer |
Time settings. Interval of audit-trail collection. A value in hours is reasonable: entries reach CWM only when keys are updated at a PD, and nothing is lost by polling less often. |
00:05:00 |
hh:mm:ss; 00:00:00 = 5 min |
RevalidationTimerInDays |
Time settings. Revalidation interval written with ALWAYS validity: after that many days the key stops working until it is updated at a PD. 0 means always valid. |
1 |
0 or more days |
With RevalidationTimerInDays above 0 the driver writes a whole-week schedule for unrestricted doors, because a revalidated key with an empty schedule opens nothing. Changes take effect after Restart and reach a key with the next upload that includes it (a Full upload for all keys).
eCliQAccessPanel
Field |
Content |
|---|---|
Meaning / placement |
Upload target for the tenant; receives Full, Incremental and Selective upload commands. Under the bus controller. |
Creation and identification |
Created manually; one per bus controller. No address. |
Lifecycle and licensing |
Groups and remote PDs are created under it by Load Configuration. Not licensed. |
Property |
Definition |
Default Value |
Range |
|---|---|---|---|
CloudSolution |
Solution type. True for a hosted CWM: the capacities below are ignored and the driver uses 10000 credential and 256 calendar positions. |
True |
True / False |
CredentialCapacity |
Solution type. On-premise only: credential positions of the panel. 0 or unset means 999; negative is reported as a configuration error. |
999 |
0 or more |
CalendarCapacity |
Solution type. On-premise only: calendar positions of the panel. 0 or unset means 256; negative is reported as a configuration error. |
256 |
0 or more |
HolidaySet |
Extra. C4 holiday set for the upload. Holiday frames are not written to eCLIQ. |
Not set |
Holiday set |
Group
Field |
Content |
|---|---|
Meaning / placement |
An eCLIQ cylinder group. Under the access panel; parent of its cylinders. |
Creation and identification |
Created by Load Configuration; identified by GroupID. |
Lifecycle and licensing |
Archived by Load Configuration once it is gone from CWM and holds no live device. Not licensed. Has no Idle status; Activated stands for it. |
Property |
Definition |
Default Value |
Range |
|---|---|---|---|
GroupID |
General settings. eCLIQ cylinder group number. Set by Load Configuration; do not edit. |
From CWM |
Integer |
GroupName |
General settings. eCLIQ group name, rewritten by every Load Configuration. Display only. |
From CWM |
Text |
Name (standard) |
C4 name. Taken from CWM when the group is created, then owned by the operator; never overwritten. |
From CWM |
Text |
eCliQCylinder
Field |
Content |
|---|---|
Meaning / placement |
An eCLIQ cylinder, used in C4 as a door. Under its group. A cylinder has up to two plugs (one per side); access is written per access point to both plugs (access cannot differ per plug, since it is taken from the same access point). |
Creation and identification |
Created by Load Configuration, or manually. Identified by Marking, which must match CWM exactly and be unique. |
Lifecycle and licensing |
Moved to its current group and archived when gone from CWM by Load Configuration. Licensed: one licence per cylinder. |
Property |
Definition |
Default Value |
Range |
|---|---|---|---|
Marking |
General. Full eCLIQ cylinder marking (for example DC.N320); links the door to CWM. Required, unique. Recommended to use it as the Name too. |
From CWM |
Text |
SupportedCredentialTypes |
Not used by the driver. Leave empty; the bus controller setting applies. |
Not set |
Empty |
RemotePD
Field |
Content |
|---|---|
Meaning / placement |
An eCLIQ remote programming device, where keys are updated. Under the access panel. |
Creation and identification |
Created by Load Configuration; its C4 device ID is its eCLIQ identity. An archived RemotePD that CWM lists again is restored with its ID and name. |
Lifecycle and licensing |
Status polled with every health check. Not licensed. |
Property |
Definition |
Default Value |
Range |
|---|---|---|---|
Marking |
General settings. Remote PD marking from CWM. Display only. |
From CWM |
Text |
Name (standard) |
C4 name; owned by the operator after creation. |
From CWM |
Text |
Configuration example and validation
Device / property |
Example value (sanitised) |
|---|---|
CliQBusController: ApiUrl |
https://cliq.example.com:8989 |
CliQBusController: CertPath |
C:\Certificates\ecliq-client.p12 |
CliQBusController: Password |
(the certificate password) |
CliQBusController: SupportedCredentialTypes |
Key 128 |
CliQBusController: Timeout / AuditTrailTimer |
00:05:00 / 01:00:00 |
CliQBusController: RetryAttempts / RevalidationTimerInDays |
3 / 0 |
eCliQAccessPanel: CloudSolution |
True |
With these values and a reachable CWM, Start brings the bus controller to Idle. Invalid values stop the start, set the bus controller to ConfigurationFailure and raise ConfigurationErrorInvalidPropertyValue with one of these descriptions:
Condition |
Event description |
|---|---|
SupportedCredentialTypes empty |
"SupportedCredentialTypes not configured. Select Key 128." |
ApiUrl empty / malformed / not HTTPS |
"ApiUrl is empty." / "ApiUrl '...' is not a valid URL." / "ApiUrl must use HTTPS; '...' uses http." |
CertPath empty / file missing |
"CertPath is empty." / "Certificate file '...' was not found." |
Wrong password or unreadable certificate |
"Could not load the client certificate from '...': .... Check CertPath and Password." |
Duplicated cylinder Marking |
"Duplicated cylinder marking: ... between cylinders ... and ..." (both cylinders ConfigurationFailure) |
Second eCLIQ bus controller in the process |
"ApiUrl (another eCLIQ bus controller, ..., is already running in this process, only one eCLIQ system is supported per driver process)" |
Negative capacity on the access panel |
"CredentialCapacity (is negative: ...; leave it unset to accept the default)" (same for CalendarCapacity) |
Services are registered before the configuration check, so Start, Stop and Restart still work in ConfigurationFailure: correct the property and Restart.
Configuration Transfer and Device Discovery
Load Configuration
Field |
Content |
|---|---|
Direction and invocation |
CWM → C4. Load Configuration command on the bus controller. Needs a connection; refused while an upload runs or waits ("Busy with ...; try again later."). |
Imported scope |
Cylinder groups (searchCylinderGroups), cylinders per group (searchCylinders filtered by group name), remote PDs (getRemotePDs) and keys (searchKeys) as Key 128 credentials named by their marking, without a holder. |
Merge and replacement rules |
New objects are added; cylinders move to their current group; groups and cylinders gone from CWM are archived (a group only once it holds no live device). C4 names of groups and remote PDs are kept. An archived remote PD that CWM lists again is restored with its name and ID. Used again later, it quickly adds new cylinders and keys. |
Credentials |
Matched to keys by code. A new credential starts Lost / Disabled if its key already is so in CWM. A credential whose key is gone is deleted only if nobody holds it; assigned ones are kept and reported. Credential names are restored to the key marking. |
Post-import work |
Restart the bus controller so the new devices are initialised. Assign the key credentials to persons and grant doors, then upload. |
Failure and recovery |
The load aborts and changes nothing if a group or cylinder read fails, no group holds a cylinder, or one cylinder is reported in two groups. A failed remote PD read keeps the existing remote PDs. Run it again once CWM answers. See T-CFG-03. |
Device Discovery, Import From File and Sending Configuration
Not supported. The device tree comes from Load Configuration only, and nothing but access data is written to CWM.
Configuration-transfer acceptance checks
After Load Configuration and Restart the tree matches CWM group by group, every key has a Key 128 credential named by its marking, all devices are Idle (groups Activated) and the bus controller log shows the retrieval started and successful events. See T-CFG-03.
Supported Identifiers
Supported credential formats
Credential / operation |
Format and limits |
Mapping and verification |
|---|---|---|
eCLIQ key (credential type Key 128) |
Key identity, a GUID. In C4: 32 hexadecimal digits without dashes, with or without the 0X prefix (CWM GUID 1A5BC68E-D551-41ED-9ED6-D16AFCE99108 is entered as 1A5BC68ED55141ED9ED6D16AFCE99108). In CWM: lower-case GUID with dashes. |
Converted both ways; codes are compared as GUIDs. T-ID-01 |
Credential name |
The key marking from CWM (E2.11, PR.4, ...). |
Copied by Load Configuration; used to attribute audit trails. The key type is read from CWM, never from the C4 name. |
PIN, card, combined, biometric |
Not applicable to eCLIQ. |
- |
Person and identifier mapping
An eCLIQ person (key holder) is created with the C4 person GUID as identity, and the C4 name and e-mail.
A name or e-mail change is sent on the next upload of that person.
A person may hold at most one eCLIQ key. Replacing a key (old one removed, new one added in the same change) is allowed.
Audit-trail events are attributed to the C4 holder of the credential whose name equals the key marking; an unassigned key is attributed to the Unknown person.
Card Learning and Person Data Read
Not supported. Keys are created as credentials by Load Configuration or entered by hand.
Default credentials and commissioning accounts
The integration uses no user account and no default password. CWM authenticates the driver by the client certificate issued for the integration; its rights are those granted to the certificate in CWM. Keep the certificate and its password out of documents, tickets and logs.
Credentials Synchronization
Ownership and object mapping
C4 object / field |
eCLIQ object / record |
Ownership and mapping rules |
|---|---|---|
Person |
Person (key holder) |
C4 → CWM. Created on first upload; deleted only by a Full upload once absent from C4. |
Key 128 credential assigned to a person |
Key handed out to the person |
C4 → CWM. A key held by someone else in CWM is moved only if C4 assigns it to this person. |
Credential status Lost / Disabled |
Key declared lost / broken |
C4 → CWM. Enabled again: declared found / operational, handed out again and programmed afresh. |
Access to a door |
E3: cylinder authorisation. E1 / E2: validity and schedule only. |
See Technology-Specific Functionality. |
Calendar on an access |
Key schedule (weekly periods per cylinder plug) |
E2 and E3 only. See Time restrictions. |
Upload modes and triggers
Mode |
Trigger / scope |
Data impact / completion evidence |
|---|---|---|
Full Upload |
Command on the access panel. Every person with access. Needed before any other upload in a fresh installation. |
Programs every key, then takes back every key nobody is to hold and deletes eCLIQ persons absent from C4. Every key is rewritten. |
Incremental Upload |
Command on the access panel. Persons whose access changed since the last upload. |
Adds, changes and revokes. A key whose programming is unchanged gets no write. |
Selective Upload |
Command on the access panel for one selected person. |
As Incremental, for that person. For several persons use Incremental Upload. |
Dynamic Upload |
Not supported. |
- |
Uploads run one at a time. An upload asked for while another runs is queued and merged with any upload already waiting (Full covers everything; Selectives combine their persons). Stop or Restart cancels the running upload: persons not reached keep their pending state for the next upload.
Lifecycle, access rights and exceptional conditions
Hand out: create a Key 128 credential under the person (code = key GUID without dashes, name = key marking) or assign an existing one with Assign the card, grant doors, upload, update the key at a PD.
Hand in: select the credential under the person and Revoke; remove the access; upload; update the key at a PD. The key is handed in and reset (validity NEVER, schedule cleared, E3 access removed). The person is kept.
Move a key to another person: Assign the card on the new holder, upload. The key is handed in from the old holder and handed out to the new one.
Delete person: only a Full upload deletes, and only once every key the person holds was handed in and reset. eCLIQ then refuses the same identity for 10-15 minutes.
Lost / broken: set the credential Lost (not recommended) or Disabled in C4 and upload. eCLIQ hands the key in by itself; the key loses all access. Set it Enabled again and upload: the key is declared found / operational, handed back to its C4 holder and programmed afresh.
Key held by another person in CWM: moved if C4 assigns it to the person being uploaded; otherwise the person fails and nothing is moved.
Unreadable calendars: every person gaining access fails with no eCLIQ call; revokes still run.
Time restrictions
For each person and door the driver asks C4's access calculator for the assigned calendars and turns their weekday time frames into weekly eCLIQ schedule periods (Sunday to Saturday) on that cylinder. Several calendars are merged; no calendar means unrestricted. A frame ending at 23:59 runs to midnight. C4's date-cut ranges for the coming week are not used, so a fresh access is not cut at the moment it was granted. Holiday frames are ignored.
An E2 / E3 key with no restriction and no revalidation gets an empty schedule, which in eCLIQ means unrestricted.
With revalidation, or when other doors on the same key are restricted, unrestricted doors get a whole-week period.
A calendar that allows no time fails the key with nothing written ("C4 calendars allow no time for key ...; not changed.").
E1 keys cannot carry a schedule; a calendar on an E1 door is reported ("E1 keys ignore time restrictions: ...").
Reserved memory positions
Not supported (F28). eCLIQ has no reserved positions. The driver keeps its own count of credential positions (one per access entry) and calendar positions against the access panel capacity: 10000 / 256 for a hosted CWM, CredentialCapacity / CalendarCapacity on-premise. Example: 120 persons with 6 doors each use 720 credential positions. Usage is reported to C4 as memory usage of the access panel (T-MEM-01).
Verification and recovery
A person is marked uploaded in C4 only when all of their operations succeeded. A failed person keeps an error text and is retried by the next upload. At the end of an upload one grouped summary names the affected keys: access mismatches between C4 and CWM as a Technical event, other failures as a Failure. The result on the key itself is checked in CWM (validity, schedule, accessible cylinders) and, after the key is updated at a PD, at the door.
Time Management
Time source and synchronization
Field |
Content |
|---|---|
Clock authority |
The eCLIQ system. The driver neither reads nor sets device time (F06 NA). |
Startup / periodic behaviour |
None. |
Conversion |
Audit-trail timestamps from CWM carry their offset and are stored in C4 as UTC. |
Schedules |
Written as weekday wall-clock times taken from the C4 calendar time frames. |
Failure / operational impact |
None from C4; a wrong key or cylinder clock is an eCLIQ matter. |
Event and access-time interpretation
An access event carries the time the key was used at the cylinder, not the time the key was docked; events can therefore appear in C4 dated days or months in the past, which is correct. Audit trails are collected by their CWM import date, so accesses recorded weeks earlier and uploaded only now are still delivered. An entry without a creation time falls back to its import time. E1 keys have no clock and are not collected.
Verification
T-TIM-01 (time synchronization) is not applicable. Event times are verified by T-EVT-02.
Technology-Specific Functionality
Key types
eCLIQ keys differ in what can be programmed into them. The driver reads the type CWM reports (TEMPORARY_KEY = E3, C_KEY = CKey, NORMAL_KEY = E1 or E2) and, for a normal key, the marking decides between E1 and E2. Keys must therefore be marked keytype.ID: E1.54, E2.3, E3.156; B1 / B2 / B3 count as E1 / E2 / E3. CKeys are marked PR or PSM, with or without an ID. Demo kits prefix DC. (DC.E3c, DC.PSM12).
Capability |
E1 |
E2 |
E3 |
CKey |
|---|---|---|---|---|
Hand out / in, reset, ALWAYS / NEVER |
yes |
yes |
yes |
no |
Schedules, revalidation, audit trails |
no |
yes |
yes |
no |
Cylinder access written by the driver |
no |
no |
yes |
no |
E3 keys
The upload writes the cylinder authorisations for exactly the doors C4 grants, then the schedule. Removing the last door removes all access. This is the only key type whose doors C4 controls fully.
E1 keys
An E1 key can only be valid (ALWAYS) or not (NEVER); its doors are the cylinders programmed in CWM to accept it. The driver compares those with the doors C4 grants:
CWM compared with C4 |
Result |
|---|---|
At least one cylinder accepts the key and C4 grants all of them |
ALWAYS |
A cylinder accepts the key that C4 does not grant |
NEVER; person not uploaded: "E1 key ... switched off: ... accept it in CWM but are not granted in C4." |
No cylinder accepts the key |
NEVER; person not uploaded: "E1 key ... switched off: no cylinder accepts it in CWM." |
ALWAYS, but a granted door does not accept the key |
Technical event "Granted in C4 but not accepted in CWM: ..." |
C4 gives a time restriction |
Technical event "E1 keys ignore time restrictions: ..." |
E2 keys
An E2 key opens the cylinders CWM authorises it for, limited by its validity and schedule. With an empty schedule it opens all of them; a cylinder missing from a non-empty schedule is not opened. When CWM authorises the key on cylinders C4 does not grant, the driver therefore writes a whole-week schedule for the granted doors instead of an empty one. A granted door that CWM does not authorise is reported ("Granted in C4 but not accepted in CWM: ..."); the driver cannot change E2 authorisations.
CKeys (PR / PSM)
CKeys are never programmed. A person holding one is uploaded without error, and the key is left as it is.
Remote Device Control
Supported commands
Element |
Command |
Meaning / precondition |
Result / test |
|---|---|---|---|
CliQBusController |
Start |
Starts communication; also clears CommunicationFailure. |
Idle when CWM answers. T-CON-02 |
CliQBusController |
Stop |
Stops communication; cancels the running upload and drops queued ones. |
Disconnected. T-UPL-02 |
CliQBusController |
Restart |
Stop, then Start. Required after changes to the device tree or bus controller properties. |
Idle when CWM answers. T-CON-02 |
CliQBusController |
Load Configuration |
Reads the tree and keys from CWM. Needs a connection; refused during uploads. |
Retrieval events; tree updated. T-CFG-03 |
eCliQAccessPanel |
Full / Incremental / Selective upload |
Programs CWM. Needs a connection; queued behind a running upload. |
Persons uploaded or failed. T-UPL-01 to T-UPL-05 |
Control restrictions
There are no door or cylinder commands: eCLIQ cylinders cannot be opened or locked remotely. A command accepted by C4 has changed CWM, not the key; the key changes when it is updated at a PD. A command that cannot run at all is logged as CommandFailed with its reason ("Not connected to eCLIQ.", "Busy with Full upload; try again later.").
Status Information Display
CliQBusController
Status |
Description / source condition |
Clearing / update behaviour |
|---|---|---|
Starting |
Driver starting. |
At start. |
ConnectingInProgress |
Connecting to CWM. |
At start and after Start / Restart. |
Idle |
Connected; uploads, Load Configuration and audit trails run. |
Set when the connection check succeeds. |
Disconnected |
Not connected, or CommunicationFailure after RetryAttempts failed checks. |
Cleared by Start or Restart once CWM answers. |
ConfigurationFailure |
A property is missing or invalid, or a cylinder Marking is duplicated. |
At start; cleared by fixing the property and Restart. |
LoadingDeviceConfiguration |
Load Configuration running. |
Returns to the real connection state when the load ends. |
UploadingCredentials |
An upload is in progress (shown as Upload in progress). |
Set by the upload framework for the duration of the upload. |
eCliQAccessPanel
Status |
Description / source condition |
Clearing / update behaviour |
|---|---|---|
Idle |
Follows the bus controller: connected. |
With the bus controller. |
Disconnected |
Follows the bus controller. |
With the bus controller. |
UploadingCredentials |
An upload is in progress (Upload in progress). |
Set by the upload framework. |
Group
Status |
Description / source condition |
Clearing / update behaviour |
|---|---|---|
Activated |
Connected. Groups have no Idle status; Activated stands for it. |
With the bus controller. |
Disconnected |
Follows the bus controller. |
With the bus controller. |
eCliQCylinder
Status |
Description / source condition |
Clearing / update behaviour |
|---|---|---|
Idle (Door Normal) |
Connected; the cylinder is known in C4. The cylinder state itself is not reported by eCLIQ. |
With the bus controller. |
Disconnected |
Follows the bus controller. |
With the bus controller. |
ConfigurationFailure |
Its Marking is duplicated on another cylinder. |
At start; cleared by fixing the Marking and Restart. |
RemotePD
Status |
Description / source condition |
Clearing / update behaviour |
|---|---|---|
Idle |
CWM reports the PD online. |
Every health check (Timeout) and right after the connection becomes ready. |
Disconnected |
CWM reports the PD offline, or the bus controller is disconnected. |
Every health check; ConnectionInterrupted logged on change. |
Unknown |
The PD state could not be read. |
Next successful poll; no event. |
Initialization, connection and freshness
When the connection becomes ready every child is set Idle (groups Activated) and the remote PDs are then polled for their real state. A failed connection check is tolerated until RetryAttempts consecutive checks have failed; the states then turn Disconnected (bus controller CommunicationFailure) and communication stays stopped until an operator issues Start or Restart, even if CWM becomes reachable again. C4 shows the last state set; there is no separate freshness indication.
State precedence and restoration
ConfigurationFailure takes precedence over all other states and is cleared only by Restart with a valid configuration. Disconnected of the bus controller propagates to every child. Communication health is the only condition reported for groups and cylinders; eCLIQ reports no physical cylinder state.
Acceptance criteria
The real condition is established in CWM (Web Service reachable, remote PD online / offline). Expected states and delays are tested by T-CON-01, T-CON-02 and T-STS-01 with the limits under Measurable acceptance limits.
Events and Audit Log
Event mapping
Source event / code |
C4 event / message |
Object / person / time |
|---|---|---|
Audit trail ACCESS_GRANTED |
AccessGranted |
Cylinder; credential holder; access time |
Audit trail NOT_IN_SCHEDULE |
AccessDeniedActiveTimeRestriction |
Cylinder; credential holder; access time |
Audit trail ACCESS_DENIED_OUTSIDE_VALIDITY, _VALIDITY_EXPIRED, _NOT_YET_VALID |
AccessDeniedOutsideOfValidityPeriod |
Cylinder; credential holder; access time |
Audit trail ACCESS_DENIED_UNKNOWN_KEY, _KEY_NOT_FOUND |
AccessDeniedUnknownCredential |
Cylinder; credential code; access time |
Audit trail ACCESS_DENIED, _DOOR_NOT_ALLOWED, _NO_AUTHORIZATION, any other code |
AccessDeniedDoorNotAllowed |
Cylinder; credential holder; access time |
Remote PD goes offline / online |
ConnectionInterrupted / ConnectionEstablished |
RemotePD; other end: bus controller |
First failed connection check |
CommunicationLost |
Bus controller |
Connection restored before RetryAttempts ran out |
DriverConnectionRestored (with the number of retries) |
Bus controller |
RetryAttempts exhausted |
DriverStopped |
Bus controller |
Missing or invalid property |
ConfigurationErrorInvalidPropertyValue (description as under Configuration example and validation) |
Bus controller |
Load Configuration |
DeviceConfigurationRetrievalStarted ("Reading cylinder groups and cylinders from eCLIQ") / Successful ("Cylinder groups, cylinders and credentials synchronised") / Failed |
Bus controller |
Uploads |
UploadStarted / UploadSuccessfullyCompleted / upload failure events (upload framework) |
Access panel |
Something failed (upload, read) |
Failure: "Failure on '...'. Description: '...'" |
Bus controller |
Something to know, nothing failed |
Unknown (Technical event): "Technical event on device '...'. More details: '...'" |
Bus controller |
A command could not run |
CommandFailed: "Command '...' issued by '...' on '...' failed. Reason: ..." |
Bus controller |
Event context and interpretation
Access events name the key's credential (by its name, the key marking) and its C4 holder (Unknown person for an unassigned key), and carry the access time. The reader is always Unknown: C4 requires a reader, which eCLIQ cannot provide. An unrecognised result code is still reported as a refused access. Displayed wording follows the C4 language; event identifiers are given here.
Device Audit Log Retrieval
Keys record accesses offline; they reach CWM when the key is updated at a PD and reach C4 with the next audit-trail poll.
Polling is watermarked on the CWM import date and persisted, so a driver restart neither loses nor repeats entries.
A new bus controller starts collecting from the moment it first starts; earlier history is not imported.
After an outage the backlog is collected 28 days per poll until caught up.
An entry for a cylinder unknown to C4 raises a Failure: "Audit trail for unknown cylinders: ... Run Load configuration."
An entry for a key whose marking matches no Key 128 credential name is skipped (trace only).
E1 keys are not collected: they have no clock.
Diagnostics and evidence
Operator-relevant messages are C4 events (above). Per-key details of an upload are written to the driver trace log only, to keep the event log readable. The trace contains key codes and markings, no passwords; person names may appear and must be handled as personal data.
Operation, Recovery and Maintenance
Normal operation and health checks
Running normally the bus controller is Idle, the health check runs every Timeout, remote PD states are refreshed with it, and audit trails are collected every AuditTrailTimer. The health check is skipped while an upload runs, because the upload itself proves the link. Cylinders keep enforcing access whether or not C4 or CWM are reachable.
Failure and recovery behavior
Condition |
Observable impact |
Recovery / data integrity |
|---|---|---|
CWM unreachable |
CommunicationLost at the first failed check. After RetryAttempts x Timeout: CommunicationFailure, all devices Disconnected, DriverStopped; uploads and Load Configuration refused. |
Restore the network, then Start or Restart. Audit trails catch up from the watermark. |
Failure during an upload |
Affected persons are not uploaded and keep their error text. |
The next upload retries them. |
Stop or Restart during an upload |
The upload stops before the next person: Technical event "... upload stopped; the rest follows in the next upload." |
Start, then upload again. |
Driver or C4 restart |
Queued uploads are dropped. |
Watermarks and last-written key programming are persisted; upload again. |
Remote PD offline |
RemotePD Disconnected; keys cannot be updated there. |
Automatic when CWM reports it online. |
CWM server error (status code 0) |
The operation fails; mostly a connectivity problem on the CWM side. |
Retry the action. |
Connection ownership and deployment constraints
CWM can be used by operators at the same time as the driver. Changes made there to persons, keys or key programming are overwritten by uploads (see Operational warnings). Run one bus controller per CWM tenant and one eCLIQ bus controller per driver process.
Backup, restore and decommissioning
Back up the client certificate file and its password (in the approved secret store) and the C4 configuration. The driver keeps its audit-trail watermark and key fingerprints in the C4 persistent store, which is part of the C4 backup.
After restoring C4 from an older backup, run a Full upload: it rewrites every key and ignores the stored fingerprints.
To decommission without touching CWM data: Stop the bus controller and remove the eCLIQ devices. Persons and keys stay in CWM as they are. Never run a Full upload against a C4 from which the persons were removed.
To withdraw all access before decommissioning: remove the access in C4, run an upload and update the keys at a PD; then Stop.
Troubleshooting and Support
Troubleshooting / Knowledge base
Symptom / diagnostic |
Checks and likely cause |
Resolution / verification |
|---|---|---|
Bus controller ConfigurationFailure; event names CertPath and Password |
Certificate missing, expired or wrong password. |
Fix CertPath / Password and Restart. |
"ApiUrl must use HTTPS; ..." |
ApiUrl is http://. |
Use the https:// address. |
"SupportedCredentialTypes not configured. Select Key 128." |
Credential type not selected, or not installed. |
Install Key 128 (Settings > Packages > Credentials) and select it. |
Authentication errors |
Certificate invalid, expired or without Web Service rights in CWM. |
Renew the certificate or its rights in CWM; Restart. |
CommandFailed "Not connected to eCLIQ." |
No connection, or CommunicationFailure. |
Check the network, then Start. |
CommandFailed "Busy with ...; try again later." |
Load Configuration while an upload runs. |
Wait for the upload. |
Person not uploaded: "eCLIQ is still deleting ... (~15 min); retry later." |
The same person was deleted in the last 15 minutes (for example two Full uploads in quick succession). |
Upload again after 15 minutes, or recreate the person in C4 with the same details (new identity). |
Person not uploaded: "'...' has 2 keys (...), only one is allowed." |
More than one eCLIQ key assigned. |
Leave one key. |
"E1 key ... switched off: ..." |
CWM cylinder authorisations and C4 doors differ. |
Grant the named doors in C4, or reprogram the cylinders in CWM. |
Technical event "Authorised in CWM, not granted in C4, no schedule limits it: ..." |
An E2 key without an electronic door in C4 is authorised on cylinders in CWM. |
Align CWM and C4. |
Person not uploaded: "Plugs of door ... not found; key not changed." |
Cylinder Marking missing or not matching CWM. |
Fix the Marking or run Load Configuration. |
Failure "Audit trail for unknown cylinders: ..." |
A cylinder in CWM has no C4 door. |
Run Load Configuration, then Restart. |
Missing access events |
Key not updated at a PD; AuditTrailTimer long; door missing in C4; credential renamed in C4; E1 key. |
Update the key; check the bus controller events; run Load Configuration to restore names. |
Status code 0 |
CWM server-side error, mostly connectivity. |
Retry the action. |
C4 refuses new event types after a driver update |
The registered plug-in is older than the driver. |
Register the plug-in again. |
First Full upload takes minutes |
Every unassigned key is read once. |
Expected; later Full uploads are fast. |
Support information package
Provide the driver and C4 versions, hosted or on-premise CWM, the time and time zone of the issue, the C4 events around it, the driver trace log, and the key markings and cylinder markings involved. Never include the certificate or its password.
Terminology
Term |
Definition |
Use / location |
|---|---|---|
CWM |
CLIQ Web Manager, the eCLIQ management server |
|
E1 / E2 / E3 |
Basic key / quartz key (schedules) / dynamic key (schedules and cylinder access) |
Key types |
CKey (PR, PSM) |
Key that cannot be programmed through the Web Service |
Key types |
Marking |
Label of a key or cylinder in CWM (E2.11, DC.N316) |
Addressing, audit trails |
Plug |
Side of a cylinder; electronic or mechanical. Access is written per electronic plug. |
E3 access |
PD / remote PD |
Programming device (key terminal) where a key is updated |
Key updates |
Validity |
ALWAYS, ALWAYS with revalidation, or NEVER |
Upload |
Schedule |
Weekly periods per cylinder plug restricting when a key opens |
Time restrictions |
Integration Tests
Test scope, environment and safety
The tests validate the scope in this manual on a test CWM tenant. Results are checked in C4 (event log, device status, person upload state, device tree) or in CWM (key Information, Validity, Schedule, Accessible cylinders and Update history).
Field |
Content |
|---|---|
Test run / purpose |
Driver release qualification. Results, tester and date are recorded in a versioned test report. |
Version combination |
COMP-01 |
Equipment and topology |
E1 (or B1), E2, E3 and PR or PSM keys; cylinders in at least two groups (examples use DC.N316, DC.N320, DC.N531, DC.N532, DC.N534); one wall / remote PD; C4 server with outbound HTTPS to CWM. |
Baseline and data |
Synthetic persons only. Settings: Timeout 00:01:00, AuditTrailTimer 00:01:00, RetryAttempts 3, RevalidationTimerInDays 0 (T-ACL-01 step 4 changes it). |
Authorizations / safety |
Test tenant or approved commissioning window; network cut on the C4 server side only. |
Evidence and instruments |
C4 event log export, CWM screenshots of key details, time of each step. |
Physical checks need the key updated at the PD first; until then CWM shows a pending update.
Measurable acceptance limits
Parameter |
Approved value / measurement |
|---|---|
T_DETECT |
RetryAttempts x Timeout (3 min with the test settings), from the network cut to CommunicationFailure. |
T_RECONNECT |
One Timeout after the network returns, when fewer than RetryAttempts checks failed. |
T_EVENT |
One AuditTrailTimer after the key is updated at the PD. |
T_STATE (remote PD) |
One Timeout. |
T_UPLOAD |
No fixed limit; it grows with the number of persons and keys. Reference: about 0.4 s per unassigned key on the first Full upload. |
Coverage and selection rules
Requirement / function |
Manual record / variant |
Test ID(s) |
Coverage decision |
|---|---|---|---|
Identity, licence, package |
Compatibility; Licensed Devices |
T-LIC-01, T-GEN-01 to T-GEN-04 |
Required |
Connection and recovery |
Operation, Recovery and Maintenance |
T-CON-01 to T-CON-03 |
Required |
F04 Encrypted Communication |
Security and safety boundaries |
T-SEC-01 |
Required |
Properties and addresses |
Device Configuration |
T-CFG-01, T-CFG-02, T-GEN-03 |
Required |
F05 Load Configuration |
Configuration Transfer |
T-CFG-03 |
Required |
Missing device |
Device Audit Log Retrieval |
T-CFG-04 |
Required |
Status |
Status Information Display |
T-STS-01, T-CON-01, T-CON-02 |
Required |
F26 Card Management |
Supported Identifiers |
T-ID-01, T-ID-02 |
Required |
Upload modes and lifecycle |
Credentials Synchronization |
T-UPL-01 to T-UPL-06 |
Required |
Memory usage |
Reserved memory positions |
T-MEM-01 |
Required |
Key types and status |
Technology-Specific Functionality |
T-KEY-01 to T-KEY-06 |
Required |
F23 Access Time Restrictions |
Time restrictions |
T-ACL-01 |
Required |
F24 Holidays Support |
Time restrictions |
- |
NA: not supported |
F33 Device Audit Log Retrieval |
Events and Audit Log |
T-EVT-01A to T-EVT-01C, T-EVT-02 |
Required |
F06 Time Synchronization |
Time Management |
T-TIM-01 |
NA: eCLIQ owns device time |
Door commands, alarms, I/O, video |
- |
T-ACS, T-ALM, T-IO, T-VID |
NA: not offered by eCLIQ |
Test result and execution record
Each case uses a description, prerequisites, paired Test Steps and Expected Results, expected audit evidence and cleanup. PASS means every applicable expected result met its limit; FAIL means at least one did not; BLOCKED means a prerequisite prevented execution; NOT RUN means no execution; NA means an approved, documented non-applicability decision. A waiver or known defect does not turn a failed test into a pass. Results are recorded in a versioned test report.
Test catalog
Test ID |
Procedure |
|---|---|
T-LIC-01 |
License attribute |
T-GEN-01 |
Driver copyright |
T-GEN-02 |
Files in driver package |
T-GEN-03 |
Device properties definition |
T-GEN-04 |
Plugin exception logging |
T-CON-01 |
Network connection lost and restored |
T-CON-02 |
Communication stopped after RetryAttempts |
T-CON-03 |
DNS name resolving |
T-SEC-01 |
Certificate and HTTPS |
T-CFG-01 |
Property value validation |
T-CFG-02 |
Duplicated addresses |
T-CFG-03 |
Load Configuration |
T-CFG-04 |
Missing device |
T-STS-01 |
Remote PD status |
T-ID-01 |
Card management - key hand-out |
T-ID-02 |
Invalid credential - one key per person |
T-UPL-01 |
Person lifecycle |
T-UPL-02 |
Interrupted and concurrent uploads |
T-UPL-03 |
Full upload clean-up |
T-UPL-04 |
Upload scenarios |
T-UPL-05 |
Selective upload |
T-UPL-06 |
Wrong C4 data and keys held elsewhere |
T-MEM-01 |
Memory info |
T-KEY-01 |
E1 keys |
T-KEY-02 |
E2 keys |
T-KEY-03 |
E3 keys |
T-KEY-04 |
CKeys |
T-KEY-05 |
Lost and broken keys |
T-KEY-06 |
Key hand-in and reassignment |
T-ACL-01 |
Access time restrictions |
T-EVT-01A |
Handling Access Granted event |
T-EVT-01B |
Handling Access Denied event - door not allowed |
T-EVT-01C |
Handling Access Denied event - time restriction |
T-EVT-02 |
Device audit log retrieval |
T-LIC-01 | License attribute
Description: Verify the licensed attribute of the driver.
Applicability: Core.
Prerequisites: Device tree with a known number of eCliQCylinder nodes.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Create a device tree with one eCliQCylinder (plus bus controller, access panel and group). |
The C4 device tree contains one eCliQCylinder with its bus controller, access panel and group. |
2 |
Start the driver and check the licence of the bus controller. |
One licence is consumed for this driver. |
3 |
Run Load Configuration and Restart with N cylinders. |
N licences are consumed. Bus controller, access panel, groups and remote PDs consume none. |
Notes:
When the driver starts, C4 counts the instances marked with the Licensed attribute (eCliQCylinder) and requests that number from the installed licence.
Cleanup: Return the device tree to the approved configuration.
T-GEN-01 | Driver copyright
Description: Verify that the driver copyright information is defined correctly.
Applicability: Core.
Prerequisites: Driver package installed.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Check the driver copyright information (driver properties in C4 or the DLL file properties). |
Copyright © ARYKA IN-WEST a.s. 2026 |
Where:
COMPANY = ARYKA IN-WEST a.s., the company that developed the driver.
YEAR = 2026, the year the driver was released.
Cleanup: None.
T-GEN-02 | Files in driver package
Description: Verify that the plugin file contains only the files needed to run the driver.
Applicability: Core.
Prerequisites: eCLIQ.c4plugin of the release.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Extract all files from eCLIQ.c4plugin (for example with 7-Zip). |
The package contents are extracted and available for comparison in step 2. |
2 |
Compare the content with the expected list. |
ARYKA.C4.Driver.eCLIQ |
Notes:
Non-common files have to be justified by the developer.
Cleanup: None.
T-GEN-03 | Device properties definition
Description: Verify that every device property is described in this manual and works as described.
Applicability: Core.
Prerequisites: Driver installed.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Add each device type to the tree: CliQBusController, eCliQAccessPanel, Group, eCliQCylinder, RemotePD. |
The tree contains the five device types, with their properties available for inspection in C4. |
2 |
Compare the properties shown in C4 with the Device Configuration chapter. |
Every property is described, with its default and range. |
3 |
Test the function of each property (T-CFG-01, T-CON-01, T-ACL-01 step 4, T-MEM-01). |
Behaviour matches the manual. |
Cleanup: Remove only the device nodes created for this test, restore the approved device tree and Restart the bus controller.
T-GEN-04 | Plugin exception logging
Description: Verify that expected situations are handled without exceptions.
Applicability: Core.
Prerequisites: Trace log available.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Run T-SEC-01, T-CON-02 and T-CFG-01 and inspect the trace log. |
No exception stack traces for expected situations (wrong password, unreachable CWM, invalid property); they are reported as configuration errors or warnings. |
Notes:
An exception may be logged only in unexpected situations.
Cleanup: Complete the cleanup specified in T-SEC-01, T-CON-02 and T-CFG-01, and confirm that the approved configuration and network connection are restored.
T-CON-01 | Network connection lost and restored
Description: Verify detection of a lost connection and its recovery before RetryAttempts run out.
Applicability: Core.
Prerequisites: Driver Idle; RetryAttempts 3, Timeout 00:01:00.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Cut the network of the C4 server. |
The C4 server connection to CWM is interrupted. Check the first failed health check in step 2. |
2 |
Wait one Timeout. |
CommunicationLost on the bus controller. States stay Idle while fewer than RetryAttempts checks have failed. |
3 |
Restore the network before RetryAttempts x Timeout. |
Within T_RECONNECT: DriverConnectionRestored with the number of retries; all devices at their real state. |
Expected audit / evidence:
CommunicationLost - 'DEVICE'
DriverConnectionRestored - 'DEVICE', number of retries: RETRYCOUNT
Where:
DEVICE represents the name of the bus controller (or the device named in the step).
RETRYCOUNT represents the number of failed checks before the connection was re-established.
Cleanup: Confirm that the network is restored and the bus controller is Idle. If RetryAttempts was exhausted, issue Start or Restart after restoring the network.
T-CON-02 | Communication stopped after RetryAttempts
Description: Verify that communication stays stopped until an operator restarts it.
Applicability: Core.
Prerequisites: Driver Idle.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Start the driver. |
Bus controller, access panel, cylinders and remote PDs Idle; groups Activated. |
2 |
Cut the network of the C4 server. |
After T_DETECT: bus controller CommunicationFailure / Disconnected, all children Disconnected. |
3 |
Run a Full upload. |
CommandFailed "Not connected to eCLIQ." |
4 |
Restore the network and wait two Timeouts. |
Still Disconnected. |
5 |
Issue Start. |
Back to Idle. |
Expected audit / evidence:
CommunicationLost - 'DEVICE'
DriverStopped - 'DEVICE'
CommandFailed - Command 'Full upload' issued by 'PERSON' on 'DEVICE' failed. Reason: Not connected to eCLIQ.
Where:
DEVICE represents the name of the bus controller (or the device named in the step).
PERSON represents the name of the person who issued the command or used the key.
Cleanup: Leave the network restored and the bus controller Idle.
T-CON-03 | DNS name resolving
Description: Verify that the driver connects when ApiUrl names the host by DNS name.
Applicability: Core.
Prerequisites: CWM reachable by host name.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Set ApiUrl to the CWM DNS host name with its actual port and context path, for example https://cliq.example.com:8989/CLIQWebManager. |
ApiUrl contains the tenant DNS name. Connection is verified after Restart in step 2. |
2 |
Restart. |
The bus controller connects and all devices go to their real state. |
Expected audit / evidence:
DriverStarted - 'DEVICE'
Where:
DEVICE represents the name of the bus controller (or the device named in the step).
Cleanup: Restore the approved ApiUrl and Restart the bus controller.
T-SEC-01 | Certificate and HTTPS
Description: Verify that a wrong certificate, a wrong password and a non-HTTPS URL are refused.
Applicability: Core.
Prerequisites: Working configuration noted.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Set a wrong Password, Restart. |
ConfigurationFailure; the event names CertPath and Password. Start / Stop / Restart are still accepted. |
2 |
Restore Password; set CertPath to a missing file, Restart. |
ConfigurationFailure, "Certificate file '...' was not found." |
3 |
Restore CertPath; set ApiUrl to http://..., Restart. |
ConfigurationFailure, "ApiUrl must use HTTPS; '...' uses http." |
Expected audit / evidence:
ConfigurationErrorInvalidPropertyValue - "Could not load the client certificate from 'PATH': ... Check CertPath and Password."
ConfigurationErrorInvalidPropertyValue - "Certificate file 'PATH' was not found."
ConfigurationErrorInvalidPropertyValue - "ApiUrl must use HTTPS; 'URL' uses http."
Where:
PATH represents the CertPath value.
URL represents the ApiUrl value.
Cleanup: Restore the working properties and Restart.
T-CFG-01 | Property value validation
Description: Verify that invalid property values are detected during start.
Applicability: Core.
Prerequisites: A known working configuration is recorded. Run each case independently with the driver stopped and all properties other than the one under test set to valid values.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Leave SupportedCredentialTypes empty, Start. |
ConfigurationFailure, "SupportedCredentialTypes not configured. Select Key 128." |
2 |
Clear ApiUrl, Start; then enter "not a url", Start. |
"ApiUrl is empty." / "ApiUrl 'not a url' is not a valid URL." |
3 |
With the driver stopped, set CloudSolution to False and CredentialCapacity to -1, then Start. |
"CredentialCapacity (is negative: -1; leave it unset to accept the default)" |
4 |
Set Timeout and AuditTrailTimer to 00:00:00, Start. |
Accepted; 5 minutes are used. |
5 |
Start the original CliQBusController with valid settings. Add a second CliQBusController in the same driver process and Start it. |
ConfigurationFailure: "... only one eCLIQ system is supported per driver process" |
Notes:
Restore the valid baseline before each case and before repeating a case for another property. Repeat the checks for every applicable property of each device type. The properties have no Regex validation in the C4 client; checks run when the driver starts.
Cleanup: Remove the second test controller, restore the recorded valid values and Restart the original controller.
T-CFG-02 | Duplicated addresses
Description: Verify the duplicated-address check on cylinders (address = Marking).
Applicability: Core.
Prerequisites: Driver stopped.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Create two eCliQCylinder devices with the same Marking. |
Two distinct eCliQCylinder nodes have the same Marking value. |
2 |
Start the driver. |
Both cylinders ConfigurationFailure; bus controller ConfigurationFailure; the driver does not finish its start. |
Expected audit / evidence:
ConfigurationErrorInvalidPropertyValue - "Duplicated cylinder marking: NUMBER between cylinders DEVICE1 and DEVICE2"
Where:
DEVICE1 and DEVICE2 represent the names of the cylinders sharing the Marking.
NUMBER represents the Marking.
Notes:
Groups are addressed by GroupID and remote PDs by their device ID, which Load Configuration keeps unique.
Cleanup: Remove the duplicate and Restart.
T-CFG-03 | Load Configuration
Description: Verify the device tree, credential import and the ownership of names.
Applicability: Core.
Prerequisites: Driver Idle; bus controller and access panel created, with the temporary cylinder required for the first start under Licensed Devices.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Run Load Configuration, then Restart. |
One Group per cylinder group with its cylinders; the remote PD under the access panel; one Key 128 credential per key, named by its marking. All devices Idle (groups Activated). |
2 |
Add a cylinder in CWM, rename a group in C4 and in CWM, run Load Configuration. |
The new cylinder is added; the C4 group name stays; GroupName shows the CWM name. |
3 |
Archive the remote PD in C4, run Load Configuration. |
It is back with the same name and ID, without an event. |
4 |
Declare a key lost in CWM, delete its credential in C4, run Load Configuration. |
The credential is recreated as Lost. |
5 |
Start a Full upload and immediately run Load Configuration. |
CommandFailed "Busy with Full upload; try again later."; the upload finishes. |
Expected audit / evidence:
'PERSON' sent command 'Load Configuration' to 'DEVICE'.
DeviceConfigurationRetrievalStarted - "Reading cylinder groups and cylinders from eCLIQ"
DeviceConfigurationRetrievalSuccessful - "Cylinder groups, cylinders and credentials synchronised"
Where:
DEVICE represents the name of the bus controller (or the device named in the step).
PERSON represents the name of the person who issued the command or used the key.
Notes:
On an existing tree the C4 names of groups and remote PDs do not change.
Cleanup: Restore the original group names and the test key's original status in both CWM and C4. Remove only the cylinder added for this test from CWM, then run Load Configuration and Restart.
T-CFG-04 | Missing device
Description: Verify that audit entries of a cylinder missing from the C4 tree are reported, and the driver keeps working.
Applicability: E2 / E3 key.
Prerequisites: Key with access to a cylinder.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Archive the cylinder in C4 and Restart. |
The cylinder is archived in C4 and the driver has been restarted with that cylinder absent from the active tree. |
2 |
Use the key at that cylinder and update the key at the PD. |
Within T_EVENT: Failure naming the cylinder marking. Other events are delivered. |
3 |
Run Load Configuration and Restart. |
The cylinder is back; later events are logged on it. |
Expected audit / evidence:
Failure - Failure on 'DEVICE'. Description: 'Audit trail for unknown cylinders: MARKING. Run Load configuration.'
Where:
DEVICE represents the name of the bus controller (or the device named in the step).
MARKING represents the marking of the missing cylinder.
Notes:
Entries reported this way are not delivered later.
Cleanup: None.
T-STS-01 | Remote PD status
Description: Verify that the RemotePD status follows CWM.
Applicability: Where a remote PD exists.
Prerequisites: Remote PD online.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Unplug the remote PD. |
Within T_STATE: Disconnected and ConnectionInterrupted. |
2 |
Plug it back. |
Within T_STATE: Idle and ConnectionEstablished. |
Expected audit / evidence:
ConnectionInterrupted - 'PD' / 'DEVICE'
ConnectionEstablished - 'PD' / 'DEVICE'
Where:
PD represents the RemotePD name.
DEVICE represents the name of the bus controller (or the device named in the step).
Cleanup: None.
T-ID-01 | Card management - key hand-out
Description: Verify that a key entered in C4 is handed out and opens the granted door.
Applicability: Core.
Prerequisites: Spare E3 key; its GUID from CWM; door DC.N316.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Create a person; add a Key 128 credential with the key GUID without dashes as Code and the key marking as Name. |
The person has one Key 128 credential whose Code matches the CWM key GUID without dashes and whose Name matches the key marking. |
2 |
Grant DC.N316 and run a Full upload (first upload of the installation) or Incremental upload. |
Person uploaded. CWM: key handed out to the person, ALWAYS, DC.N316 in Accessible cylinders. |
3 |
Update the key at the PD and use it at DC.N316. |
Door opens; AccessGranted for the person within T_EVENT. |
Expected audit / evidence:
UploadStarted / UploadSuccessfullyCompleted - 'UPLOAD_TYPE' upload to 'PANEL'
AccessGranted - 'PERSON' at 'DOOR' using 'KEY', reader Unknown
Where:
UPLOAD_TYPE represents the upload issued.
PANEL represents the eCliQAccessPanel.
PERSON represents the test person.
DOOR represents the cylinder.
KEY represents the credential name (key marking).
Cleanup: Keep for T-UPL-01.
T-ID-02 | Invalid credential - one key per person
Description: Verify that a person can hold only one eCLIQ key.
Applicability: Core.
Prerequisites: E2 and E3 keys. Run the three cases independently. Use a new test person for step 1 and a valid E3-only assignment as the starting state for steps 2 and 3.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
New person with both keys, upload. |
Person not uploaded; nothing changed in CWM. |
2 |
Starting with a person who holds only the E3 key, add E2 and upload. |
As step 1; the E3 keeps working unchanged. |
3 |
Starting again with the valid E3-only assignment, remove E3 and add E2 in the same change, then upload. |
Uploaded. CWM: E3 in stock, NEVER; E2 handed out and programmed. |
Expected audit / evidence:
Failure - Failure on 'DEVICE'. Description: ''PERSON' has 2 keys (KEYS), only one is allowed.'
Where:
DEVICE represents the name of the bus controller (or the device named in the step).
PERSON represents the name of the person who issued the command or used the key.
KEYS represents the key codes.
Cleanup: Restore the approved key assignments and access, upload the affected persons and update the keys at the PD. Remove only persons created for this test and complete the documented Full upload cleanup where required.
T-UPL-01 | Person lifecycle
Description: Verify creating, renaming, revoking and deleting a person.
Applicability: Core.
Prerequisites: Person and key from T-ID-01.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Rename the person, upload. |
CWM: name updated. |
2 |
Remove all access, upload. |
CWM: person exists; key in stock, NEVER, no schedule, no cylinders. |
3 |
Delete the person in C4, Full upload. |
CWM: person deleted; key in stock, NEVER. |
4 |
Within 15 minutes restore the person and upload. |
Not uploaded, "eCLIQ is still deleting PERSON (~15 min); retry later." After 15 minutes the upload succeeds. |
5 |
Run an Incremental upload twice with no change. |
CWM Update history: no new entry from the second upload. |
Where:
PERSON represents the name of the person who issued the command or used the key.
Cleanup: Remove the test person from C4 and run a Full upload to remove the corresponding CWM person. Update the returned test key at the PD so the revoked state reaches the key.
T-UPL-02 | Interrupted and concurrent uploads
Description: Verify queuing, Stop and a disconnection while sending credentials.
Applicability: Core.
Prerequisites: Several persons pending.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Start a Full upload, then immediately a Selective upload. |
Both finish; no CommandFailed. |
2 |
Start a Full upload and issue Stop a few seconds in. |
Technical event "Full upload stopped; the rest follows in the next upload."; persons not reached show "Upload stopped before this person; not changed." |
3 |
Start, then Full upload. |
All persons uploaded. |
4 |
Start an upload of several persons and cut the network of the C4 server during it; restore it. |
Persons whose calls failed are not uploaded and keep their error; no person is half-changed in C4. The next upload after reconnection uploads them. |
Expected audit / evidence:
Unknown - Technical event on device 'DEVICE'. More details: 'Full upload stopped; the rest follows in the next upload.'
Where:
DEVICE represents the name of the bus controller (or the device named in the step).
Cleanup: Restore the network. If communication has stopped, issue Start or Restart, then complete an upload for the pending persons and confirm that no test upload remains pending.
T-UPL-03 | Full upload clean-up
Description: Verify that a Full upload takes back unassigned keys and deletes persons missing from C4.
Applicability: Test tenant only.
Prerequisites: Test tenant.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
In CWM hand a spare key to a C4 person who has no access to it in C4; Full upload. |
CWM: key in stock, NEVER. No C4 event (trace only). |
2 |
Create a person in CWM only; Full upload. |
CWM: person deleted; any key they held in stock, NEVER. |
Cleanup: Confirm that the temporary CWM-only person is removed and the spare test key is in stock with validity NEVER. Update the key at the PD before returning it.
T-UPL-04 | Upload scenarios
Description: Verify access and attribution after each change of persons, doors and keys.
Applicability: Core; E3 keys (doors fully controlled by C4).
Prerequisites: Persons A, B, C; doors D1 (DC.N316) and D2 (DC.N320); keys C1, C2, C3. For a valid Before state, establish it with a completed upload. For the deliberately invalid Before states in U09-U12, verify rejection of the multi-key assignment instead of expecting a successful baseline upload. Then apply the stated change, use the upload mode stated by the variant (Incremental unless Full is specified), update the affected keys at the PD and try the doors.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Run each variant in the table below. |
Each variant meets its stated verification. Valid assignments produce the specified access and person attribution; deliberately invalid multi-key assignments are rejected for the affected person as specified. |
2 |
Add access to a door that is not in the device tree for one person. |
The upload is not disturbed. |
3 |
Place persons under different organisation units. |
No difference. |
T-UPL-04 | Upload variants
Variant |
Before → After |
Required verification |
|---|---|---|
U01 |
A and B: D1+D2 → A: D1; B: D2 |
Removed access is denied; retained access works. |
U02 |
A: D1; B: D2 → A: D1+D2; B: D2 |
New access works without changing B. |
U03 |
A: D1; B: D2 → A: D2; B: D1 |
Rights are exchanged without residual access. |
U04 |
A, B, C: access → revoke all access for B |
Only B loses access; B's key in stock, NEVER; B kept in CWM. |
U05 |
Three active persons → delete B (Full upload) |
B deleted from CWM; B's key in stock, NEVER. |
U06 |
A: C1; B: C2 → A: C2; B: C1 |
Keys move to their new holders; events name the new holder. |
U07 |
A: C1; B: C2; C: C3 → A: C1; B: C2+C3; C: none |
Rejected for B (two keys); B unchanged; C keeps C3 until B is corrected. |
U08 |
A: C1; B: C2; C: C3 → A: C2; B: C3; C: C1 |
Three-way reassignment; no stale attribution. |
U09 |
A: C1+C2; B: none → A: C1; B: C2 |
Before state rejected (two keys); After: A holds C1, B holds C2. |
U10 |
A: C1+C2; B: C3 → A: C3; B: C1+C2 |
Rejected for B (two keys); one key per person is enforced. |
U11 |
A: C1+C2; B: C3 → A: C2; B: C1+C3 |
Rejected for B; A gets C2 only when its own change is valid. |
U12 |
A: C1+C2; B: C3 → A: none; B: C1+C2+C3 |
Rejected for B (three keys). |
U13 |
A: C1; B: C2 → A: C2+C3; B: C1 |
Rejected for A (two keys); B gets C1 only after A is corrected. |
U14 |
A: C1; B: C2 → A: C1; B: C3; new C: C2 |
C2 moves to the new person C; B holds C3. |
Variants with more than one key per person verify the documented rejection ("... has N keys (...), only one is allowed."); nothing is sent for the rejected person.
Cleanup: Remove the test access, revoke the test key assignments, upload and update the keys at the PD. Remove the test persons and run a Full upload to complete their removal from CWM.
T-UPL-05 | Selective upload
Description: Verify that a Selective upload changes only the selected person.
Applicability: Core.
Prerequisites: Persons A and B with keys and access.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Change the access of A and B in C4. |
Both persons have changed access in C4; neither change has yet been uploaded. |
2 |
Run a Selective upload for A. |
A uploaded; CWM shows A's change only. B stays pending in C4. |
3 |
Run an Incremental upload. |
B uploaded. |
Cleanup: Restore the original access of persons A and B, run an Incremental upload and update their keys at the PD.
T-UPL-06 | Wrong C4 data and keys held elsewhere
Description: Verify that wrong C4 data never changes a key, and that a key held by another person is moved only when C4 says so.
Applicability: Core.
Prerequisites: Person with an E3 key.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Clear a cylinder's Marking in C4 and upload a person with that door. |
Event "Cylinder '...' has no Marking."; person not uploaded, "Plugs of door ... not found; key not changed."; key unchanged. |
2 |
Restore the cylinder Marking. In CWM hand the E3 key to person X; in C4 assign it to Y and upload Y. |
CWM: key moved to Y. |
Cleanup: Restore the approved Marking and key assignment in C4, upload the affected person and update the key at the PD.
T-MEM-01 | Memory info
Description: Verify that memory usage is reported against the access panel capacity.
Applicability: Core.
Prerequisites: Access panel with CloudSolution False.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Set CredentialCapacity 10 and CalendarCapacity 5; Restart; Full upload. |
C4 shows credential and calendar usage of the access panel against 10 / 5. |
2 |
Grant access entries beyond 10 positions, upload. |
Failure "Credential out of memory"; persons beyond the capacity not uploaded. |
3 |
Set CloudSolution True, Restart, upload. |
Usage reported against 10000 / 256. |
Expected audit / evidence:
Failure - Failure on 'DEVICE'. Description: 'Credential out of memory'
Where:
DEVICE represents the name of the bus controller (or the device named in the step).
Cleanup: Restore the original CloudSolution, CredentialCapacity and CalendarCapacity values and remove only access entries added for this test. Restart, run a Full upload and update the affected keys at the PD.
T-KEY-01 | E1 keys
Description: Verify the strict E1 rule against the cylinders that accept the key in CWM.
Applicability: Core.
Prerequisites: Note the cylinders CWM lists under the E1 key's Accessible cylinders.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Grant every listed door, upload. |
CWM: ALWAYS. C4: uploaded. |
2 |
Leave one listed door out, upload. |
CWM: NEVER. C4: not uploaded, "E1 key ... switched off: ... accept it in CWM but are not granted in C4." |
3 |
Use an E1 key no cylinder accepts, grant a door, upload. |
CWM: NEVER. "E1 key ... switched off: no cylinder accepts it in CWM." |
4 |
As step 1 plus a door that does not accept the key. |
ALWAYS; Technical event "Granted in C4 but not accepted in CWM: ...". |
5 |
As step 1 with a calendar. |
ALWAYS; Technical event "E1 keys ignore time restrictions: ...". |
Cleanup: Remove the test access, upload and update the affected keys at the PD.
T-KEY-02 | E2 keys
Description: Verify E2 validity and schedules, including cylinders CWM authorises but C4 does not grant.
Applicability: Core.
Prerequisites: E2 key authorised in CWM on all cylinders.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Grant only cylinder X, no calendar, upload. |
CWM: ALWAYS; schedule with one Sunday 00:00 - Saturday 23:59 period on X only. No event about the other cylinders. |
2 |
Update the key at the PD; try X and cylinder Y. |
X opens, Y does not. |
3 |
Grant a door CWM does not authorise for the key, upload. |
Technical event "Granted in C4 but not accepted in CWM: ...". |
Cleanup: Remove the test access, upload and update the key at the PD.
T-KEY-03 | E3 keys
Description: Verify that E3 cylinder access follows C4 exactly.
Applicability: Core.
Prerequisites: E3 key assigned to a person.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Grant cylinder X and cylinder Y, upload. |
CWM Accessible cylinders: exactly those two. |
2 |
Remove Y, upload. |
Only X. |
3 |
Remove the last door, upload. |
Key in stock, NEVER, no cylinders, no schedule; person still exists. |
Cleanup: Update the key at the PD to apply the final revoked state.
T-KEY-04 | CKeys
Description: Verify that CKeys are never programmed and cause no failure.
Applicability: Core.
Prerequisites: PR or PSM key; also a DC.PSM key if available.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Give a person the CKey and a door, upload. |
Uploaded, no Failure event; key unchanged in CWM. |
Cleanup: Remove the assignment.
T-KEY-05 | Lost and broken keys
Description: Verify that key status set in C4 is carried to CWM, and back.
Applicability: Core.
Prerequisites: E3 key with a holder and doors.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Set the credential Lost, upload. |
CWM: Lost, no holder; the key loses all access. |
2 |
Set it Enabled, upload. |
CWM: operational, handed out to the same person, cylinders and schedule written again. |
3 |
Repeat with Disabled. |
Broken, then operational. |
4 |
Lost → upload → Disabled → upload. |
Broken, with no "operation not allowed" error. |
5 |
Declare the key lost in CWM while C4 says Enabled, upload the holder. |
Found again and handed back. |
Cleanup: Set the credential to Enabled, upload and update the key at the PD.
T-KEY-06 | Key hand-in and reassignment
Description: Verify handing a key in with Revoke and moving it with Assign the card.
Applicability: Core.
Prerequisites: Persons A and B; E3 key held by A with doors.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Under A, select the key credential and Revoke; remove A's access; upload. |
CWM: key in stock, NEVER, no cylinders; A still exists. |
2 |
On B use Assign the card, enter the key name and select it; grant doors; upload. |
CWM: key handed out to B and programmed with B's doors. |
3 |
Assign the same key back to A without revoking it first; upload A. |
CWM: key handed in from B and handed out to A. |
4 |
Update the key at the PD and use it. |
Access events name the current holder. |
Cleanup: Revoke the test key from its current holder, remove its test access, upload and update the key at the PD before returning it.
T-ACL-01 | Access time restrictions
Description: Verify that C4 calendars become weekly eCLIQ schedules.
Applicability: E2 and E3 keys.
Prerequisites: Calendar Mon-Fri 08:00-17:00; a calendar with no time frames.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Grant cylinder X with the Mon-Fri calendar, upload. |
CWM: Monday-Friday 08:00-17:00 on X only, with no first-day cut. |
2 |
Add cylinder Y with no calendar, upload. |
CWM: Y whole week, X its hours. |
3 |
Use the calendar with no time frames, upload. |
Not uploaded, "C4 calendars allow no time for key ...; not changed."; key unchanged. |
4 |
Set RevalidationTimerInDays to 7, Restart, Full upload with Y only and no calendar. |
CWM: ALWAYS with revalidation and a whole-week period on Y. |
5 |
Restore RevalidationTimerInDays to 0 and Restart. Restore the step 1 setup for cylinder X with the Mon-Fri 08:00-17:00 calendar, run a Full upload and update the key at the PD. Try cylinder X inside and outside those hours. |
Opens inside; refused outside (T-EVT-01C). |
Cleanup: Restore RevalidationTimerInDays to 0, Restart, run a Full upload and update the key at the PD.
T-EVT-01A | Handling Access Granted event
Description: Verify that an access becomes an AccessGranted event with the access time.
Applicability: E2 and E3 keys.
Prerequisites: Key with access to a cylinder.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Open cylinder, wait one minute, then update the key at the PD. |
Within T_EVENT: AccessGranted on cylinder with the access time (not the docking time), the key holder and the key name; reader Unknown. |
Expected audit / evidence:
AccessGranted - Access granted to 'PERSON' at 'DEVICE' using 'KEY' at 'Unknown'.
Where:
PERSON represents the key holder.
DEVICE represents the cylinder.
KEY represents the credential name (key marking).
Cleanup: None.
T-EVT-01B | Handling Access Denied event - door not allowed
Description: Verify a refused access at a cylinder the key may not open.
Applicability: E2 and E3 keys.
Prerequisites: Key without access to DC.N531.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Try a cylinder, then update the key at the PD. |
Within T_EVENT: AccessDeniedDoorNotAllowed on cylinder naming the holder and key. |
Expected audit / evidence:
AccessDeniedDoorNotAllowed - 'PERSON' at 'DEVICE' using 'KEY'
Where:
PERSON, DEVICE, KEY as in T-EVT-01A.
Cleanup: None.
T-EVT-01C | Handling Access Denied event - time restriction
Description: Verify a refusal outside the schedule.
Applicability: E2 and E3 keys.
Prerequisites: T-ACL-01 step 1 setup.
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Try a cylinder outside 08:00-17:00, then update the key at the PD. |
AccessDeniedActiveTimeRestriction on cylinder. |
Expected audit / evidence:
AccessDeniedActiveTimeRestriction - 'PERSON' at 'DEVICE' using 'KEY'
Where:
PERSON, DEVICE, KEY as in T-EVT-01A.
Cleanup: None.
T-EVT-02 | Device audit log retrieval
Description: Verify that offline accesses are delivered with their original time, once, across restarts.
Applicability: E2 and E3 keys.
Prerequisites: Key with access to a cylinder
Step |
Test Steps |
Expected Results |
|---|---|---|
1 |
Stop the driver. Use the key at cylinder twice, one minute apart; update the key at the PD. |
The driver remains stopped. The two accesses have been performed one minute apart and the key has been updated at the PD; delivery to C4 is checked after Start in step 2. |
2 |
Start the driver. |
Within T_EVENT: both accesses appear once, with their access times (UTC converted to the C4 display time). |
3 |
Restart the driver. |
No entry is repeated. |
4 |
Use an E1 key at a cylinder and update it. |
No event (E1 keys are not collected). |
Notes:
A new bus controller collects only from its first start; earlier history is not imported.
Cleanup: None.