islandora-rdm / islandora_riprap
RipRap reports in Drupal.
Installs: 17
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 6
Type:drupal-module
Requires
This package is auto-updated.
Last update: 2024-12-13 04:07:59 UTC
README
Introduction
A Drupal 8 module to provide node-level reports using data from the Riprap fixity microservice.
Overview
Currently under development. So far, adds a "Fixity auditing" field to the "Media" tab (which is actually the output of the "Manage Media" view provided by the Islandora module) showing Fedora URLs for Media associated with the node. Each URL is color coded to indicate whether or not any fixit events have failed, with a link to a full report of the events.
Requirements
Installation
- Clone this repo into your Islandora's
drupal/web/modules/contrib
directory. - Enable the module either under the "Admin > Extend" menu or by running
drush en -y islandora_riprap
.
Configuration
Note: If you are running Islandora in a CLAW Playbook Vagrant machine and Riprap on the Vagrant host machine, start the Riprap web server by running
php bin/console server:start *:8001
in the Riprap directory. Then in Drupal, make sure your "Riprap microservice REST endpoint" setting says "http://10.0.2.2:8001/api/fixity".
- Go to Drupal's "Configuration" menu.
- In the "Islandora" section, click on the "Fixity auditing" link.
- Adjust your config options.
- Add the "Fixity Auditing" field to the "Manage Media" View (like you would add any other field to a view):
- In your list of Views ("Admin > Structure > Views"), click on the "Edit" button for the "Manage Media" View.
- In the "Page" display, click on the "Add" Fields button.
- From the list of fields, check "Fixity Auditing".
- Click on "Apply (this display)".
- Change the label if you want.
- Click on "Apply (this display)".
- Optionally, you can locate the new "Fixity Auditing" field to any position you want in the Media table.
- Click on the "Save" button to save the change to the View.
Now, when you click on the "Media" tab in an Islandora object node, you will see a new column in the table showing the Fedora URL for the media file:
The cell is green to indicate that all fixity events for the media file were successful. The "Details" link leads to a full report of the events.
If Riprap is not found or is not running at its configured endpoint URL, each cell will contain an error message to that effect: