Overview

This is a description of the process to manually create a structure-rich PDS Document object batch using Batch Builder 2 (BB). This method is best to use when you have only one or two PDS objects in your batch.

Procedure summary:

Create a new project
Enter DRS deposit settings
Create object template
Add directories to template
Create a new object batch
Copy files into object directories on disk
Adjust PDS METS file(s) for ingest by BB
Rename the PDS METS file(s) to required naming scheme.
Place PDS METS file(s) into corresponding object directori(es/y) on disk
Process the batch
Upload batch to dropbox
Check load report in email

What you need before you start:

Prepare a batch of page images and (optionally) accompanying machine readable text and XML layout (Alto) files that constitute a future PDS Document object and put them in a directory of your choice somewhere on local hard disk or network drive. If you have more than one file per page image (e.g.: an archival master and a deliverable or an archival master, a deliverable and a thumbnail) make sure file names match (e.g.: file1.tif, file1.jp2 and file1.jpg). The file names of text files and XML layout (Alto) files should match the file names of the page images files (e.g.: file1.tif, file1.jp2 file1.jpg, file1.txt, file1.xml).
- Repeat the steps above for each PDS object you are preparing. Files for all objects you are preparing should reside in directories designated by their future roles – e.g.: archival masters for all objects reside in one directory, large deliverables for all objects reside in another, nested directory, etc.
Make sure all the files names have appended PDS sequence numbers. The syntax used in BB2: [filename]_ [sequence_number].[extension]. E.g.: file1 1.jpg, file2 _2.jpg, etc. Check the File name pattern options section of Setup for more information about setting file name patterns in BB. Alternatively, instead of supplying appended sequence numbers you can provide them via the external mapping file called mapping.txt. See Section 6. Using External Mapping Files for more information.
Decide what you will use for Owner Supplied Names for your object and the digital image files it consists of. For instance, you could use local classification numbers, local accession numbers, or an Aleph or Alma ID.
Supply externally generated PDS METS file for each object for ingest by Batch Builder (see Harvard METS Profile for PDS for a list of elements that can be included in the PDS METS file). See sub-section Preparing externally generated METS file for import into Batch Builder 2 above to learn how to adjust the METS file for ingest by Batch Builder.

Procedure:

Start at Step 5 if you are reusing a project to generate a new batch.

Create new project in Batch Builder
1. From main menu select Project > New.
2. Enter project data:
  Project Name: enter a name for your project (used for internal tracking only).
  Project Directory: select the directory where project will be saved (click ellipsis button to browse for or create a directory).
  Content Model: select the value "PDS document" from the dropdown.
3. Click OK to continue.
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.
Create object template:Metadata added at this level will be applied to every object in a batch, unless overridden by specific batch-, object-, or directory-level metadata that you define in later steps.
1. Click on "Object Template" in Project Panel tree:
2. Enter required object metadata in the form:
  
  Owner Code: your owner code (use all caps).
  Billing Code: your billing code (use all caps).
  File Access Flags: the DRS access flag for the files. At this level, select the least restrictive value if the batch will contain a mix of public and restricted files.
  URN Authority Path: your NRS authority path. Use all caps. Look up your Path here if needed: http://nrs.harvard.edu/urn-3:hul.ois:nrsstatusprod.
  File URN Resource Name Pattern: type “{n}” to generate a random unique number for IDS file delivery URN. Note that a value in this field is required even if you elect not to have Batch Builder generate IDS URNs for deliverable images. Hover over the field or see Metadata Reference for more values for this field.
  Object URN Resource Name Pattern: leave at default “{n}” to generate a random unique number for PDS object delivery URN. Type “{objectName}” to have the PDS object delivery URN derived from the object name. Hover over the field or see Metadata Reference for more values for this field.
  
  Enter optional admin and descriptive metadata to the object template. Click the "optional" tab 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.
Add directories to template:

Image directories

For one image file per page image:

1. Add directory: right click on "Object Template" in Project Panel tree. The new directory name will start with "image" 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 "HIGHUSE".
  Optional: scroll down to "Still Image File Metadata":
  Role: use Ctrl Click to select ARCHIVAL_MASTER and DELIVERABLE roles. Note that in order to get a delivery URN on deposit a file needs to have a role DELIVERABLE set in BB.
For multiple image files per page image (e.g., archival master, deliverable), you need to create a directory for the master file and a nested sub-directory for each derivative file.
1. Add a master directory: right click on "Object Template" in Project Panel tree to create an "image" directory. In the text field, enter "-archival_master" or a similar suffix that describes the role.
2. Add metadata for the master directory: click to select the new directory, then add required metadata to the form:
  Required:
  First Generation in DRS: select "yes".
  Usage Class: select "LOWUSE".
  Optional (scroll down to "Still Image File Metadata"):
  Role: select ARCHIVAL_MASTER.
3. Add a nested directory for derivative: right click on the directory you just created and create another directory nested inside it (e.g., a directory for deliverable images). Add a suffix for this derivative (e.g., "-deliverable").
4. Add metadata for this derivative subdirectory: click to select the new subdirectory, then add metadata to the form:
  Required:
  First Generation in DRS: select "no".
  Usage Class: select "HIGHUSE".
  Optional (scroll down to "Still Image File Metadata"):
  Role: select appropriate value for derivative (e.g., DELIVERABLE). Note that in order to get a delivery URN on deposit a file needs to have a role DELIVERABLE set in BB.
5. Repeat the previous steps to create additional nested directories if you have more files derived from the current one.
6. Save your work (Project > Save on main menu).

Text directories

1. Right click on "Object Template" in the Project Panel to add a file directory. Enter the directory name in the dialog box. The directory name starts with "text" but you can append a custom suffix.
2. In the Project Panel on the left select the directory you just created.
3. In the Content Panel on the right choose "yes" from the dropdown list for the field "First Generation in DRS".
4. Choose "HIGHUSE" for Usage Class.

Layout directories (for Alto coordinates files)

1. Right click on "Object Template" in the Project Panel to add a file directory. Enter the directory name in the dialog box. The directory name starts with "layout" but you can append a custom suffix.
2. In the Project Panel on the left select the directory you just created.
3. In the Content Panel on the right choose "yes" from the dropdown list for the field "First Generation in DRS".
4. Choose "LOWUSE" for Usage Class.

5. Create new batch with objects:

Note: Metadata added at this level can be applied to a specific object or file directory.

1. Create new batch: select "Batch > New" from the main menu. Enter a name for the batch (will be used as the batch directory name on disk). Click OK.Tip: including the word "batch" in the name will help you remember the directory's purpose on the file system.
2. Click to select new batch in Project Panel tree. (Look for red letter B).
3. Create new object from template: select Object > New from the main menu. Enter the name of the object (by default, will be used as object OSN). Make sure this object name is unique! Click OK. (Look for blue letter O).
4. Enter optional metadata for each object and file. Click the object directory in the Project Panel tree and select the "optional" tab on the right to enter optional metadata (for example descriptive metadata, roles or/and relationships that will apply to your objects).For more about optional metadata see 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 the previous steps to create additional objects (if you have more than one object in the batch).
6. Save your project (Project > Save on main menu).

6. Copy files into batch object directories on disk (done outside Batch Builder).

Page image files go into an object's "image" directory. Text files go in a "text" directory. Layout files go in a "layout" directory.

Note: if you need to check where the batch/object directories are on disk, click on "Deposit Settings" in the Project Panel tree and look at the Project Path field at bottom.
** Quick way to copy content files: you can drag files from your file system onto the object directories in the Batch Builder project panel.
** If using mapping.txt, this is when you should copy it to the auxiliary object path in the project.
** If including external MODS descriptive metadata, this is when you should copy it to the auxiliary object path in the project.

7. Adjust PDS METS file(s) for ingest by BB. See Preparing externally generated METS file for import.

8. Rename the PDS METS file(s) to correspond to BB external mapping files naming scheme. See Preparing externally generated METS file for import.

9. Place the PDS METS file(s) into corresponding object directories. The PDS METS file(s) should be placed into corresponding object directories: [project]_aux\\[batch]|[object].

10. Process the batch:

1. In the Project Panel tree, right click on the batch you want to process (batch icon with a red letter B) and select "Create descriptors and batch.xml."
2. Processing messages will appear in the messages pane.
3. When the batch is successfully processed you will see the following message: FINISHED - Creation of batch.xml and descriptors complete for batch:

11. Upload batch to dropbox

1. Open your SFTP client and log into your DRS2 training dropbox account.
2. Change to the "incoming" directory.
3. Upload the batch: copy the entire batch directory to the "incoming" directory.
4. Close the SFTP client. Batch processing will start.

12. Check load report in email.

1. Open your email inbox.
2. Look for message from "drs2-support" with subject "DRS LOAD REPORT …"
3. For a more readable report, open the attached text file in Excel, or just copy the file listing and paste into Excel.

On this page:

Library Technology Services: Staff Documentation Center

Using BB manual object building option (PDS Object)

Overview

Procedure summary:

What you need before you start:

Procedure: