Entities Solution Pack

Overview

This module allows you to add person, place, event, and organization entities to an Islandora repository. Entities are small, metadata-based objects. A number of forms and additional features are provided in this module for those building an institutional repository with Islandora. Much of the functionality for batch ingest and autocomplete (to use entities as authority objects) centres around the MADS forms provided with the module. 

 Custom thumbnails can be added via the manage tab to ingested Events, Places, and Organizations. When creating People entities, a thumbnail can be added at time of object creation. If the thumbnail is not added afterward for the Events, Places, and Organizations Entities, the default icon is the folder icon used for collections.

Objects ingested under Events, Places, Organization and People content models are also affiliated with the generic "Entity" content model provided with the solution pack. To use the Entity content model, you must add it explicitly to the collection policy and associate an appropriate form. 

Additional features for use with the People Entity's MADS form:

Batch Ingest - Person Entities using the MADS form (Scholars) can be batch uploaded using the submodule Islandora Entities CSV Import, available at DRUPAL_ROOT/import_entity_csv. Batch ingested entities have a default association with the Person Entity Content model and create a MADS datastream matching the default MADS person form.

Prepare a comma-delimited CSV file using the column names below. Only columns with names in the list will be processed; all others will be ignored. Any comma within a field must be replaced with a double pipe ie - 'Nursing, Department of' must be replaced with 'Nursing|| Department of'.

• STATUS
• POSITION
• EMAIL
• BUILDING ROOM_NUMBER
• IDENTIFIER
• TERM_OF_ADDRESS
• GIVEN_NAME
• FAMILY_NAME
• FAX
• PHONE
• DISPLAY_NAME
• DEPARTMENT
• BUILDING
• CAMPUS
• NAME_DATE
• STREET
• CITY
• STATE
• COUNTRY
• POSTCODE
• START_DATE
• END_DATE
• ROOM_NUMBER
• BUILDING
• CAMPUS

This will result in the following MADS datastream:

<mads xmlns="http://www.loc.gov/mads/v2" xmlns:mads="http://www.loc.gov/mads/v2"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xlink="http://www.w3.org/1999/xlink">
    <authority>
        <name type="personal">
            <namePart type="given">[GIVEN_NAME]</namePart>
            <namePart type="family">[FAMILY_NAME]</namePart>
            <namePart type="termsOfAddress">[TERM_OF_ADDRESS]</namePart>
            <namePart type="date">[NAME_DATE]</namePart>
        </name>
        <titleInfo>
            <title>[DISPLAY_NAME]</title>
        </titleInfo>
    </authority>
    <affiliation>
        <organization>[DEPARTMENT]</organization>
        <position>[POSITION]</position>
        <address>
        <email>[EMAIL]</email>
        <phone>[PHONE]</phone>
        <fax>[FAX]</fax>
        <street>[STREET]</street>
        <city>[CITY]</city>
        <state>[STATE]</state>
        <country>[COUNTRY]</country>
        <postcode>[POSTCODE]</postcode>
        <start_date>[START_DATE]</start_date>
        <end_date>[END_DATE]</end_date>
    </address>
    </affiliation>
    <note type="address">[ROOM_NUMBER] [BUILDING] [CAMPUS]</note>
    <identifier type="u1">[IDENTIFIER]</identifier>
    <note type="status">[STATUS]</note>
</mads>

Multiple arguments within one column can be separated with a tilde (~) e.g. meat~cheese~pickles. However, this may yield unexpected results (missing XML attributes, improper nesting) if used outside the following fields: FAX, PHONE, EMAIL, POSITION. The following is the result of including two values in each field can be seen below:

<?xml version="1.0" encoding="UTF-8"?>
<mads xmlns="http://www.loc.gov/mads/v2" xmlns:mads="http://www.loc.gov/mads/v2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xlink="http://www.w3.org/1999/xlink">
  <authority>
    <name type="personal">
      <namePart>[GIVEN_NAME1]</namePart>
      <namePart type="given">[GIVEN_NAME2]</namePart>
      <namePart>[FAMILY_NAME1]</namePart>
      <namePart type="family">[FAMILY_NAME2]</namePart>
      <namePart>[TERM_OF_ADDRESS1]</namePart>
      <namePart type="termsOfAddress">[TERM_OF_ADDRESS2]</namePart>
      <namePart>[NAME_DATE1]</namePart>
      <namePart type="date">[NAME_DATE2]</namePart>
    </name>
    <titleInfo>
      <title>[DISPLAY_NAME1]</title>
      <title>[DISPLAY_NAME2]</title>
    </titleInfo>
  </authority>
  <affiliation>
    <organization>[DEPARTMENT1]</organization>
    <organization>[DEPARTMENT2]</organization>
    <position>[POSITION1]</position>
    <position>[POSITION2]</position>
    <address>
      <email>[EMAIL1]</email>
      <email>[EMAIL2]</email>
      <phone>[PHONE1]</phone>
      <phone>[PHONE2]</phone>
      <fax>[FAX1]</fax>
      <fax>[FAX2]</fax>
      <street>[STREET1]</street>
      <street>[STREET2]</street>
      <city>[CITY1]</city>
      <city>[CITY2]</city>
      <state>[STATE1]</state>
      <state>[STATE2]</state>
      <country>[COUNTRY1]</country>
      <country>[COUNTRY2]</country>
      <postcode>[POSTCODE1]</postcode>
      <postcode>[POSTCODE2]</postcode>
      <start_date>[START_DATE1]</start_date>
      <start_date>[START_DATE2]</start_date>
      <end_date>[END_DATE1]</end_date>
      <end_date>[END_DATE2]</end_date>
    </address>
  </affiliation>
  <note>[ROOM_NUMBER1]</note>
  <note>[ROOM_NUMBER2] 
[BUILDING1]</note>
  <note>[BUILDING2] 
[CAMPUS1]</note>
  <note type="address">[CAMPUS2]</note>
  <identifier>[IDENTIFIER1]</identifier>
  <identifier type="u1">[IDENTIFIER2]</identifier>
  <note>[STATUS1]</note>
  <note type="status">[STATUS2]</note>
</mads>

Dependencies

• Islandora
• Islandora Basic Collection
• Islandora Solr (include the XSL transformations in basic-solr-config)
• Islandora Solr Metadata
• Islandora Bookmark

Downloads

Release Notes and Downloads

Configuration

• The autocomplete for the MADS forms requires Solr values. A standard installation should include the XSL transformations in basic-solr-config (example config from discoverygarden)
• The foxmlToSolr.xslt file associated with Solr must contain a link to a MADS transformation (such as in this foxmlToSolr.xslt file from discoverygarden)
• Islandora Solr Metadata must be chosen as the default metadata display. This can be set at Administration » Islandora » Metadata Display (admin/islandora/metadata).

The Solr fields for searching entities and the collections that contains the entities can be configured at Administration » Islandora » Solution pack configuration » Entities (admin/islandora/solution_pack_config/entities). The configuration fields correspond to options for adding autocomplete fields to the MADS forms packaged with the module. The following autocomplete paths will work using the basic configuration:

• islandora/entities/autocomplete/scholar (for people)

• islandora/entities/autocomplete/department (for organizations)

• islandora/entities/autocomplete/disambiguated (for people in the "disambiguated full name" MADS field)

Configuration Panel:

By default, the solution pack creates a single collection for all entities. If entities are divided into several collections, the PIDS for relevant collections can be added here. 

View EACCPF Person

The default view for an EACCPF person record:

View MADS Person

The default view for a MADS person record (reflecting a "scholar" in an Institution)

Other Views

EACCPF Objects, Events, and Places (after a thumbnail has been affiliated) will look as below:

Content Models, Prescribed Datastreams and Forms

The Entities Solution Pack comes with the following objects in http://path.to.your.site/admin/islandora/solution_pack_config/solution_packs:

• Islandora Entity Content Model (islandora:entityCModel)
• Islandora Place Content Model (islandora:placeCModel)
• Islandora Person Content Model (islandora:personCModel)
• Islandora Event Content Model (islandora:eventCModel)
• Islandora Organization Content Model (islandora:organizationCModel)
• Entity Collection (islandora:entity_collection)

Entity objects created using these content models will have the following datastreams:

People entities comes with a default MADS and EACCPF form. Events, and Places have an EACCPF form. Organization entities come with a Organization EAC-CPF form and a Department MADS form.