Skip to main content

Unpaywall

Unpaywall is an integratable service that assists Komodo Publications Planning users in locating scholarly, published manuscripts that are hosted in online university and government repositories. This service helps collaborators expand the scope of their research in an easy-to-use interface.

The steps required to integrate the Unpaywall package with the Komodo Publications Planning product are as follows:

  1. Install the Unpaywall package via the Komodo Install Service.

  2. Configure the Unpaywall package.

  3. Create and assign the appropriate Unpaywall permissions.

Configure the Unpaywall package

Because the Unpaywall package does not require the linking of an API, or user licensing and authentication, configuration requirements are minimal.

To configure the Unpaywall package:

  1. Ensure the Unpaywall Setting (PP_Unpaywall_Settings__mdt) custom metadata type contains the Unpaywall API Base URL (https://api.unpaywall.org) in the Unpaywall Setting record (PP_Default).

  2. Configure page layout assignments.

  3. Schedule batch jobs.

Unpaywall Setting custom metadata type

The package utilizes the Unpaywall Setting (mvn__PP_Unpaywall_Settings__mdt) custom metadata type. The only configuration required for this custom metadata type is to ensure the base URL appears in the default Unpaywall API Base URL custom field.

To review the Unpaywall Setting custom metadata type default setting:

  1. In the Quick Find search box in Setup, search for and select Custom Metadata Types.

  2. Click Unpaywall Setting.

  3. Click Manage Unpaywall Settings.

  4. In the Default record row, click Edit.

  5. Confirm that the Unpaywall API Base URL field is populated with the correct URL.

Configuring page layouts

To ensure that information derived from the Unpaywall package displays properly, configurations need to be made to the Unpaywall Setting Layout.

To configure Unpaywall Setting Layout assignments:

  1. In the Quick Find search box in Setup, search for and select Custom Metadata Types.

  2. Click Unpaywall Setting.

  3. Scroll to the bottom of the page and click Page Layout Assignment under the Page Layouts section.

  4. Click the name of the profile you want to add to the Unpaywall Setting Layout.

  5. From the dropdown, select Unpaywall Setting Layout.

  6. Click Save.

Scheduling batch jobs

Each batch job is contained within its own Apex class and needs to be scheduled for execution. To do so, use the Developer Console to execute the following anonymous Apex strings:

//System.schedule('Daily Unpaywall Integration','0 0 5 ** ? *',new mvn.PP_UnpaywallSchedulable(10));
mvn.PP_UnpaywallSchedulable unpaywallSchedulable = new mvn.PP_UnpaywallSchedulable(10);
unpaywallScehduleable.execute(null);

Assign Unpaywall permissions

To configure and view Unpaywall data, you must be assigned either the PP_UP_Admin or PP_UP_Read_Only permission set.

Table 122. Unpaywall permission sets

Permission set

API name

Custom permissions

Description

PP_UP_Admin

PP_UP_Admin

  • None

Users with this permission set have admin access to Unpaywall article attributes / configuration.

PP_UP_Read_Only

PP_UP_Read_Only

  • None

Users with this permission set have read access to Unpaywall article attributes / configuration.



Custom objects

The Unpaywall package utilizes the following objects with custom Unpaywall fields: