Synchronization of user master data
In Avendoo, users can be imported. The user data is transferred into a standardized CSV file and imported. With automatic master data synchronization, a nightly full synchronization ensures that new user data (e.g. from the HR system) is transferred to the Avendoo learning environment. Existing accounts are updated, e.g. in the event of name changes after a marriage. Employees who leave the company can be automatically anonymized, set to inactive, or deleted. The procedure for setting this up is explained in the following instructions.
Template
This CSV file serves as a template for manual import or automatic synchronization.
Example
This CSV file contains sample data for two users and explanations of the columns.
Checklist
The checklist is used to define important framework conditions for setting up automatic master data synchronization.
1
Definition of the mapping
The mapping is based on the template provided. Check which data is available and assign it to the appropriate columns.
Please note that terms may be used differently. In your master data system, for example, the “department” or “team name” may be maintained, while this data is listed under “organizational unit” in the CSV file.
2
Definition of the raw data extract of the existing user data
In an event date with your Avendoo contact person, we will go through the user data mapping. Please bring a “raw data extract” of the existing user data to the event date.
3
Verification of the mapping
To test the configuration, a manual, initial (partial) user import is first carried out to check the mapping.
4
Configuration of the interface call
The interface call (REST-API) is configured to match the mapping. A completed checklist is required for the configuration. This contains all relevant information for user master data synchronization.
5
Execution of the user import
The import is carried out by you by calling the REST-API according to the configuration provided.
The REST-API call is then executed on your system from which the Avendoo system can be accessed via the https-URL (=SSL-encrypted).
Alternatively, you can provide us with the data via SFTP server. The import is created with cURL.
POST /v1/user/stringImport
User data is transmitted in CSV format directly in the body of the API call. This is the preferred method because it is efficient and direct.
POST /v1/user/import
User data is transferred as a CSV file via “Multipart-Body”. This method is used if the data comes from different systems and intermediate storage in a CSV file is required.
PUT /v1/user/
Enables the creation of a single user. However, this method is not suitable for synchronizing all accounts of a client, but only for targeted individual actions (e.g. account creation from a web shop).
6
Results of the import
- Users who are not yet in the system are created as “New User”.
- A data synchronization takes place for users who are already in the system. If there is new information, it will be added, or information that is no longer provided will be deleted. If no new information is provided, the user remains unchanged.
- If the user is no longer supplied, they will be set to inactive, anonymized, deleted, or permanently deleted. Which variant should be selected is determined before the import using a checklist.
The columns in the CSV file are always assigned to a user profile. This means: Only one user profile may be used for each synchronization. If multiple profiles are used, all users who are no longer included in the synchronization are automatically set to inactive or deleted.