Assuming that OJS has been correctly installed, and a journal has already been created, the Journal Manager must at the minimum go through the journal’s 5-step setup process. Detailed instructions and screenshots are here: The Journal Manager will be asked to configure most aspects of the system during the five steps, including the use of DOIs; OAI harvesting; access rights; and so on. In order to prepare a journal for integration into the Synergies platform, the Journal Manager should pay close attention to the following:

Journal Setup Step 1

At a minimum, the following must be properly supplied:

  • Journal title

  • Initials

  • Principal Contact

  • Technical Support Contact

  • Publisher, as the Synergies portal displays whatever is added in that field.

Journal Setup Step 2

LOCKSS functionality is enabled in Journal Setup Step 2.6.  Our LOCKSS network is still under development, and thus it is not possible to join at this moment; but when available this is where it will be configured.

Journal Setup Step 3

Setup Step 3.4 (For Authors to Index Their Work):

This step allows Journal Managers to enable author-submittable metadata fields. Any fields enabled here will appear for the Author to optionally fill out during submission of their article. (Of course, anything Authors add to enabled fields during submission should be checked by the Editor during the Review and/or Editing process!) Any metadata published with the final submission will be harvested by the Synergies platform and will be used in the search and indexing process.

It is especially important to include the Keywords field at a minimum.

Setup Step 3.5 (Register Journal for Indexing)

This step includes information on how to register the journal with various OAI-PMH harvesters. This step also lists the journal's OAI base URL, which is needed for Synergies harvesting.

Setup Step 3.7 (Citation Markup Assistant)

While not mandatory, you are strongly encouraged to enable and use this assistant, as it helps provide citation information for articles in NLM XML format, and will be important for future citation components within the Synergies platform.

Journal Setup Step 4

Setup 4.2: Publication scheduling

The Journal manager should check off Volume and Issue numbering, even if the journal is not going to be publishing by volume and issue.  The Synergies portal may have problem displaying journals otherwise.  This change will be transparent to the Editors of the journal, who will be able to publish in whatever schedule they normally use.

Further Configuration

The Journal Manager must also configure other parts of the journal for proper integration, depending on various options as used by the journal.

Indexing PDFs

If the journal is publishing PDF galleys, the Journal Manager (or more likely, a system or server administrator) must ensure that the PDF indexing tools are configured properly in the application’s configuration file so that the PDF full-text is included in the document harvesting. (This is in the [search] section of the file.) The pdftotext tool installed on the server (this is often standard for *NIX systems, and is available for Windows as a free download). The section should contain something similar to:

index[application/pdf] = "/usr/bin/pdftotext -enc UTF-8 -nopgbrk %s -"

If this isn't properly configured, the journal’s NLM data will not include the article full-text from PDF files.

Subscription-based journals

If the journal includes subscription-based content, there must be an IP-based subscription in place for the University of Montreal (they will provide IP addresses). If the journal is open access, this step can be ignored. Please contact the head node should you need to obtain IP addresses.

Subscription access is enabled in Journal Setup Step 4. If enabled, a new "Subscriptions" link will be found in the Journal Manager's User Home page, from where subscriptions can be added. More information on subscription management can be found here:

Configuring Journal Sections

The journal’s Journal Sections must be configured so that they correspond to established NLM article types. They can be configured by clicking the "Journal Sections" link on the Journal Manager’s User Home page. Click the "Edit" link for each section and find the field with labelled: "Identify items published in this section as a(n)..." For EACH SECTION, make sure that the values in that field are EXACTLY one of the values listed at <> (e.g. "addendum", "book-review", etc, not including the quotes).

Adding NLM Support (OJS 2.2.x only)

If you are running OJS 2.2.3 or 2.2.4, you must also make a few code changes to add NLM export support to the system. (If you are running OJS 2.3+, this functionality already exists in the system.) Download the newest version of the patch file from < > and save it on your server in the OJS installation directory. Apply it using the GNU Patch tool -- this should be available on any *NIX platform, and is available as a free download for Windows machines. Test applying it by running the following on your command line, from the OJS installation directory:

patch -p0 --dry-run < patch-filename-here

...where patch-filename-here is the filename of the patch file you downloaded. If you don't receive any error messages, that means that the patch is ready to apply. You can actually apply it (the above command just tests) by running the above command again, this time without the --dry-run option.

Note for Windows servers: The patch tool sometimes complains about files that have UNIX-style line endings (usually an "Assertion failed" message). To work around this, convert the line endings to Windows ones. You can do this by opening the patch file with Wordpad and saving it again.

Once the patch is applied, save the file somewhere handy. If you need to update to a new version of the patch, you'll have to first reverse this patch (by using the above instructions, this time with the -R option to the patch tool), then apply the new one as before.

Test that it's working: try looking at an OAI response from your server. To do this, find the OAI Base URL for your server. Log in a Site Administrator and go into "Site Settings". The OAI Base URL is available at the bottom of the page, i.e. <> for the Postcolonial Text journal.

Add the OAI "verb" and "metadataPrefix" parameters to the end of the URL to get:


If the patch has not been properly applied, your system will display a message complaining that it does not know what NLM is. If the patch is correctly installed, you should see XML output.

Syndicate content
© 2011 Synergies Canada. All rights reserved