System variables for personnel

Table 1. System variables for personnel
System Variable Name	Description	Value Type	Default Value
Allow Activation After Expiration	Determines when personnel credentials are valid, depending on activation and expiration dates. If True, credentials can be activated after the expiration date. If False, credentials must be saved before the expiration date. Note: This setting cannot be changed while the apC Driver is running. Shut down the apC Driver. Change the system variable setting. Restart the apC Driver. For more information about stopping and starting the apC Driver, refer to the C•CURE 9000 Server Configuration Application Guide.	Boolean	False
Allow Activation Equal Expiration	Determines when personnel credentials are valid, depending on activation and expiration dates. If True, the activation date can be equal to the expiration date. If the activation date is equal to the expiration date, the credential is always active (default behavior). If False, a credential that has the activation date equal to the expiration date cannot be saved.	Boolean	True
Auto Increment Card Number	Automatic creation of incremental card numbers. If True, for each new entry, the card number increases by 1.	Boolean	False
Auto Increment Card Number Start	Sets the starting value for incremental card numbering if the Auto Increment Card Number variable is set to True. The number must be between 1 and 2147483646.	Numeric	1
Auto Increment Issue Code	Automatically increments a Credential Issue Code before a badge is printed. If True, the Credential Issue Code is incremented before a badge prints. If False, the Credential Issue Code is not incremented before a badge prints.	Boolean	False
Disable by Inactivity and Expiring Clearance Cleanup Scan Time	The time of day, hour and minute in Coordinated Universal Time (UTC), when the Disable by Inactivity process is started. Note: This Expiring Clearance Cleanup process is not affected by the Disable by Inactivity Enabled variable. Expiring Clearance Cleanup automatically removes credentials that are expired for more than five days.	hh:mm	00:00
Disable by Inactivity Enabled	You can disable personnel credentials based on a period of inactivity defined for the individual personnel type. Note: Only Card Admits are considered card activity by the Disabling for Inactivity service. Card Rejects do not count. If True, credentials are disabled when the inactivity period set for their personnel type is met. If False, the Disable by Inactivity process cannot run regardless of the inactivity periods set for personnel types.	Boolean	False
Display PIN	Display Personal Identification Number (PIN) in the personnel record. If True, the PIN is displayed. If False, the personnel record displays the PIN as a series of asterisks.	Boolean	False
Enforce CPNI PIN Strength	If set to True, this variable enforces CPNI PIN strength for new Personnel PINs. If you assign a PIN to a Personnel profile, and the PIN does not meet the PIN strength requirements, an error message displays when you try to save the Personnel.	Boolean	False
Enterprise High Assurance (HA) Grace Period (Hours)	The extended time period added after the Source of Authority Certificate (Not valid after) expires if there is a communication failure between the MAS and the SAS. If the Source of Authority Certificate (Not valid after) expires, and the MAS/SAS communication is not restored, then all cards become invalid and require full download to the controller. Extending the time ensures all cards remain valid for the selected period after the Source of Authority Certificate expires. If the connectivity between the MAS/SAS is down for an extended period of time.	Numeric	0
Extend Maximum Cards Per Person	If True, permanent personnel credentials with a status of Lost, Stolen, or Disabled do not count against the limit set by the system variable Maximum Cards Per Person. For example, if a person has 2 active permanent personnel credentials and 3 lost credentials on a system with a Maximum Cards Per Person limit of 3, one more permanent personnel credential could be added to the personnel record. The personnel record can also have up to 3 active temporary credentials and an unlimited number of inactive, expired, lost, or stolen temporary credentials. If False, all permanent personnel credentials count against the limit set by the system variable Maximum Cards Per Person. Only active temporary credentials count against this limit, with an allowed unlimited number of inactive temporary credentials.	Boolean	False
Maximum Cards Per Person	Number of credentials that you can add to a single person record. The number must be between 1 and 10 and applies to each of permanent personnel credentials and active temporary credentials. This does not limit the number of inactive, expired, lost, or stolen temporary credentials.	Numeric	1
Maximum Clearances Per Person Note: For both apCs and iSTARs, the total number of common and custom clearances combined cannot be greater than 1000 clearances.	The maximum number of 'common' clearances that you can assign to a person. You cannot change this value if the iSTAR driver or apC driver is running. The apC supports up to 40 clearances for each person. iSTAR Classic, Pro, eX, and Edge support up to 150 clearances for each person. iSTAR Ultra supports up to 1000 clearances for each person. The number must be between 1 and 1000.	Numeric	10
Maximum Custom Clearance Per Person Note: For both apCs and iSTARs, the total number of common and custom clearances combined cannot be greater than 150 clearances	The maximum number of 'custom' clearances that you can assign to a person and if you can assign custom clearances to a person at all: (zero) means that no custom clearances can be assigned. greater than 0 (zero) means that custom clearances can be assigned and indicates the maximum number. You cannot change this value if the iSTAR driver or apC driver is running. The apC supports up to 40 custom clearances for each person. Note: No more than 17 custom clearances for apC elevators assigned to a single person can be downloaded to a single apC panel. The number must be between 0 and 20.	Numeric	0
Maximum Documents Per Person	The maximum number of documents that can be assigned to a single person record. The number must be between 0 and 2.	Numeric	2
Personnel Quick Search Field1	Pick any fields to display in Quick Search area. It can be Text1 to Text25 or Date1 to Date4 or Int1to Int9 or Personnel UDF fields from the system. Selected fields are visible in Personnel Quick Search area.	Int
Personnel Quick Search Field2	Pick any fields to display in Quick Search area. It can be Text1 to Text25 or Date1 to Date4 or Int1to Int9 or Personnel UDF fields from the system. Selected fields are visible in Personnel Quick Search area.	Text
Personnel Quick Search Fields	Pick any two fields to display in Quick Search area.	Default
PIN Length	Number of digits required in a PIN. You cannot change this value if the apC driver is running. If you try to import a personnel record with a PIN that is too large, the system displays an error message. If you edit a personnel record with a PIN that is too large for the current variable value, the system displays a warning on the PIN field. If you modify the PIN length value, it affects new records with PINs only. The system does not validate existing personnel records against the new changed value. The number must be between 3 and 9.	Numeric	4
Prevent Deleting Clearance if Assigned to Person	If set to true, clearances assigned to personnel cannot be deleted. False allows the deletion of clearances in the dynamic view even though they may be assigned to personnel. The default is False.	Boolean	False
Previous Doors Replay Number	Number of journal entries displayed when you select the Limit Replay to x Records check box on the Previous Doors tab of the Personnel screen. The number must be between 0 and 999.	Numeric	3
Previous Personnel Replay Number	Maximum number of journal entries to display when a Previous Personnel replay is performed with the Limit Replay option enabled. The default value is 10. You can assign a numeric value from 1 - 999.	Numeric	10
Random Card Number Length	If specified, defines number of digits or the range used when generating a unique random card number in the Personnel editor or the Credential editor. To configure the random card number length, double-click this variable, select one of the following options, and then click Save and Close. Use card's CHUID format. This is the default option. Use fixed length. Select this option to specify the number of digits that a randomly generated card number is limited to. Use range-bound. Select this option to limit randomly generated card numbers to a range of numbers.
Smart ID Mode	Smart ID Mode provides the capability to create 128-bit credentials in C•CURE 9000. The text entry format used by the Smart ID Field. 0 - Smart ID field is disabled. 1 - Enables the Smart ID field (a 32 character Hexadecimal format field with a maximum value of FFFF,FFFF,FFFF,FFFF,FFFF,FFFF,FFFF,FFFF). When enabled, you can add the Smart ID field to a Personnel view to facilitate the use of 128-bit credentials Refer to the C•CURE 9000 Personnel Configuration Guide. 2,3,4 - Reserved for future use. When you change this value, restart the iSTAR driver to display the correct format in access journal messages.	Text	0
Temporary Credential Activation Default	The default number of days that a newly activated temporary credential remains active. The number must be between 1 and 99.	Numeric	5
TimeSpan Of Expiration	The years, days, or hours added by default to the activation date to establish an expiration date. The number must be between 1 and 36135, and applies to the different time options.	Numeric	5
Use PIN only Auto Generated PIN as General PIN	Auto-generated PIN can overwrite the PIN defined on the General tab of the Personnel screen. If True, clicking Auto Generate on the Credentials tab overwrites the PIN set on the General tab. On the General tab, the PIN appears as read-only. If False, clicking Auto Generate on the Credentials tab creates a PIN that is different from the PIN defined on the General tab.	Boolean	False

Allow Activation After Expiration

Determines when personnel credentials are valid, depending on activation and expiration dates.

If True, credentials can be activated after the expiration date.

If False, credentials must be saved before the expiration date.

Note: This setting cannot be changed while the apC Driver is running.

Shut down the apC Driver.
Change the system variable setting.
Restart the apC Driver.

For more information about stopping and starting the apC Driver, refer to the C•CURE 9000 Server Configuration Application Guide.

Boolean

False

Allow Activation Equal Expiration

Determines when personnel credentials are valid, depending on activation and expiration dates.

If True, the activation date can be equal to the expiration date. If the activation date is equal to the expiration date, the credential is always active (default behavior).

If False, a credential that has the activation date equal to the expiration date cannot be saved.

Boolean

True

Auto Increment Card Number

Automatic creation of incremental card numbers.

If True, for each new entry, the card number increases by 1.

Boolean

False

Auto Increment Card Number Start

Sets the starting value for incremental card numbering if the Auto Increment Card Number variable is set to True.

The number must be between 1 and 2147483646.

Numeric

1

Auto Increment Issue Code

Automatically increments a Credential Issue Code before a badge is printed.

If True, the Credential Issue Code is incremented before a badge prints.

If False, the Credential Issue Code is not incremented before a badge prints.

Boolean

False

Disable by Inactivity and Expiring Clearance Cleanup Scan Time

The time of day, hour and minute in Coordinated Universal Time (UTC), when the Disable by Inactivity process is started.

Note: This Expiring Clearance Cleanup process is not affected by the Disable by Inactivity Enabled variable. Expiring Clearance Cleanup automatically removes credentials that are expired for more than five days.

hh:mm

00:00

Disable by Inactivity Enabled

You can disable personnel credentials based on a period of inactivity defined for the individual personnel type.

Note: Only Card Admits are considered card activity by the Disabling for Inactivity service. Card Rejects do not count.

If True, credentials are disabled when the inactivity period set for their personnel type is met.

If False, the Disable by Inactivity process cannot run regardless of the inactivity periods set for personnel types.

Boolean

False

Display PIN

Display Personal Identification Number (PIN) in the personnel record.

If True, the PIN is displayed.

If False, the personnel record displays the PIN as a series of asterisks.

Boolean

False

Enforce CPNI PIN Strength

If set to True, this variable enforces CPNI PIN strength for new Personnel PINs. If you assign a PIN to a Personnel profile, and the PIN does not meet the PIN strength requirements, an error message displays when you try to save the Personnel.

Boolean

False

Enterprise High Assurance (HA) Grace Period (Hours)

The extended time period added after the Source of Authority Certificate (Not valid after) expires if there is a communication failure between the MAS and the SAS. If the Source of Authority Certificate (Not valid after) expires, and the MAS/SAS communication is not restored, then all cards become invalid and require full download to the controller.

Extending the time ensures all cards remain valid for the selected period after the Source of Authority Certificate expires. If the connectivity between the MAS/SAS is down for an extended period of time.

Numeric

0

Extend Maximum Cards Per Person

If True, permanent personnel credentials with a status of Lost, Stolen, or Disabled do not count against the limit set by the system variable Maximum Cards Per Person.

For example, if a person has 2 active permanent personnel credentials and 3 lost credentials on a system with a Maximum Cards Per Person limit of 3, one more permanent personnel credential could be added to the personnel record. The personnel record can also have up to 3 active temporary credentials and an unlimited number of inactive, expired, lost, or stolen temporary credentials.

If False, all permanent personnel credentials count against the limit set by the system variable Maximum Cards Per Person. Only active temporary credentials count against this limit, with an allowed unlimited number of inactive temporary credentials.

Boolean

False

Maximum Cards Per Person

Number of credentials that you can add to a single person record. The number must be between 1 and 10 and applies to each of permanent personnel credentials and active temporary credentials. This does not limit the number of inactive, expired, lost, or stolen temporary credentials.

Numeric

1

Maximum Clearances Per Person

Note: For both apCs and iSTARs, the total number of common and custom clearances combined cannot be greater than 1000 clearances.

The maximum number of 'common' clearances that you can assign to a person.

You cannot change this value if the iSTAR driver or apC driver is running.

The apC supports up to 40 clearances for each person.

iSTAR Classic, Pro, eX, and Edge support up to 150 clearances for each person.

iSTAR Ultra supports up to 1000 clearances for each person.

The number must be between 1 and 1000.

Numeric

10

Maximum Custom Clearance Per Person

Note: For both apCs and iSTARs, the total number of common and custom clearances combined cannot be greater than 150 clearances

The maximum number of 'custom' clearances that you can assign to a person and if you can assign custom clearances to a person at all:

(zero) means that no custom clearances can be assigned.
greater than 0 (zero) means that custom clearances can be assigned and indicates the maximum number.

You cannot change this value if the iSTAR driver or apC driver is running. The apC supports up to 40 custom clearances for each person.

Note: No more than 17 custom clearances for apC elevators assigned to a single person can be downloaded to a single apC panel.

The number must be between 0 and 20.

Numeric

0

Maximum Documents Per Person

The maximum number of documents that can be assigned to a single person record.

The number must be between 0 and 2.

Numeric

2

Personnel Quick Search Field1

Pick any fields to display in Quick Search area. It can be Text1 to Text25 or Date1 to Date4 or Int1to Int9 or Personnel UDF fields from the system. Selected fields are visible in Personnel Quick Search area.

Int

Personnel Quick Search Field2

Pick any fields to display in Quick Search area. It can be Text1 to Text25 or Date1 to Date4 or Int1to Int9 or Personnel UDF fields from the system. Selected fields are visible in Personnel Quick Search area.

Text

Personnel Quick Search Fields

Pick any two fields to display in Quick Search area.

Default

PIN Length

Number of digits required in a PIN. You cannot change this value if the apC driver is running.

If you try to import a personnel record with a PIN that is too large, the system displays an error message.
If you edit a personnel record with a PIN that is too large for the current variable value, the system displays a warning on the PIN field.
If you modify the PIN length value, it affects new records with PINs only. The system does not validate existing personnel records against the new changed value.

The number must be between 3 and 9.

Numeric

4

Prevent Deleting Clearance if Assigned to Person

If set to true, clearances assigned to personnel cannot be deleted.

False allows the deletion of clearances in the dynamic view even though they may be assigned to personnel.

The default is False.

Boolean

False

Previous Doors Replay Number

Number of journal entries displayed when you select the Limit Replay to x Records check box on the Previous Doors tab of the Personnel screen.

The number must be between 0 and 999.

Numeric

3

Previous Personnel Replay Number

Maximum number of journal entries to display when a Previous Personnel replay is performed with the Limit Replay option enabled.

The default value is 10. You can assign a numeric value from 1 - 999.

Numeric

10

Random Card Number Length

If specified, defines number of digits or the range used when generating a unique random card number in the Personnel editor or the Credential editor.

To configure the random card number length, double-click this variable, select one of the following options, and then click Save and Close.

Use card's CHUID format. This is the default option.

Use fixed length. Select this option to specify the number of digits that a randomly generated card number is limited to.

Use range-bound. Select this option to limit randomly generated card numbers to a range of numbers.

Smart ID Mode

Smart ID Mode provides the capability to create 128-bit credentials in C•CURE 9000.

The text entry format used by the Smart ID Field.

0 - Smart ID field is disabled.
1 - Enables the Smart ID field (a 32 character Hexadecimal format field with a maximum value of FFFF,FFFF,FFFF,FFFF,FFFF,FFFF,FFFF,FFFF).
When enabled, you can add the Smart ID field to a Personnel view to facilitate the use of 128-bit credentials Refer to the C•CURE 9000 Personnel Configuration Guide.
2,3,4 - Reserved for future use.

When you change this value, restart the iSTAR driver to display the correct format in access journal messages.

Text

0

Temporary Credential Activation Default

The default number of days that a newly activated temporary credential remains active.

The number must be between 1 and 99.

Numeric

5

TimeSpan Of Expiration

The years, days, or hours added by default to the activation date to establish an expiration date.

The number must be between 1 and 36135, and applies to the different time options.

Numeric

5

Use PIN only Auto Generated PIN as General PIN

Auto-generated PIN can overwrite the PIN defined on the General tab of the Personnel screen.

If True, clicking Auto Generate on the Credentials tab overwrites the PIN set on the General tab. On the General tab, the PIN appears as read-only.

If False, clicking Auto Generate on the Credentials tab creates a PIN that is different from the PIN defined on the General tab.

Boolean

False