Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated to Smart ID names

This article describes how to install and configure the Unison Pacom Service, to enable integration between Smart ID Identity Manager (PRIME) PACS Backend and  Physical Access and Unison Pacom. 

Unison is an Access Control System provided by Pacom and managed by a GUI and a web service on the server and the service interacts with Unison through the wcf service.

After integration, all administration of Users, Access Token and Entitlements (besides defining them) should be done in Nexus PRIMEIdentity Manager, never in Unison.

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


Expandall

Prerequisites

Expand
titlePrerequisites

The following prerequisites apply:

  • PRIME PACS Backend Physical Access is installed. See here.
  • Unison Pacom is installed.
  • The wcf service is installed.
  • The Message Queue Server must be running.

Configure Unison Pacom Service

The service is configured in the configuration table in the PACS Backend Physical Access database and 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.

Expand
titleSet parameters in the configuration file

The configuration file is named UnisonService.exe.config.

Excerpt Include
Set parameters in PACS connector configuration file
Set parameters in PACS connector configuration file
nopaneltrue


Expand
titleApply configuration

Excerpt Include
Apply configuration changes in PACS connector service
Apply configuration changes in PACS connector service
nopaneltrue


Expand
titleConfigure database

Excerpt Include
Configure database in PACS admin panel
Configure database in PACS admin panel
nopaneltrue

Excerpt Include
Physical Access database - messagingqueue parameters
Physical Access database - messagingqueue parameters
nopaneltrue

group: general

keyData typeRequired or OptionalDescription
updatesPerPollintOptional

The maximum number of messages read from the message queue.

Default: 100

group: unison

keyData typeRequired or OptionalDescription
hoststringRequired

The hostname and path to the Unison.AccessService. The path should always point to the .svc file for the service.

usernamestringRequiredThe username to use when connecting to the Unison Service.
passwordstringRequiredThe password to use when connecting to the Unison Service.
cardmaxlengthstringRequiredThis is maximum length of card number which we send to Unison. This is default setting in case of access profile setting is not available.
identifiertypestringRequiredThis is the type of identifier of access token. This setting indicates which type of identifier we want to use for card number.
personnumberfieldstringRequiredThis the unique value of person which is used to send on unison side to represent person uniquely.
layoutidentifiertypestringRequiredThe layoutidentifiertype is used to set identifier type of layout. This setting is required to configure access profiles.

Example

IdGroupIndexKeysystemvalue
1general0updatesPerPollUnison100
2unison0hostUnisonhttp://my.company.com/Unison.AccessService
3unison0usernameUnisonadmin
4unison0passwordUnisonadmin

group: cardformatmappings

The optional setting cardformatmappings can be used to configure access profiles. If cardformatmappings is used, then all its settings are required to be configured, otherwise the connector will throw an error. This setting directly depends on the setting layoutidentifiertype.

keyData typeRequired or OptionalDescription
layout stringRequired

This is the value of the identifierType which we have configured in setting layoutidentifiertype.

Example
The connector will fetch the value of layout from access token identifiers, for example, Standard Magnetkort, and search in the configuration group cardformatmappings for the same value of layout, that is, Standard Magnetkort. If this setting is found, then the card will be exported with this configuration.

profilestringRequiredThe unison card profile to use when matching profiles to the Unison Service. For matching profile name, the profile key is assigned to the card.
identifiertypesstringRequired

A comma-separated list of identifier types to match in access token identifiers. If a complete list exists in the identifier, then the only system will transfer the data in the associated fields. Otherwise the card will be marked with errors. 

By default, the system will use the default profile from Unison with identifiertype and cardmaxlength configurations to transfer access tokens to Unison.

keyData typeDescription
fieldnamesstring

A comma-separated list of unison system fields to transfer data. System will match predefined types CardNumber, SystemNumber, VersionNumber and MiscNumber.

formatstring

A comma-separated list of access token format types to validate encoding format for the associated profile. The System will match predefined types Hex, Dec and Binary.

lengthstring

A comma-separated list of lengths of identifier types to validate the length of access tokens identifier.


Example

The table below shows a sample configuration of an access profile called Standard Magnetkort. The access token identifiers are configured in the following way:

Code Block
languagexml
"Identifiers": [
   {"type": "mifare","value": "999809"},
   {"type": "Layout","value": "Standard Magnetkort"},
   {"type": "SystemNumber","value": "100000"},
   {"type": "VersionNumber","value": "01"}
]


IdGroupIndexKeysystemvalue
14cardformatmappings0layoutUnisonStandard Magnetkort
15cardformatmappings0profileUnisonStandard Magnetkort
16cardformatmappings0identifiertypesUnisonmifare,SystemNumber,VersionNumber
17cardformatmappings0formatUnisonDec,Dec,Dec
18cardformatmappings0lengthUnison6,6,2
19cardformatmappings0fieldnamesUnisonCardNumber,SystemNumber,VersionNumber


Note

In the cardformatmappings configuration, remove extra spaces from key and value and make sure that all keys are in lowercase.

group: userfieldmappings

This mapping is used to export values of user related objects such as User, Email, Address, Phone and Useradditionalfields table fields to Unison fields. For exporting user table fields configuration settings will be combination of Table_name.column_name, field_id_of_Unison and for rest of the table it will be Table_name.value_type, field_id_of_Unison.

IdGroupIndexKeysystemvalue
20unison.export1userfieldmappingsUnisonphone.mobile,1
21unison.export1userfieldmappingsUnisonAddress.work,2
22unison.export1userfieldmappingsUnisonEmail.work,3
23unison.export1userfieldmappingsUnisonuseradditionalfield.category,4
24unison.export1userfieldmappingsUnisonuser.ssn,5
25unison.export1userfieldmappingsUnisonuser.title,6



Expand
titleUnison Pacom field mapping

The service mainly transfers user data including related access tokens and entitlement assignments. The tables below show the default field mapping.

If needed, additional fields can be configured, using the SCIM API and useradditionalfield in the database configuration. 

User field mapping

By default, the following data is mapped between the USER table in the PACS Backend Physical Access and the Unison service: 

SR NoPACS Backend Physical Access field (Web API)Unison field (UI)
1givenname (givenName)firstName (förnamn)
2familyname (FamilyName)lastName (efternamn)
3pin (Pin)pinCode (PIN)
4Collection of multiple fields of User,email,address,phone and emailfields(Fields defined in UI)

Access token field mapping

By default, the following data is mapped between the ACCESSTOKEN and ACCESSTOKENIDENTIFIER tables in the PACS Backend Physical Access and the Unison service: 

SR NoPACS Backend Physical Access field (Web API)Unison field (UI)
1CardNumber (identifiers-type-value)CardNumber (Kortnummer)
2Configuration Card Profile (identifiers-type-value)ProfileKey (kort profil)
3assigneeId(assignee)UserKey(User)
4Configuration Card Profile (identifiers-type-value)SystemNumber (Systemnummer)
5

Configuration Card Profile (identifiers-type-value)

VersionNumber(Versionsnummer)
6Variable “Misc-” + AccessTokenIDMiscNumber (Not on UI)

Entitlement assignment field mapping

By default, the following data is mapped between the ENTITLEMENTASSIGNMENT table in the PACS Backend Physical Access and the Unison service: 

SR NoPACS Backend Physical Access field (Web API)Unison field (UI)
1assigneeid (assignee -value)userKey (Selected User Name)
2entitlementid (entitlement-value)groupKey (Group Name)
3validfrom (ValidFrom)validFrom (giltig fr.o.m.)
4validto (ValidTo)validTo (giltig t.o.m.)


Install Unison Pacom service

Expand
titleInstall service

The installation file is named UnisonService.exe.

Excerpt Include
Install PACS connector service
Install PACS connector service
nopaneltrue

Restart Unison Pacom service 

Expand
titleRestart service

The service SystemId is Unison

Excerpt Include
Restart PACS connector service
Restart PACS connector service
nopaneltrue