Visit Nexus to get an overview of Nexus' solutions, read customer cases, access the latest news, and more.


This article describes how to configure the Demo service that functions as a PACS simulator with Smart ID Physical Access component in Smart ID Identity Manager.

If Physical Access is being used with the Demo service, all administration of Users, Access Tokens and Entitlements (besides defining them) should be done in Identity Manager.

The Demo service is used to import entitlements (or access groups) from the AccessGroups.json file and export persons, cards and entitlement assignments from Physical Access to the Users.json file. For details on how data can be imported and exported from the demo access control system, see About import and export to Physical Access.


Expand/Collapse All

Prerequisites

The following prerequisites apply:

  • Physical Access and the PACS demo Docker container/service are installed. See Deploy Smart ID
  • The message queue server must be running.

Configure Demo service data fields

The Demo service data is configured in the configuration table in the Physical Access database. All configuration is cached when the service starts so any configuration changes will require the service to be restarted in order to take effect.

To connect to a PACS system:

  1. Log in to Physical Access admin panel as an admin user.
    All configured PACS connector services are listed, as well as Generic configurations to define the messaging queue. 
  2. Click on a system to do updates.
    All database entries are listed. 
  3. To update an entry, click on the icon. Edit as needed and then click Update
  4. To create an entry, click on +Create. Select Group, enter Key, Value and Index, and then click Create

group: messagingqueue

keyData typeRequired or OptionalDescription
serverstringRequired

IP Address of Message Queue Server. If it is installed on the local server then we can use localhost. If we are accessing this server remotely then need to mention IP address.

usernamestringRequired

Username of message queue server.

Default value: “guest”

passwordstringRequired

Password of message queue server.

Default value: “guest”

systemstringRequired

Defines which messaging queue to be used, either "rabbitmq" or "azureservicebus".

Default value: "rabbitmq"

group: general

keyData typeRequired or OptionalDescription
deleteUserOnNoEntitlementstringOptional

Defines if the user shall be deleted if no active entitlement assignment are present for that user.

Valid values: true or false.

Default: true

deleteUserOnNoAccessTokenstringOptional

Defines if the user shall be deleted if no active access tokens are present for that user.

Valid values: true or false.

Default: true 

heartbeatInterval

intOptional

Heartbeat interval is the time difference between two successive heartbeats, and it is used to know if the system is in active (running) or in inactive (stopped) state.

Default value and minimum value: 60 seconds. If it is set less than 60 seconds, it will be considered as 60 seconds to update the status.

group: export

keyData typeRequired or OptionalDescription
userfieldmappings stringOptional

userfieldmappings is used to export additional data of user to the Demo Service and populate them in Users.json. The value is a combination of table_name.value_of_type_column, additionalFields fieldname in Demo Service. This configuration setting is the mapping between the Physical Access table field and Demo Service field Id.

User column fields can be sent by adding the configuration user.column_name, demo_field_id.

The following table shows sample configuration for userfieldmappings:


system

keyvaluegroupindex
DEMOuserfieldmappingsuser.title, additionalFields. titleexport0

group: demo.card.mapping.default

This group defines how to export card numbers by default, when a card’s layout does not have a specific mapping.

keyData typeRequired or OptionalDescription
layoutIdentifierstringRequiredThe name of the card layout to match (case insensitive) for this mapping. Each layout may only be mapped once.

cardNumberIdentifier 

stringOptional

The default identifier type to read card numbers.

Default: mifare

format

stringOptional

The format that the card number should be converted into before exporting it to the Demo service.

Valid values: Linear

Default: Linear

length

intOptional

The length that the card number should be trimmed (leading digits) or padded (with leading zeroes) to after converting it.

Default: 9

group: demo.card.mapping

This group contains compound configuration elements using the config_index column. For each unique config_index value in this group, each key defined below must be defined exactly once. Note that this group is not required as a whole, and should only be used if you have specific requirements for one or more card layouts.

keyData typeRequired or OptionalDescription

layout

stringOptionalThe name of the card layout to match (case insensitive) for this mapping. Each layout may only be mapped once.

cardNumberIdentifier

stringOptionalThis indicates the identifier for card number.

format

stringOptional

The format that the card number should be converted into before exporting it to the Demo Service.

Valid values: Linear, Skip.

lengthintOptionalThe length that the card number should be trimmed (leading digits) or padded (with leading zeroes) to after converting it.

Example

Example configuration for card mapping settings:

system

keyvaluegroupindex
DEMOlayoutLinear

demo.card.mapping

1
DEMOcardNumberIdentifiermifare

demo.card.mapping

1
DEMOlength9demo.card.mapping1
DEMOformatLineardemo.card.mapping1
DEMOlayoutskipdemo.card.mapping2
DEMOcardNumberIdentifiermifaredemo.card.mapping2
DEMOlength9demo.card.mapping2
DEMOformatskipdemo.card.mapping2

Restart service

  1. Restart the PACS Demo service:

    Restart Physical Access Demo service
    cd <SMARTIDHOME>/compose/physicalaccess
    docker-compose restart smartid-pa-demo

This article is valid for Smart ID 21.04 and later.

Related information