Graduate Education Manager user data
Graduate Education Manager requires more data than other Haplo Research Manager modules, because it needs details of research projects as well as academic researchers and staff.
Students should be included in the user sync once they have enrolled (unless Graduate Education Manager is managing your Recruitment and Admissions process). All other users can be included whether or not they are involved in a research project.
Data will typically be sourced from your Student Information System and HR system, and provided as structured data in JSON or XML (recommended).
All users
All users must have:
- Name (split into title, first and last name fields)
- Username/ID (see notes below)
- Organisational unit
- Category of user: Academic staff, Non-academic staff, Postgraduate Researcher (student)
Additionally, your institution may wish to provide:
- Telephone number
- Address
- Disability information
- REF Unit of Assessment (for UK institutions only)
See the example user feed file.
Usernames
The username of a user must be unique within the data files, so that users can be unambiguously matched. In addition, either the username or email address will have to match the identifier used to identify users when they log in.
Usernames are opaque to the user sync, and can be any string or identifier. Note that usernames are case insensitive, and internally are converted to lower case. The identifiers used as the username must not differ only in case, eg JSmith and jsmith must refer to the same user.
If a record duplicates the username of a previous record, it will be ignored with an error in the user sync 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.
Mappings for data provided as a code
Many of the fields will be provided as codes to unambiguously identify things like organisational units, visas and project types.
You should not include the human readable names within the feed. Instead, please provide Haplo with a mapping that specifies how to interpret the codes. This information can be provided in any format, for example a spreadsheet or a document.
Student project data
As well as the required information above, students must have:
- Project title
- Supervisors (as usernames and roles)
- Mode (full time or part time)
- Project type
- Start date
- Enrolment status (e.g. active, suspended)
- Current stage (e.g. submitted, examined)
and optionally,
- Fee status
- Visa type (especially for Tier 4 monitoring for UK institutions)
- ATAS (for UK institutions)
- Scholarship/studentship information
Additional data and revisions to user feed
Your institution may require additional data to be synchronised to enable implementation of business rules and provide necessary information to your users. Addition of custom fields will be chargeable.
In addition, the integration architecture will determine how data is transferred between systems.
Some of these requirements will only be discovered during the design phase of the implementation. If so, you may need to provide a revised data file at a later stage of the implementation project.
Project data and setup tasks
Additional data about the project and historical changes need to be provided alongside the user data.
Institutional structure
Historical data import
One-off import
Example user sync file
Sending initial data files