Skip to main content
ExLibris
Ex Libris Knowledge Center

Researchers Data Format

The purpose of this guide is to outline in high level the schema for the Esploro Researcher. It complements the schema XSD, available in the Ex Libris Developer Network, here.

Esploro Researchers

Esploro researchers are Alma users that have been identified as researchers. The researcher record is an extension of the Alma user record with additional data elements. In addition to the extension, two changes have been made to the Alma user record to support researchers:
  1. A “preferred name” has been added. This name will be used in Esploro as the default researcher name. This has been added since the Alma 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 will be possible to store and display the actual published form of the name at the level of every asset.
  2. Additional types of identifiers have been added (ORCID, Scopus ID, ResearcherID, etc.). These types will be added to the User Identifier Types code table upon activation of your Esploro environment.

The Loader Schema XSD

There are three XSD files

rest_users.xsd – this is a wrapper XSD. Same as the Alma users.xsd.

rest_user.xsd – this is the same as the Alma user.xsd with the following additions:

  • A flag to indicate if the user is a researcher – “is_researcher”
  • The “Researcher” element which is described in the third xsd
  • In addition, note the new fields – pref_first_name, pref_middle_name, pref_last_name - for the “preferred name” which, as noted above, is a new element added for Esploro to the Alma user record.

 

rest_researcher.xsd

  • The rest_researcher.xsd may be downloaded here. For more information, see the Ex Libris Developer Network, here.

The Researcher Loader Schema – The Fields

The following fields can be loaded per researcher in addition to Alma 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 will create the “Researcher” role and the researcher extension for such users. 

position

0-1

The position or role of the researcher within the institution. Positions are defined in the Organization Positions Code Table. The code table will be open to customers in future. See below for the OTB values.

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 name is included in automatic capture. Default: Yes.

research_center

0-1

This flag controls access to the Researcher Center. Default: Yes.

default_publication_language

1

Default publication language. Use two-letter codes as defined in the User Preferred Language code table. This is the same code table used for the Alma user preferred language field.

researcher_alternate_emails

0-n

Additional emails for the researcher. These will be used to help identify the researcher in external capture

researcher_organization

_affiliations

0-n

These are the researcher academic unit affiliations. The code must match the organization structure loaded into Esploro.

Every affiliation includes the code, start and end date. In future we plan to add the researcher’ position per unit.

Note that the XSD also includes the unit name. In principle this is not required and may be removed in future.

researcher_previous_

organization_affiliations

0-n

Previous affilations within the institution

researcher_external_

organization_affiliations

0-n

These are current affilations the researcher may have in other (“external”) organizations. In principle the code should match the external organization defined in Esploro.

 

Esploro will include a database of global research related institutions. In addition, organizations can be added manually.

A mapping between the local code and the Esploro code may require.

researcher_previous_

external_organization_affiliations

0-n

These are previous affiliations the researcher may have in other organizations. In principle the code should match the external organization defined in Esploro.

 

See note above

researcher_name_variants

0-n

These are any additional forms of the researcher name. These will be used to help match the researcher with assets for External Capture.

researcher_research_topics

0-n

These are controlled research areas using a thesaurus provided by Esploro.

researcher_keywords

0-n

These are uncontrolled researcher areas or tags.

researcher_associations

0-n

A list of associations, professional or other organizations which are not represented in the lists of organization 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 honors the researcher has received. For every entry it is possible to add the organization code, name the title and time period (free text for both).

In principle the code should match the external organization defined in Esploro.

 

See note re affilations to external organizations above

researcher_descriptions

0-n

Text describing the researcher’s areas of interest

researcher_webpages

0-n

A list of researcher webpages.

These are the OTB values of the “Organization Position” code table. You can customize this table to include your own values.
Organization Position Code Table
Code Label

lecturer

Lecturer

senior_lecturer

Senior Lecturer

associate_professor

Assistant Professor

professor

Professor

chair

Chair

reader

Reader

research_associate

Research Associate

visiting_professor

Visiting Professor

visiting_researcher

Visiting Researcher

research_student

Research Student

  • Was this article helpful?