Skip to content

Configuring media types

Overriding Workbench's default extension to media type mappings


Drupal's use of Media types (image, video, document, etc.) is distinct from Islandora's use of "model", which identifies an intellectual entity as an image, video, collection, compound object, newspaper, etc.

By default Workbench defines the following file extension to media type mapping:

File extensions Media type
png, gif, jpg, jpeg image
pdf, doc, docx, ppt, pptx document
tif, tiff, jp2, zip, tar file
mp3, wav, aac audio
mp4 video
txt extracted_text

If a file's extension is not defined in this default mapping, the media is assigned the "file" type.

If you need to override this default mapping, you can do so in two ways:

  1. If the override applies to all files named in your CSV's file column, use the media_type configuration option, for example media_type: document). Use this option if all of the files in your batch are to be assigned the same media type, but their extensions are not defined in the default mapping or you wish to override the default mapping.
  2. On a per file extension basis, via a mapping in the media_types_override option in your configuration file like this one:
  - video: ['mp4', 'ogg']

Use the media_types_override option if each of the files named in your CSV's file column are to be assigned an extension-specific media type, and their extensions are not defined in the default mapping (or add to the extensions in the default mapping, as in this example).

Note that:

  • If a file's extension is not present in the default mapping or in the media_types_override custom mapping, the media is assigned the "file" type.
  • If you use the media_types_override configuration option, your mapping replaces Workbench's default mappings for the specified media type. This means that if you want to retain the default media type mapping for a file extension, you need to include it in the mapping, as illustrated by the presence of "mp4" in the example above.
  • If both media_type and media_types_override are included in the config file, the mapping in media_types_override is ignored and the media type assigned in media_type is used.

Overriding Workbench's default MIME type to file extension mappings

For remote files, in other words files that start with http or https, Workbench relies on the MIME type provided by the remote web server to determine the extension of the temporary file that it writes locally. If you are getting errors indicating that a file extension is not registered for a given media type, and you suspect that the extensions are wrong, you can include the mimetype_extensions setting in your config file to tell Workbench which extensions to use for a given MIME type. Here is a (hypothetical) example that tells Workbench to assign the '.foo' extension to files with the MIME type 'image/jp2' and the extension '.bar' to files with the MIME type 'image/jpeg':

  'image/jp2': '.foo'
  'image/jpeg': '.bar'

Configuring a custom media type

Islandora ships with a set of default media types, including audio, document, extracted text, file, FITS technical metadata, image, and video. If you want to add your own custom media type, you need to tell Workbench two things:

  1. which file extension(s) should map to the new media type, and
  2. which field on the new media type is used to store the file associated with the media.

To satisfy the first requirement, use the media_type or media_types_override option as described above. To satisfy the second requirement, use Workbench's media_type_file_fields option.

The values in the media_type_file_fields option are the machine name of the media type and the machine name of the "File" field configured for that media. To determine the machine name of your media type,

  1. go to the field configuration of your media types (Admin > Structure > Media types)
  2. choose your custom media type
  3. choose the "Manage fields" operation for the media type. The URL of the Drupal page you are now at should look like /admin/structure/media/manage/my_custom_media/fields. The machine name of the media is in the second-last position in the URL. In this example, it's my_custom_media.
  4. in the list of fields, look for the one that says "File" in the "Field type" column
  5. the field machine name you want is in that row's "Machine name" column.

Here's an example that tells Workbench that the custom media type "Custom media" uses the "field_media_file" field:

 - my_custom_media: field_media_file

Put together, the two configuration options would look like this:

  - my_custom_media: ['cus']
 - my_custom_media: field_media_file

In this example, your Workbench job is creating media of varying types (for example, images, videos, and documents, all using the default extension-to-media type mappings. If all the files you are adding in the Workbench job all have the same media type (in the following example, your "my_custom_media" type), you could use this configuration:

media_type: my_custom_media
 - my_custom_media: field_media_file