Object properties

Owned by Julie Wetherill
Last updated: Feb 09, 2023
4 min read


Syntax

Note:

To pass an Aleph or Alma ID (in order to import metadata from HOLLIS) use a separate switch: -aleph See Switches for an example.


Syntax 1 (for all object properties except relatedLinks and harvardMetadataLinks)

-objectprop object_name1::property=value,property=value;object_name2::property=value,property=value; etc.

Syntax 2: (for relatedLinks and harvardMetadataLinks properties):
Related Links (line breaks in this example are for readibility)
-objectprop object_name1::relatedLinks="Relationship=value --- URI=value"\;
object_name2::relatedLinks="Relationship=value --- URI=value" etc.

Note that the separator between "Relationship=value" field/value pair and "URI=value" field/value pair is " — " (i.e. "{blank_space}{three dashes}{blank_space}"). Note that you need to escape the semicolon by "\".

Harvard Metadata Links (line breaks in this example are for readibility)
-objectprop object_name1::harvardMetadataLinks="Type=LinkType --- Identifier=value --- Label=DisplayLabel"\;
object_name2::harvardMetadataLinks="Type=LinkType --- Identifier=value --- Label=DisplayLabel" etc.

Note that the separator between "Type=LinkType" field/value pair and "Identifier=value" field/value pair and "Label=value" is " --- " ( i.e. "{blank_space}{three dashes}{blank_space}"). Note that you need to escape the semicolon by "\".

The LinkType value for harvardMetadataLinks comes from a controlled list. The following are valid link types (case sensitive):

  • Aleph
  • Alma
  • Finding Aid
  • Gale
  • HLSL
  • HULPR
  • Local
  • OCLC
  • RLIN
  • URI
  • DASH
  • Shared Shelf

List of overridable object properties

Property Name

Definition

Descriptor.xml field

ownerCode

Owner Code

<hulDrsAdmin:drsObject><hulDrsAdmin:ownerCode

billingCode

Billing Code

<hulDrsAdmin:drsObject><hulDrsAdmin:billingCode

accessFlag

DRS Access Flag


adminCategory

Administrative Category ID (can be looked up in Word Shack by searching for Admin Category display value)

<hulDrsAdmin:drsObject><hulDrsAdmin:adminCategory

captionBehavior

IDS / PDS Caption Behavior

<hulDrsAdmin:drsObject><hulDrsAdmin:captionBehavior

captionUnitName

IDS / PDS Caption Unit Name

<hulDrsAdmin:drsObject><hulDrsAdmin:captionUnitName

captionDescription

IDS / PDS Caption Description

<hulDrsAdmin:drsObject><hulDrsAdmin:captionDescription

metsLabel

METS Label display value (currently displays in citation label of PDS Document objects)

<mets @LABEL>

methodology

Object methodology

<hulDrsAdmin:drsObject><hulDrsAdmin:methodology

nonPublicNote

Value for the non-public note field

<hulDrsAdmin:drsObject><hulDrsAdmin:nonPublicNote

processingLevel

Object processing level

<hulDrsAdmin:drsObject><hulDrsAdmin:processingLevel

producer

Object producer – controlled value from Word Shack

<hulDrsAdmin:drsObject><hulDrsAdmin:producer

relatedLinks

Related links values – displays in PDS.

How is this multipart element (relationship + relatedURI) communicated?


harvardMetadataLinks

Harvard metadata links values – displays in PDS

How is this multipart element (metadataType + metadataIdentifier, with optional displayLabel) communicated?


pdsObjectPDS Objects that are part of a PDS Document List

viewText

viewText option – affects display of text in PDS

<hulDrsAdmin:drsObject><hulDrsAdmin:viewText

secureStorage

not yet implemented



secureStorageBasis

not yet implemented


secureStorageLicense

not yet implemented


secureStorageLicenseTerms

not yet implemented


secureStorageGrantEnd

not yet implemented


embargoDuration

Embargo duration value in days, months or years. Date format is yyyy-mm-dd.

How is this multipart element (duration + unit) communicated?

<hulDrsRights:drsRights><hulDrsRights:embargoDuration><hulDrsRights:duration>


<hulDrsRights:drsRights><hulDrsRights:embargoDuration><hulDrsRights:unit>

embargoBasis

One of the controlled values:

  • Harvard policy
  • license
  • risk assessment
  • statute
  • copyright
<premis:rights><premis:rightsStatement><premis:rightsBasis>

embargoLicense

URN of the DRS license object – corresponds to BB GUI field Documentation


embargoLicenseTerms

Corresponds to BB GUI field Documentation Note


embargoGrantStart

Corresponds to BB GUI field Start Date

<premis:rights><premis:rightsStatement><premis:termOfGrant><premis:startDate>

embargoGrantEnd

Corresponds to BB GUI field End Date

<premis:rights><premis:rightsStatement><premis:termOfGrant><premis:endDate>

harvardPolicy

URN of an existing Harvard policy object in DRS


license

URN of an existing license object in DRS


statute

URN of an existing statute object in DRS


titleInfoType

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


titleInfoTitle

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


titleInfoSubTitle

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


titleInfoPartNumber

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


titleInfoPartName

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


titleInfoNonSort

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


titleInfoType2

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


titleInfoTitle2

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


titleInfoSubTitle2

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


titleInfoPartNumber2

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


titleInfoPartName2

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


titleInfoNonSort2

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameType

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameAuthority

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameNamePart

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameNamePartType

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameDisplayForm

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameAffiliation

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameRoleTerm

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameDescription

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameType2

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameAuthority2

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameNamePart2

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameNamePartType2

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameDisplayForm2

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameAffiliation2

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameRoleTerm2

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameDescription2

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameType3

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameAuthority3

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameNamePart3

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameNamePartType3

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameDisplayForm3

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameAffiliation3

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameRoleTerm3

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


nameDescription3

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


typeOfResource

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


typeOfResourceCollection

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


typeOfResourceManuscript

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


genre

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


originInfoPlaceTerm

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


originInfoPublisher

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


originInfoDateIssued

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


originInfoDateCreated

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


originInfoDateCaptured

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


originInfoDateValid

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


originInfoDateModified

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


originInfoCopyrightDate

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


originInfoDateOther

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


originInfoEdition

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


languageTerm

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


physicalDescriptionReformattingQuality

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


physicalDescriptionDigitalOrigin

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


abstract

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


tableOfContents

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


classification

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


identifier

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


identifierType

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


identifier2

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


identifierType2

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


identifier3

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


identifierType3

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


accessCondition

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


accessConditionDisplayLabel

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


accessConditionType

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


recordInfoRecordIdentifier

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


recordInfoSource

MODS Metadata – see http://www.loc.gov/standards/mods/v3/mods-userguide-elements.html for more information


has_documentation

Object URN of a related Documentation object in DRS


has_methodology

Object URN of a related Methodology object in DRS


urnAuthorityPath

URN Authority Path


resourceNamePattern

Resource Name Pattern for a URN


role

Object role

<hulDrsAdmin:drsObject><hulDrsAdmin:role

Examples

Example 1:

C:\Program Files\BatchBuilder\BatchBuilder-2.0.14> batchbuildercli -a build -p "C:\Documents and Settings\user\Desktop\stillimage-imgs-Shared Shelf" -b batch3 -objectprop "Obj1::ownerCode=FHCL.FAL,billingCode=FCHL.FAL.SSP_0001,urnAuthorityPath=FHCL"

Example 2:

C:\Program Files\BatchBuilder\BatchBuilder-2.0.14> batchbuildercli -a build -p "C:\Documents and Settings\user\Desktop\stillimage-imgs-Shared Shelf" -b batch4 -objectprop "Obj1::ownerCode=FHCL.FAL,billingCode=FCHL.FAL.SSP_0001,urnAuthorityPath=FHCL;Obj2::ownerCode=FHCL.FAL,billingCode=FCHL.FAL.SSP_0001,urnAuthorityPath=FHCL"





On this page: