Manually build Opaque objects from template

Owned by Julie Wetherill
Last updated: May 22, 2017
4 min read

 

Overview

This is a description of the procedure to manually create a batch of opaque objects from template in Batch Builder 2 (BB). This method should be used if you have less than 5 objects per batch.

Procedure summary:

  1. Create a new project
  2. Enter DRS deposit settings
  3. Create object template
  4. Add directories to template
  5. Add metadata
  6. Save your work
  7. Create a new object batch
  8. Move/copy files into corresponding directories on disk
  9. Process the batch

What you need before you start:

  • Prepare several opaque objects and put them in a directory of your choice somewhere on local hard disk or network drive. Consult DRS2 Content Models Reference for guidelines on creating opaque objects.
  • Decide what you will use for Owner Supplied Names (OSNs) for opaque objects. For instance, you could use local classification or local accession numbers. Consult Section 3 Naming rules for files, objects and directories of this Guide for more information.

Procedure:

  1. Create a new project.
    1. Open BB by double clicking on the executable.
    2. From the Project menu select New.
    3. In the dialog enter Project Name (used for internal tracking); select the directory on disk in which the project will be saved (click the ellipsis button to browse to it on disk); select Content Model "opaque" from the dropdown; click OK to continue.

  2. Enter DRS deposit settings.
    1. Click on "Deposit Settings" in Project Panel tree.
    2. Enter deposit data in the form:
      Batch Name Pattern: default - {owner}{batchDir}{yyyy}{mo}{dd}_{hh24}{mm}{ss}

      (This is the name for a batch that appears on DRS deposit reports. Batch name must be at least 3 characters long.)

      Success Email: type email and press enter. 
      Failure Email: type email and press enter.
      Success Method: choose how you will receive load report. 
      Deposit Agent: type your HUID.
      Deposit Agent Email: type your official Harvard email address.

  3. Create object template
    1. Select "Object Template" in Project Panel on the left and then enter information in the Content Panel on the right.
    2. Enter Owner Code for objects you will be depositing (use all caps).
    3. Enter Billing Code for objects you will be depositing (use all caps).
    4. Select DRS Access Flag value for objects you will be depositing .
    5. (Optional) Switch to "optional" tab in the Content Panel to enter any optional metadata (for example descriptive metadata, roles or/and relationships that will apply to your objects). For more about optional metadata see Sections 9. Adding Relationships, 10. Adding Descriptive Metadata, 11. Adding Supporting Content.

  4. Add directories to template.

    About files in opaque objects:     All files that make up the opaque object must be stored in one "content" directory. Any documentation files that describe the opaque content must be stored in a "documentation" directory. The "documentation" directory must be parallel to the "content" directory. There can be only one "content" directory per opaque object.

    Content directory     (an opaque object can have only one directory named "content"):
    1. Add directory: Right click on "Object Template" in Project Panel on the left and add a directory. Content directories are prefixed with "content, but you can append a custom suffix to the directory name.
    2. Add metadata: click to select the new directory, then add metadata to the form:
    3. Required: 
           First Generation in DRS: select "yes". 
           Usage Class: select "LOWUSE".
      Optional: 
           Role: There are no roles for content files,

Documentation directory (optional):

    1. Add directory: Right click on "Object Template" in the Project Panel on the left and add a directory. The directory name starts with "documentation" but you can append a custom suffix.
    2. Add metadata: click to select the new directory, then add metadata to the form:
      Required: 
           First Generation in DRS: select "yes". 
           Usage Class: select "LOWUSE".
      Optional: 
           Role: You can select either DOCUMENTATION or LICENSE roles for documentation files. Select any role that applies.

5.  Save your work: Project > Save on main menu.

6.  Create a new object batch.

    1. From the Batch menu select "New"; enter the name of the new batch directory to be created on disk and click OK. A new batch icon will be added to the Project Panel on the left (icon with red letter B).
    2. From the Object menu select New; leave Content Model at default (FROM TEMPLATE) and enter the name of the object (Object Owner Supplied Name). Click OK.
    3. Click on the "+" next to the Batch icon to expand it – it will show the icon for the new object.
    4. (Optional) Select the object icon of your new object in the Project Panel and switch to "optional" tab in the Content Panel to enter any optional metadata (for example descriptive metadata, roles or/and relationships that will apply to your objects). For more about optional metadata see Sections 9. Adding Relationships, 10. Adding Descriptive Metadata, 11. Adding Supporting Content. Note that any metadata entered at the object level will override metadata entered at the template level.
    5. Repeat b-d if you have more than object.

7.  Move/copy images into corresponding file directories on disk. (Done outside Batch Builder)

The directory structure on disk is the same as what you see in the Project Panel in Batch Builder if you expand the batch icon. If you need to check where on disk Batch Builder built the directory structure, click on Deposit Settings in the Project Panel on the left and look at the Project Path field at the bottom of the Content Panel on the right.

    1. Copy the content files into the corresponding content directory in the object directory.
    2. Copy documentation files into the corresponding documentation directory in the object directory.
    3. Repeat if you have more than one object.

8.  Process the batch.

    1. In the Project Panel on the left right-click on the batch you want to process (batch icon with a red letter B) and select "Create descriptors and batch.xml."
    2. Builder will start processing the batch.
    3. When the batch is successfully processed you will see the following message: FINISHED - Creation of batch.xml and descriptors complete for batch: …

On this page: