This page lists every field portierX keeps for a key, its copies and a card. A key's fields are on its Information tab, a copy's on the Copies tab, a card's in its details panel; a card is added under Access Credentials with Add.
Also called: key data, key record, entry in the key plan. A mechanical key is one record with numbered copies. A card, a transponder or a credential added by hand has no copies and is its own record.
A key reaches portierX with the import of the master key plan. Name, structural type, locking type and class can be edited, with Edit on the Information tab; that needs the Organisation Admin, Access Manager or Credential Manager role.
Field | What it holds | Rules |
|---|---|---|
Key number | The key's number in the plan. | Cannot be changed. With the suffix it makes the code every copy carries. |
Suffix | Part of the key's identity, from the import. | Cannot be changed. |
Name | A name for the key. | Optional, 100 characters at most. |
Structural type | Individual key, Group key or Same key, as the plan states it. | Can be changed. Not the same as the class. |
Locking type | The locking type the plan states for the key. | Can be changed, 255 characters at most. |
Class | Where the key sits in the hierarchy of the master key system. | A suggestion from the import until someone confirms it; see below. |
Source | Imported or Added by hand. | Read-only. |
Vendor id | The identifier the import file gives the key. | Read-only. A re-import finds the key again by it. |
Locking system | The master key system the key belongs to, with brand and product. | Fixed by the import. |
Copies declared | The number of copies the import file states, or Count not stated. | Read-only. The copies on record are on the Copies tab. |
Created | The day the key was created. | Set by portierX. |
Remove key on the same tab deletes the key with all its copies. Only the Organisation Admin may, and only while nobody holds a copy. A lost or stolen key is not removed but reported.
The class has four rungs, lowest first: Individual, Master, Grand master and Great grand master. A key with no class reads Unclassified.
The import suggests: a group key in the import file becomes Master, a single key Individual. The import never suggests the two top rungs.
A class is confirmed when you choose it under Class and save, even if it is the suggestion. The line under it then says who confirmed it and when.
Clear confirmation goes back to the suggestion. A re-import never overwrites a confirmed class.
In the Access Credentials list, the Class column marks a suggestion with suggested.
The class Individual and the key type Individual key are two different fields. The field a word stands in says which is meant.
The Approval before handover card on the Overview tab shows whether a key is marked for approval. When it is, every hand-over of one of its copies needs a yes from the person named as owner on its locking system.
Mark for Approval sets the mark, Remove Mark takes it off. Only the Organisation Admin may do either; every other role reads the card.
Only a key of a mechanical master key system with a confirmed class of Master, Grand master or Great grand master can be marked.
A request already raised stays decided as it was raised, even if the mark goes later.
How to mark a key and name owners is on Name approvers, owners and reviewers.
Field | What it holds |
|---|---|
Copy | The copy's number, for example Copy 4 of 12, with the key's code under it. A number is never given out twice, not even after a copy is removed. |
State | The copy's state, see Key, copy and card states. Under it, the depot the copy belongs to. |
Person | Who holds the copy. For an archived copy, who resolved the incident. |
Since | Since when the person holds the copy; for an archived copy, the day it was archived. |
Due | The copy's return date. |
Under the code, Replaces or Replaced by appears when a defect copy and its replacement are linked. Every copy opens the same doors as its key.
Field | What it holds | Rules |
|---|---|---|
Credential ID | The card's or credential's identifier, often its marking. | Required, 24 characters at most, used once in the organisation. portierX suggests one when you add a card. For ASSA ABLOY eCLIQ it cannot be changed. |
Name | A name that makes the card findable in lists. The form calls the field Credential Name. | Optional, 100 characters at most. |
Access points | The doors the card opens, linked under Access Point Connection. | How to set them when adding is on Add a key or card by hand. |
In the list, the Type column reads Card for a credential of a digital system and Key for every other. The Technology filter narrows to Mechanical or Digital, and All shows both. A card from a connected locking system is created by the connection, and its data comes from there.
A special case documents an exception on one copy or on a card, never on the whole key. You choose it under Special case, in the Kind field; the default is Not a special case.
Kind | What it is for |
|---|---|
Permanently validated | A credential that does not expire on the usual schedule. |
Emergency card | Held for an incident or a callout outside working hours. |
Fire brigade key depot | Kept in the fire brigade key box for the emergency services. |
Other | Any other documented exception. |
With a kind chosen, Reason is required, 500 characters at most. Say there why the copy is a special case and who decided.
You set a special case when adding a card, with Add Copy, or later with Mark as special case in the copy's menu; Edit special case changes or removes it. Marking and editing in the menu need the Organisation Admin, Access Manager or Credential Manager role; adding a card or a copy is for the Organisation Admin only.
A flag beside the copy shows the kind and the reason when you hold the pointer on it.
For Fire brigade key depot, portierX warns while the copy sits in no depot.
The Special case filter in the list shows All credentials, Any special case or one kind.
An archived copy cannot be marked as a special case. A special case it already carries can still be changed or removed.
Code, suffix, source, vendor id, locking system and copies declared come from the import and cannot be changed in portierX.
A card is created by hand, while assigning access, or by a connected locking system. A copy is created by the import or with Add Copy.
A Credential ID exists once per organisation. portierX refuses a second one with the same ID when you save.
