Documentation for ACFA PSIM 1.3.

Previous page Appendix 2. Configuring the correct operation of the Access Manager module in a distributed system  Appendix 4. Creating a single photo database Next page

You can create additional fields for the User object that are used in the Access Manager module (see Working with users in the Access Manager software module).

You can create additional fields using the text editor that allows you to view and edit the ASCII text encoding.

Structure of additional fields in .dbi

Additional fields for the User object are divided into two groups:

  1. The base field with the default processing has the following structure: (db_name), (db_type) // (description).
    Example: is_guest, BIT // Guest key.
    The default processing depends on the data type (see Supported SQL data types).
  2. The base field with a special processing has the following structure: (db_name), (db_type) // (description){(fmt)%(prms)}.
    Example: job_title, CHAR, 20 // Position{C%Waiter|Cashier|Storekeeper}.

    Attention!

    1. The db_name structural element cannot be empty and must not match the existing standard user fields, because this disrupts the general logic of the Access Manager module and leads to failures and data loss.
    2. The description structural element cannot be empty, because it is also the name of an additional field displayed in the Access Manager interface window, otherwise it will be ignored by the system.
    3. The fmt structural element must be one of a fixed set of modifiers (see Field formats with special processing). If a modifier not from the set is specified or the parameters (prms) are specified incorrectly, the field will be processed by default according to its type (see Supported SQL data types).

Supported SQL data types

SQL data typeRepresentationDefault processing
BITBooleanDrop-down list with Yes/No values

INTEGER
Range (-2147483648; 2147483647)

Integer

Numeric field with increment/decrement and manual input option

SMALLINT
Range: from -32768 to 32767, values outside the range will not be updated in the database

DATETIMEDateTimeCalendar with date and time selection option

CHAR
The maximum size must be specified (example: 'CHAR, 30')

StringText field
TEXT

Field formats with a special processing

FormatDescriptionSyntax
C 

A drop-down list with a predefined and fixed set of possible values.

Note. The type in the database can also be numeric, in which case the entire set of values must be numeric

{C%value1|value2|...|valueN}
Example: {C%Waiter|Cashier|Storekeeper|Security}
CT 

A drop-down list where you can enter arbitrary values. The logic is similar to the C format, but it allows you to manually fill the field with text if necessary. It is used if the full list of possible values is too large, but there are few most frequently used options (they are predefined)

{CT%value1|value2|...|valueN}
Example: {CT%Tokyo|Paris}
CCI

A drop-down list with predefined values and option to generate events on saving. It is used if changes in key user parameters need to be logged in the database or “intercepted” by the Event Manager/script. It is recommended to make this field mandatory.

Note. The event is generated if the given user was saved after changing the field, and the event is not generated when new users are currently created. The event that was edited is generated for the Access Manager module object. To see this event in the Event Viewer or use it in the Event Manager, add these events to the Access Manager object in the DDI file of the Access Manager module

{CCI%Descr1(EVENT1)|Descr2(EVENT2)|...||DescrN(EVENTN)}
Example: {CCI%Issued(CARD_ISSUED)|Lost(CARD_LOST)|Broken(CARD_BROKEN)}

S

A numeric field with increment/decrement and manual input option.

Note. If a numeric data type is selected for a field in the database, then it is necessary to take into account the minimum and maximum values in accordance with the ranges in the syntax

{S%0} or {S%min|max}

Example 1: {S%0}—range of values: min -2147483648, max 2147483647
Example 2: {S%100|999}—range of values: min 100, max 999

U

This format is internal and cannot be used to generate additional fields

-
UT 

A unique text with validation (checking for compliance with certain requirements) using a regular expression template. It is a convenient customization tool, but it requires technical knowledge in writing regular expressions. The text entered by the operator is checked against the template, and only if it matches the template, the field value can be changed. Also, when saving a user, the uniqueness of the entered value is checked: there cannot be two users with the same value for this field

{UT%pattern_base64}
Example:
{UT%XlvQkNCS0JXQmtCc0J3QntCg0KHQotCj0KVdXGR7M31b0JDQktCV0JrQnNCd0J7QoNCh0KLQo9ClXXsyfVxkezIsM30k}

The text encoded in Base64 format contains the following template (for the English version of the product):
^[A-Z]\d{3}-\d{3}-\d{2}-\d{3}-\d$.
This template allows you to check the entry of a car license plate in the state of Florida:

  • F031-469-45-999-5—matches the template,
  • F 31-469 45-A99-5—does not match the template

Advanced format options:

  • With an additional text masking during reading (masked only while reading user data).
    Example:
    {UT%MR|XjR7NX0k}
    The text encoded in Base64 format contains the 44444 template.
  • With an additional permanent text masking (always masked).
    Example:
    {UT%MA|XjR7NX0k}
    The text encoded in Base64 format contains the 44444 template
TC

A non-unique text that contains predefined values, with the option to add new values. It allows you to supplement the set of text values as necessary and re-select values from the list. It can have a fixed set of predefined values.

Note. Before you edit a field, you must collect all variants of the value of this field from all users, eliminate the duplicates and add values to the list of predefined values, if any. Therefore:

1) If you want to remove a certain cached value from this list, you need to clear or change it for all users who have this value set in their fields.

2) If you save a value with an error, it will be cached along with other values. That is, the options “bucket”, “buc ket”, “bUcket” or “buket” will end up in the cache and can appear in the list of available values

{TC%EMPTY} or {TC%value1|value2|...|valueN}
Example 1: {TC%EMPTY}—no predefined values.
Example 2: {TC%Engineer|Medic|Accountant}
TL 

A text with a limited length.

Note. It is necessary to make sure that the field type in the database does not exceed the allowed length. The example above requires TEXT or CHAR, 10 (or more)

{TL%length}
Example: {TL%10}—the line length is limited to 10 characters
RO

An arbitrary readonly field. It is used, for example, to display data when importing users from an external system or if this field is filled in with a script when manual input by the operator is prohibited.

Note. This format is similar to the normal text field, which is used in the Access Manager by default and marked as "Read Only" settings. The difference is that this field remains non-editable even if it is marked as editable. It also has a default value

{RO%def_value}
Example: {RO%Not specified}               

Creating additional fields for the User object

To create additional fields for the User object, do the following:

  1. In the Axxon PSIM installation directory, for example C:\Program Files (x86)\Axxon PSIM\ create a .dbi text document, for example, psim.person_extra_fields.dbi.

  2. Open the created .dbi file in the text editor.

    Attention!

    Before you enter any data, make sure that the UTF-8 text encoding is selected. Otherwise, when adding additional fields to the database, the text will be recognized incorrectly.

  3. In the first line of the text document, enter [OBJ_PERSON].
  4. In subsequent lines, specify the additional fields parameters:

    1. Separated by commas, enter the field name (db_name) that will be saved in the database, the field data type (db_type) with the maximum field size, if required—see Supported SQL data types.

    2. Using a double slash "//", indicate the field description (description) that will be displayed in the interface window of the Access Manager.

    3. If necessary, set the field behavior pattern by indicating the beginning and end using curly braces "{ }".

  5. Save the changes.

    Attention!

    After you save the .dbi file, it is necessary to update the main database. To do this, use the idb.exe utility (see The idb.exe utility for converting databases, selecting database templates and making backup copies of databases).

An example of a .dbi file with additional fields for the User object is shown in the figure below:

As a result, the created fields will be available on the settings panel of the Access Manager object on the Additional fields tab (see Configuring the Main department type).

In the interface window of the Access Manager, in the area of additional fields, the corresponding additional fields will be displayed depending on the configured visibility and availability of fields for editing, as well as the specified category.

Basic structural elements of the additional field of the User object

IndicationDescription
db_name

The additional field name (db_name) that will be saved in the database

db_type

Data type (db_type) of the additional field, size (if required, see Supported SQL data types)

descriptionName of the additional field displayed in the Access Manager interface window
fmtA modifier from the set (see Field formats with special processing)
prmsField value parameters, entered using parentheses ()
{Beginning of the additional field behavior template
%

After the %, the names of the predefined values of the additional field are listed. 

Note. If you specify %EMPTY, there will be no predefined values

value1, valueNNames of predefined values of the additional field
|Separation of predefined values of the additional field
lengthLine length limit
def_valueDefault value
}End of the additional field behavior template

Creating additional fields for the User object is complete.

  • No labels