Toolchain: CONTENTdm Generic Compound

Overview

This toolchain allows the creation of Islandora import packages consisting of compound objects retrieved from CONTENTdm. The resulting Islandora import packages can then be ingested into Islandora using the Islandora Compound Batch module.

This toolchain generates the parent object's MODS.xml file and all child objects of a parent. For each child object, the toolchain creates a subdirectory containing the file associated with the CONTENTdm child object and saves it as OBJ.ext (where '.ext' is the extension assigned to the file by CONTENTdm) and the child's metadata as a MODS.xml file.

Some things to note about this toolchain:

• This toolchain only creates flat compound objects, that is, compound objects that have one level of children. If CONTENTdm objects that have a multiple levels of children are processed by this toolchain, their structures will be flattened.
• After generating import packages with this toolchain, you must generate structure.xml files for your objects by running Islandora Compound Batch's extras/scripts/create_structure_files.php. More detail on running this script is provided on Compound Batch's README.md file.

Preparing the content files

Currently, this toolchain retrieves all files from CONTENTdm. No preparation of any input files is necessary.

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 = compound_test
last_updated_on = "2016-02-01"
last_update_by = "Mark Jordan"

The FETCHER section

This section of the configuration file must contain 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
alias = dkb
temp_directory = "m:\production_loads\dkb_compound_test\temp"
ws_url = "http://content.lib.sfu.ca:81/dmwebservices/index.php?q="
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. The 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 = dkb
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 = 'extras/sfu/mappings_files/chinesetimes_mappings.csv'
; Include the migrated from uri into your generated metadata (e.g., MODS)
include_migrated_from_uri = TRUE
repeatable_wrapper_elements[] = extension

The FILE_GETTER section

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

• class: Required. Must be 'CdmCompound'.
• 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 = CdmCompound
alias = dkb
ws_url = "http://content.lib.sfu.ca:81/dmwebservices/index.php?q="
utils_url = "http://content.lib.sfu.ca/utils/"

The WRITER section

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

• class: Required. Must be 'CdmCompound'.
• 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. A multivalued list of datastream files that you want MIK to create. If not included, MIK will create all the files that the various file getter, metadata parser, and writer classes used in the toolchain can create. If included, only the indicated datastream files will be generated. 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 = CdmCompound
alias = dkb
output_directory = "m:\production_loads\dkb_compound_test"
postwritehooks[] = "php extras/scripts/postwritehooks/validate_mods.php"
; generate_fits.php does not apply to the Compound toolchain
; postwritehooks[] = "php extras/scripts/postwritehooks/generate_fits.php"
postwritehooks[] = "php extras/scripts/postwritehooks/object_timer.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.

The "CdmCompound" fetcher manipulator is not required unless you want to limit they type of compound object retrieved from CONTENTdm. Valid types are Document, Document-PDF, Document-EAD, Postcard, Picture Cube, and Monograph.

Example

[MANIPULATORS]
fetchermanipulators[] = "CdmCompound|Document"
; fetchermanipulators[] = "RandomSet|2"
fetchermanipulators[] = "SpecificSet|configs\ctimes_pointers.txt"
metadatamanipulators[] = "SplitRepeatedValues|Subjects|/subject/topic|;"
metadatamanipulators[] = "AddContentdmData"
metadatamanipulators[] = "AddUuidToMods"

Manipulators that you may find useful with this toolchain include:

• CdmCompound
• 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]
path_to_log = "/tmp/dkb_compound_test/mik.log"
path_to_manipulator_log = "/tmp/dkb_compound_test/manipulator.log"