User sync

User sync keeps the Haplo user database and user profile objects synchronised with an external system. Regular batch files are uploaded which contain information on all current users, and the user sync works out the difference between this and the previous version to:

  • add new users and their associated profile store objects,
  • update existing users and profile objects to match the information in the feed,
  • block users who are no longer in the feed, and mark their profile object as ‘past’,
  • unblock users who reappear in the feed, and mark their profile object as current.

A user interface is provided to configure the user sync, view logs of all sync runs, download previous batch files, and examine received data on individual users.

While the user sync plugin maintains the user database and profile information, logging in users is handled by a separate plugin.

The user sync will not alter users that it has not created, so it can be used in parallel to other user management systems.

Required plugins

The haplo_user_sync_generic plugin provides user sync services based on the data import framework. Other plugins may add to the Model.

No duplicate usernames, avoid duplication of email addresses

The username of a user must be unique within the data files, so that users can be unambiguously matched. However, usernames are opaque to the user sync, and can be any string or identifier.

If a record duplicates the username of a previous record, it will be ignored with an error in the logs.

While it’s not an enforced constraint, it is advised that email addresses are unique for avoiding ambiguity. This is particularly important for authenticating users through external identity systems that use the email address to identify the authenticated user.

Setting up a user sync

To set up a user sync,

  • As the generic user sync mechanism is very general, and the exact data Model will depend on the application, consult the application specific documentation for additional guidance.
  • Find an identifier for your users which will never change over the entire time they are involved with your organisation to use as the username. This might be their account username, but some organisations change usernames, so another person identifier may be more appropriate. (For example, your institution may change usernames when staff change their surname through marriage, or issue a new username when a user moves from a student to staff role.)
  • View the haplo:user-sync Model and note the required and optional data that needs to be provided.
  • Prepare data exports from the originating system, usually by writing database queries that select data for all active users. Output these files in JSON format (recommended), or use XML (child nodes), XML (attributes) or TSV.
  • Write a Control file which describes how to map the input data onto the Model, using the control file generator linked from the Model page to create a starting point. Follow the additional documentation for your specific application.
  • Write an upload script which uploads the control file and data files to a test instance of your application.
  • Refine the data and mappings. The error count for a sync run should be as close to zero as possible.
  • Set up the live user sync by automating data generation and upload.

Table of contents

Control file
User groups
Upload script
Admin UI
Troubleshooting