The Relesys user integration is not part of the Integration Hub on your Learningbank platform. However, we still provide a standard solution, that the Learningbank team can setup for you on your platform.
Here's how it works🚀
Standard Relesys Integration
Below you'll find a description on how the Relesys integration works, focusing on how users and departments are imported from Relesys and synchronized with the Learningbank platform.
As a standard, the integration runs every day at 06:00 AM. It will look at the changes that have happened in Relesys in the past 24 hours.
The integration is set up with a skip list. Skipping users or departments means they will not be handled by the integration. This is used for users who need manual updates, such as platform owners, certain content creators, etc.
The integration is equipped with a way to ignore certain permission types. This means that if a permission is excluded, no users in Learningbank will have it assigned.
Note: Deleting users in Relesys will not be reflected as inactive in Learningbank. This is because all references to a deleted user disappear. Instead, Learningbank offers to run another cleanup integration. This integration deactivates all users who are in Learningbank but not in Relesys unless they are on the skip list. The cleanup integration runs every Monday at 03:00 AM.
Users
The following table explains how the integration transforms users from Relesys, to fit the users in Learningbank.
Field in LB | Relesys Map |
Username | The phone number of the user, excluding the country code. |
Directly from Relesys. Certain email endings (for example @test.com) can be excluded, so they are not imported. | |
Is Active | A user is deemed active if they have the status “Activated” in Relesys. Else, they are inactive. |
External ID | The ID from Relesys |
Phone | A combination of the phone number of the user and the country code of the number. |
First name | Takes the full name from Relesys. The first word in the full name is regarded as the first name. |
Last name | Same as full name, but everything else that is not the first word will be regarded as the last name. |
First day | Employment date in Relesys. |
Last day | Employment end date in Relesys. |
Job profile | The title in Relesys |
Departments | A combined list of primary departments and additional departments. These will all be regarded as the department list in Learningbank. |
Permissions | Taken directly from the user groups. |
The integration takes care of creating, updating, reactivating and deactivating users. Again, do note here, that users are only deactivated from day-to-day, if they are deactivated in Relesys and not deleted.
Departments
The following table explains how the integration transforms departments from Relesys to fit the departments in Learningbank.
Field in LB | Relesys Map |
ID | ID of the department |
Name | Name of the department |
Street | Address line in Relesys |
City | City of the department |
ParentID | The ID of the parent. If the parent department has one, this department will be under it. It can also be empty, in which case the department will be created under the top department. |
The department part of the integration creates new departments and updates the hierarchy if it changes in Relesys. It will be a 1:1 mirror of the structure in Relesys. It does not update the department data itself, which means that names, addresses, etc., will not be updated. However, the parent of the department, which changes the hierarchy, can be updated.
How to set it up
To set up the Relesys integration on your Learningbank platform, it is first required to have a Client ID and Client Secret. These can be acquired from Relesys. Please see the link below under the section “Getting access”, to see how these can be acquired:
Once these have been acquired, the integration can be set up on your platform. This can be done, by reaching out to your Learningbank contact person or the support team.
Quick tip💡 Once you have set up your Relesys user integration, you have the opppturnity have notifications about learning set to users via Relesys.
Read this article, to find out how.
When the integration is being set up, there are a few settings to choose from. The following settings are currently available (default manager permission is currently not available):
The integration is also equipped with the exclusion of users and departments, just like the Integration hub on the platform. To update these lists, please reach out to the support team.
A complete Relesys set us the following:
A user/department integration is set up by Learningbank with the credentials from Relesys with the scope of relesys.api.users.
A SSO is set up by Relesys using credentails from Learningbank.
Communication is set up in Learningbank with credentials from Relesys. It can be an advantage to use the same ones, however, with the extended scope to include relesys.api.notifications.
The Sync
When an integration for Relesys is created, the following will be synced from Relesys to the platform:
All users (except for excluded users and users in excluded departments)
All departments, a 1:1 hierarchy will be created in the platform, mirroring the structure in Relesys
All user groups (except for user groups of users that are excluded)
When a user is synced, they will be synced with both the primary department of the user and any additional departments they have.
Good to know💭 When the integration is set up, it will only updates changes and additions, and not a full sync.
Technical support
The integration pulls users straight from Relesys. This means, that if you discover users that seems to have incorrect values, such as a wrong department and/or a job profile in the platform, please do first check in Relesys that the user is correct. If it is, then please reach out to the support team and we will be able to investigate it further.