View on GitHub

equella.github.io

Home

Harvester Profile Configuration Guide

Harvesting guide

Content from third-party sources can be obtained by using EQUELLA’s harvesting tool that is used to collect learning objects and resources from third-party institutions and upload them automatically to the EQUELLA repository. Content can be obtained from The Learning Federation using the LORAX protocol, while content from other institutions can be gathered with the OAI (Open Archives Initiative) metadata harvesting protocol.

Content contained in the EQUELLA Digital Repository can also be accessed by using the OAI protocol.

The purpose of this guide is to provide system administrators with an understanding of the EQUELLA Harvester Profile tool to enable successful management of harvesting.

Please note that this guide has been developed to best reflect the full capabilities of EQUELLA and as such may differ in appearance to your own installation.

Harvester Profile tool

The EQUELLA harvester allows content from third-party sources to be collected and uploaded to the EQUELLA Digital Repository. Content can be obtained from The Le@rning Federation (TLF) using the Learning Object Repository Access and eXchange (LORAX) protocol, while metadata can be gathered with the Open Archives Initiative (OAI) metadata harvesting protocol. Content from other EQUELLA Digital Repositories can also be collected.

The Harvester Profile:

Configure a harvester profile

Harvester profiles are created and modified using the Harvester Profiles tool available in the Administration Console.

To access EQUELLA and open the Administration Console
  1. Open a browser and enter your EQUELLA URL (e.g.‘http://equella.myequellainstitution.edu’).
  2. Log in to EQUELLA as an administrator user to display the EQUELLA dashboard.
  3. Click the Settings button to display the Settings page, then select Administration console from the categories list.
  4. Select the Harvester Profiles option to display the Harvester Profiles pane that contains a list of all previously configured profiles.

Administration Console elements

When a tool has been selected the Add, Edit, Remove, Clone, Import and Export buttons are enabled.

Add

Click Add to display the Harvester Profiles Editor and create a new profile.

Edit

Select a profile then click Edit (or double-click on a profile) to display the Harvester Profiles Editor and modify the selected profile.

If the selected profile is being edited by another user a Locked dialog is displayed, providing the following options:

Remove

Click the Remove button to delete the selected profile.

Clone

Click the Clone button to copy an existing profile. The cloned profile can then be modified by selecting the Edit button.

Import

Click the Import button to import a harvester profile that has previously been exported from the Administration Console. A warning dialog is displayed.

Note: Only ZIP files that have been exported from the Administration Console should be imported—other ZIP files may adversely affect the stability of the system.

Export

Click the Export button to export a profile as a ZIP file.

Harvester types

Each Harvester profile type provides options for harvesting resources or metadata from different repository types:

Add a harvester profile

To add a profile

  1. Click Add on the Administration Console to display a Harvester Types dialog listing the available harvester types.
  2. Select a harvester type from the list.
  3. Click OK to display the Harvester Profile Editor.

The Harvester Profile Editor provides an interface for harvester creation with the following tabs:

Each tab is described in the following sections.

Details tab

The Details page displays the harvester’s general details such as name, enabled status, collection to harvest to and import transformation. These elements are common to all harvester profile types.

Each type of harvester has other various configurable requirements. The Harvester Profile Editor—Details page contains configurable elements specific to the selected harvester type as well as the common elements.

The common Details page elements are:

The harvester type specific elements are described in the following sections:

EQUELLA Harvester

The EQUELLA type allows harvesting of resources and attachments from other EQUELLA repositories. The configurable EQUELLA Settings include:

LORAX Harvester

The LORAX protocol is used to harvest TLF content.

The configurable LORAX Settings are:

MEX Harvester

MEX is an Australian protocol used to harvest free content provided under the National Digital Learning Resource Network (NDLRN).

The configurable MEX Settings are:

OAI Harvester

OAI is a protocol that is used to harvest metadata from third-party sources.

The configurable OAI Settings are:

SHEX Harvester

SHEX is an Australian protocol used to harvest free content provided under the National Digital Learning Resource Network (NDLRN).

The configurable SHEX Settings are:

Actions tab

The Actions page provides a flexible method for scheduling and running the harvest.

The Actions page elements include:

Access Control tab

The Access Control page allows a harvester profile to be restricted to a set of users, groups or roles.

On this page, two privileges can be configured:

Other privileges relevant to Harvester Profiles, which are configured in the Security Manager, not from this page, are:

Typically these privileges are granted to Administrators, but anyone who performs a harvest will need DOWNLOAD_ITEM granted to them for the given collection.

To configure a privilege

  1. Select the Access Control tab to display the Access Control page.
  2. Click the Who can? drop-down arrow to reveal the list of available privileges.
  3. Select the delete this harvester profile privilege.
  4. Select the Advanced option to display the access control list.
  5. Click Add.
  6. In the Action field, select either Grant or Revoke by clicking on the current setting and selecting the appropriate option from the drop-down menu.
  7. In the Who? field, click Everyone to display the Select Recipients… dialog.
  8. Select the Roles option.
  9. Click Search to display a list of all available roles. Alternatively, type the first letter or letters of search resource and click Search.
  10. Select System Administrator then select the > button to move the role to the right-hand pane.
  11. Remove Everyone from the right-hand pane by selecting it then clicking the < button.
  12. Click Save to close the dialog. The delete privilege has now been granted to users in the system administrator role.
  13. Click Save to save the harvester profile.

Further privileges and users can be configured using the above procedure.

To save a profile

When all elements have been configured for a profile:

  1. Click Save to save the harvester profile details.
  2. Click Close to close the Harvester Profile Editor.

Harvester profiles scheduled task

Harvesters run with other EQUELLA schedules tasks. Scheduled tasks are configured from the Settings page.

To configure Scheduled tasks

  1. Select Settings from the navigation menu, then click the Scheduled tasks link. The Scheduled tasks page displays.
  2. Harvester profiles are run daily. Select the required time from the Run daily tasks at drop-down, then click Save.

All enabled profiles are included when the scheduled task is run.

Harvester system settings

A Harvester setting is available from the Settings page, and allows harvesters sourcing content from the current institution to harvest content without accepting any DRM licenses.

To configure the Harvester option

  1. Select Harvester from the Settings page.
  2. Select the Harvester link from the Settings page. The Harvester page displays.
  3. Select the Configure harvesters to skip DRM acceptances when harvesting items checkbox.
  4. Click Save.