Researchers Data Format
The purpose of this guide is to outline in high level the schema XSD for the Esploro Researcher, for use in conjunction with the API. The Esploro Researcher XSD complements the Esploro User schema XSD, available in the Ex Libris Developer Network at xsd/rest_users.xsd. For additional information about the Researcher API, see Esploro Researchers in the Ex Libris Developer Network.
Esploro Researchers
- Preferred name – This name is used in Esploro as the default researcher name. This has been added since the username is generally the user’s official name; his or her published form may be different. Note that in addition to this name, which is stored at the user record level, it is possible to store and display the actual published form of the name at the level of every asset.
- Additional identifier types – Additional types of identifiers that are relevant to researchers in Esploro, such as ORCID, Scopus ID, and ResearcherID. These types are added to the User Identifier Types code table upon activation of your Esploro environment. For a list, see Working with User Identifiers.
Loader Schema XSD Files
Three XSD files are used to manage Esploro researchers:
rest_users.xsd – This is a wrapper XSD. It is the same as the platform users.xsd.
rest_user.xsd – This is the same as the platform user.xsd, with the following additions:
- A flag to indicate if the user is a researcher – is_researcher
- The researcher element, whose properties are described in the Researcher XSD (rest_researcher.xsd)
- The new fields – pref_first_name, pref_middle_name, pref_last_name – for the “preferred name” which, as noted above, is an element added for Esploro to the platform user record.
rest_researcher.xsd – The Researcher XSD, which can be downloaded from the Ex Libris Developer Network at xsd/rest_researcher.xsd.
Researcher Loader Schema Fields
The following fields can be loaded per researcher in addition to platform user fields. For more detailed information, see the researchers Data Dictionary in the Ex Libris Developer Network.
| Element | Occurs | Description |
|---|---|---|
|
is_researcher |
1 |
true/false Indicates if the user is a researcher or at least a potential researcher. The system creates the “Researcher” role and the researcher extension for such users. |
| researcher_first_name | 0-1 | The researcher's first name |
| researcher_middle_name | 0-1 | The researcher's middle name |
| researcher_last_name | 0-1 | The researcher's last name |
| researcher_suffix | 0-1 | The researcher's suffix; example: Junior |
| researcher_title | 0-1 | The researcher's title. Titles are defined in the UserTitles code table. |
| profile_image_url | 0-1 | URL of the profile image the researcher uploaded to their profile. Once this is added, it cannot be changed via the API/SIS; only the researcher can change it. |
| photo_url | 0-1 | Photo URL. Optional in the User API and in SIS load. If no profile_image_url exists, this researcher photo is used instead. |
| profile_identifier_url | 0-1 | URL of the researcher's profile |
| display_title | 0-1 | The title to display for the researcher in the Research Portal |
|
position |
0-1 |
The code of the current position or role of the researcher within the institution. Position codes are defined in the Organization Positions code table; see Configuring the Organization. |
|
portal_profile |
0-1 |
This flag controls whether the researcher’s profile is included in the Research Portal. Default: Yes. |
|
auto_capture |
0-1 |
This flag controls whether the researcher's name is included in automatic capture (Smart Harvesting). Default: Yes. |
| update_ORCID_profile | 0-1 | This flag controls whether the researcher's ORCID profile is updated. Default: Yes. |
|
research_center |
0-1 |
This flag controls whether the researcher has access to his profile in the Researcher Center. Default: Yes. |
| previous_affiliated | 0-1 | This flag indicates whether a non-affiliated researcher was previously affiliated. Possible values: true/false. Default: false. |
|
default_publication_language |
0-1 |
The researcher's default publication language. Use two-letter codes, e.g., en for English. For a list of available languages, see Configuration > Researchers > Default Researcher Settings, under Default publication language. For additional information, see Working with Researchers. |
| researcher_alternate_emails | 0-n | Alternate email addresses for the user |
|
_affiliations |
0-n |
The researcher's current academic affiliations within the organization. Every affiliation must include the code of the organizational unit (see Configuring the Organization), and can also include its name, the start date and end date of the affiliation, the researcher's position (a code from the Organization Positions code table; see Configuring the Organization), the researcher's full title, and the position's order (an integer indicating where in the list of affiliations this affiliation should appear in the research hub and the researcher's profile). Note: If the end date has already passed, the affiliation is added as a previous affiliation. And if the end date passes after the affiliation is added, the affiliation is automatically converted to a previous affiliation. |
|
researcher_previous_ organization_affiliations |
0-n |
The researcher's previous affiliations within the institution (see researcher_organization_affiliations, above) |
|
researcher_external_ organization_affiliations |
0-n |
The researcher's current affiliations in other organizations (see researcher_organization_affiliations, above). The code should match the code of an external organization defined in Esploro (see Configuring the Organization). |
|
researcher_previous_ external_organization_affiliations |
0-n |
The researcher's previous affiliations in other organizations (see researcher_organization_affiliations, above). The code should match the code of an external organization defined in Esploro (see Configuring the Organization). |
|
researcher_name_variants |
0-n |
Any additional forms of the researcher's name. These are used to help match the researcher with assets during Smart Harvesting. |
| researcher_engagement_types |
0-5 |
Codes of the researcher's engagement types (see Configuring Researcher Details) |
|
researcher_research_topics |
0-n |
Codes of the researcher's research topics. For a list of the topics that can be used and their codes, see Appendix - Research Topics. |
|
researcher_keywords |
0-n |
Free-text descriptions of the researcher's areas of research |
|
researcher_associations |
0-n |
A list of professional or other organizations that are not represented in the lists of organizational units and with which the researcher is associated |
|
researcher_languages |
0-n |
The languages the researcher is familiar with. These are language names and not codes. |
|
researcher_honors |
0-n |
A list of the honors the researcher has received. For every entry, it is possible to add the organization code and name, the title of the honor, and time period (free text for the last three). The code should match the code of an external organization defined in Esploro. |
| researcher_educations | 0-n | A list of the educational programs in which the researcher took part in the past |
|
researcher_descriptions |
0-n |
Text describing the researcher’s areas of interest |
|
researcher_webpages |
0-n |
A list of researcher webpages. |
| user_identifiers | 0-n | A list of the researcher's additional identifiers (see Working with User Identifiers) |
| researcher_redirection_mapping | 0-1 | The identifier for mapping the redirection from legacy systems |
| proxy_for_researchers | 0-n | A list of the researcher's proxy researchers |