Guides for Content Providers
How to register an OJS Journal in OpenAIRE
Using the OJS Connector for the OpenAIRE Graph
Registration of OJS Journals in OpenAIRE
OpenAIRE allows for the registration of scholarly communication data sources, such as Journals, Literature and Data Repositories and CRIS Systems, among others. Managers can register their data sources in OpenAIRE using the OpenAIRE PROVIDE service that offers a dashboard in which data source managers can benefit from a set of added-value functionalities (https://provide.openaire.eu/about).
For journals based on Open Journal Systems (OJS), there is a new OJS plugin (OJS Connector for the OpenAIRE Graph), which ensures compatibility with the latest version of the OpenAIRE guidelines for Literature, Institutional, and Thematic Repositories (OpenAIRE 4.0 guidelines).
It is available at https://github.com/munipress/openAIREstandard and supports the current three major OJS versions 3.2.1, 3.3 and 3.
How to use the OJS Connector
The plugin needs to be downloaded in the version matching the OJS version and added to the plugin set in the [OJS root folder]/plugins/generic/folder. The plugin will then appear in the plugins gallery in OJS and can be enabled.
When the plugin is active, it is possible to select the article type for each section of the journal according to the COAR Resource Type Vocabulary.
For more information, you can refer to chapter 4 from CRAFT-OA Deliverable 6.1_OJS Connector for OpenAIRE Research Graph.
When the plugin is enabled in the OJS plugin gallery, an additional metadata format with the metadataPrefix "oai_openaire" is added to the list of metadata formats in the OAI-PMH protocol, which can be listed using the ?verb=ListMetadataFormatsparameter. Here is an example: https://cyberpsychology.eu/oai?verb=ListMetadataFormats.
How to register a Journal in OpenAIRE
To use OJS plugin, when registering the journal, the software platform that is selected must always be "OJS" and the setting of the guidelines must always be "OpenAIRE 4.0 (inst. & thematic. repo.)". For more details and information about this plugin, please refer to: https://zenodo.org/records/12633203.
It is possible to login to OpenAIRE via different organizations by using the authentication and authorization infrastructure (AAI) login and your institutional account via the eduGAIN interfederation service. Alternatively, if your organization is not supported, you can create an OpenAIRE account and login via it.
Below is a guide to help you register your journal with OpenAIRE, after enabling the plugin:
- Go to https://provide.openaire.eu/dashboard to register your journal with OpenAIRE
- Choose "Sign in" and either choose an existing account or choose "Sign up" to create an OpenAIRE account
- After logging in, you should be forwarded to https://provide.openaire.eu/dashboard
- Choose "Register"
- Choose the option "Journal"
- Fill in the form regarding basic data for your journal
Stage 1: Enter Information
- Software Platform: OJS
- Official Name: your journal's name
- ISSN: if you only have eISSN fill it here, or fill in your print ISSN
- EISSN: if you have both print and eISSN, give eISSN here
- Description: a short description of your journal
- Country: the country where your journal is published
- Longitude and latitude: Fill in the geocoordinates.
(To determine your geocoordinates, use e.g. https://www.openstreetmap.org, search for your institution/town, right-click it, pick “Show address” from the drop-down menu, then copy the coordinates.) - Entry URL: the URL leading to the front page of your journal
- English Name: can be the same as above if you only have an English name for the journal
- Timezone: the time zone where the journal is situated
- Repository type: Journal
- Admin Email: Preferably the same as the one given for the OAI-PMH verb Identify (see your OAI-PMH feed at "http://yourdomain.com/index.php/yourjournal/oai" => Identify)
- Click "Next" to add the interface of your journal
Stage 2: Add Interfaces
- Base OAI-PMH URL: Specify the page from which to retrieve metadata. Find your OAI-PMH URL "http://yourdomain.com/index.php/yourjournal/oai". Visiting the correct URL should show a page with the title "OAI 2.0 Request Results".
- Validation Set: If left empty, all sets will be harvested.
- Desired Compatibility Level: Choose "OpenAIRE 4.0"
- Click "Next" and you are ready.
Your journal is now registered with OpenAIRE.
How to use the OJS Plugin for the JATS XML format
This plugin ensures compliance with the OpenAIRE standards, particularly through the integration of the JATS XML format.
The OpenAIRE plugin for OJS enables journals to align with the OpenAIRE guidelines, improving interoperability and metadata completeness.
This includes:
- The ability to add funding information
- The use of controlled vocabularies for access rights and resource types
- Support for the JATS XML format, allowing full-text content to be machine-readable
The OJS Plugin for the JATS XML format adds JATS as a new XML metadata format in the OAI-PMH and it also implements controlled vocabularies from COAR, namely: access rights and resource types.
Article access rights are defined using the COAR Access Rights Vocabulary (https://vocabularies.coar-repositories.org/access_rights/). In section settings, journals can select a publication type from the COAR Resource Type vocabulary that best describes the articles published in that section (https://vocabularies.coar-repositories.org/resource_types/).
This plugin is available at https://github.com/ojsde/openAIRE and in the OJS Plugin Gallery.
For further instructions, please see https://github.com/ojsde/openAIRE/blob/master/readme.md.
For more information, please refer to: https://www.openaire.eu/ojs-news-standards-achieve-openaire-compliance-jats.
For journals that are already registered in OpenAIRE:
- After enabling the OpenAIRE plugin in OJS, please open a ticket at OpenAIRE Helpdesk under https://www.openaire.eu/support/helpdesk or send an email to helpdesk[@]openaire.eu and let us know that you want your metadata to be included in the JATS format by using the plugin for OJS.
- If you have used the old OpenAIRE plugin and have saved FP7 project IDs to the database, this plugin will still show them in the OAI-PMH.
For journals that are not yet registered in OpenAIRE:
After enabling the plugin and logging in, register your journal either as "Open Access Journals" if you are hosting one OJS journal on your site or "Aggregator" if you are hosting multiple journals.
The software platform selected must be OJS and the desired compatibility level "OpenAIRE 3.0". After registration, please open a ticket at OpenAIRE Helpdesk under https://www.openaire.eu/support/helpdesk or send an email to helpdesk[@]openaire.eu to draw attention to your registration and let us know that you want your metadata to be included in the JATS format.
More specifically, after enabling the plugin:
- Go to https://provide.openaire.eu/dashboard to register your journal with OpenAIRE
- Choose "Sign in" and either choose an existing account or choose "Sign up" to create an OpenAIRE account
- After logging in you should be forwarded to https://provide.openaire.eu/dashboard
- Choose "Register"
- Depending on whether you are hosting one or several OJS journals on your site you either choose the option "Open Access Journals" or the option "Aggregator".
- Fill in the form you selected
6.1 (one journal) or 6.2 (multiple journals)
6.1. For Option "Open Access Journals", one OJS journal
Stage 1: Enter Information
- Software Platform: OJS
- Official Name: your journal's name
- ISSN: if you only have eISSN fill it here, or fill in your print ISSN
- EISSN: if you have both print and eISSN, give eISSN here
- Description: a short description of your journal
- Country: the country where your journal is published
- Longitude and latitude: Fill in the geocoordinates.
- (To determine your geocoordinates, use e.g. https://www.openstreetmap.org, search for your institution/town, right-click it, pick “Show address” from the drop-down menu, then copy the coordinates.)
- Entry URL: the URL leading to the front page of your journal
- English Name: can be the same as above if you only have an English name for the journal
- Timezone: the time zone where the journal is situated
- Repository type: Journal
- Admin Email: Preferably the same as the one given for the OAI-PMH verb Identify (see your OAI-PMH feed at "http://yourdomain.com/index.php/yourjournal/oai" => Identify)
- Click Next
Stage 2: Add Interfaces
- Base OAI-PMH URL: Find your OAI-PMH URL "http://yourdomain.com/index.php/yourjournal/oai". Visiting the correct URL should show a page with the title "OAI 2.0 Request Results".
- Validation Set: leave empty
- Desired Compatibility Level: Choose "OpenAIRE 3.0"
- Click Next and you are ready.
Your journal is now registered with OpenAIRE.
or
6.2. For option "Aggregator", OJS site with multiple journals (like https://journal.fi)
Stage 1: Enter Information
- Software Platform: OJS
- Official Name: your OJS site's name (containing multiple journals)
- Description: a short description of your site
- Country: the country where your site is maintained
- Longitude and latitude: Longitude and latitude: Fill in the geocoordinates.
- To determine your geocoordinates, use e.g. https://www.openstreetmap.org, search for your institution/town, right-click it, pick “Show address” from the drop-down menu, then copy the coordinates.
- Entry URL: the URL leading to the front page of your site index
- Institution: the name of the organization maintaining the site
- English Name: it can be the same as above if you only have an English name for the OJS site
- Timezone: the time zone where the site is situated
- Repository type: Journal Aggregator/Publisher
- Admin Email: Should be the same as the one given for the OAI-PMH verb Identify (see your OAI-PMH feed at http://yourdomain.com/index.php/index/oai => Identify)
- Click Next
Stage 2: Add Interfaces
- Base OAI-PMH URL: Find your site's main OAI-PMH URL http://yourdomain.com/index.php/index/oai. Visiting the correct URL should show a page with the title "OAI 2.0 Request Results".
- Validation Set: leave empty
- Desired Compatibility Level: Choose "OpenAIRE 3.0"
- Click Next and you are ready.
Your OJS site is now registered with OpenAIRE.
-
After registering your journal/site with OpenAIRE a validation process will start and you will be notified of the results. Note that, currently, the validation may fail, because OpenAIRE is still lacking the required validation rules for the JATS format that the OpenAIRE plugin uses. However, this will not prevent your content from being registered with OpenAIRE.
-
Please open a ticket at OpenAIRE Helpdesk under www.openaire.eu/support/helpdesk or send an email to helpdesk@openaire.eu to draw attention to your registration and let us know that you want your metadata to be included in the JATS format.
NOTE, that eventually the registration process will be updated to include the JATS option so that the last step of this guide will be redundant.
OpenAIRE Helpdesk
Ask your question using the form below or send an email to helpdesk[@]openaire.eu
Publication date: February 03, 2025