This article describes how to install and configure the SiPass Integrated Service, to enable integration between the Smart ID Physical Access component in Smart ID Identity Manager and SiPass.

SiPass Integrated is an Access Control System provided by Siemens and managed by a GUI and a Restful API. After integration, all administration of Users, Access Token and Entitlements (besides defining them) should be done in Identity Manager, never in SiPass.

Some sections below are only relevant for Windows installations. For Docker deployment, see Deploy Smart ID. The instructions on configuring data fields are common for Windows and Docker deployments.

For details on which data can be imported and exported from SiPass, see About import and export to Physical Access.

Prerequisites

The following prerequisites apply:

Physical Access is installed. See Physical Access installation and upgrade.
SiPass must be installed. Physical Access has been tested with version 2.76.
The message queue server must be running.

Configure SiPass Service on Windows

The service is configured in the configuration file. All configuration is cached when the service starts so any configuration changes will require the service to be restarted in order to take effect.

Set parameters in the configuration file

The configuration file is named SiPassService.exe.config.

Error rendering macro 'excerpt-include' : No link could be created for 'Set parameters in PACS connector configuration file'.

Apply configuration

Error rendering macro 'excerpt-include' : No link could be created for 'Apply configuration changes in PACS connector service'.

Configure SiPass Service data fields

The SiPass 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.

Configure database

Error rendering macro 'excerpt-include' : No link could be created for 'Configure database in PACS admin panel'.

group: messagingqueue

key	Data type	Required or Optional	Description
server	string	Required	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.
username	string	Required	Username of message queue server. Default value: “guest”
password	string	Required	Password of message queue server. Default value: “guest”
system	string	Required	Defines which messaging queue to be used, either "rabbitmq" or "azureservicebus". Default value: "rabbitmq"

group: general

key Data type Required or Optional Description

deleteUserOnNoEntitlement

string

Optional

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

Valid values: true or false.

Default: true

deleteUserOnNoAccessToken

string

Optional

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

int

Optional

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: sipass.system

key Data type Required or Optional Description

clientUniqueId

string

Required

The Unique client name for SiPass HR API.

Default: PHYSICAL-ACCESS-SIPASS-CLIENT

username

string

Required

The username that will be used when accessing SiPass HR API endpoints.

Default: Siemens

password

string

Required

The password that will be used when accessing SiPass HR API endpoints.

Default: spirit

group: sipass.general

key Data type Required or Optional Description

apiUrl

string

Required

API URL of SiPass HR Restful Service API of SiPass Integrated Service.

Default: https://sipass-system:8745/

Install SiPass service on Windows

Install service

The installation file is named SiPassService.exe.

Error rendering macro 'excerpt-include' : No link could be created for 'Install PACS connector service'.

Restart SiPass service on Windows

Restart service

The default service SystemId is named SiPass.

Error rendering macro 'excerpt-include' : No link could be created for 'Restart PACS connector service'.

This article is valid for Smart ID 20.11 and later.

Related information

Integrate Identity Manager with physical access control system (PACS)

Set up integration with SiPass Integrated

Prerequisites

Configure SiPass Service on Windows

Configure SiPass Service data fields

[data-colorid=xa7m7e4h62]{color:#333333} html[data-color-mode=dark] [data-colorid=xa7m7e4h62]{color:#cccccc}[data-colorid=rcf1rg96t8]{color:#333333} html[data-color-mode=dark] [data-colorid=rcf1rg96t8]{color:#cccccc}group: messagingqueue

group: general

group: sipass.system

group: sipass.general

Install SiPass service on Windows

Restart SiPass service on Windows

Related information

group: messagingqueue