Overview

If your repository doesn’t accurately represent your organization's hierarchical structure, for example you want to limit what departments you can see in the Explorer or you want to use different wording - not to worry. Here at Altmetric we’re able to configure your EFI integration to support reading your departmental structure from an external service rather than taking it directly from your OAI-PMH feed - giving you the freedom and control to see exactly what you want in the way that makes the most sense.


Using this documentation as a guide, you’ll just need to create either a JSON or CSV file that matches our specification and then have it hosted somewhere publicly accessible ready for our system to consume.


The integration supports any HTTPS service which means that you’ll be able to use popular services like Dropbox, Google Drive or your own hosting infrastructure.


The OAI-PMH feed sync is scheduled to run weekly which means that we’ll update your departmental structure at the same time as your research outputs and authors. Any changes to the file will automatically be processed by us and appear within the Explorer the next day.


That’s it - when you’re ready for us to start consuming this new endpoint please contact us at support@altmetric.com to let us know. We’ll then perform a few checks to get things tested before making the changes live.


So whether you are a new client currently in the onboarding stage or you’re an existing one looking to make some changes to your OAI-PMH feed - we’re here to help. If using a CSV/JSON file to populate departments in the Explorer is something that you are interested in please feel free to reach out to us at support@altmetric.com and we’ll be happy to answer any questions.


Schema

JSON

Root object

Property

Required

Description

hits

Yes

An array of objects containing hierarchical information relating to the organization's departmental structure.


Hits child object

Property

Required

Description

name

Yes

The display name used to represent the given department within the Explorer.

id

Yes

A unique identifier assigned to the department. 


Must match the setSpec property value used within the metadata header for records returned in the OAI-PMH feed using the ListRecords verb.

parent_id

No

The unique identifier of the parent department. 


Can be either null or omitted completely if the department has no parent (for example top level departments).


CSV

Column header

Required

Description

name

Yes

The display name used to represent the given department within the Explorer.

id

Yes

A unique identifier assigned to the department. 


Must match the setSpec property value used within the metadata header for records returned in the OAI-PMH feed using the ListRecords verb.

parent_id

No

The unique identifier of the parent department. 


Can be either null or omitted completely if the department has no parent (for example top level departments).


Notes
  • All headers are required
  • All headers must appear in the exact order case as described
  • If no parent_id is supplied there must still be a comma after the id field (column count should be three)


Example

Below is an example of how a basic ListSet would look when converted to JSON and CSV.


setName

setSpec

Lilliput University - EMEA

lilliputuniversity-emea

Faculty of Science

lilliputuniversity-emea:facultyofscience

Lilliput University - US

lilliputuniversity-us

 

JSON

{
  "hits": [
    {
      "name": "Lilliput University - EMEA",
      "id": "lilliputuniversity-emea",
      "parent_id": null
    },
    {
      "name": "Faculty of Science",
      "id": "facultyofscience",
      "parent_id": "lilliputuniversity"
    },
    {
      "name": "Lilliput University - US",
      "id": "lilliputuniversity-us"
    }
  ]
}


CSV
name,id,parent_id
Lilliput University - EMEA,lilliputuniversity-emea,
Faculty of Science,facultyofscience,lilliputuniversity-emea
Lilliput University - US,lilliputuniversity-us,


Explorer for Institutions departments view

Below is a screenshot of how this department hierarchy would look when viewed in the Explorer.