Open Access Switchboard Plugin

This plugin enables OJS journals to automatically send P1-PIO type messages to the Open Access Switchboard API at the moment of article publication.

Announcement: OA Switchboard OJS plug-in: Supporting diamond journals to increase the visibility of their OA output among research funders, libraries, and consortia.

Table of Contents

1. Open Access Switchboard Plugin
2. Version support
3. Plugin Installation
4. Requirements for usage
   • Journal Requirements
   • Publication Requirements
5. Usage
   • Demonstration video
6. What metadata fields are included in the message?
7. Credits
8. License

Version support

The main branch of this repository is compatible with OJS 3.4.0.x.

A version compatible with OJS 3.3.0.x is available in the stable-3_3_0 branch.

• Plugin version v1.x.x.x is compatible with OJS 3.3.0.x
• Plugin version v2.x.x.x is compatible with OJS 3.4.0.x

You can find the latest version of the plugin compatible with your OJS version in the Releases page.

Plugin Installation

1. Go to Settings -> Website -> Plugins -> Plugin Gallery. Click on OA Switchboard Plugin and then click on Install.

2. After installing the plugin, go to the plugin Settings, and follow the Usage instructions.

Requirements for usage

Make sure to fulfill these requirements so that the P1-PIO Message can be sent to OASwitchboard at the moment of article publication.

Journal Requirements

1. api_key_secret

The OJS instance must have the api_key_secret configuration set up, you may contact your system administrator to do that (see this post).

This is required to use the API credentials provided, that are stored encrypted in the OJS database.

2. ISSN

The Journal must have at least one ISSN configured, either digital or print.

Publication Requirements

• All authors of the article must have an affiliation set.
• The publication must have a DOI associated to it.
• The authors need to have family name besides the given name.

It's recommended that at least one author of the article has a ROR ID associated with their affiliation (requires the ROR plugin), in order for the message to be sent to the associated affiliation. The ROR usage instructions for OJS are described in the ROR plugin's README.

Funding information: In order to include funding information in the message, the journal must be using the Funding plugin to provide that information for the article.

Usage

• First of all, make sure you have met all requirements for properly sending the P1-PIO messages.

• After installing the plugin, go to the plugin Settings, and enter your credentials for accessing the OASwitchboard API.

  • You may need different credentials for the sandbox API.

• Before publishing the article, the status of the submission is displayed so that the message is sent successfully or not, you can ignore them or edit the article to meet the requirements of the plugin.

• In the moment of the publication of an article, a P1-PIO type Message will be sent to OASwitchboard via API, if all publication requirements are met.

  • Upon success, you should see a green notification on the top-right corner of the screen.

Demonstration video

This is a demonstration video to guide you through the installation and basic usage of the plugin.

What metadata fields are included in the message?

The metadata retrieved from OJS and sent to OA Switchboard is listed below in the collapsible element.

Click here to see the list

• About the Publication:
  • Title
  • Type
  • DOI
  • Submission ID
  • Submission date
  • Acceptance date
  • Publication date
  • Manuscript ID
  • VoR (Version of Record)
    • Type of journal publication
    • License
• About each Author:
  • Given name
  • Family name
  • ORCID
  • Email
  • Position in listing order
  • Is corresponding author
  • Affiliated institution
    • Name
    • ROR ID
• About each Funder: (if available with Funding plugin)
  • Name
  • Identifier
• About the Journal:
  • Title
  • ID (can be ISSN or eISSN)
  • ISSN
  • eISSN
• Timing in the workflow that the message is sent.

Credits

This plugin was developed open source to OA Switchboard by Lepidus Tecnologia with Openjournals.nl as testing partner. The development has been made possible by funding from the Max Planck Digital Library (MPDL).

Developed by Lepidus Tecnologia.

License

This plugin is licensed under the GNU General Public License v3.0.

Copyright (c) 2024 Lepidus Tecnologia.
Copyright (c) 2024 Stichting OA Switchboard