Before setup and checking OAI on OJS, we must know first, what is the use of OAI.
What is OAI? #
The Open Archives Initiative (OAI) is a formal organization, in the circle around colleagues Herbert Van de Sompel, Carl Lagoze, Michael L. Nelson and Simeon Warner, to develop and apply technical interoperability standards for archives to share catalog information (metadata).
Citation from openarchives.org:
The Open Archives Initiative develops and promotes interoperability standards that aim to facilitate the efficient dissemination of content. OAI has its roots in the open access and institutional repository movements. Continued support of this work remains a cornerstone of the Open Archives program. Over time, however, the work of OAI has expanded to promote broad access to digital resources for eScholarship, eLearning, and eScience.https://www.openarchives.org/
Long story short, OAI is involved in developing technology frameworks and interoperability standards to improve access to e-print archives and OAI created a protocol called OAI-PMH.
OAI-PMH is a data exchange protocol that basically allows any metadata / content provided by the application in order to communicate with each other.
PKP (OJS software developer) has implemented this protocol where to access it, at the end of the journal url add: /oai/
What is the relationship between OAI-PMH and OJS? #
OJS uses the OAI-PMH protocol to easily provide article metadata which resource providers can use, such as journal articles, preprints, books, etc.
e.g. : OneSearch ID, BASE, Google Scholar, WorldCat.
What are the benefits of using this OAI-PMH method for OJS? #
- Can connect indexing engines, like : BASE and other indexing search engines.
- Support increased volume access to journal traffic and reach more users.
- Easy to be indexed to well-known search engines, like: Google, Bing, and ect.
And now, you are starting to understand a little about the OAI-PMH protocol, its uses, benefits and advantages. Now we are going to setup and check OAI in our OJS journal.
Checking OAI OJS in the Journal #
To open the OAI page in OJS, you can type like the example below:
For example is like this:
/ojs3/demo/, is the folder where the OJS file is stored / Subfolder.
And later a page like this will come out.
Then to check whether our OJS site passes OAI-PMH, you can check it on this website:
- https://validator.oaipmh.com/ (Good User interface)
- http://oai.clarin-pl.eu/ (More complete features, User interface : Ok)
But if you want a recommendation, I recommend using oai.clarin-pl.eu for a more complete OAI validation.
Request type #
There are six different types of requests:
- Identify*, function description of an archive.
- ListMetadataFormats*, retrieve the available metadata formats from the archive.
- ListSets*, retrieve the repository set structure.
- ListIdentifiers, stands for ListRecords, takes only headers.
- ListRecords, harvest records from the repository.
- GetRecord, retrieve individual metadata records from the repository.
Actually If Identify*, ListMetadataFormats*, ListSets* request passed. You can register your journal to indexing providers. The rest if other requests fail it’s okay. (depending on the indexing provider rules)
My journal passed OAI checking. What’s next? #
If valid, you can register the journal and go to the Official OAI website.
But before that, you must read and agree to the OAI Terms of service.
Select “Register this site” to register your journal and it will be registered later (or you can validate it first if you want to check).
And there you have it, you have successfully registered and will be indexed to several OAI services!
For a list of indexing providers that will display your journal articles, please see here.
But you may ask, “Why are there so few OAI service providers?“
Well, for OAI service providers, only well-known indexers like BASE register their services with OAI. However, other OAI service providers, you must register them directly through their website. Such as OneSearch ID, Neliti, WorldCat services.
Trouble shooting OAI-PMH #
- Enable OAI on config.inc.php :
oai = On
- Repository wrong name on config.inc.php :
repository_id = ojs2.urdomain.com // example ojs2.google.com or ojs2.translate.google.com
- Respons slow :
set oai_max_records to = 20; // default 100
- Enable OAI on OJS :
In Settings > Distribution > Access: Enable OAI set to Enable.
So, in a nutshell. This OAI is an organization that created the OAI-PMH protocol where the protocol will harvest all article metadata in a journal, so that the metadata can be managed for the purposes of providing article resources, journal (Indexing).
Examples of indexing providers: OneSearch ID, BASE, WorldCat, Google Scholar, Crossref, DOAJ, etc.
This will have a good impact on our Journal site because it will be indexed quickly, in other words our journal will be famous and the articles published can be accessed widely and easily by people.
People who find your journal articles is using the indexing search engine where you registered your OAI journal on there.