Toolchain: CONTENTdm single file objects

Overview

This toolchain allows the creation of Islandora import packages consisting of CONTENTdm objects that contain a single file, such as images, PDFs, movies, etc. The resulting Islandora import packages can then be ingested into Islandora using the Islandora Batch module.

You have the option of using as your Islandora objects' OBJ datastream files either files from the local filesystem or files from CONTENTdm.

Preparing the content files

If you are retrieving the OBJ file from CONTENTdm, you do not need to prepare any files on your local filesystem.

If you do want to use OBJ files from your local filesystem, in a single flat directory, like this:

├── MSC109-0360.tif
├── MSC109-0361.tif
├── MSC109-0362.tif
├── MSC109-0363.tif
├── MSC109-0367.tif
├── MSC109-0368.tif
├── MSC109-0371.tif
├── MSC109-0372.tif
├── MSC109-0381.tif
└── MSC109-0384.tif

Each file in this directory must have a name that corresponds to the value in a specific field in the CONTENTdm metadata, as described in the entry for the CdmSingleFile filegetter manipulator.

Preparing the configuration file

All MIK configuration files are standard INI files which contain the following sections: [SYSTEM], [CONFIG], [FETCHER], [METADATA_PARSER], [FILE_GETTER], [WRITER], [MANIPULATORS], and [LOGGING]. Entries are required unless indicated otherwise below.

Commented lines begin with a semicolon. Values that contain whitespace or special characters (equals, semicolon, etc.) should be wrapped in double quotation marks. If in doubt, use the quotation marks. The order of the sections and the entries within each section do not matter.

The SYSTEM section

This section of the configuration file sets or overrides configuration settings for PHP and the various third-party PHP components used by MIK. It can contain the following entries:

• date_default_timezone: Optional. Provide a default timezone if date.timezone is null in the the PHP INI. You will know if you need to use this setting because Monolog will throw MIK exceptions and halt MIK. Set to one of the valid PHP timezone values listed at http://php.net/manual/en/timezones.php.
• verify_ca: Optional. OSX's default PHP configuration use Apple's Secure Transport rather than OpenSSL, causing issues with Certificate Authority verification in Guzzle requests against websites that use HTTPS. This setting allows Guzzle to override CA verification. You will know if you need to use this setting because Guzzle will write entries in your mik.log complaining about CA verification. Set to false to ignore CA verification.

Note: if you set verify_ca to false, you are bypassing HTTPS encryption between MIK and the remote website. Use at your own risk.

Example

[SYSTEM]
date_default_timezone = 'America/Vancouver'
verify_ca = false

The CONFIG section

Key-value pairs of configuration entries in this section are simply written to the top of the log file specified in the [LOGGING] section's path_to_log setting. You can add whatever values you want, but they are static (that is, they can't be dynamically derived at runtime). Therefore, all entries in this section are optional.

Example

[CONFIG]
config_id = vanpunk_test
last_updated_on = "2016-02-01"
last_update_by = "Mark Jordan"

The FETCHER section

This section of the configuration file contains the following entries:

• class: Required. Must be 'Cdm'.
• alias: Required. The CONTENTdm alias (collection string) for the source collection, without the leading /.
• temp_directory: Required. Full path to the directory where the fetchers write data for use later in the toolchain.
• ws_url: Required. The full URL to your CONTENTdm server's web services API endpoint.
• use_cache: Optional; set to false in automated tests (in other words, you will not need to use this unless you are writing automated tests for this fetcher).
• record_key: Required. Must be 'pointer'.

Example

[FETCHER]
class = Cdm
; The alias of the CONTENTdm collection.
alias = vanpunk
ws_url = "http://content.lib.sfu.ca:81/dmwebservices/index.php?q="
temp_directory = "/tmp/vanpunk_temp"
; 'record_key' should always be 'pointer' for CONTENTdm fetchers.
record_key = pointer

The METADATA_PARSER section

This section of the CONTENTdm Newspapers toolchain's configuration file contains the following entries:

• class: Required. Must be 'mods\CdmToMods' or 'templated\Templated'. Use the former if simple source field-to-MODS-element mappings are sufficient for your needs, the latter if your source metadata requires complex logic to be converted to MODS.
• alias: Required. The CONTENTdm alias (collection string) for the source collection, without the leading /.
• ws_url: Required. full URL to your CONTENTdm server's web services API endpoint.
• mapping_csv_path: The path, either full or relative to the mik script, where the metadata mapppings file is located.
• include_migrated_from_uri: Required. If set, adds an <identifier> element to the object's MODS XML that indicates the source object's reference URL in CONTENTdm. For example: <identifier type="uri" invalid="yes" displayLabel="Migrated From">http://content.lib.sfu.ca/cdm/ref/collection/CT_1930-34/id/17583</identifier>.
  • To set: Use your CONTENTdm instance's base URL for browsing objects. In the above example, you would enter include_migrated_from_uri = 'http://content.lib.sfu.ca/cdm/ref/collection/'.
  • To skip creating this element, leave the value empty: include_migrated_from_uri =.
• repeatable_wrapper_elements: Optional. By default MIK reduces repeated top-level wrapper MODS elements (same element name with the same attributes) down to a single instance of the element. This setting lets you indicate which elements you want to be repeated (i.e, have multiple of) in your MODS. The most common use for this setting is to allow repeated <extension> elements.

Example

[METADATA_PARSER]
class = mods\CdmToMods
alias = vanpunk
ws_url = "http://content.lib.sfu.ca:81/dmwebservices/index.php?q="
; Path to the csv file that contains the CONTENTdm to MODS mappings.
mapping_csv_path = 'vanpunk.csv'
; Include the migrated from uri into your generated metadata (e.g., MODS)
include_migrated_from_uri = TRUE

The FILE_GETTER section

This section of the CONTENTdm Newspapers toolchain's configuration file contains the following entries:

• class: Required. Must be 'CdmSingleFile'.
• input_directories: Optional. A multivalued list of full paths to the directories where the content files are located. The files should be named as described in the "Preparing the content files" section above. Note that the more specific the paths in this option, the faster MIK will be; using multiple specific paths instead of a single high-level directory path here is recommended.
  • Comment out or remove input_directories if you want this toolchain to retrieve the OBJ datastream file from CONTENTdm. (Leaving the input_directories line in with a blank value will generate errors.)
• temp_directory: Required. Full path to the directory where the file getter will write data for use later in the toolchain. Can be the same as the temp_directory value used in the [FETCHER] section.
• ws_url: Required. The full URL to your CONTENTdm server's web services API endpoint.
• utils_url: Required. The full URL to your CONTENTdm server's web "utilities" directory. More information is available in the API entries listed under the "CONTENTdm Website API Reference — utils" section of the CONTENTdm API documentation.

Example

[FILE_GETTER]
class = CdmSingleFile
alias = vanpunk
ws_url = "http://content.lib.sfu.ca:81/dmwebservices/index.php?q="
utils_url = "http://content.lib.sfu.ca/utils/"
temp_directory = "/tmp/vanpunk_temp"
input_directories[] = "/home/mark/Downloads/punk_poster_tiffs"
; Use an empty value for 'input_directories' option if you are retrieving your OBJ files from CONTENTdm.
; input_directories =
; Or, comment out or remove the input_directories line.

Note that if you are migrating objects from CONTENTdm that use "master" files stored on a local filesystem that you want to use as the Islandora objects' OBJ datastreams, you must enable and configure the CdmSingleFile filegetter manipulator. If you are not using files on a local filesystem, you do not need to use this manipulator. [todo: add explanation of how to configure not using the manipulator.]

The WRITER section

This section of the CONTENTdm Newspapers toolchain's configuration file contains the following entries:

• class: Required. Must be 'CdmSingleFile'.
• output_directory: Required. The full path to the directory where output packages are written.
• postwritehooks: Optional. A multivalued list of post-write hook scripts. Values have two parts, the full path to the PHP, Python, or shell executable, and the full path to the script itself.
• datastreams: Optional. Valid values are 'MODS', 'OBJ', or both. If defined, only the indicated datastream files will be generated. If not defined, MIK will create both the MODS XML file and the OBJ file. Most useful for testing metadata generation, for example datastreams[] = "MODS", which would tell MIK to generate only a MODS XML file for each object.

Example

[WRITER]
class = CdmSingleFile
alias = vanpunk
ws_url = "http://content.lib.sfu.ca:81/dmwebservices/index.php?q="
output_directory = "/tmp/vanpunk_output"
; Leave blank for Cdm single file objects (the MIK writer assigns the filename).
metadata_filename =
postwritehooks[] = "/usr/bin/php extras/scripts/postwritehooks/validate_mods.php"
; datastreams[] = MODS

The MANIPULATORS section

This section of the CSV toolchain's configuration file defines which manipulators should be used. Multiple manipulators can be defined for each type (fetchermanipulators, filegettermanipulators, metadatamanipulators) as illustrated below. The value of each entry is the manipulator class name plus any pip-separated parameters that the manipulator may require. Entries in this section are optional.

Example

[MANIPULATORS]
metadatamanipulators[] = "FilterModsTopic|subject"
; fetchermanipulators[] = "CdmSingleFileByExtension|jp2"
; fetchermanipulators[] = "RandomSet|50"
; fetchermanipulators[] = "CdmNoParent"
; You must use the CdmSingleFile filegetter manipulator if you want your OBJ
; datastream files to come from the local filesystem and not from CONTENTdm.
filegettermanipulators[] = "CdmSingleFile|identi|tif,tiff"

Manipulators that you may find useful with this toolchain include:

• CdmSingleFile filegetter manipulator
• CdmByDmDate
• AddContentdmData
• FilterModsTopic

The LOGGING section

This section of the CSV toolchain's configuration file contains the following entries:

• path_to_log: Required. The full path to the standard log generated by MIK.
• path_to_manipulator_log: Required. The full path to the log that the manipulators write status and error messages to.

Example

[LOGGING]
; Full path to log file for general mik log file.
path_to_log = "/tmp/vanpunk_output/mik.log"
; Full path to log file for manipulators.
path_to_manipulator_log = "/tmp/vanpunk_output/manipulator.log"