discoverygarden/islandora_spreadsheet_ingest

v3.5.0 2023-11-01 17:23 UTC

This package is auto-updated.

Last update: 2024-04-30 00:46:16 UTC


README

Introduction

A module to facilitate the ingest of data using a spreadsheet. It makes csv migrations re-usable by allowing the upload of migrations to be used as templates to be associated with source CSVs. It is based on Drupal's migrate framework and is compatible with its tooling.

Requirements

This module requires the following modules/libraries:

Usage

Template migrations can be implemented in either modules or config. An example migration is implemented in the islandora_spreadsheet_ingest submodule.

To make use of templates to ingest, you can go to your site's admin/content/islandora_spreadsheet_ingest endpoint and hitting the "Add request" endpoint, and:

  1. Naming your request.
  2. Uploading your CSV/Spreadsheet file
  3. Entering the name of the worksheet (if applicable)
  4. Selecting the template to use; and,
  5. Submitting the form.

The ingest proper can be kicked off in various ways from the given request's "Process" task page. Most users should submit as "Deferred", which submits the request to be processed in by a daemon process. "Immediate" runs as a batch directly in the browser. "Manual" is intended more for developer use (or those with CLI access), to run the requests by other means (it is not necessary to explicitly submit the request for processing in "Manual" mode; it is the default state when a request is added to the system).

Building migration templates

Templates are expected to be built by developers, as they can get rather complex when taking advantage of the many customizations made available throughout the Drupal Migrate infrastructure.

Useful Resources

Installation

Install as usual, see this for further information. Configure allowed binary paths at /admin/config/islandora_spreadsheet_ingest.

Troubleshooting/Issues

Having problems or solved a problem? Contact discoverygarden.

Maintainers/Sponsors

Current maintainers:

Development

An example migration and cmd that can help with development is provided. If you would like to contribute to this module create an issue, pull request and or contact discoverygarden.

License

GPLv3