- Created by Mikko Kerava, last modified on Jul 07, 2020
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 3 Next »
General
Thre are three different syncs:
User Sync (BenePortal)
Directory sync of existing users
Directory sync of directory entries
User Sync is used for managing users in BenePortal.
Directory sync of existing users is used for keeping directory information of users up to date. User is someone having Benemen services.
Directory sync of directory entries is used for creating, updating and removing directory entries in Benemen directory. A directory entry is just an object in the Benemen directory and does not have any Benemen services.
For all Syncs:
App registration must be added to customers AzureAD tenant.
For User sync following must be defined:
AzureAD group of which members will be synced
Attribute mappings
Removal policy
Email address for syn reports
Directory sync of existing users:
Attribute mappings
Directory sync of directory-entries:
AzureAD group of which members will be synced as directory-entires
Attribute mappings
Any attributes found from AzureAD can be used as a source attribute. However, not all attributes are synced from on-premises AD to AzureAD by default. Follow these instructions to sync extension attributes from on-prem AD to AzureAD: https://docs.microsoft.com/en-us/azure/active-directory/hybrid/how-to-connect-sync-feature-directory-extensions
The attributes are prefixed with extension_{ApplicationId}_ where {ApplicationId} is id of Tenant Schema Extension App in AzureAD.
For example to retrieve values from externsionAttribute11, and AppID is 9d98ed114c4840d298fad781915f27e4 mapping value will be extension_9d98ed114c4840d298fad781915f27e4_externsionAttribute11.
ApplicationId has the same value for all attributes in AzureAD tenant.
User Sync (From AzureAD → BenePortal)
Users to be synced in BenePortal is defined by being a member of a specified group in AzureAD. All users belonging in the group or any of its nested subgroups will be included in the sync.
Following BenePortal fields are mandatory
UserEmail
FirstName
LastName
ContractName
BillingContractName
CostCenter
Following fields are optional
AltEmail (Alternative email to send password recovery emails etc.)
UserCountry
UserRegion
UserLanguage
ExtAuthUserName
ExtAuthDomain
BenePortal fields can have constant value, mapping or both.
If constant value is set and no attribute mapping, the constant value will be used for all users.
If there are both constant value and mapping,. value for fields is first tried to get from the mapped attribute. If it’s not set for a user, the constant value will be used.
If its needed to have different configurations for different users, multiple sync jobs can be configured. For example, If there are users in two counties, and some values values should be set to BenePortal which are not found from AzureAD-attributes, we can set up two different sync-jobs with a different configuration.
There must be then own group for each User Sync job, users to be synced must be a member of only one of these groups!
WhenSyncModule runs the sync, it gets all users from three sources: Local database, BenePortal and users from AzureAD. If there are users that are found from both from BenePortal and AzureAD (username in BenePortal match UPN in Azure), they are added to the local database and updated to BenePortal if needed. User is now included in the sync, and future changes will be handled similarly as for users created by SyncModule.
If there are users in BenePortal which are not found from AzureAD, they are left as is.
There are two options for user removals: By default removed user is only added to user sync report and actual removal must be done manually. There is an option for automatic removals, in this case, user and users services are terminated immediately.
In Benemen systems email is used as a username, and changing it requires manual work by Benemen support.
Sync module keeps a local database of synced user objects, having AzureAD objectId as a primary key. If the user's Email/UPN is changed in Azure, this is reported in sync-report for manual change.
Directory sync of existing users
Sync is performed for all users in Benemen directory. For each user, SyncModule tries to find the corresponding user from AzureAD by using ExternalId (hidden from Directory) and Email-address. Benemen Email can be mapped to UserPrincipalName or EmailAddress in AzureAD.
If the corresponding user is found form AzureAD, directory information of Benemen user is updated based on information in AzureAD.
Following fields in the directory are managed by BenePortal, and cannot be updated directly:
EmailAddress
FirstName
LastName
WorkNumber
MobileNumber
All other fields can be mapped to be synced from AzureAD:
Title
Description
OtherNumber
Company
Location
Department
Group
Team
Superior (see “How Manager->Supervisor mapping works?”)
Substitute
Address
PostalCode
City
Country
PhoneticName
All fields in Benemen directory are plain text, whereas Manager attribute in AzureAD is a link to an other AzureAD user. If the supervisor field is mapped to Manager-attribute, the value of DisplayName-attribute of user set as a manager is set to supervisor field.
Directory sync of directory entries
Users to be synced as directory entries to Benemen Directory is defined by being a member of a specified group in AzureAD. All users belonging in the group or any of its nested subgroups will be included in the sync.
If there is already active user having the same username (ie. Email-address), directory entry will not be created.
- No labels