Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mjordan/islandora_log_ingest

Utility module that logs identifier information on objects as they are ingested into an Islandora repository.
https://github.com/mjordan/islandora_log_ingest

Last synced: 29 days ago
JSON representation

Utility module that logs identifier information on objects as they are ingested into an Islandora repository.

Awesome Lists containing this project

README

        

# Islandora Log Ingest

## Overview

This utility module logs identifier information on objects as they are ingested into an Islandora repository. It writes a tab-(or other delimiter)-separated log file that contains the following columns:

```
[prefix] identifiers PID
```

* Prefix is an optional string that is configured using the module's admin settings form. This string can be used to identify a batch load, for example.
* Identifiers is a sting containing all of the values of the dc:identifier elemements in an object's DC datastream. If the DC datastream contains more than one dc:identifier element, the values from all dc:identifier elements are concatenated using a delimiter defined in the admin settings. If dc:identifier is empty, an empty string will be written to the log.
* PID is the PID of the object being ingested.

Its purpose it to provide a simple way of relating PIDs to identifiers defined in incoming objects' metadata datastreams. This log can then be used in custom Tuque scripts or other contexts. A sample log file where the prefix is 'foo' and the entry delimiter is '|' is:

```
foo|local: mylib01020304|islandora:160
foo|local: mylib01020308|islandora:161
foo||islandora:162
foo|local: mylib01020322|islandora:163
foo|local: mylib01020324|islandora:164
foo|local: mylib01020325|islandora:165
foo|local: mylib01020330|islandora:166
```
Note that the idenfifier is missing in the third entry because the ingested object's dc:identifier element was blank. The 'local:' string is part of the identifer as produced by Islandora (in this case, by the default MODS form that comes with the Basic Image Solution Pack).

## Configuration

To add your own log entry prefix, define your delimiters, or change the default log file location from [Drupal install directory]/sites/default/files/islandora_log_ingest.txt, visit admin/islandora/tools/log_ingest.

## Usage

Install and enable (and configure) the module. All objects ingested after the module is endabled will be logged.

## Maintainer

* [Mark Jordan](https://github.com/mjordan)

## Feature requests

This module was written as part of a large migration to Islandora from another repository platform. It wasn't intended to be extensible or terribly flexible. So feel free to fork the Github repo and modify it to suit your needs. That said, if enough people +1 a featue identified in the issue queue or on the Islandora email lists, we can look at how we can develop the module further.