Cardholder
This context lets you access and manage a single cardholder.
Unique Actions
Cardholder context has several show report actions for viewing reports on this cardholder:
Configure
This action is used to edit properties of cardholder.
 | Changing Name field during this operation will cause renaming of current context. This may lead to malfunctioning of other system components that use context name/path as a primary identifier. |
Action Type: |
Common Actions
Delete, Make Copy, Replicate, Edit Context Permissions, Monitor Related Events, View Status
Context States and Icons
This context has no states. It is always represented by the 
icon.
Advanced Information |
Context Information
Context Type: cardholder
Context Name: provided by user
Context Description: provided by user
Context Path: cardholders.CARDHOLDER_NAME for cardholders that belong cardholders context in root context, organizations.ORGANIZATION_NAME.cardholders.CARDHOLDER_NAME for cardholders that belong cardholders context in certain organization context, organizations.ORGANIZATION_NAME.divisions.DIVISION_NAME.cardholders.CARDHOLDER_NAME for cardholders that belong cardholders context in certain division context, organizations.ORGANIZATION_NAME.divisions.DIVISION_NAME.departments.DEPARTMENT_NAME.cardholders.CARDHOLDER_NAME for cardholders that belong cardholders context in certain department context
Context Mask: cardholders.* for all cardholders that belong cardholders context in root context, organizations.*.cardholders.* for all cardholders that belong cardholders context in all organization contexts, organizations.*.divisions.*.cardholders.* for all cardholders that belong cardholders context in all division contexts, organizations.*.divisions.*.departments.*.cardholders.* for all cardholders that belong cardholders context in all department contexts
Context Permissions
Level | Description |
None | No access allowed. |
Observer | Basic event monitoring. Status browsing. |
Operator | Configuration browsing. |
Manager | Cardholder configuration and removal. |
Engineer | Same as Manager. |
Administrator | Same as Manager. |
Public Variables (Properties)
Common Variables: groupMembership (Group Membership), activeAlerts (Active Alerts)
Cardholder Properties
See description of the variable and its fields here.
Variable Name: | childInfo |
Records: | 1 |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | Cardholder Name. Name of this cardholder context, required to refer to this cardholder from other parts of the system. It should satisfy the context naming conventions. Length: 1-50 characters. |
firstname | String | First Name |
lastname | String | Last Name |
gender | Integer | Gender |
position | String | Position |
country | Integer | Country |
region | Boolean | Region/State/Province/Area |
zip | String | ZIP/Postal Code |
city | String | City |
address1 | String | Address 1 |
address2 | String | Address 2 |
String | E-mail Address | |
workPhone | String | Work Phone |
homePhone | String | Home Phone |
mobilePhone | String | Mobile Phone |
notes | String | Notes |
birthDate | Date | Birth Date |
disabled | Boolean | Disabled |
emergency | String | Emergency Contact Information |
Cards/Badges
See description of the variable and its fields here.
Variable Name: | cards |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
id | String | Card/Badge ID |
status | Integer | Status |
activationDate | Date | Activation Date |
deactivationDate | Date | Deactivation Date |
Photo
Variable Name: | photo |
Records: | 1 |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
photo | Data Block | Uses image editor. |
Voice Tag
Variable Name: | voice |
Records: | 1 |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
voice | Data Block | Uses sound editor. |
Custom Shift
See description of the variable and its fields here.
Variable Name: | customShift |
Records: | 1 |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
customShift | String | Cardholder's custom shift. |
Attendance Exceptions
See description of the variable and its fields here.
Variable Name: | attendance |
Records: | 1 |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
startDate | Date | Date-only editor is used. |
endDate | Date | Date-only editor is used. |
isWorkday | Boolean | |
reportingTime | Date | Time-only editor is used. |
knockOffTime | Date | Time-only editor is used. |
hasLunch | Boolean | |
lunchBeginHour | Date | Time-only editor is used. |
lunchEndHour | Date | Time-only editor is used. |
maximumOT | Long | |
minimumOT | Long | |
category | Integer | |
comment | String |
Public Functions
This context has no public functions.
Public Events
Common Events: info (Information)
Was this page helpful?