Synchronize users, units, and roles from Ziik to Learningbank.
Topics in this article
Disabling or removing the integration
About the integration
When the Learningbank integration is configured, every time a Ziik user, unit, or role is added, modified or deleted, Ziik will synchronise it to Learningbank.
This means that new Learningbank departments will be created to mirror the unit structure in Ziik, new Learningbank permission types will be created to mirror the roles in Ziik and Learningbank users will be created and assigned to departments and permissions based on their units and roles in Ziik.
Easy authentication
Users never have to manually authenticate when opening Learningbank from Ziik. All authentication is automatically handled and makes the integration between Ziik and Learningbank seamless. Automatic authentication works when pressing the Learningbank shortcut and pressing a link sent through the chat to a Learningbank web-address.
Requirements in Ziik
Only administrators in Ziik can configure the Learningbank integration.
Requirements in Learningbank
You will need to have an active subscription and have access to the different Learningbank API credentials.
Vocabulary
|
Ziik |
Learningbank |
|
Admin |
|
|
User |
User |
|
Unit |
Department |
|
Role |
Permission type |
|
NA |
Job profile Defines the learning modules for the user |
Configure the integration
Go to the integration page in the admin panel. Press create integration to get started and select Learningbank.
Follow the steps outlined below:
1. Create API keys in LearningbankObtain username, password, and token from Learningbank by creating a new set of API keys in Learningbank.
2. Assign a default job profile in LearningbankWe recommend, you assign a job profile as the default in Learningbank. Otherwise, we’ll do our best to add the right job profile to each user.
3. Create Learningbank integration in ZiikFill in the obtained API credentials from step 1 when creating the Learningbank integration in Ziik. Choose your integration settings when creating the integration as you might want different behaviour than the default.
4. Synchronize the integration
In this final step, we’ll sync all units, roles, and users to Learningbank.
How the integration works
|
Ziik |
Learningbank |
|
|
Top Unit |
|
Ziik top unit will be connected to the top department in Learningbank. The name of the Learningbank top department will not be changed. |
|
Sub-units |
|
Ziik subunits are mirrored 1:1 to Learningbank, meaning that the Ziik unit hierarchy will be recreated in Learningbank. Sub-units will be created as Learningbank departments with the same name as in Ziik. When “Unique Units” are enabled, the Ziik unit ID will be appended to the department name - and in the same hierarchy. |
|
Updating name of unit |
Will update name of department |
|
|
Deleting unit |
Will delete department |
|
|
If a Unit is moved in Ziik. |
Unit movement will be mirrored in Learningbank. |
|
|
Role |
There is no connection between permissions in Ziik and permissions in Learningbank, as there is no clear overlap between what actions a user may perform in Ziik and what the corresponding permissions are in Learningbank. |
|
|
Updating name of role |
Will update name of the permission type |
|
|
Deleting role |
Will delete permission type |
|
|
User |
Users in Ziik are created as users in Learningbank with the following attributes: - First name- Last name - Email address - Active/inactive status - Language |
|
|
Unit membership(s) |
Users are assigned to a department based on their unit memberships in Ziik. If a user has multiple Ziik unit memberships, all units will be synchronised to Learningbank. |
|
|
Role(s) |
Roles on the user’s (first) unit membership in Ziik will be matched with permission types in Learningbank and assigned to the user. Any permission types in Learningbank that are not created by Ziik, but are assigned to the user in Learningbank, will remain on the user. Ziik will only add/remove permission types that come from Ziik. Important note If there is a Learningbank job profile that matches the user’s role in Ziik exactly, this job profile will be applied to the user. If there is not a Learningbank job profile that matches the user’s role, the default job profile will be assigned by Learningbank on user creation, but can be changed manually in Learningbank user administration after creation. |
|
|
Updating user’s name, email address, assigned unit and role |
Will update the user's name, email address, assigned department and permission types. |
|
|
Deactivating user |
Will deactivate the user in Learningbank. |
Disabling or removing the integration
When the integration in Ziik is disabled, all synchronisation stops. No data will be added, updated or removed in Learningbank and disabling the integration will not change any data in Learningbank.
When re-enabling the integration, the “Initiate synchronisation” button should be clicked in the integration administration, to ensure that units, users or roles created while the integration was disabled, will be created in Learningbank.
Removing an integration completely will sever the connection between Ziik and Learningbank, but no data will be touched in Learningbank in the process.
This article was updated 1st March 2024