This page lists, for each system portierX connects to, what portierX reads from it, what it writes to it, how often, and what stays in that system. The connections are under Integrations, on the Connected tab. Each system's own page covers the set-up and the details.
Also called: interface, integration, sync, synchronisation, write-back.
System | How portierX reaches it |
|---|---|
SALTO | through SHIP, the interface of SALTO ProAccess SPACE |
dormakaba MATRIX | through the MATRIX REST interface |
ASSA ABLOY eCLIQ | through the web service of the CLIQ Web Manager |
Interflex IF-6040 | through the OpenAPI interface of the IF-6040 |
Microsoft Entra ID, single sign-on | through SAML, at every sign-in |
Microsoft Entra ID, provisioning | through SCIM, called by Entra ID |
HR file | through a drop folder portierX assigns to your organisation |
Master key plan | through an XML file you upload |
portierX reads the four access control systems, SALTO, dormakaba MATRIX, ASSA ABLOY eCLIQ and Interflex IF-6040, every 10 minutes and writes changes back to them. The other four connections only send data into portierX.
The set-up is on Connect your SALTO system.
What | SALTO |
|---|---|
portierX reads | Doors as access points, users as people, and each user's key as an access credential held by that person. The door events in SALTO's audit trail, which portierX stores with the connection. The Audit Log does not list them. The live state of online doors, on the Door Status tab. |
portierX writes | An access point you add to the SALTO system is created in SALTO as a door, and an access point's name and description go to its door. For a person who holds a SALTO key, the first name, last name, email address and mobile number go to SALTO, with the doors the key opens. When the person has no SALTO user, portierX creates one. A key taken back or reported lost is cancelled in SALTO. |
How often | Reading runs every 10 minutes and at once with Start Sync on Summary. The audit trail is read every 10 minutes as well, the door states when the tab opens and on Refresh. Each change is written when it is saved in portierX. |
Stays in SALTO | Encoding keys, opening doors remotely and switching office mode. A door's hardware facts, such as battery level, opening mode and partition, come from SALTO only. |
The set-up is on Connect dormakaba MATRIX.
What | dormakaba MATRIX |
|---|---|
portierX reads | Doors as access points, persons and external company employees as people, and ID cards as access credentials held by their person. Rights on single readers and on room zones, as links between a card and its doors. |
portierX writes | An access point's name and Location/Label go to the door's name and short name. A person's details and access rights go to MATRIX, and portierX creates the person there when MATRIX does not know them. When the hand-over of an ID card is confirmed, portierX creates the card in MATRIX, and a changed card label follows it. An ID card taken back or reported lost is deleted in MATRIX, and the person's rights are rewritten from the cards they still hold. |
How often | Reading runs every 10 minutes and at once with Start Sync on Summary. Each change is written when it is saved in portierX. |
Stays in MATRIX | Rights granted through an access profile or the locking plan, which the interface does not supply. Changes to external company employees are not written back. |
The set-up is on Connect ASSA ABLOY eCLIQ.
What | ASSA ABLOY eCLIQ |
|---|---|
portierX reads | Persons as people, each cylinder side as an access point, keys with their holders as access credentials, and a key's authorisations on cylinders as links. Domains, cylinder groups and access profiles as well. Door events, while Enable audit history is on. |
portierX writes | A renamed access point renames the cylinder, and a changed person is updated in the CLIQ Web Manager. A key taken back is handed in and reset there, and a key reported lost is declared lost. Access given or taken away rewrites a dynamic key's authorisations on cylinders. |
How often | Reading runs every 10 minutes and at once with Start Sync on Summary, with the door events on each of these runs. Each change is written when it is saved. The CLIQ Web Manager takes it as a job that reaches the key the next time the key is updated, and the Sync Log shows it as Push pending, then as Applied. |
Stays in the CLIQ Web Manager | A cylinder's identity, side and planned location. Handing a key out to a person is not written to the CLIQ Web Manager. Authorisations are written to dynamic keys only. |
The set-up is on Connect Interflex IF-6040.
What | Interflex IF-6040 |
|---|---|
portierX reads | Persons, matched by personnel number, as people. Badges as access credentials held by their person. Zones as access points with no space. Each access profile, at its first read, as a people group. The names of the time profiles. |
portierX writes | A person's first name, last name and email address. A badge handed out gains its link to the person in the IF-6040, a badge taken back has that link ended, and a badge reported lost is blocked as well. When a badge is linked to or unlinked from an access point that is a zone, its holder gains or loses the personal permission on that zone. |
How often | Reading runs every 10 minutes and at once with Start Sync on Summary. Each change is written when it is saved in portierX. |
Stays in the IF-6040 | A zone's name, a badge's label, the zones a profile contains, and the members of a people group taken over from a profile. Door events, time recording and visitor data are never read. |
The set-up is on Set up single sign-on with Microsoft Entra ID.
What | Single sign-on |
|---|---|
portierX reads | On activation, the sign-on address, identifier and signing certificate of your Entra application, from the App Federation Metadata Url (from Entra). At each sign-in, who is signing in, with email address, first name and last name. On Verify, the DNS TXT record of your email domain. |
portierX writes | Nothing to Entra ID. |
How often | On activation, at every sign-in and at every verification. |
Stays in Entra ID | Passwords, and the decision who may use the application. |
The set-up is on Provision people from Microsoft Entra ID.
What | Provisioning over SCIM |
|---|---|
portierX receives | Entra ID calls portierX to create, update and deactivate users: user name, name, email address, whether the user is active, and the user's id in Entra ID. |
portierX writes | Nothing to Entra ID. |
How often | Whenever Entra ID calls, on its own schedule. Nothing in portierX starts a transfer. |
Stays in Entra ID | Groups. They decide in Entra ID who is provisioned and are not created in portierX. |
The set-up is on Connect your HR system through a daily file.
What | HR file |
|---|---|
portierX reads | Each file your HR system places in the drop folder, with the columns of the interface specification. Columns and values are on Spreadsheet and file formats. |
portierX writes | Nothing to the HR system. portierX deletes each file from the folder once it has become a run. |
How often | Once a day, at the first check after 07:00 in your organisation's time zone, or UTC when none is set. The check runs every 5 minutes. A paused source is not read, and no button starts a run by hand. |
Stays in the HR system | The HR records themselves. portierX only receives the file. |
The set-up is on Import your master key plan from an XML file.
What | Master key plan |
|---|---|
portierX reads | The XML file you upload, 20 MB at most: the master key system, its buildings, the cylinders as access points, the keys as access credentials, and the locking functions. |
portierX writes | Nothing back, neither into the file nor into the planning software. |
How often | Each time you upload a file. A further file is imported as the next version. |
Stays with your locksmith | The planning of the master key system, in your locksmith's or manufacturer's software. |
For SALTO, dormakaba MATRIX, ASSA ABLOY eCLIQ and Interflex IF-6040:
A draft reads and writes nothing. Only an active connection syncs.
The 10 minutes apply to every connection alike and are not set per connection.
With Auto push off on the Configuration tab, portierX holds back changes that give or describe access: renames, changed people, hand-outs and added links. Changes that take access away always go out: a key taken back or reported lost, and a removed link.
Of the incidents, only a loss is passed to the system, not a theft and not damage. What each outcome does is on Incident types and outcomes.
A return reaches only the system the key or card belongs to.
A change that comes from the system itself is not written back to it.
A write that fails is tried again, as many times as Attempts on Configuration allows. What each run read and wrote is on the connection's Sync Log.
A connection sends no email.
