README

Introduction

Drupal 10/11 Module required by Islandora Workbench. Enables the following Views:

• Term from URI
• Term from term name

Also enables the following REST resources:

• Field
• Field Storage
• Entity Form Display
• User
• URL alias
• File upload
• Media type
• Content type
• Taxonomy Vocabulary

Also provides endpoints for exposing:

• Drupal core's version number
• this module's version number
• a given file's checksum

Usage

There is no user interface to this module. It only installs configuration that is required by Islandora Workbench.

Requirements

• Islandora Modern

Installation

You can install this module using Composer. Within your Drupal root directory, run the following:

1. composer require mjordan/islandora_workbench_integration "dev-main"
2. Enable the module either under the "Admin > Extend" menu or by running drush en -y islandora_workbench_integration.

If you're deploying Islandora via ISLE, install and enable this module using these two commands from within your isle-dc directory:

1. docker-compose exec -T drupal with-contenv bash -lc "composer require mjordan/islandora_workbench_integration"
2. docker-compose exec -T drupal with-contenv bash -lc "drush en -y islandora_workbench_integration"

Configuration

By default, all vocabularies are registered in the views. To prevent vocabularies from being updated by Workbench, remove them from the "Terms in vocabulary" View using its "Taxonomy term: Vocabulary" filter.

Updates

Since this module enables a number of REST endpoints, you may need to reimport the configuration if a new endpoint is added. For example, after pulling in updates from Github, you should run the following drush commands from within the /var/www/html/drupal/web directory:

1. drush cim -y --partial --source=modules/contrib/islandora_workbench_integration/config/optional
2. drush cr

Or, if you are using ISLE:

1. docker-compose exec -T drupal with-contenv bash -lc "drush cim -y --partial --source=modules/contrib/islandora_workbench_integration/config/optional"
2. docker-compose exec -T drupal with-contenv bash -lc "drush cr"

Note that as of the 1.0.0 release, the "Terms in vocabulary" View is no longer used by Workbench. Unless you are using this View for some other purpose, as of version 1.0.0 you can disable/delete it from your Drupal.

Permissions

All REST endpoints added or endabled by this module require the use of Basic Authentication. The username/password combination used in your Islandora Workbench configuration files should be a member of the "Administrator" role.

Running tests locally

A docker-compose.yml file is defined in ./tests that can automatically lint and run phpunit tests for this module. These are how tests are ran in GitHub Actions.

cd tests
export MODULE_DIRECTORY=$(pwd | xargs dirname)
export ENABLE_MODULES=islandora_workbench_integration
export DRUPAL_VERSION=10.4
export PHP_VERSION=8.3
docker compose up --quiet-pull --abort-on-container-exit

Current maintainer

• Mark Jordan

License

GPLv2