Home

Digital Repository Services (DRS) User Manual for

Contents

1. producer Object producer controlled value from Word Shack quality Quality usageClass Usage Class methodology File Methodology processingNote Processing Note Text files encodingAgent Encoding Agent Text files encodingRole Encoding Role Text files language Language Text files disposition Audio Metadata useType Audio Metadata leftRightPanMap Audio Metadata frontRearPanMap Audio Metadata role Role has_target Has target in DRS has_color_profile Has color profile in DRS has_world_reference_data Has world location in DRS has_documentation Has documentation in DRS has_ subset Has subset files in DRS has_ presentation Has a playlist in DRS Audio only maxPixelDimension IDS restriction on delivery size for JP2 images in pixels maxPixelBasis maxPixelLicense One of the controlled values Harvard policy license risk assessment statute copyright URN of the DRS license object corresponds to BB GUI field Documentation maxPixelLicenseTerms Corresponds to BB GUI field Documentation Note downloadProhibited Prohibits delivery of audio as downloadable file Audio will only be delivered as streaming downloadProhibitedBasis One of the controlled values Harvard policy license risk assessment statute copyright downloadProhibitedLicense URN of the DRS license object corresponds to BB GUI field Document
2. Building HulDrsAdmin file metadata Success If you see any error messages at the end of batch processing remedy the errors and re process the batch you can disregard any errors showing during batch processing on command line as long as you get the final Success message 5 3 Processing images for OLIVIA Procedure summary 1 2 3 4 5 Create a new project Enter deposit settings Create object template Add directories to object template Follow manual or automatic object creation process as described in sections 5 1 or 5 2 to create objects and process the batch Steps 1 2 Create new project in Batch Builder a From main menu select Project gt New b 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 still image value from the dropdown Click OK to continue Enter DRS deposit settings a Click on Deposit Settings in Project Panel tree Revised June 2 2013 Batch Builder 2 Beta User Guide Page 29 of 131 b Enter deposit data in the form 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 3 Create object template Metadat
3. Bp About contents faa messages e About information about Batch Builder version and built date e Contents link to Batch Builder 2 User Guide Context menus There are six types of context menus that are available in BB2 all from the Project Panel These are 1 Project context menu 2 Object template context menu 3 Object template directory context menu 4 Batch context menu 5 Object context menu 6 Object directory context menu These context menus are described below in more detail Project context menu Right clicking on the project icon P will open a context menu that allows you to create a new batch Project Panel sP E 5e New Batch Deposit 5i _ T OBJECT TEMPLATE 5 B batch1 forDRS2 intro 0 olvwork85583 201 10801 0 olvwork85586 201 10801 0 olvwork85592 201 10801 batch xml reports Object template context menu Right clicking on the object template icon T will open a menu where you can add a new directory or automatically create a batch of objects from template Revised June 2 2013 Batch Builder 2 Beta User Guide Page 13 of 131 ea isqunsu optional Object Metadata P Images from VIA for DRS 2 Intro Deposit Settings E OBJECT TFMDI ATF SB batchi dd Directory o of Create a new batch with objects from template 0 olvwork85586 201 10801 0 olvwork85592 201 10801 batch xml reports Own
4. Important the file names for all files belonging to the same object need to match e g audio 1 aif audio 1 wav audio 1 mp3 6 Add object name prefix to file names or supply a mapping txt file In order to tell BB which object each file should end up with you need to either add object name prefixes to each file name or supply a mapping txt file that associates each file with its future object o Add an object owner supplied name as a prefix to the name of each file The prefix needs to be separated from the file name by the special separator sting E g objl1 file1 aif isa file name that tells Batch Builder that this particular file needs to be part of object obj1 Make sure that the file name pattern setting in the BB Options dialog is set to the correct setting See more information about file Owner Supplied Name pattern settings in section 1 2 2 Provide a mapping file mapping txt placed in the project _aux template directory which maps each file to an object owner supplied name Syntax relative_file_path file_OwnerSuppliedName PDS_sequence number optional object_OwnerSuppliedName 6699 Notes on syntax There should be no spaces between a comma and the next character If an optional element value is skipped it still needs to be designated by a comma so Batch Builder can associate the right value with the right element For example for objects that do not have PDS sequence numbers an ext
5. In the Command Line Interface a In the command line window Terminal on Mac or Linux or CMD on Windows change to the BB installation directory e g cd C Program Files BatchBuilder BatchBuilder 2 0 17 Type bathcbuildercli a buildtemplate p project_directory_path b batch_directory_name e g batchbuildercli a buildtemplate p E My Project b batchl Note that the batch directory name is the name of your new batch directory to be created by BB If the batch creation is successful you will see the following messages Initializing BB Done Creating batchl and objects from files in the template Success 8 Process the batch You can process your batch in the Graphical User Interface GUD or using the Command Line Interface CLI In the Graphical User Interface a 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 Builder will start processing the batch When the batch is successfully processed you will see the following message FINISHED Creation of batch xml and descriptors complete for batch If you see any error messages remedy the errors and re process the batch In the Command Line Interface a In the command line window Terminal on Mac or Linux or CMD on Windows change to the BB installation directory e g cd C Program F
6. 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 Repeat the previous steps to create additional nested directories if you have more files derived from the current one Save your work Project gt Save on main menu 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 In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose HIGHUSE for Usage Class d 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 In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS 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 a Create new batch select Batch gt New from the main menu Enter a name for the batch will be
7. 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 a 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 Add metadata for the master directory click to select the new directory then add required metadata to the form In required tab First Generation in DRS select yes Usage Class select LOWUSE In optional tab scroll down to Still Image File Metadata Role select ARCHIVAL_MASTER 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 Add metadata for this derivative subdirectory click to select the new subdirectory then add metadata to the form In required tab First Generation in DRS select no Usage Class select HIGHUSE Revised June 2 2013 Batch Builder 2 Beta User Guide Page 35 of 131 In optional tab scroll down to Still Image File Metadata
8. Preparing externally generated METS file for import into Batch Builder 2 Where to place the PDS METS file s o When building the objects manually the file s should be placed into the directory 1 project _ aux batch object o When building objects automatically the file s should be placed into the directory project _aux template How to adjust PDS METS file s for ingest by BB There are changes to the file path and the file name in each xlink href attribute in the lt filesec gt section of the provided METS files that need to be done before the file can be read and converted by BB a Required The file path must be updated to correspond to the Batch Builder 2 naming and directory structure for every file referenced in xl ink href attribute in the lt filesec gt section of the provided METS file For instance given that when you created directories in BB template you named your archival master directory image arch your deliverable directory image deliverable and your text directory text the DRS 1 style PDS METS lt filesec gt section should be updated in the following way xlink href archival_master mydoc__1 tif should be updated to read xlink href 1mage arch mydoc__1 tif xlink href archival_master deliverable mydoc__1 jp2 should be updated to read xlink href 1mage arch image deliverable mydoc__1 jp2 xlink href archival_master ocr_uncorrected mydoc__1 txt should be updated to read xlin
9. required accepts three actions templatedirs buildtemplate and build e templatedirs rebuild the directories in the object template from the information in the project configuration file Revised June 2 2013 Batch Builder 2 Beta User Guide Page 99 of 131 e buildtemplate Create a new batch with objects from template in the specified project e build build the descriptors and batch xml for a specified batch within a specified project using batch object and directory level property values supplied on command line or and in the Graphical User Interface GUI p project directory path required indicates the path to the project directory on disk This path must be created in Batch Builder GUI before using the command line option The project path cannot be created while executing this command If path does not already exist the action will fail b batch_name required for actions buildtemplate and build name of batch directory When using buildtemplate action BB2 will create a new batch directory with the name specified by the b switch e g batchbuildecli a buildtemplate p c myproject b new_batch_directory_name When using the build action BB2 will process the existing batch directory specified by the b switch e g batchbuildecli a build p c myproject b existing_batch_directory_name aleph object_name1 alephID object_name2 alephID etc optional system number of correspondi
10. B imabatch_20100719vz Reports diraeta 2 2 BB menus There are two sets of menus in BB e Menus accessible from the menu toolbar at the top e Context menus accessible by right clicking a particular item in the Project Panel on the left Menu toolbar There are five menus that are accessible from the menu toolbar Project menu el Batch Builder Image Batch from F Project Batch Object View Help ae R 40 Open Close Save Save 4s Exit e New create new project e Open open existing project e Close close currently open project e Save save currently open project e Save as save currently open project as a new project This option saves the project configuration file project conf which contains all the project metadata settings entered in the Deposit Settings and Object Template into a new directory This is a useful option to use if you are planning to create a new project but the Deposit Settings information or and Object Template information is going to be the same Revised June 2 2013 Batch Builder 2 Beta User Guide Page 11 of 131 e Exit exit the program Batch menu wt Batch Builder Image Batch from FAL Project Batch Object view Help ae New messag m e New create a new object batch e Create descriptors amp batch xml process a selected batch note that a batch icon for a given batch needs to be selected in the Project Panel for this command to bec
11. Copy the content files into the corresponding content directory in the object directory b Copy documentation files into the corresponding documentation directory in the object directory c Repeat if you have more than one object Process the batch a Inthe 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 b Builder will start processing the batch c When the batch is successfully processed you will see the following message FINISHED Creation of batch xml and descriptors complete for batch 7 2 Automatically build Opaque objects from template This is a description of the procedure to automatically create a batch of opaque objects from template in Batch Builder 2 BB This method should be used if you have 5 or more opaque objects per batch and the object contents are simple e g several files per object without any nested directories If the object content consists of many files and nested directories this method becomes impractical In this latter case use the procedure to manually build Opaque objects from template Procedure summary Oa OY A OE Se Ye Create a new project Enter DRS deposit settings Create object template Add directories to template Add metadata Save your work Move copy files into corresponding directories on disk Create new batch with objects Revised June 2 2013 Batch Builder 2
12. Enter a name for the batch will be used as the batch directory name on disk Click OK Tip including the word batch in your batch name will help you remember the directory s purpose on the file system b Select the batch with the red letter B in the project Panel c From the main menu select Object gt New leave Content Model at default FROM TEMPLATE and enter the name of the object Object Owner Supplied Name Click OK d Click on the next to the Batch icon to expand it it will show the icon for the new object e Optional Select each object icon in the Project Panel and edit any needed metadata for instance if each object has a separate corresponding Aleph record you can switch to the Optional tab in the Content Panel on the right while the object icon is selected in the Project Panel on the left and enter the Aleph ID for each object in the Aleph ID for MODS import field f Repeat if you have more than object Move copy files into corresponding file directories on disk Can be 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 a Copy the files for into corresponding
13. batch template in BB 1 a Select Object Template in Project Panel on the left and then enter information in the Content Panel on the right Enter DRS Owner Code for objects you will be depositing use all caps Enter DRS Billing Code for objects you will be depositing use all caps Select DRS Access Flag value for objects you will be depositing Use P for Beta testing Enter the URN Authority Path for your objects Look up your Path here if needed http nrsadmintest lib harvard edu 9012 nrs status html use all caps Enter URN Resource Name Pattern Use the default value of n for Beta testing Optional switch to 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 14 Adding Relationships 15 Adding Descriptive Metadata 16 Adding Licenses Documentation and Other Supporting Content 4 Add directories to template Revised June 2 2013 Batch Builder 2 Beta User Guide Page 79 of 131 If there is one audio file per object e g one file that serves as archival master and as deliverable a Right click on Object Template in the Project Panel on the left and add a directory and select the add a directory menu option Type in a name for your directory in the text box The directory name starts with audio but the name you
14. ces eeeceseceseceeeceeeceeeeeeeeeees 5 1 2 2 File name pattern options for generating file OSNS 00 0 cece eeeeeeereeeeeeees 6 1 2 3 Setting options for processing large batches ccsccceesseceereeeeeeeeeneeeeeeeeees 8 2 Us r TNterlace Basis sictscsseccacsssetsactiscsusesdectua nsise reris 8 ZA BB panels i iaiia ead E A TA E TE SANS 8 2 2 BB MENUSA the SA eas e eee a eds ae ee ees 10 3 Naming Rules for Objects Files and Directories ccssccsssscssssscsssccees 14 4 Object and Batch Directories Structure and Contents cscsscssssssssees 16 5 Creating and Processing Still Image Object Batches ssccssssccssssesees 18 5 1 Manually create still image objects from template ee eeeeeeeeseeereeeneeeeees 18 5 2 Automatically build still image objects from template 000 ee eee eeeeseeereeeneees 23 5 3 Processing images for OLIVIA moenie reni iiite e e i E a aean 28 6 Creating and Processing PDS Document Object Batches csssccssseeees 31 6 1 Accepted formats sussesctutivesvistelh iden enh austin rales 31 6 2 File Mame TUES i sees cee EE EE teeta age Cece aa RA alte eae 31 6 3 Procedures to create a batch ee ecsccescceeseeceeseeceenceceeeeeaeceeaeeceeeeeeeaeeeeeeeeeeees 32 6 3 1 Manually create PDS Document objects from template eee 32 6 3 2 Automatically build PDS objects from template 0 eee eee ceeeeeteeeeees 37 6 3 3 Use externally generated METS file to build s
15. d lete Nested directories indicate a derivative relationship where a file in the top directory serves as a source of the files in the subdirectories Each object type has a set of required directory name prefixes such as image for Still Image object type Custom names can be appended to the required prefixes Batch Builder automatically enforces object directory structure and required directory prefixes based on the content model selected After a batch is processed Batch Builder will place a descriptor xml file at the top level of each object directory No other files should be stored there Batch directory structure and contents All objects within a batch must be located in a batch directory The top level of this directory should contain only the batch control file batch xml and object directories No other file should be stored in the top level batch directory Revised June 2 2013 Batch Builder 2 Beta User Guide Page 18 of 131 5 Creating and Processing Still Image Object Batches 5 1 Manually create still image objects from template 5 2 Automatically create still image objects from template There are three methods you can use to create Still Image objects in Batch Builder 1 Manually create objects from template This is best for small batches 10 objects or less In this scenario you generate an object structure in BB for each object and then copy files into it can be done outside BB See section 5 1 f
16. your billing code use all caps Object Access the DRS access flag 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 nrsadmintest lib harvard edu 9012 nrs status html URN Resource Name Pattern use default value n to generate a unique number Switch to optional tab to enter any optional metadata for example descriptive metadata roles and relationships that will apply to your objects For more about optional metadata see sections 14 Adding Relationships 15 Adding Descriptive Metadata 16 Adding Licenses Documentation and Other Supporting Content Note that any metadata entered at the object level will override metadata entered at the template level 4 Add directories to template In automatic object workflow you create role based directories archival master deliverable and in a later step Batch Builder will create the objects for you a Right click on OBJECT TEMPLATE in the Project Panel on the left and select the add a directory menu option Type in a name for your directory in the text box The directory name will start with document but the name you type will be appended to it Tip to make it easier to read start your directory name with an underscore _ So typing _PDFs will result in a directory called docu
17. 16 Adding Licenses Documentation and Other Supporting Content Note that metadata entered at the object level will override metadata entered at the template level Revised June 2 2013 Batch Builder 2 Beta User Guide Page 72 of 131 4 Add directories to template a Right click on Object Template in the Project Panel on the left and add a directory The directory name starts with text but you can append a custom suffix In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose HIGHUSE for Usage Class In the Content Panel switch to Optional tab scroll down to Text File Metadata and use Ctrl Click on your keyboard to select role ARCHIVAL_MASTER and role DELIVERABLE Note that in order to get a delivery URN on deposit a file needs to have a role DELIVERABLE set in BB Go to Project menu in the top menu bar and choose Save to save your project 5 Create new object batch a e 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 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 Click on the
18. Batch Builder using file base name excluding the object name prefix as the file OSN Don t use this option for PDS Object if the file basename is the same for all the files only the seq number is different o For all objects except PDS Document objects this accomplishes the following When building objects automatically this option captures the file base name discarding the object name prefix as file OSN e g obj1 file1 jpg will result in file OSN file When building objects manually this option captures the file base name as file OSN e g filel jpg will results in file OSN file1 o For PDS Document objects e Use baseName pageSeq as file OSN this option results in Batch Builder using file base name and page sequence suffix if present but excluding the object name prefix as the file OSN o For all objects except PDS Document objects this accomplishes the following When building objects automatically this option captures the file base name discarding the object name prefix as file OSN e g obj1 file1 jpg will result in file OSN file1 When building objects manually this option captures the file base name as file OSN e g filel jpg will results in file OSN file1 o For PDS Document objects When building objects automatically this option captures the file base name and page sequence number as file OSN discarding the object name prefix e g obj
19. Beta User Guide Page 58 of 131 9 Process the batch 10 Upload batch to dropbox 11 Check load report in email What you need before you start Prepare your 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 Note that each opaque object can have only one content directory in which the contents are contained The word content is reserved and cannot be used in any directory names that are part of the directory structure of the object itself i e directories nested inside the content directory 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 Make sure that the object OSNs are supplied for each file by one of the following methods o Append the object prefix to each file name the syntax is ob jprefix filename ext Set the desired file name pattern objects in the BB Options dialog see section 1 2 2 for more information o Supply an external mapping file that maps each file to object see section 12 1 for more information Procedure Start at Step 5 if you are reusing a project to generate a new batch 1 Create new project in Batch Builder a From main
20. 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 nrsadmintest lib harvard edu 9012 nrs status html Revised June 2 2013 Batch Builder 2 Beta User Guide Page 34 of 131 URN Resource Name Pattern default value n will generate a unique number 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 14 Adding Relationships 15 Adding Descriptive Metadata and 16 Adding Licenses Documentation and Other Supporting Content 4 Add directories to template For one image file per page image a 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 Add metadata click to select the new directory then add metadata to the form In required tab First Generation in DRS select yes Usage Class select HIGHUSE In optional tab scroll down to Still Image File Metadata
21. Builder 2 Beta User Guide Page 105 of 131 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 originInfoDatelIssued 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 originInfoDate Valid originInfoDateModified originInfoCopyrightDate originInfoDateOther originInfoEdition languageTerm MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www
22. Guide for more information Make sure you either provide object name prefixes for each file to specify which objects it should be assigned to The syntax is obj osn file_name extension or provide object assignment for your file in an external mapping file For more details about providing object prefixes for your files see section 1 2 2 For more details about external mapping files see section 12 1 Procedure Start at Step 5 if you are reusing a project to generate a new batch 1 Create new project in Batch Builder a From main menu select Project gt New b 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 TIP use project as part of the directory name to make it easier to identify later e g museum_slide_project Revised June 2 2013 Batch Builder 2 Beta User Guide Page 24 of 131 c Content Model select the still image value from the dropdown Project Description optional Any information relevant to the project will only remain locally Click OK to continue 2 Enter DRS deposit settings a b Click on Deposit Settings in Project Panel tree 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 a
23. June 2 2013 Batch Builder 2 Beta User Guide Page 51 of 131 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 a 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 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 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 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 Repeat previous steps to create additional nested directories if you
24. See Using mapping txt file for how to create a mapping file In the automatic workflow files with the same role archival master deliverable are copied into the corresponding role based directory In a later step Batch Builder will use the object name prefix for each file to create object directories and move files for each object into these directories Note if you need to check where the 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 template directories in the Batch Builder project panel Tf using mapping txt this is when you should copy it to the auxiliary template path in the project Tf including external MODS descriptive metadata this is when you should copy it to the auxiliary template path in the project 7 Create a new object batch Revised June 2 2013 Batch Builder 2 Beta User Guide Page 27 of 131 You can create your new object batch in the Graphical User Interface or using the Command Line Interface CLI In the Graphical User Interface a From the Object menu in BB select Create a new batch with objects from template enter the name of the batch directory to be created on disk and click OK A new batch icon will be added to the Project Panel on the right icon with a red letter B and new objects will be built that are
25. and click OK A new batch icon will be added to the Project Panel on the left icon with red letter B 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 Click on the next to the Batch icon to expand it it will show the icon for the new object Revised June 2 2013 Batch Builder 2 Beta User Guide Page 57 of 131 8 9 d 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 14 Adding Relationships 15 Adding Descriptive Metadata 16 Adding Licenses Documentation and Other Supporting Content Note that any metadata entered at the object level will override metadata entered at the template level e Repeat b d if you have more than object 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
26. content 17 Uploading Batches to DRS Batches are loaded to DRS 2 in the same way as in DRS 1 Revised June 2 2013 Batch Builder 2 Beta User Guide Page 126 of 131 1 Log on to your ftp dropbox and drag and drop the whole batch directory the one that has the file batch xml and object directories in it that BB processed into the incoming directory in the dropbox 2 Disconnect from the dropbox to kick off batch processing Once the batch is processed you will get a successful load batch report or an error report in the email The path to the DRS 2 dropbox is drs2drop lib harvard edu Username is your regular DRS 1 dropbox username with prefix drs2_ added to the username For example if your DRS 1 production dropbox is xyzftp then your DRS 2 dropbox is drs2_xyzftp etc The password is the same as the password you have for the DRS 1 production dropbox 18 Interpreting Load Reports 13 1 Succesful load reports 13 2 Failure load reports This section describes features of the loader reports generated in the DRS 2 environment The DRS batch loader sends out an email message that reports on the success or failure of a processed batch A batch consists of objects a descriptor xml file included with each object and the batch xml batch control file Recipients of the loader reports are identified within the batch xml file 18 1 Successful load reports Reports of successfully processed batches will be sen
27. e JPEG File Interchange Format image files file extension jpg e Graphic Interchange Format GIF image files file extension gif e Tagged Image File Format TIFF image files file extension tif or tiff Page Text e Plain UTF 8 encoded text file extension txt Page Layout e Extensible Markup Language XML Files file extension xml The file extensions noted above are mandatory File name rules This topic describes specific file name requirements for page turned object batches See Naming Rules for Objects Files and Directories for general Batch Builder requirements Page image page text and page layout file naming The file naming scheme for page image text and page layout files in page turned object is fileBaseName separator sequenceNumber extension where fileBaseName is usually a locally meaningful name for example a name that associates the digital file with an analog counterpart This may be an accession number Aleph ID or other curatorially significant name Valid characters to use for the fileBaseName are letters digits underscores _ and hyphens separator is a double underscore __ used to separate the fileBaseName from the page sequence number Revised June 2 2013 Batch Builder 2 Beta User Guide Page 32 of 131 sequenceNumber is the numeric value that represents the sequence number of the page within the page turned document A sequenceNumber can be compose
28. ea doe ets 96 10 3 4 Depositing to the DRS oe ceecceesseceececeeeeeesaceeeaaeceeaeeceeeeeaeceeaneceeees 97 11 Processing Batches Using Command Line Interface scscsecesseeee 98 Revised June 2 2013 Batch Builder 2 Beta User Guide Page 3 of 131 11 1 Basic command line Syntax eee eesecsecseceseceseceeeeseeeseeseneeeneeeneeeseeenaeenaees 98 LT 2 Switches ee et sadn aaee ae a oot fae eh dace E plea hates ects aeiia 98 11 3 Deposit settings properties batch properties 0 0 cee eeeeeeeeeeeeeereeereeeeeeeeeneees 99 LL4 Object properties stresses ets esis esna we sae oid Soloed Seema E E 100 11 5 Directory file properties sssrinin enen theta ee a 107 12 Using External Mapping Files to Supply ownerSuppliedNames Page Sequence Numbers and Aleph IDS ess ceceved ccccccusscessiindescovcsssseeveanaccecesssedencesecaescoiatvebiessscceess 110 121 Usine mappin sixt fle oeiee ee e E EAE sete OA RR E ECO tees 110 Rules for using mapping txt file eeeeeeeseeeeeseeeeesererestesresresresresserresseersseenreses 110 Procedure for creating and placing a mapping file sssesesseessseessessseessesssesssee 111 12 2 Using object_mapping txt file 0 eee eseeseeeneecseecneecnaecesecssecsseesseeeseeeseeeees 112 13 Working with URNS coisas sce cass vues cdedecsy aces coveccseuee dass veruntnssennscvpceevausnnsehecvs tens 113 13 1 Assigning URN resource name patterns ee eee eeeeeeseeeneeeneecseceaecnseeeseeees 114 1322 Using U
29. for this relationship to be created HAS STATUTE object has an associated statute object in the DRS A DRS ID or a DRS URN of the statute object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS DOCUMENTATION OBJECT object has an associated documentation object in the DRS A DRS ID or a DRS URN of the documentation object needs to be entered in the object level metadata panel in Content Panel of Batch Builder in order for this relationship to be created 14 3 Opaque object relationships File to object HAS LICENSE file has an associated license object in the DRS A DRS ID or a DRS URN of the license object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS HARVARD POLICY file has an associated Harvard Policy object in the DRS A DRS ID or a DRS URN of the Harvard Policy object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created Revised June 2 2013 Batch Builder 2 Beta User Guide Page 118 of 131 HAS STATUTE file has an associated statute object in the DRS A DRS ID or a DRS URN of the statute object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS DOCUMENTATION OBJECT
30. 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 Revised June 2 2013 Batch Builder 2 Beta User Guide Page 106 of 131 information abstract tableOfContents classification identifier identifierT ype identifier2 MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information 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 informa
31. of 131 19 Viewing Your Deposited Objects In Web Admin Use Firefox or Chrome web browsers Internet Explorer is currently not supported 1 Connect to DRS 2 WebAdmin https drs2 ga hul harvard edu 9400 drs2_webadmin search Enter the object ID from the emailed batch report into the Quick Search field and click on the Quick Search button Click on the object ID in the search results You will see an object view page with summarized information about your object View files in your objects by clicking on files IDs within the file listing table at the bottom of the screen For more instructions on searching and testing Web Admin please consult the DRS 2 WebAdmin User Guide In DRS public delivery systems You can view your objects using the following DRS 2 QA Delivery Services IDS PDS FDS and SDS audio delivery Still Image objects are delivered by IDS PDS Document objects are delivered by PDS Document objects and Text objects are delivered by FDS Audio objects are delivered by SDS The URNs created by Batch Builder 2 resolve in NRS QA Use the following URLs to view your DRS2 objects To view Still Image objects in IDS http idstest lib harvard edu 900 1 ids view file_id E g http idstest lib harvard edu 9001 ids view 1166538 To view PDS Document objects in PDS http pdstest lib harvard edu 9005 pds view object_id E g http pdstest lib harvard edu 9005 pds view 1016400 To view Document
32. of Java here http www java com en Installation 1 Download the zip file from here http hul harvard edu ois systems drs BatchBuilder 2 current zip 2 When prompted save the BB zip archive to your computer e g a download directory or your desktop 3 Unzip the archive and extract the files to a directory of your choice e g Program Files or Applications The installer will create a batchbuilder 2 x directory and copy the files to it 4 To start the GUI double click the launch executable file look for the BB icon kW in the batchbuilder 2 x directory If you can t start BB using the executable try the following alternative o On Windows double click on the file bat chbuildergui bat A command prompt window will open and then BB Graphical User Interface will start up o On Mac or Linux open terminal change directory to the BB home directory and type sh batchbuildergui sh and then press Enter BB Graphical User Interface will start up 5 To start the Command Line Interface CLD o On Windows run the command prompt CMD change directory to the BB home directory type bat chbuildercli with required parameters and press Enter Revised June 2 2013 Batch Builder 2 Beta User Guide Page 5 of 131 o On Mac or Linux run the Terminal change directory to the BB home directory and type sh batchbuildercli sh with required parameters and press Enter 1 2 Setting options 1 2 1 General B
33. of day mm 00 to 59 Current minute of hour mo 01 to 12 Current month of year ss 00 to 59 Current second of hour yyyy 1999 to 9999 Current year n 0 to 10 to the 27th power Unique numeric value fileBaseName Name of the file excluding the file Base name of file Note that this extension mask works only in BB It does not work if assigning URNs to existing objects in Web Admin Here are examples of URN masks and the resulting resource name urm 3 dig n gt urn 3 dig 75 urn 3 FAL yyyy n gt urn 3 FAL 1999 76 urn 3 HCL DIG yyyy mo dd gt urn 3 HCL DIG 20000103 unique only for one file on any given day urn 3 HCL DIG yyyy mo dd n gt urn 3 HCL DIG 200001032 always unique Revised June 2 2013 Batch Builder 2 Beta User Guide Page 115 of 131 13 2 Using URNs Each URN assigned by NRS has the form urn 3 authorityPath resourceName urn 3 RAD SCHL 1081404 where urn 3 is the Harvard namespace identifier authorityPath is the NRS authority path corresponding to the organizational unit responsible for the URN and resourceName is the unique identifier for the digital file To make a URN actionable usable in a browser for DRS 2 test objects you must append it to an NRS URL http nrstest harvard edu 9031 The full working URL for the example URN above would be http nrstest harvard edu 903 1 urn 3 HUL Guest 152824 New URNs are passed to the NRS name resolution
34. on Object Template in the Project Panel on the left and add a directory The directory name starts with content but you can append a custom suffix In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose LOWUSE for Usage Class Documentation directory optional a d 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 In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose LOWUSE for Usage Class Go to Project menu in the top menu bar and choose Save to save your project 5 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 There are no roles for content files but you can select either DOCUMENTATION or LICENSE roles for documentation files Select any role that applies 6 Save your work Project gt Save on main menu 7 Create a new object batch a From the Batch menu select New enter the name of the new batch directory to be created on disk
35. only be streamed If dowload true two delivery URNs will be created for deliverable audio one for FDS and one for SDS accessFlag one of P R N The default access flag to use for this object s files Can be overridden by the access flag specified in file level properties files alephID a valid Aleph 009513791 2 Identifier authorityPath a valid NRS authority FHCL Loeb Authority path for any URNs path that will be created for this object s files Revised June 2 2013 Batch Builder 2 Beta User Guide billingCode 100 character limit Valid values ASCII alpha numeric characters a Valid value examples Project_137_4a 5 la Batch 123_23yux a 21 Invalid values examples batch amp amp lt lt gt gt gt lt project A tH RSH The following reserved XML characters should be excluded gen delims wN p sub delims aS a a a Ge ne ne oe Ef NS i a valid DRS billing code FHCL MUSI MUS_004 A299ff FHCL MUSI Revised June 2 2013 a valid 8 digit HUID depositA gent objectOSN resourcePattern A unique value within the content s DRS owner code a valid DRS owner code an NRS resource pattern see Section 13 1 Assigning URN Resource Name Patterns currently no roles for audio object are used Page 89 of 131 Name for the batch Billing code for the object Person depositing the object Name for the object Ownin
36. server for activation A URN requested during DRS2 batch deposit should become active within 15 minutes of successful batch deposit 14 Adding Relationships 14 1 Image relationships 14 2 PDS Document object relationships 14 3 Opaque object relationships 14 4 Document PDF object relationships 14 5 Text object relationships 14 6 Audio object relationships DRS models relationships between files and objects Relationships can indicate derivative relationships between object files how an object is structured or associations between content Derivative relationships and structural relationships are automatically determined by Batch Builder based on placement of files in particular directories and on file names Other relationships must be explicitly set by depositors especially relationships between objects or files being processed in Batch Builder to objects or files already stored in the DRS Below is a list of relationships Batch Builder can create for the six content models it currently supports 14 1 Still image object relationships File to file HAS SOURCE relationships between derivative images The relationship is automatically inferred by Batch Builder if a file with the same file name is present in two directories one of which is nested inside the other HAS SUBSET FILE file is the source of relationship to another file that is part of a stitched image A DRS ID or a DRS URN of the related subset f
37. sink gold_20130416_ Message batch pds kitchen sink gold txt 554 KB Batch Summary Em ff Batch directory name batch pds kitchen sink gold Batch name HUL TEST_batch pds kitchen sink gold_20130416_160921 Depositor Vitaly Zakuta Batch id 97001 Owner s HUL TEST Batch drop off time Wed Apr 17 12 50 02 EDT 2013 Time waiting to start load hours 5 minutes seconds Loading start time Wed Apr 17 12 55 02 EDT 2013 Loading end time Wed Apr 17 13 20 03 EDT 2013 Total load time hours 25 minutes seconds Number of objects deposited 1 Number of files deposited 2253 Batch size 11 576 127 488 bytes 11 304 812 kilobytes 11 039 855 megabytes Number of objects per object type PDS DOCUMENT 1 Number of files per format JPEG 2000 JP2 563 Plain text 563 Extensible Markup Language 564 Tagged Image File Format 563 About the file listing Following the batch summary section the report lists metadata for each file in the batch including any object descriptor files descriptor xml The data in this section is tab delimited with these metadata headings at the top e OBJ ID DRS ID of the object associated with this file e OBJ DELIV URN Delivery URN of the object only PDS Objects have delivery URNs e OBJ URN DRS URN an alternative internal identifier to DRS ID of the object associated with this file e DEPOSITOR First and Last name of depositor responsible for this batch e OBJ OSN Own
38. special separator sting E g ob j1 filel txt isa file name that tells Batch Builder that this particular file needs to be part of object obj1 o Provide a mapping file mapping txt placed in the project _aux template directory which maps each file to an object owner supplied name Syntax relative_file_path file_OwnerSuppliedName PDS_sequence number optional object_OwnerSuppliedName Example document 379129 txt FILEOSN1 Obj1 document 4541102 txt FILEOSN2 Obj2 6699 Notes on syntax There should be no spaces between a comma and the next character If an optional element value is skipped it still needs to be designated by a comma so that Batch Builder can associate the right value with the right element For example when using mapping txt file for objects other than PDS Documents an extra comma needs to be inserted between the FILE OSN value and Object OSN value where PDS sequence number value would be expected 7 Create a new object batch You can create your new object batch in the Graphical User Interface or using the Command Line Interface CLI In the Graphical User Interface a From the Object menu in BB select Create a new batch with objects from template enter the name of the batch directory to be created on disk and click OK A new batch icon will be added to the Project Panel on the right icon with a red letter B and new objects will be built that are going to b
39. specific file directory a Create new batch select Batch gt 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 Select the batch with the red letter B in the Project Panel From the main menu select Object gt New leave Content Model at default FROM TEMPLATE and enter a unique name for the object Object Owner Supplied Name and click OK Revised June 2 2013 Batch Builder 2 Beta User Guide Page 22 of 131 d Click on the next to the Batch icon to expand it it will show the icon for the new object blue letter O e 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 14 Adding Relationships 15 Adding Descriptive Metadata 16 Adding Licenses Documentation and Other Supporting Content Note any metadata entered at the object level will override metadata entered at the template level f Repeat b e if you have more than object g Save your project Project gt Save on main menu 6 Copy image files into batch object directories on disk can be done outside Batch Builder Note
40. specified batch within a specified project using batch object and directory level property values supplied on command line or and in the Graphical User Interface GUI e templatedirs rebuild the directories in the object template from the information in the project configuration file e buildtemplate Create a new batch with objects from template in the specified project CLI should be used in conjunction with the GUI For instance a depositor can use the Batch Builder GUI to build the initial project and then use the command line to substitute batch level object level and directory level metadata values when processing batches of objects CLI On screen Help To see on screen help while in CLI type batchbuildercli h to display only example usage batchbuildercli fullhelp to display example usage and a list of all overridable batch object and directory properties 11 1 Basic command line syntax Please note that on computers running Microsoft Windows XP or later the maximum length of the string that you can use at the command prompt is 8191 characters batchbuildercli a action p project_dir b batch_name a actions templatedirs buildtemplate build aleph object_name 123 batchprop property value property value property value objectprop object_name property value property value dirprop object_name directory_path property value property value 11 2 Switches a action
41. this method when only several Text objects need to be created processed in Batch Builder BB and deposited into the DRS If you have many over 10 objects to create use the procedure to build objects automatically Procedure summary 2 A a a Create a new project Enter DRS deposit settings Create object template Add directories to template Create new object batch Move copy files into corresponding directories on disk Process the batch Revised June 2 2013 Batch Builder 2 Beta User Guide Page 71 of 131 What you need before you start Prepare several text files and put them in a directory of your choice somewhere on local hard disk or network drive Decide what you will use for Owner Supplied Names for your Text objects and the digital files they consist of For instance you could use local classification or local accession numbers Section 3 of this Guide for more information about file and object Owner Supplied Names Procedure 1 Create a new project a Open BB by double clicking on the executable b From the Project menu select New c Inthe 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 text from the dropdown click OK to continue Enter DRS deposit settings a Select Deposit Settings in Project Panel on the left and then enter informati
42. to it So typing deliverable will result in a directory called image deliverable h In the Project Panel on the left select the directory you just created i In the Content Panel on the right choose no from the dropdown list for the field First Generation in DRS j Choose HIGHUSE for Usage Class Add additional metadata for this derivative subdirectory optional a Select the new directory in the Project Panel on the left b In the Content Panel select the optional tab c Scroll down to Still Image File Metadata d Enter any file level optional metadata in the form 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 e Repeat steps 3 and 4 to create additional nested directories if you have more files derived from the current one 5 Save your work Project gt Save on main menu 6 Copy image files into Batch Builder template directory on disk can be done outside Batch Builder The directories you created in BB have been created on disk in the project s template path project_name template In order to tell BB which object each file should end up with you need to either add object name prefixes to each file name or supply a mapping txt file that associates each file with its future object See Naming Rules for Objects for how to add an object name prefix
43. to be created HAS HARVARD POLICY object has an associated Harvard Policy object in the DRS A DRS ID or a DRS URN of the Harvard Policy object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS STATUTE object has an associated statute object in the DRS A DRS ID or a DRS URN of the statute object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS DOCUMENTATION OBJECT object has an associated documentation object in the DRS A DRS ID or a DRS URN of the documentation object needs to be entered in the object level metadata panel in Content Panel of Batch Builder in order for this relationship to be created 14 5 Text object relationships File to file HAS SOURCE relationships between derivative files The relationship is automatically inferred by Batch Builder if a file with the same file name is present in two directories one of which is nested inside the other File to object HAS LICENSE file has an associated license object in the DRS A DRS ID or a DRS URN of the license object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS HARVARD POLICY file has an associated Harvard Policy object in the DRS A DRS ID or a DRS URN of the Harvard Policy object needs
44. to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS STATUTE file has an associated statute object in the DRS A DRS ID or a DRS URN of the statute object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS DOCUMENTATION file has an associated documentation object in the DRS A DRS ID or a DRS URN of the documentation object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created Object to object HAS LICENSE object has an associated license object in the DRS A DRS ID or a DRS URN of the license object needs to be entered in the object level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS HARVARD POLICY object has an associated Harvard Policy object in the DRS A DRS ID or a DRS URN of the Harvard Policy object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS STATUTE object has an associated statute object in the DRS A DRS ID or a DRS URN of the statute object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created Revised June 2 2013 Batch Builder 2 Beta
45. type will be appended to it Tip to make it easier to read start your directory name with an underscore _ So typing _mp3_files will result in a directory called audio_mp3_files c In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose HIGHUSE for Usage Class In the Content Panel switch to Optional tab scroll down to Audio File Metadata and use Ctrl Click on your keyboard to select role ARCHIVAL_MASTER and role DELIVERABLE Note that in order to get a delivery URN on deposit an audio file needs to have a role DELIVERABLE set in BB If there are two or more audio files per object e g a separate file for archival master and a separate file for deliverable Create a directory for an archival master and nest one or more deliverable directories inside it this is needed for BB to determine the derivative relationship a Right click on OBJECT TEMPLATE in the Project Panel on the left and select the add a directory menu option In the text box type archival_master or a similar suffix that describes the role of your directory The directory name will start with audio but the name you type will be appended to it So typing archival_master will result in a directory called audio archival_master c Inthe Project Panel o
46. you should copy it to the auxiliary object path in the project Tf including external MODS descriptive metadata this is when you should copy it to the auxiliary object path in the project Process the batch a 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 b Processing messages will appear in the messages pane c When the batch is successfully processed you will see the following message FINISHED Creation of batch xml and descriptors complete for batch Upload batch to dropbox a Open your SFTP client and log into your DRS2 training dropbox account b Change to the incoming directory c Upload the batch copy the entire batch directory to the incoming directory d Close the SFTP client Batch processing will start Check load report in email a Open your email inbox b Look for message from drs2 support with subject DRS LOAD REPORT For a more readable report open the attached text file in Excel or just copy the file listing and paste into Excel If you see any error messages remedy the errors and re process the batch 8 2 Automatically create document objects from template This is a description of the procedure to automatically build a batch of Document PDF objects from template using Batch Builder 2 BB Use this method if you have a large number of objects more than 10 that need to
47. 1 filel__seq1 jpg will result in file OSN file1__seq1 When building objects manually this option captures the file base name and the page sequence number as file OSN e g filel__seq1 jpg will result in file OSN filel__seq1 e Use only pageSeq as file OSN this option only applies to PDS Document Objects o When building objects automatically this option captures the page sequence number as file OSN discarding the object name prefix and the file name e g obj 1 filel__seq1 jpg will result in file OSN seq1 o When building objects manually this option captures the page sequence number as file OSN e g filel__seq1 jpg will result in file OSN seq1 Revised June 2 2013 Batch Builder 2 Beta User Guide Page 8 of 131 1 2 3 Setting options for processing large batches When processing large batches either from large file sizes or the sheer number if files you may get out of memory errors The threshold is around 30GB If you do get memory errors you will need to make adjustments to BB configuration files to assign more memory to Java Note for Windows users If you find that you need more than 3GB of RAM to run Batchbuilder you will also need to use a 64 bit version of Windows Assigning more memory to Java 1 In the main BB program directory use a text editor to open batchbuildergui bat Windows or batchbuildergui sh Mac 2 Find line starting with java
48. 29 tif ac1234 skipped sequence number value skipped Object OwnerSuppliedName value skipped Aleph ID value e Relative file path the relative path to the file including the file name and extension from either the _aux batch object or _aux template directory This is the file that the next 3 parameters will be applied to e File Owner Supplied Name Required The file owner supplied name e Sequence number Optional Alternate method to providing the sequence number as part of the file name pattern This controls in which order page images and text appear in PDS Document objects when they are displayed in PDS e Object Owner Supplied Name Optional When the object Owner Supplied Name is not provided as part of the file name pattern then this property can be used to control which files are added to which objects when building objects from the template This parameter is ignored when the mapping txt file is placed directly into _aux batch object directory for a manually created object e Aleph ID Optional Aleph ID of the HOLLIS record where the object is described Batch Builder imports MODS descriptive metadata from the HOLLIS record specified and places it into the object descriptor during batch processing Note that there are multiple methods of passing a MODS descriptive metadata file to Batch Builder Only one method at a time can be used Procedure for creating and placing a mapping file Create the
49. 9ff audio properties mods xml relationships csv Note that as an alternative to supplying a MODS file descriptive metadata can be imported from Aleph by Batch Builder by providing an Aleph ID in the audio properties file See Figure 2 Optionally provide technical metadata for files in the batch in the AES57 format These files should be named the same as the files they describe except with an xml file extension For example in Figure 1 on page 1 of this document the file at my_batch 19a326 my_object A299ff archival sub_dir1 file1 xml contains technical metadata for the file at my_batch 19a326 my_object A299ff archival sub_dir1 file1 wav Batch Builder will read in and use the technical metadata supplied by these files but will supplement it with format metadata supplied by FITS see http fits z00glecode com Optionally provide properties files for files in the batch to override Batch Builder configured metadata values These files can contain any file level batch Builder properties shown in the Table below Revised June 2 2013 Batch Builder 2 Beta User Guide Property adminCategory done isFirstGenerationInDrs isPreferredDeliverableS ource processing Page 93 of 131 Access level of file http id lib harvard e du wordshack admin Category 12345 34561 a7 bach Valid values one of P R N Administrative categories to associate with the file A comma delimited list of one or more Word
50. BLE 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 object e g a file for archival master and a separate file for deliverable you need to create a directory for the master file and a nested sub directory for each derivative file This is needed for BB to determine the derivative relationship Add a master directory a Right click on OBJECT TEMPLATE in the Project Panel on the left and select the add a directory menu option Type archival_master or a similar suffix that describes the role for your directory in the text box The directory name will start with image but the name you type will be appended to it So typing archival_master will result in a directory called image archival_master In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose LOWUSE for Usage Class Revised June 2 2013 Batch Builder 2 Beta User Guide Page 21 of 131 Add additional metadata optional a b c d Select the new directory in the Project Panel on the left In the Content Panel select the optional tab Scroll down to Still Image File Metadata Enter any file level optional metadata in the form Role select ARCHIVAL_MASTER Add a nested dire
51. Billing Code for objects you will be depositing use all caps Select DRS Access Flag value for objects you will be depositing Use P for Beta testing Enter the URN Authority Path for your objects Look up your Path here if needed http nrsadmintest lib harvard edu 9012 nrs status html use all caps Enter URN Resource Name Pattern Use the default value of n for Beta testing Optional switch to 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 14 Adding Relationships 15 Adding Descriptive Metadata 16 Adding Licenses Documentation and Other Supporting Content 4 Add directories to template If there is one audio file per object e g one file that serves as archival master and as deliverable Revised June 2 2013 Batch Builder 2 Beta User Guide Page 83 of 131 Right click on Object Template in the Project Panel on the left and add a directory The directory name starts with audio but you can append a custom suffix In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose HIGHUSE for Usage Class In the Content Panel switch to Optional tab scroll down to Audio File Metadata and use Ctrl Clic
52. From main menu select Project gt New b 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 TIP use project as part of the directory name to make it easier to identify later e g software_documentation _ project Content Model select the document value from the dropdown Project Description optional Any information relevant to the project will only remain locally c Click OK to continue Enter DRS deposit settings a Click on Deposit Settings in Project Panel tree b Enter deposit data in the form Revised June 2 2013 Batch Builder 2 Beta User Guide Page 67 of 131 Batch Name Pattern default owner _ batchDir _ yyyy mo dd _ hh24 mm ss This is the name for a batch that appear on DRS deposit reports 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 3 Create object template Metadata added at this level will be applied to every object in a batch unless overridden by specific object metadata that you define in later steps Click on Object Template in Project Panel tree Enter required object metadata in the form DRS Owner Code your owner code use all caps DRS Billing Code
53. Harvard University Information Technology Library Technology Services Batch Builder 2 User Guide Beta This Testing Guide describes how to create and process DRS 2 objects using Batch Builder 2 Beta a Java desktop application that creates a DRS 2 batch deposit The objects belonging to the following DRS 2 Content Models are supported by this version of Batch Builder 2 e AUDIO e DOCUMENT e OPAQUE e PDS DOCUMENT e STILL IMAGE e TEXT This software is intended for DRS 2 testing and is not a production release DRS 1 batches cannot be created using this software Need help To report a problem or ask a question about Batch Builder 2 please contact LTS DRS 2 support team http nrs harvard edu urn 3 HUL OIS drs2help If you are reporting a problem please provide a detailed description of the problem and a copy of any Batch Builder error or warning messages Batch Builder is developed and supported by HUIT Library Technology Services LTS June 2 2013 2011 President and Fellows of Harvard College http hul harvard edu ois systems drs docs bb2 userguide bb2 userguide pdf Batch Builder 2 Beta User Guide Page 2 of 131 1 Setting Up Batch Bul et soy cass siccecsveceicccecsdivececoncacseenssncocecadnedveocavoaeavsnconssoaecoese 4 1 1 Installing Batch Builder teie eee coor ies eae Paice eeleeees 4 12 Setting OptiOns sieves eenaa ea ET a E cect OS ae eae Deseo 5 1 2 1 General Batch Builder application Options 0 0 0 0
54. In the Content Panel switch to Optional tab scroll down to Audio File Metadata and select role DELIVERABLE Note that in order to get a delivery URN on deposit an audio file needs to have a role DELIVERABLE set in BB If you have more deliverables that are derived from the archival master an mp3 deliverable and an mp4 deliverable for instance right click on the topmost audio directory you created add a custom suffix if needed and follow steps g i once again Go to Project menu in the top menu bar and choose Save to save your project 5 Move Copy files into template directory Done outside Batch Builder Once you added directories to Object Template in BB they were also created on disk The directory structure on disk is the same as what you see in the Project Panel in Batch Builder when you expand the Object Template icon but on disk the Object Template directory is called template If you need to check where on disk Batch Builder built the directory structure Revised June 2 2013 Batch Builder 2 Beta User Guide Page 84 of 131 click on Deposit Settings in the Project Panel and take a look at the Project Path field at the bottom of the main metadata panel o If you have one audio file per object copy each file to the corresponding audio directory inside the template directory If you have more than one file per object copy the files for each object into corresponding nested audio directories in the template directory
55. METS file name is original_name xml and the PDS Document object owner supplied name is ob j1 the new name of the METS file should be 0b j1_mets xml1l Note that the object OSN that is part of the METS file name e g ob j1_mets xm1 should match the object OSN specified in the object name prefix for each file e g ob j1 imagel_1 4p2 or in the external mapping file mapping t xt See Using mapping txt file for how to create a mapping file If building objects automatically once a new batch is created the METS file s will be moved to the appropriate object directory ies project _ aux batch object Note that if you need to edit your METS file s after the batch has been created you can edit them in their new locations project _ aux batch object 6 3 3 1 Using BB manual object building option 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 Oy ON ee et a 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 Revised June 2 2013 Batch Builder 2 Beta User Guide Page 44 of 131 7 8 9 10 11 Adjust PDS METS file s for ingest by BB Rename the PDS METS file s to required naming scheme Place PDS METS f
56. Name__pageSeq as file OSN 5 Use only pageSeg as file OSN Derive File OSN from File Name set by default this option when set results in Batch Builder using file name for the file owner supplied name according to one of the options checked below e Use full file name minus the extension as file OSN results in full file name being used as OSN o For all objects except PDS Document objects this accomplishes the following When building objects automatically this option captures the full file name including the object name prefix as file OSN e g obj1 file1 jpg will result in file OSN obj 1 file1 When building objects manually this option captures the full supplied file name as file OSN e g file1 jpg will result in file OSN file1 o For PDS Document objects using the file name used as OSN option accomplishes the following Revised June 2 2013 Batch Builder 2 Beta User Guide Page 7 of 131 When building objects automatically this option captures the full file name including the object name prefix and the page sequence number as file OSN e g obj 1 filel__seq1 jpg will result in file OSN obj1 file1__seq1 When building objects manually this option when set captures the full file name including the page sequence number as file OSN e g filel__seq1 jpg will result in file OSN file1__seq1 e Use baseName as file OSN this option results in
57. Number of files deposited e Batch size e Number of objects per object type e Number of files per format Sample summary for still image object batch From drs2 support hulmail harvard edu Sent Wed 5 29 2013 3 46 PN To Zakuta Vitaly Ce Subject DRS LOAD REPORT owner FHCL JUD batch dir batch_olivia_via batch FHCL JUD_batch_olivia_via_20130529_154009 DB 118002 A Message __ batch_olivia_via txt 8 KB Batch Summary Batch directory name batch_olivia_via Batch name FHCL JUD_batch_olivia_via_20130529_154ee9 Depositor Vitaly Zakuta Batch id 118002 Owner s FHCL JUD Batch drop off time Wed May 29 14 19 50 EDT 2013 Time waiting to start load 1 hours 25 minutes 13 seconds Loading start time Wed May 29 15 45 03 EDT 2013 Loading end time Wed May 29 15 45 47 EDT 2013 Total load time hours minutes 44 seconds Number of objects deposited 17 Number of files deposited 34 Batch size 64 867 016 bytes 63 346 695 kilobytes 61 862 megabytes Number of objects per object type STILL IMAGE 17 Number of files per format JPEG 2000 JP2 17 Extensible Markup Language 17 Revised June 2 2013 Batch Builder 2 Beta User Guide Page 128 of 131 Sample summary for page turned PDS object batch From drs2 support hulmail harvard edu Sent Wed 4 17 2013 1 20 PM To Zakuta Vitaly Ce Subject DRS QA LOAD REPORT owner HUL TEST batch dir batch pds kitchen sink gold batch HUL TEST_batch pds kitchen
58. RD POLICY file has an associated Harvard Policy object in the DRS A DRS ID or a DRS URN of the Harvard Policy object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS STATUTE file has an associated statute object in the DRS A DRS ID or a DRS URN of the statute object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS DOCUMENTATION OBJECT file has an associated documentation object in the DRS A DRS ID or a DRS URN of the documentation object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created Object to object HAS LICENSE object has an associated license object in the DRS A DRS ID or a DRS URN of the license object needs to be entered in the object level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS HARVARD POLICY object has an associated Harvard Policy object in the DRS A DRS ID or a DRS URN of the Harvard Policy object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS STATUTE object has an associated statute object in the DRS A DRS ID or a DRS URN of the statute object needs to be entered in the directory level metadata pan
59. RNS visr sick cot ana a eet eas eee Swen eee 115 14 Adding Relationships cccsssccssssscssssscssssccssssccsscsccsessesssccsssscssssecsesees 115 14 1 Still image object relationships 2 0 0 eee ceeeceeesseeeeeeeeeeeeseecaeecaecsaeenaeesseenes 115 14 2 PDS document object relationships ce eeceeeeeseeeeneeeseeeseeeseecaeceaeceseeeseenes 116 14 3 Opaque object relationships 0 0 0 cee eeseceseceseceseeeseeeeceesseeeseeesaecsaecaecsseeseenes 117 14 4 Document PDF object relationships 0 0 cee ee eeceeeeeeeneeeeeeneecnaeceaecnseenseeees 118 14 5 Text object relationships 3 monisteesi traten reinari i eirinn 119 14 6 Audio object relationships eeeeseseeesesreseessesresresresresresserrisseertesrenresreesesressese 120 15 Adding Descriptive Metadata oessoesssecssecesocesooesoocssscsssccesocesoosssoessseessese 121 15 1 Importing an Aleph record sssessseeseeseseeersseessrsresresressesrrsstertssrenesresseserssee 121 15 2 Entering descriptive metadata in the BB GUL seeeseserserereerereerrrrerrerrreen 122 15 3 Importing descriptive metadata from a MODS file 122 Rules for importing a MODS file oo ee eeeeeeeeeseeeseecsaecnaecnaecnaecsaeenseenes 122 Procedure for importing a MODS file eee eeeeeeeereeeeeeseecaecaecnaeenseenseenes 123 16 Adding Licenses Documentation and Other Supporting Content 125 17 Uploading Batches to DRS sccsssssssssssssssssssssessessessesssssssses
60. UD or using the Command Line Interface CLD In the Graphical User Interface a 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 Builder will start processing the batch When the batch is successfully processed you will see the following message FINISHED Creation of batch xml and descriptors complete for batch If you see any error messages remedy the errors and re process the batch In the Command Line Interface a In the command line window Terminal on Mac or Linux or CMD on Windows change to the BB installation directory e g cd C Program Files BatchBuilder BatchBuilder 2 0 17 Type bathcbuildercli a build p project_directory_path b batch_directory_name e g batchbuildercli a build p E My Project b batchl Revised June 2 2013 Batch Builder 2 Beta User Guide Page 70 of 131 b Optional add additional parameters to the bathcbuildercli command to substitute batch object and directory level properties For more information see section 11 Processing Batches Using Command Line Interface c When the batch is successfully processed you will see the following messages Building PREMIS file metadata Building HulDrsAdmin file metadata Success If you see any error messages at the end of batch processing remedy the errors and re pr
61. User Guide Page 120 of 131 HAS DOCUMENTATION OBJECT object has an associated documentation object in the DRS A DRS ID or a DRS URN of the documentation object needs to be entered in the object level metadata panel in Content Panel of Batch Builder in order for this relationship to be created 14 6 Audio object relationships File to file HAS SOURCE relationships between derivative files The relationship is automatically inferred by Batch Builder if a file with the same file name is present in two directories one of which is nested inside the other File to object HAS LICENSE file has an associated license object in the DRS A DRS ID or a DRS URN of the license object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS HARVARD POLICY file has an associated Harvard Policy object in the DRS A DRS ID or a DRS URN of the Harvard Policy object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS STATUTE file has an associated statute object in the DRS A DRS ID or a DRS URN of the statute object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS DOCUMENTATION OBJECT file has an associated documentation object in the DRS A DRS ID or a DRS URN of the documentation
62. _IMAGE THUMBNAT L AUDIO_DECISION _LIST PROCESS_FIL ES PROCESS_HISTO RY downloadProhibited yes Audio file must be streamed for audio files direct download will not be permitted Revised June 2 2013 Batch Builder 2 Beta User Guide downloadProhibitedBas is for audio files downloadProhibitedLic ense for audio files downloadProhibitedLic enseTerms for audio files downloadProhibitedGra ntStart for audio files downloadProhibitedGra ntEnd for audio files one of Harvard policy license statute Risk assessment DRS object URN of the license object any text A date timestamp A date timestamp Page 95 of 131 license Basis for the restrictions or terms of use urn ID of the documentation 3 HUL DRS OBJEC within the DRS e g a T 197548 deposited donor agreement 90 year policy A note about the documentation e g the applicable section yyyy mm dd Embargo start date yyyy mm yyyy schema date and schema dateTime formats yyyy mm dd Embargo end date yYY Ysa yyyy schema date and schema dateTime formats Note that because of the way the support for PREMIS rights is implemented in the advanced workflow properties files you can also set object level embargo and secure storage rights in the audio properties files You just need to use the appropriate property names These files should be named the same as the files they describe except with a properties fi
63. a added at this level will be applied to every object in a batch unless overridden by specific object metadata that you define in later steps a Click on Object Template in Project Panel tree b Enter required object metadata in the form DRS Owner Code your owner code use all caps DRS Billing Code your billing code use all caps Object Access the DRS access flag 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 nrsadmintest lib harvard edu 9012 nrs status html URN Resource Name Pattern use default value n will generate a unique number c 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 Adding Relationships Adding Descriptive Metadata or Adding Licenses Documentation and Other Supporting Content 4 Add directories to object template a For one image file per object e g one JP2 as both master and deliverable 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 Add metadata click to select the new directory then add met
64. adata to the form In the Required tab First Generation in DRS select yes Usage Class select HIGHUSE In the Optional tab this is required for OLIVIA VIA workflow 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 and for a file to get linked in OLIVIA a file needs to have a role DELIVERABLE set in BB Quality Select 5 from the dropdown list required for OLIVIA VIA workflow b For multiple image files per object e g archival master deliverable you need to create a directory for the master file and a nested sub directory for each derivative file 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 Revised June 2 2013 Batch Builder 2 Beta User Guide Page 30 of 131 e Add metadata for the master directory click to select the new directory then add required metadata to the form In the Required tab First Generation in DRS select yes Usage Class select LOWUSE In the Optional tab scroll down to Still Image File Metadata Role select ARCHIVAL_MASTER Quality select a value higher than 5 from dropdown list any value higher than 5 is allowed 10 is the highest quality Add a n
65. ages Add a suffix for this derivative e g deliverable Add metadata for this derivative subdirectory click to select the new subdirectory then add metadata to the form required tab First Generation in DRS select no Usage Class select HIGHUSE optional tab 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 Repeat the previous steps to create additional nested directories if you have more files derived from the current one Save your work Project gt Save on main menu 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 In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose HIGHUSE for Usage Class 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 In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdo
66. ame of a digital file will be changed once the file is in DRS storage At the point of deposit DRS assigns each file a numeric DRS identifier The file name will be the DRS ID followed by the format extension e g 5844020 tif 5844022 jpg The original file name is preserved in DRS metadata The DRS load report that is sent after a successful DRS deposit will associate the file s DRS ID with the original file name FILE ORIGPATH Also if you use Batch Builder s default method for assigning owner supplied name the original file name minus format extension will be preserved in DRS metadata as the owner supplied name In the case of PDS documents the original filename will be the part of the owner supplied name before the double underscore e g docl in the owner supplied name docl__seq1 Object and batch directory names on disk e Maximum directory name length is 100 characters e No spaces are allowed in batch or object directory names e Valid directory name characters are letters numbers underscores _ and hyphens File owner supplied names File owner supplied name file OSN serves as an identifier that can be used to link files deposited into the DRS with local information about the files such as local accession numbers or classification numbers An owner supplied name is generally optional for files and need not be unique except in the case of e images linked to OLIVIA e audio files if a play
67. atch Builder and regenerate the batch 4 An unexpected problem occurred processing batch batch ID Sample An unexpected problem occurred processing batch 8004 If this problem persists please contact drs support hulmail harvard edu forwarding the entire contents of this message Revised June 2 2013 Batch Builder 2 Beta User Guide Page 130 of 131 Cause This error usually indicates an internal DRS issue rather than an error in the batch In many cases reloading the same batch will be successful But if the problem persists send a message to the DRS2 team in LTS using this form http nrs harvard edu urn 3 HUL OIS drs2help 5 Object descriptor path to descriptor xml not found Sample Type of problem Object descriptor drs2dev dropboxes ois2dev incoming Defective DescriptorBatch DontRegenerateTheDescript desc riptor xml not found Cause The specified object descriptor file was expected by the loader but not found Upload the missing descriptor file and the batch xml file and disconnect from the dropbox 6 MD5 checksum mismatch for descriptor path to descriptor xml Sample Type of problem MD5 checksum mismatch for descriptor file drs2dev dropboxes ois2dev incoming BadDescriptorChecksum DontRebuildTheDescriptor descri ptor xml services reported 22B5A77B58 1CCFFE908E535795CDA06A Cause MD5 checksum calculated by DRS services does not match the checksum supplied in the batch 7 File not found path to file Sam
68. atch Builder application options There are a few Batch Builder features that are controlled by using View gt Options on the file menu These options will affect all projects Options Ignore file validation errors C Open last project on application startup Use File name as owner supplied name verbose logging C Delete object and directory contents when removing Copy files when dragging and dropping onto project tree Batch Builder Default Options Auto increment new batch directory names Unselected by default When selected if you create a batch directory name that ends with a number the next time you click Batch gt New Batch Builder will use the same directory name but will increment the number to the next value Ignore file validation errors Selected by default When selected this option forces Batch Builder to create a batch even when the FITS tool has detected errors in one or more files in the batch Note this option must be selected when generating PDF Document objects as well as Opaque objects Open last project on application startup Unselected by default When selected on Batch Builder startup the most recently used project will open automatically Verbose logging Selected by default This option is exposed specifically for testing purposes Leave it checked during this testing phase so that LTS staff can troubleshoot Batch Builder processing errors Delete object and directory contents whe
69. ated manually will inherit the following property values specified in this file File Owner Supplied Name PDS Document sequence number Placement e For use during automatic object building place the file in the project_dir _aux template directory When used with the automatic object building function the file will be automatically copied to project_dir _aux batch_name object_name for each object created e For use during manual object building place the file in the project_dir _aux batch_name object_name directory Revised June 2 2013 Batch Builder 2 Beta User Guide Page 111 of 131 Syntax relative_file_path file_OwnerSuppliedName PDS_sequence number optional object_OwnerSuppliedName optional AlephNumber optional E g image_archival master 379129 tif ac1234 1 ObjwTiff 12345 image_archival master 4541102 jp2 ac5678 2 ObjwJP2 67890 image_archival master image_deliverable 379129 jpg ac1234 1 ObjwTiff 12345 image_archival master image_deliverable 4541102 jpg ac5678 2 0bjwJP2 67890 66 09 Notes on syntax There should be no spaces between a comma and the next character If an optional element value is skipped it still needs to be designated by a comma so Batch Builder can associate the right value with the right element E g image_archival master 379129 tif ac1234 ObjwTiff skipped sequence number value skipped Aleph ID value image_archival master 3791
70. ation downloadProhibitedLicenseTerms Corresponds to BB GUI field Documentation Note harvardPolicy Object URN of related Harvard policy Revised June 2 2013 Batch Builder 2 Beta User Guide Page 109 of 131 object in DRS license Object URN of related license object in DRS statute Object URN of related statute object in DRS idsDeliverableURNs Additional IDS URNs for individual images within a PDS Document object See the DRS 2 Metadata Reference document on the DRS 2 iSite for more detailed descriptions of the substituted properties See Adding Relationships section for more details definitions of substituted relationship values Example 1 C Program Files BatchBuilder BatchBuilder 2 0 17 gt batchbuildercli a build p E Testing BatchBuilderProjects Still Image 20110907 b batch4 batchprop successEmail successl example com successEmail successemail2 exam ple com failureEmail failure example com objectprop objl ownerCode FHCL FAL billingCode FHCL FAL SSP_0001 accessFlag R urnAuthorityPath FHCL obj2 ownerCode FHCL FAL billingCode FHCL FAL SSP_0001 accessFlag R urnAuthorityPath FHCL dirprop objl image_archmaster accessFlag N isFirstGenerationInDrs yes q uality 10 o0bj1 image_archmaster image_deliverable accessFlag R i sFirstGenerationInDrs yes quality 5 Revised June 2 2013 Batch Builder 2 B
71. ation in the Content Panel on the right b Enter email address es for DRS Reports to be sent to c Type the email in Success Email field and press Enter on the keyboard d Type the email in Failure Email field and press Enter on the keyboard e For more email addresses repeat c and d f Choose success method email is the most commonly used g Enter HUID of the person who will be making DRS deposits will be recorded in DRS metadata for each batch Create object template a Select Object Template in Project Panel on the left and then enter information in the Content Panel on the right b Enter DRS Owner Code for objects you will be depositing use all caps c Enter DRS Billing Code for objects you will be depositing use all caps Revised June 2 2013 Batch Builder 2 Beta User Guide Page 56 of 131 d Select DRS Access Flag value for objects you will be depositing Use P for Beta testing 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 14 Adding Relationships 15 Adding Descriptive Metadata 16 Adding Licenses Documentation and Other Supporting Content 4 Add directories to template Content directory note that an opaque object can have only one directory named content a d Right click
72. aylist object and audio deliverable files will be automatically created by the DRS Loader After executing Batch Builder the following changes should be visible in the batch directory my_batch 19a326 batch xml DRS batch loading file descriptor xml object descriptor for the audio object my_object A299ff misc misc_files zip the files that were in the misc directory workspace moved_content will contain the content that was in the misc directory playlistl A299ff_descriptor xml object descriptor for the playlist object containing playlist1 A299ff xml playlist2 A299ff_descriptor xml object descriptor for the playlist object containing playlist2 A299ff xml Revised June 2 2013 Batch Builder 2 Beta User Guide Page 97 of 131 10 3 4 Depositing to the DRS After executing the script copy the following portion of the directory structure to your DRS dropbox my_batch 19a326 example batch directory batch xml descriptor xml my_object A299ff example object directory archival deliverable misc original production playlist1 A299ff_descriptor xml example descriptor for a playlist object playlist2 A299ff_descriptor xml example descriptor for a playlist object The DRS loader will not automatically delete any files or directories that are uploaded to a dropbox but that aren t referenced in the object descriptors These files and directories should be filtered out as part of the transfer process ot
73. batchl and objects from files in the template Success 8 Process the batch You can process your batch in the Graphical User Interface GUD or using the Command Line Interface CLI In the In the Graphical User Interface a 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 b Builder will start processing the batch Revised June 2 2013 Batch Builder 2 Beta User Guide Page 28 of 131 c When the batch is successfully processed you will see the following message FINISHED Creation of batch xml and descriptors complete for batch If you see any error messages remedy the errors and re process the batch In the Command Line Interface a Inthe command line window Terminal on Mac or Linux or CMD on Windows change to the BB installation directory e g cd C Program Files BatchBuilder BatchBuilder 2 0 33 d Type bathcbuildercli a build p project_directory_path b batch_directory_name e g batchbuildercli a build p E My Project b batchl b Optional add additional parameters to the bat hcbuildercli command to substitute batch object and directory level properties For more information see section 11 Processing Batches Using Command Line Interface c When the batch is successfully processed you will see the following messages Building PREMIS file metadata
74. be created and your source files are not broken into directories by object e g you have 100 PDF files in a directory on disk Procedure summary 1 Create a new project Revised June 2 2013 Batch Builder 2 Beta User Guide Page 66 of 131 SN nw PY N Enter DRS deposit settings Create object template Add directories to template Move copy files into template directory Add object name prefix to file names or supply mapping txt file Create new object batch Process the batch What you need before you start Prepare the PDF files and put them in a directory of your choice somewhere on local hard disk or network drive Decide what you will use for qwner supplied names for document objects and the PDF files they consist of 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 Make sure you either provide object name prefix for each file to specify which objects it should be assigned to The syntax is obj osn file_name extension or provide object assignment for your file in an external mapping file For more details about providing object prefixes for your files see section 1 2 2 For more details about external mapping files see section 12 1 Procedure Start at Step 5 if you are reusing a project to generate a new batch 1 2 Create new project in Batch Builder a
75. bject with an object OSN The new object OSN supplied in CLI overwrites the object OSN that was given to the object at the time it was originally created For more details about CLI see section 11 Processing Batches Using Command Line Interface in this Guide 4 Supply object OSN using external mapping file during batch processing Note that to use this option you need to have an existing object with an object OSN The new object OSN supplied in the external mapping files overwrites the object OSN that was given to the object at the time it was originally created To find out more about using mapping files see section 12 Using External Mapping Files to Supply ownerSuppliedNames Page Sequence Numbers and Aleph IDs of this document Recommendations for owner supplied names e The number of characters per owner supplied name should not exceed a 100 e Only alpha numeric characters and these symbols should be used underscores _ and hyphens 4 Object and Batch Directories Structure and Contents Object directory structure and contents An object directory structure is generated by Batch Builder when a new object is created The object directory structure is dependent on the content model For instance a Still Image object directory structure may look like this Revised June 2 2013 Batch Builder 2 Beta User Guide Page 17 of 131 Obj1 Required prefix image image Werivative Appended custom name image
76. ch Builder 2 Beta User Guide Page 20 of 131 Switch to optional tab to enter any optional metadata for example descriptive metadata roles and relationships that will apply to your objects For more about optional metadata see sections 14 Adding Relationships 15 Adding Descriptive Metadata 16 Adding Licenses Documentation and Other Supporting Content 4 Add directories to template For one image file per object Add directory a Right click on OBJECT TEMPLATE in the Project Panel on the left and select the add a directory menu option Type in a name for your directory in the text box The directory name will start with image but the name you type will be appended to it Tip to make it easier to read start your directory name with an underscore _ So typing _tifs_and_jpegs will result in a directory called image_tifs_and_jpegs In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose HIGHUSE for Usage Class Add additional metadata optional a b c d Select the new directory in the Project Panel on the left In the Content Panel select the optional tab Scroll down to Still Image File Metadata Enter any file level optional metadata in the form Role use Ctrl Click to select ARCHIVAL MASTER and DELIVERA
77. ch file name or supply a mapping txt file that associates each file with its future object See Naming Rules for Objects for how to add an object name prefix See Using mapping txt file for how to create a mapping file Note if you need to check where the 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 template directories in the Batch Builder project panel Tf using mapping txt this is when you should copy it to the auxiliary template path in the project Tf including external MODS descriptive metadata this is when you should copy it to the auxiliary template path in the project 9 Create a new object batch You can create your new object batch in the Graphical User Interface or using the Command Line Interface CLI In the Graphical User Interface a From the Object menu in BB select Create a new batch with objects from template enter the name of the batch directory to be created on disk and click OK A new batch icon will be added to the Project Panel on the right icon with a red letter B and new objects will be built that are going to be part of this batch In the Project Panel click on the next to the Batch icon of the batch you just created to expand the tree it will show the icons for the new objects a blue letter O Re
78. cli a build p C Documents and Settings user Desktop stillimage imgs olivia b batch3 objectprop Obj jl ownerCode FHCL FAL billingCode FCHL FAL SSP_0001 urnAuthori tyPath FHCL Example 2 C Program Files BatchBuilder BatchBuilder 2 0 14 gt batchbuildercli a build p C Documents and Settings user Desktop stillimage imgs olivia b batch4 objectprop Obj 1 ownerCode FHCL FAL billingCode FCHL FAL SSP_0001 urnAuthori tyPath FHCL Obj2 ownerCode FHCL FAL billingCode FCHL FAL SSP_OOO1 urnAuthorityPath FHCL 11 5 Directory file properties Syntax dirprop Nobjectl directory_path1l property value property value objectl directory_path2 property value property value object2 directory_ pathl property value property value ete List of overridable directory properties Property Name Definition accessFlag File DRS Access Flag adminCategory Administrative Category ID can be looked up in Word Shack by searching for Admin Category display value adminFlag Adminstrative Flag adminFlagNote Administrative Flag Note isFirstGenerationInDrs isPreferredDeliverableSource Is first generation in DRS Is preffered deliverable source for future reformatting purposes nonPublicNote Value for the non public note field processing Processing Revised June 2 2013 Batch Builder 2 Beta User Guide Page 108 of 131
79. cp 3 In that line find the section Xmx1024m and do one of the following e To assign 2GB of RAM change it to Xmx2048m e To assign 3GB of RAM change it to Xmx3072m e To assign 4GB of RAM change it to Xmx4096m 4 Save the file Use the smallest amount of RAM to get rid of the error to avoid performance problems with your local computer When you need to process a large batch start BatchBuilder using the batchbuildergui bat or batchbuildergui sh instead of the executable file 2 User Interface Basics 2 1 BB panels 2 2 BB menus The Batch Builder interface includes a menu bar a tool bar and three display panels Context menus are also available by right clicking on certain places within the GUI 2 1 BB panels In the following screen shot of the interface these components are labeled Revised June 2 2013 Batch Builder 2 Beta User Guide Page 9 of 131 B Batch Builder Still Image Project Project Batch Object View Help aba amp e messages INFO Building PREMIS file metadata Message panel displays information INFO Building HulDrsAdmin file metadata INFO Examining obj2 00000002xb gif and error messages as you use the INFO Building PREMIS file metadata application INFO Building HulDrsAdmin file metadata FINISHED Creation of batch xml and descriptors complete for batch batch_stil_img Project Panel Project Name Still I
80. ct and DRS files or objects The format must be Revised June 2 2013 Batch Builder 2 Beta User Guide Page 91 of 131 source relationship_name target_type target where o source for files in this object relative path to the source file from the object directory for this object the word object o relationship_name one of HAS_SOURCE indicates derivative relationships between files in this object HAS_DOCUMENTATION for pointing from files or the object to DRS stored documentation files or objects HAS_METHODOLOGY for pointing from the object to a DRS stored methodology object HAS_RIGHTS for pointing from files or the object to DRS stored rights files or objects o target_type one of RELATIVE_PATH used for a relative file path HUL_DRS_OBJECT_URN used for the URN of a DRS object m For example urn 3 HUL DRS OBJECT 175616 m These are persistent IDs new to DRS2 given to all objects that always have a HUL DRS OBJECT authority path OBJECT_OSN used for the owner supplied name of a DRS object having the same owner code as this object Note that the object ingest service needs to be updated to support handing relationships using OBJECT_OSN We also support HUL_DRS_OBJECT_ORACLE and HUL_DRS_FILE_ORACLE target_type values o target relative path to a file DRS object URN or DRS object owner supplied name Lines can be commented out by starting the line with the symbol Figure 3 an example relatio
81. ct processing level producer Object producer controlled value from Word Shack relatedLinks Related links values displays in PDS harvardMetadataLinks Harvard metadata links values displays in PDS viewText viewText option affects display of text in PDS secureStorage Rights Metadata not yet implemented Expected in Production Release 2 secureStorageBasis Rights Metadata not yet implemented Expected in Production Release 2 secureStorageLicense Rights Metadata not yet implemented Expected in Production Release 2 secureStorageLicenseTerms Rights Metadata not yet implemented Expected in Production Release 2 secureStorageGrantEnd Rights Metadata not yet implemented Expected in Production Release 2 embargoDuration Embargo duration value in days months or years embargoBasis One of the controlled values e Harvard policy e license e risk assessment e statute e copyright 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 embargoGrantEnd Corresponds to BB GUI field End Date 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 w
82. ctions 10 1 and 10 2 instead If you want to deposit just audio files and corresponding AES 60 playlists but do not need to deposit any additional technical metadata files you may do so using the Audio genre and Text genre in Batch Builder GUI First deposit the audio and then deposit the playlists as a separate Text object batch See Sections 10 1 and 10 2 for depositing simple audio and Section 9 for depositing Text Object batches for more information Note that BB2 in advanced mode is COMMAND LINE ONLY Required and optional metadata such as deposit settings object and file metadata is supplied using special configuration files 10 3 1 Command line syntax The existing Batch Builder Windows bat and Unix shell scripts are used to launch Batch Builder in advanced mode The syntax is e On PC batchbuildercli advanced audio d object directory path o Use Windows style directory separator V e On Mac or Linux batchbuildersli sh advanced audio d object directory path o use UNIX style directory separator Note that by default the object directory name serves as the object Owner Supplied Name you can override that in audio properties file Example 1 Windows batchbuildercli advanced audio d C mybatch 004390909 Example 2 Mac Linux batchbuildersli sh advanced audio d mybatch 004390909 10 3 2 Preparation 1 Arrange the content so that it has the directory structure shown in Figure 1 Revise
83. ctory for derivative e g a directory for deliverable images a e Right click on the directory you just created in the Project Panel on the left and select the add a directory menu option Type deliverable or a similar suffix that describes the role for your directory in the text box The directory name will start with image but the name you type will be appended to it So typing deliverable will result in a directory called image deliverable In the Project Panel on the left select the directory you just created In the Content Panel on the right choose no from the dropdown list for the field First Generation in DRS Choose HIGHUSE for Usage Class Add additional metadata for this derivative subdirectory optional a b c e f Select the new directory in the Project Panel on the left In the Content Panel select the optional tab Scroll down to Still Image File Metadata Enter any file level optional metadata in the form 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 Repeat steps 3 and 4 to create additional nested directories if you have more files derived from the current one Save your work Project gt Save on main menu 5 Create new batch with objects Metadata added at this level can be applied to a specific object or
84. d June 2 2013 Batch Builder 2 Beta User Guide Page 48 of 131 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 Processing messages will appear in the messages pane 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 a b c d Open your SFTP client and log into your DRS2 training dropbox account Change to the incoming directory Upload the batch copy the entire batch directory to the incoming directory Close the SFTP client Batch processing will start 12 Check load report in email a b Open your email inbox Look for message from drs2 support with subject DRS LOAD REPORT For a more readable report open the attached text file in Excel or just copy the file listing and paste into Excel 6 3 3 2 Using BB automatic object building option This is a description of the procedure to build structure rich PDS objects using externally generated METS files by means of the BB automatic object building option This method is best to use when you have more than two PDS objects in your batch Procedure summary UPOS Tet BON RNs a ee Create a new project Enter DRS deposit settings Create object template Add directories to template Move copy files into template director
85. d June 2 2013 Batch Builder 2 Beta User Guide Page 87 of 131 Figure 1 An example directory structure created in preparation for use with Batch Builder Items highlighted yellow must be named as shown Other directories can exist in the directory structure but Batch Builder will ignore them my_batch 19a326 my_object A299ff o audio properties required relationships csv required if have derivative relationships mods xml optional descriptive metadata for the object archival required if have archival master files sub_dir1 filel wav filel xml AES57 metadata for filel wav filel properties DRS metadata for filel wav file2 wav file2 xml AES57 metadata for file2 wav file2 properties DRS metadata for file2 wav sub_dir2 filel wav fFilel xml AES 57 metadata for filel wav filel properties DRS metadata for filel wav file2 wav file2 xml AES57 metadata for file2 wav file2 properties DRS metadata for file2 wav sub_dirl adl ADL for wav files in sub_dirl sub_dir2 adl ADL for wav files in sub_dir2 digiprov xml process history for object deliverable performances required if have deliverable files filel mp3 filel xml AES57 metadata for filel mp3 filel properties DRS metadata for filel mp3 file2 mp3 file2 xml AES57 metadata for file2 mp3 file2 properties DRS metadata for file2 mp3 playlists required for playlists playlistl xml AES60 file playlist2 xml AES60
86. d and places it into the object descriptor during batch processing e Note that there are multiple methods of passing a MODS descriptive metadata file to Batch Builder Only one method at a time can be used e Object Owner Supplied Name Optional This property can be used to override the object Owner Supplied Name that is normally derived from object directory name It will be applied to the object specified by in the object directory name property Example 1 specifying object directory name and aleph ID birdsofasia 005111819 brighambulletin 006659177 The extra comma at the end represents the blank value for object owner supplied name It is required even if object owner supplied name is not specified Example 2 specifying object directory name aleph ID and object owner supplied name birdsofasia 005111819 BA_2348 brighambulletin 006659177 BA_35559 In this example all three values are specified Example 3 specifying object directory name and object owner supplied name birdsofasia BA_2348 brighambulletin BA_35559 The extra comma in the middle represents the blank value of the aleph ID for the object Even if aleph ID is not specified the comma delimited is required 13 Working with URNs 13 1 Assigning URN resource name patterns 13 2 Using URNs Batch Builder by default requests public delivery service URNs for deliverable files of still image objects document objects and text objects For PDS docum
87. d be project _aux template o Note that you can place several corresponding METS files for each of your objects in the project _aux template directory The naming scheme for the PDS METS files is explained in step 7 of this procedure Procedure Start at Step 5 if you are reusing a project to generate a new batch 1 Create new project in Batch Builder a From main menu select Project gt New b 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 PDS document value from the dropdown Revised June 2 2013 Batch Builder 2 Beta User Guide Page 50 of 131 C Click OK to continue 2 Enter DRS deposit settings a b Click on Deposit Settings in Project Panel tree Enter deposit data in the form 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 3 Create object template 4 Note Metadata added at this level will be applied to every object in a batch unless overridden by specific object level metadata that you define in later steps a b Click on Object Template in Project Panel tree Enter required object metadata in the form DRS Owner Code your owner co
88. d of any of the following characters 0123456789 The sequence number can include leading zeros for example the third page can be written as 3 or 03 or 000000003 The page sequence number indicates a page s relative position within a sequence of pages regardless of the numbering that may appear on the page extension is one of the valid file extensions at the beginning of this topic By default Batch Builder assumes that fileBaseName plus the separator and the page sequence number is the file OwnerSuppliedName E g in a file 12345__01 tif Batch Builder will assume that 12345__01 is the file OwnerSuppliedName This default can be changed in View Options menu See section 1 2 Setting Options Alternatively instead of using the file naming scheme the file OwnerSuppliedName the page sequence number and the object OwnerSuppliedName can be supplied in a special mapping file called mapping txt More about mapping files 6 3 Procedures to create a batch 6 3 1 Manually create PDS Document objects from template 6 3 2 Automatically build PDS objects from template 6 3 3 Use externally generated METS file to build structure rich PDS objects 6 3 1 Manually create PDS Document objects from template This is a description of the process to manually create a 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
89. data entered at the object level will override metadata entered at the template level In the Command Line Interface a In the command line window Terminal on Mac or Linux or CMD on Windows change to the BB installation directory e g cd C Program Files BatchBuilder BatchBuilder 2 0 17 Type bathcbuildercli a buildtemplate p project_directory_path b batch_directory_name Example batchbuildercli a buildtemplate p E My Project b batch1 Note that batch_directory_name is the name of your new batch directory to be created by BB If the batch creation is successful you will see the following messages Initializing BB Done Creating batchl and objects from files in the template Success 10 Process the batch You can process your batch in the Graphical User Interface GUD or using the Command Line Interface CLI In the Graphical User Interface a 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 Builder will start processing the batch When the batch is successfully processed you will see the following message FINISHED Creation of batch xml and descriptors complete for batch If you see any error messages remedy the errors and re process the batch In the Command Line Interface a C In the command line window Terminal on Mac or Linu
90. dd a suffix for this derivative e g deliverable 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 Repeat previous steps to create additional nested directories if you have more files derived from the current one Save your work Project gt Save on main menu 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 In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose HIGHUSE for Usage Class Revised June 2 2013 Batch Builder 2 Beta User Guide Page 40 of 131 a 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 b In the Project Panel on the left select the directory you just created c Inthe Cont
91. de use all caps DRS Billing Code your billing code use all caps File Access Flags DRS access flag for the files in the object Should contain the least restrictive access flag that applies to all the files URN Authority Path your NRS authority path Use all caps Look up your Path here if needed http nrsadmintest lib harvard edu 9012 nrs status html URN Resource Name Pattern default value n will generate a unique number Enter optional admin and descriptive metadata to the object template Click the optional tab IDS URN for Deliverable JPG and JP2 Select Yes if you need IDS URNs for all deliverable images in the batch Add directories to template In automatic object workflow you create role based directories archival master deliverable and in a later step Batch Builder will create the objects for you For one image file per page image a 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 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 Revised
92. directories on disk Process the batch Upload batch to dropbox Check load report in email What you need before you start Prepare several digital images 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 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 image 1 tif image 1 jp2 and image 1 jpg Consult section 3 Naming rules for files objects and directories of this Guide for more information Revised June 2 2013 Batch Builder 2 Beta User Guide Page 19 of 131 e Decide what you will use for owner supplied names for image objects and the digital image files they consist of 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 Start at Step 5 if you are reusing a project to generate a new batch 1 Create new project in Batch Builder a From main menu select Project gt New b Enter project data C 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 TIP use project as part of the directory name to make it easier to identify later e g museum_slide_pro
93. 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 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 Revised June 2 2013 Batch Builder 2 Beta User Guide Page 46 of 131 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 C 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 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 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 im
94. e Remove Object 3 Switch to Optional tab in the Content Panel on the right 4 Enter the Aleph ID into the field Aleph ID for MODS import Revised June 2 2013 Batch Builder 2 Beta User Guide Page 122 of 131 Project Panel required optional P OLIVIA VIA Test Metadata Import Properties Deposit Settings i Aleph ID for MODS t T OBJECT TEMPLATE ws B batch_olivia_via 5 0 JPCDPEO 1074 0000001_20 Embargo Rights Hi image am descriptor xml Basis v 0 JPCDPEO 1075 0000001_20 Do tation a o JPCDPEO1076 0000001_20 Note that Aleph ID is not repeatable Save the project before processing the batch so that the new information is written into the BB2 configuration file Once the batch is processed the descriptive metadata for the object will end up in the MODS section of the object descriptor Make sure that no other methods of entering descriptive metadata are used at the same time e g there is no MODS file as well or there is no descriptive metadata also entered in the Object Metadata fields in the BB GUD or you will receive an error while processing a batch 15 2 Entering descriptive metadata in the BB GUI You can enter descriptive metadata directly in the BB GUI in the Object Metadata section in the Content panel In BB select the object in the Project Panel on the left switch to Optional tab in the Content Panel on the right and enter the descriptive metadata into the
95. e 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 3 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 a b Click on Object Template in Project Panel tree Enter required object metadata in the form DRS Owner Code your owner code use all caps DRS 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 nrsadmintest lib harvard edu 9012 nrs status html URN Resource Name Pattern default value n will generate a unique number 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 14 Adding Relationships 15 Adding Descriptive Metadata and 16 Adding Licenses Documentation and Other Supporting Content 4 Add directories to template For one image file per page image a Add
96. e part of this batch b In the Project Panel click on the next to the Batch icon of the batch you just created to expand the tree it will show the icons for the new objects a blue letter O c Optional Select the object icon of your new object in the Project Panel and switch to optional tab in the Content Panel to add any additional optional metadata for example descriptive metadata roles or and relationships that will apply to your objects For more about optional metadata see sections 14 Adding Relationships 15 Adding Descriptive Metadata 16 Adding Licenses Documentation and Other Supporting Content Note that metadata entered at the object level will override metadata entered at the template level In the Command Line Interface Revised June 2 2013 Batch Builder 2 Beta User Guide Page 76 of 131 a In the command line window Terminal on Mac or Linux or CMD on Windows change to the BB installation directory e g cd C Program Files BatchBuilder BatchBuilder 2 0 17 Type bathcbuildercli a buildtemplate p project_directory_path b batch_directory_name e g batchbuildercli a buildtemplate p E My Project b batchl Note that the batch directory name is the name of your new batch directory to be created by BB If the batch creation is successful you will see the following messages Initializing BB Done Creating batchl and objects from files in th
97. e template Success 8 Process the batch You can process your batch in the Graphical User Interface GUD or using the Command Line Interface CLI In the Graphical User Interface a 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 Builder will start processing the batch When the batch is successfully processed you will see the following message FINISHED Creation of batch xml and descriptors complete for batch If you see any error messages remedy the errors and re process the batch In the Command Line Interface a In the command line window Terminal on Mac or Linux or CMD on Windows change to the BB installation directory e g cd C Program Files BatchBuilder BatchBuilder 2 0 17 Type bathcbuildercli a build p project_directory_path b batch_directory_name e g batchbuildercli a build p E My Project b batchl Optional add additional parameters to the bathcbuildercli command to substitute batch object and directory level properties For more information see section 11 Processing Batches Using Command Line Interface When the batch is successfully processed you will see the following messages Building PREMIS file metadata Building HulDrsAdmin file metadata Success If you see any error messages at the end of batch processing remedy the err
98. e that in order to get a delivery URN on deposit and for a file to get linked in OLIVIA a file needs to have a role DELIVERABLE set in BB Quality Select 1 from the dropdown list required for OLIVIA VIA workflow Repeat steps a and b to create additional nested directories if you have more files derived from the current one Save your work Project gt Save on main menu 5 Follow instructions in section 5 1 for manually creating a batch of objects or in section 5 2 for automatically creating a batch of objects from template and then process the batch Revised June 2 2013 Batch Builder 2 Beta User Guide Page 31 of 131 6 Creating and Processing PDS Document Object Batches 6 1 6 2 6 1 Accepted formats 6 2 File name rules 6 3 Procedures to create a batch PDS Document objects are page turned objects that can be delivered by the DRS Page Delivery Service PDS Each object can be composed of multiple files each representing either a page image a page text or optionally the page text together with the layout ALTO files All PDS Document objects automatically get assigned public delivery service URNs which resolve to the Page Delivery Service PDS URLs Individual files within a PDS Document object do not automatically get assigned public delivery service URNs Accepted formats PDS Document objects can contain files in the following formats Page Image e JPEG 2000 JP2 image files file extension jp2
99. ectories and move files for each object into these directories Note if you need to check where the 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 file template directories in the Batch Builder project panel Tf using mapping txt this is when you should copy it to the auxiliary template path in the project Tf including external MODS descriptive metadata this is when you should copy it to the auxiliary template path in the project 8 Create new batch with objects a Create new batch From the menu select Object gt Create a new batch with objects from template Enter the name of the batch directory to be created on disk and click OK In response to this action you will see Revised June 2 2013 Batch Builder 2 Beta User Guide Page 60 of 131 C FINISHED Moved objects to batch name in the message panel A new batch directory with red letter B added to the Project Panel New object directories marked by blue letter O and file directories nested below the batch directory Behind the scenes BB created the batch and object directories on disk and moved the content files from the project_name template directory into the object directories Add optional metadata for each object and or each file Note that required metadata was supplied by t
100. el From the main menu select Object gt New leave Content Model at default FROM TEMPLATE and enter a unique name for the object Object Owner Supplied Name and click OK Click on the next to the Batch icon to expand it it will show the icon for the new object blue letter O 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 14 Adding Relationships 15 Adding Descriptive Revised June 2 2013 Batch Builder 2 Beta User Guide Page 65 of 131 7 8 10 11 Metadata 16 Adding Licenses Documentation and Other Supporting Content Note any metadata entered at the object level will override metadata entered at the template level f Repeat b e if you have more than object Save your project Project gt Save on main menu Copy image files into batch object directories on disk can be done outside Batch Builder 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 Tf using mapping txt this is when
101. el in Content Panel of Batch Builder in order for this relationship to be created HAS DOCUMENTATION OBJECT object has an associated documentation object in the DRS A DRS ID or a DRS URN of the documentation object needs to be entered in the object level metadata panel in Content Panel of Batch Builder in order for this relationship to be created 14 2 PDS document object relationships File to file HAS SOURCE relationships between derivative images The relationship is automatically inferred by Batch Builder if a file with the same file name is present in two directories one of which is nested inside the other Revised June 2 2013 Batch Builder 2 Beta User Guide Page 117 of 131 File to object HAS COLOR PROFILE OBJECT file has an associated color profile object in the DRS A DRS ID or a DRS URN of the color profile object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created Note that the Color Profile Content Model is not supported by Batch Builder 2 yet HAS TARGET OBJECT file has an associated target object in the DRS A DRS ID or a DRS URN of the target image object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created Note that the Target Image Content Model is not supported by Batch Builder 2 yet HAS LICENSE file has an associated license object i
102. ent Panel on the right choose yes from the dropdown list for the field First Generation in DRS d Choose LOWUSE for Usage Class 5 Copy files into Batch Builder template directories on disk can be done inside or outside of Batch Builder The directories you created in BB have been created on disk in the project s template path project_name template In order to tell BB which object each file should end up with you need to either add object name prefixes to each file name or supply a mapping txt file that associates each file with its future object See Naming Rules for Objects for how to add an object name prefix See Using mapping txt file for how to create a mapping file In the automatic workflow files with the same role archival master deliverable text layout are copied into the corresponding role based directory In a later step Batch Builder will use the object name prefix for each file to create object directories and move files for each object into these directories Note if you need to check where the 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 template directories in the Batch Builder project panel Tf using mapping txt this is when you should copy it to the auxiliary template path in the project Tf including ex
103. ent Panel switch to Optional tab scroll down to Text Metadata and use Ctrl Click on your keyboard to select role ARCHIVAL_MASTER and role DELIVERABLE Note that in order to get a delivery URN on deposit a file needs to have a role DELIVERABLE set in BB Go to Project menu in the top menu bar and choose Save to save your project 5 Move Copy files into template directory Done outside Batch Builder Once you added directories to Object Template in BB they were also created on disk The directory structure on disk is the same as what you see in the Project Panel in Batch Builder when you expand the Object Template icon but on disk the Object Template directory is called template If you need to check where on disk Batch Builder built the directory structure Revised June 2 2013 Batch Builder 2 Beta User Guide Page 75 of 131 click on Deposit Settings in the Project Panel and take a look at the Project Path field at the bottom of the main metadata panel Copy files to the corresponding text directory inside the template directory 6 Add object name prefix to file names or supply a mapping txt file In order to tell BB which object each file should end up with you need to either add object name prefixes to each file name or supply a mapping txt file that associates each file with its future object o Add an object owner supplied name as a prefix to the name of each file The prefix needs to be separated from the file name by the
104. ent objects a public delivery URN is requested for the object itself rather than for a particular file within the object For opaque objects no public delivery URNs are requested URN authority path and URN resource name pattern values can be entered in the required settings panel for each object or in the object template required setting panel in which case the settings will propagate to all objects created from the template Revised June 2 2013 Batch Builder 2 Beta User Guide Page 114 of 131 NRS URN Authority Path HUL Guest URN Resource Name Pattern n Required settings panel NRS section 13 1 Assigning URN resource name patterns The resource name component of the URN must be unique relative to the authority path Batch Builder can generate all or part of the resource name automatically using mask fields that will be replaced with actual values by the system shown in the table below Resource names can be composed of alpha numeric characters upper and lower case although all NRS comparisons are case insensitive and the following punctuation characters Clete See ee Batch Builder will use n as the default resource name mask field n resolves to a unique number However Batch Builder supports additional resource name patterns that are described below URN resource name pattern fields Field Replacement Value Meaning dd 01 to 31 Day of the month hh24 Ol to 24 Current hour
105. er Code l File Access Flags i Object template directory context menu Right clicking on the directory icon will open a context menu where you can add a new directory nested inside the present one or remove a directory fe Veposic seccings S T OBJECT TEMPLATE oF Add Directory O ol Remove Directory 0 olvwork85586 201 10801 d rT it a nn oe tees T Batch context menu Clicking on the batch icon B opens a context menu where you can create a new object process the batch and remove the batch P Images from YIA for DRS 2 Intro Deposit Settings OBJECT TEMPLATE Hy image batch1 0 olv p e Create Descriptors amp Batch xml i i Create New Object Remove Batch 0 olvwork85586 201 10801 H image descriptor xml 0 olvwork85592 201 10801 batch xml H reports Object context menu Right clicking on the object icon O will open a context menu where you can add new directory rename an object and remove and object Revised June 2 2013 Batch Builder 2 Beta User Guide Page 14 of 131 Dyer eee oyu cu Object h P Images from YIA For DRS 2 Intro Deposit Settings Own 5 T OBJECT TEMPLATE image 7 B batch1 forDR52 intro Bilin 0 olvwork85583 201 10801 File image descriptor xml 0 olvwork8558 271 1n0n1 0 olvwork8559 Add Directory batch xml Rename Object reports Remove Object Tl Note tha
106. er supplied name of the object associated with this file e BILLING Billing code for this file e OWNER Owner code for this file e OBJ TYPE The content model identifier and name e g STILL IMAGE for the associated object e OBJ ROLES Lists object roles for each object if any were specified e FILE ID DRS ID of the file Revised June 2 2013 Batch Builder 2 Beta User Guide Page 129 of 131 e FILE URN Delivery URN of the file e FILE FORMAT Format of the file e FILE SIZE Byte size of the file e FILE OSN Owner supplied name of the file e FILE ORIGPATH Directory path of the file in the batch Tips and tricks Working with the file list Entries in the file list are arranged in the order files were ingested by the loader If you find it difficult to locate a particular file in the file list best practice is to import the listing into an application that can sort tabular data such as MS Excel if working with the emailed report import the attachment into MS Excel or another spreadsheet software In Excel if you sort by the FILE ID column rows associated with a single object will sort together For page turned object batches sorting this way should push the METS file to top of the listing 18 2 Failure load reports If any errors are detected during a load the entire batch is rejected and an error report is sent to the email addresses in the lt failureEmail gt element of the batch xml document The error me
107. ested directory for derivative JP2s or JPEGs 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 Add metadata for this derivative subdirectory click to select the new subdirectory then add metadata to the form In the Required tab First Generation in DRS select no Usage Class select HIGHUSE In the Optional tab required for OLIVIA VIA workflow scroll down to Still Image File Metadata Role select DELIVERABLE Note that in order to get a delivery URN on deposit and for a file to get linked in OLIVIA a file needs to have a role DELIVERABLE set in BB Quality Select 5 from the dropdown list required for OLIVIA VIA workflow Add a second nested directory if thumbnails are needed If your deliverables are JPEGs create an additional nested directory for a thumbnail image Right click on the deliverable directory you just created for large delivery images and create another directory nested inside it Add a suffix for this derivative e g thumb Click to select the new subdirectory then add metadata to the form In the Required tab First Generation in DRS select no Usage Class select HIGHUSE In the Optional tab required for OLIVIA VIA workflow scroll down to Still Image File Metadata Role select DELIVERABLE Not
108. eta User Guide Page 110 of 131 12 Using External Mapping Files to Supply ownerSuppliedNames Page Sequence Numbers and Aleph IDs 12 1 Using mapping txt file 12 2 Using object_mapping txt file Batch Builder can use external mapping files to 1 Associate Owner Supplied Names with existing files and new to be built automatically by BB objects mapping txt Associate Aleph IDs with new to be built automatically by BB objects mapping txt Determine page sequence numbers for PDS Document objects mapping txt Associate Aleph IDs with existing objects object_mapping txt Gv ge ee 1 Associate Owner Supplied Names with existing objects object_mapping txt Mapping files can be used in two ways e To interact with files and objects during automatic object building from template e To interact with files and objects during batch processing Batch Builder will display an INFO message in the message panel when any of the auxiliary input files are discovered e g INFO found mapping txt in E Testing DRS_2 2 BatchBuilderProjects StillImage 2 3 11 _aux batch1 0ObjwJP2 12 1 Using mapping txt file Rules for using mapping txt file File name mapping txt Function e Objects that are built by BB automatically from template will inherit the following property values specified in this file File Owner Supplied Name PDS Document sequence number Object Owner Supplied Name and Aleph ID e Objects that are cre
109. fields in the Object Metadata section The descriptive metadata is expected in MODS 3 4 format and the fields in the GUI follow MODS 3 4 You can look up MODS 3 3 fields definitions at http www loc gov standards mods userguide generalapp html 15 3 Importing descriptive metadata from a MODS file Rules for importing a MODS file Descriptive metadata for an object can be imported from a locally supplied MODS file BB expects the MODS to be valid MODS 3 4 XML There should be one MODS XML file per object being described Descriptions of multiple objects cannot be supplied in the same MODS file Each MODS file can contain only one set of descriptive metadata for an object e g a collection level record and an object lelel record cannot be part of the same MODS file for the same object File Name obj_name _mods xml where obj_name is OSN Format Valid MODS version 3 4 XML file Placement For use while automatically creating a batch place the file in project_dir _aux template directory Note that the file placed into project_dir _aux template directory will be moved to the corresponding _aux directory for the object _aux batch_name object_name after the object batch is built The MODS file will be accessed by BB during batch processing when batch xml and object descriptor is created Revised June 2 2013 Batch Builder 2 Beta User Guide Page 123 of 131 For use during with manually creating a batch place the fi
110. file misc optional can contain any of files in any format original optional audio_object xml AES57 metadata for original item production required if have production master files sub_dir1 filel wav filel xml AES57 metadata for filel wav filel properties DRS metadata for filel wav file2 wav file2 xml AES57 metadata for file2 wav file2 properties DRS metadata for file2 wav sub_dir2 filel wav filel xml AES57 metadata for filel wav filel properties DRS metadata for filel wav Revised June 2 2013 Batch Builder 2 Beta User Guide Page 88 of 131 file2 wav file2 xml AES57 metadata for file2 wav file2 properties DRS metadata for file2 wav sub_dirl adl ADL for wav files in sub_dirl sub_dir2 adl ADL for wav files in sub_dir2 workspacs optional can contain any of files in any format 2 Create the required audio properties configuration file This contains all required batch and object settings The format of it must be a US ASCII text b Each line in property value format c Lines can be commented out by starting the line with the symbol d Can t use reserved XML characters see the table below for full list The table below lists the properties that can be specified in this file An example audio properties file is shown in Figure 2 download true false dowload true specifies whether deliverable audio can be downloaded or can
111. file directories in the object directory b Repeat if you have more than one object Process the batch a 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 b Builder will start processing the batch c When the batch is successfully processed you will see the following message FINISHED Creation of batch xml and descriptors complete for batch If you see any error messages remedy the errors and re process the batch Upload batch to dropbox a Open your SFTP client and log into your DRS2 training dropbox account Revised June 2 2013 Batch Builder 2 Beta User Guide Page 81 of 131 b Change to the incoming directory c Upload the batch copy the entire batch directory to the incoming directory d Close the SFTP client Batch processing will start 10 Check load report in email a Open your email inbox b Look for message from drs2 support with subject DRS LOAD REPORT For a more readable report open the attached text file in Excel or just copy the file listing and paste into Excel If you see any error messages remedy the errors and re process the batch 10 2 Automatically build audio objects from template This is a description of the procedure to automatically build a batch of audio objects from template using Batch Builder 2 BB Use this method if you have a large number of objects
112. file has an associated documentation object in the DRS A DRS ID or a DRS URN of the documentation object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created Object to object HAS LICENSE object has an associated license object in the DRS A DRS ID or a DRS URN of the license object needs to be entered in the object level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS HARVARD POLICY object has an associated Harvard Policy object in the DRS A DRS ID or a DRS URN of the Harvard Policy object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS STATUTE object has an associated statute object in the DRS A DRS ID or a DRS URN of the statute object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS DOCUMENTATION OBJECT object has an associated documentation object in the DRS A DRS ID or a DRS URN of the documentation object needs to be entered in the object level metadata panel in Content Panel of Batch Builder in order for this relationship to be created 14 4 Document PDF object relationships File to file HAS SOURCE relationships between derivative files The relationship is automatically inferred by Batch Builder if a
113. file with the same file name is present in two directories one of which is nested inside the other File to object HAS LICENSE file has an associated license object in the DRS A DRS ID or a DRS URN of the license object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS HARVARD POLICY file has an associated Harvard Policy object in the DRS A DRS ID or a DRS URN of the Harvard Policy object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS STATUTE file has an associated statute object in the DRS A DRS ID or a DRS URN of the statute object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS DOCUMENTATION OBJECT file has an associated documentation object in the DRS A DRS ID or a DRS URN of the documentation object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created Revised June 2 2013 Batch Builder 2 Beta User Guide Page 119 of 131 Object to object HAS LICENSE object has an associated license object in the DRS A DRS ID or a DRS URN of the license object needs to be entered in the object level metadata panel in Content Panel of Batch Builder in order for this relationship
114. formation in the Content Panel on the right Enter DRS Owner Code for objects you will be depositing use all caps Enter DRS Billing Code for objects you will be depositing use all caps Select DRS Access Flag value for objects you will be depositing Use P for Beta testing Enter the URN Authority Path for your objects Look up your Path here if needed http nrsadmintest lib harvard edu 9012 nrs status html use all caps Enter URN Resource Name Pattern Use the default value of n for Beta testing Optional Switch to optional tab in the Content Panel to enter any additional optional metadata for example descriptive metadata roles or and relationships that will apply to your objects For more about optional metadata see sections 14 Adding Relationships 15 Adding Descriptive Metadata 16 Adding Licenses Documentation and Other Supporting Content Note that metadata entered at the object level will override metadata entered at the template level 4 Add directories to template a Right click on Object Template in the Project Panel on the left and add a directory The directory name starts with text but you can append a custom suffix In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose HIGHUSE for Usage Class In the Cont
115. g appended sequence numbers you can provide them via the external mapping file called mapping txt See section 12 Using External Mapping Files to Supply ownerSuppliedNames Page Sequence Numbers and Aleph IDs for more information e Decide what you will use for Owner Supplied Names OSNs for your objects and the digital image files they contain For instance you could use local classification or local accession numbers or ALEPH IDs e Make sure that the object OSNs are supplied for each file by one of the following methods o Append the object prefix to each file name the syntax is ob jprefix filename __ pageSeq ext Set the desired file name pattern objects in the BB Options dialog see section 1 2 2 for more information o When preparing several objects objprefix for a corresponding object should be used for the files that are going to be part of that object E g obj1 filel__01 jpeg obj2 filel__01 jpeg obj1 file2__02 jpeg obj2 file2__02 jpeg ect o Supply an external mapping file that maps each file to object see section 12 1 for more information One mapping file can contain references to multiple objects e 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 The PDS METS file should be placed into project _aux template directory for Unix Linux or Mac the path woul
116. g externally generated METS file for import into Batch Builder 2 at the top of section 6 3 9 Create a new object batch You can create your new object batch in the Graphical User Interface or using the Command Line Interface CLD In the Graphical User Interface a From the Object menu in BB select Create a new batch with objects from template enter the name of the batch directory to be created on disk and click OK A new batch icon will be added to the Project Panel on the right icon with a red letter B and new objects will be built that are going to be part of this batch b In the Project Panel click on the next to the Batch icon of the batch you just created to expand the tree it will show the icons for the new objects a blue letter O c 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 that applies specifically to your object for example descriptive metadata or Aleph ID administrative categories Revised June 2 2013 Batch Builder 2 Beta User Guide Page 53 of 131 etc Note that any optional metadata that applies to all objects in the batch should be entered in the object template before your batch is created For more about optional metadata see sections 14 Adding Relationships 15 Adding Descriptive Metadata 16 Adding Licenses Documentation and Other Supporting Content Note that any meta
117. g unit of the object Resource name pattern for any URNs created for this object s files One or more roles for the object not likely to be used included to support future uses Batch Builder 2 Beta User Guide Page 90 of 131 failureEmail one or more valid examplel fas harvard ed People who will be sent failed email addresses u loader reports separated by commas example2 fas harvard ed u successEmail one or more valid example fas harvard ed People who will be sent email addresses u successful loader reports separated by commas example2 fas harvard ed successMethod one of EMAIL Distribution method for the DROPBOX ALL loader reports Figure 2 an example audio properties file properties for the object alephID 009513791 authorityPath FHCL Loeb batchName Project_137_4a billingCode FHCL MUSI MUS_004 depositAgent 12345678 failureEmail example 1 fas harvard edu example2 fas harvard edu objectOSN A299ff ownerCode FHCL MUSI resourcePattern n successEmail example1 fas harvard edu example2 fas harvard edu successMethod EMAIL Place the audio properties file at the same file system level as the object directory e g my_batch 19a326 my_object A299ff audio properties 3 Create a relationships file This must be a comma separated file named relationships csv supplying relationships between files in the object and or between this object and DRS objects and or between files in this obje
118. going to be part of this batch In the Project Panel click on the next to the Batch icon of the batch you just created to expand the tree it will show the icons for the new objects a blue letter O 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 14 Adding Relationships 15 Adding Descriptive Metadata 16 Adding Licenses Documentation and Other Supporting Content Note that any metadata entered at the object level will override metadata entered at the template level Save the project to have BB2 write the new metadata values to the internal configuration files In the Command Line Interface a In the command line window Terminal on Mac or Linux or CMD on Windows change to the BB installation directory e g cd C Program Files BatchBuilder BatchBuilder 2 0 33 Type bathcbuildercli a buildtemplate p project_directory_path b batch_directory_name Example batchbuildercli a buildtemplate p E My Project b batchl Note that the batch directory name is the name of your new batch directory to be created by BB If the batch creation is successful you will see the following messages Initializing BB Done Creating
119. guide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information 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 Revised June 2 2013 Batch
120. h When the batch is successfully processed you will see the following message FINISHED Creation of batch xml and descriptors complete for batch Revised June 2 2013 Batch Builder 2 Beta User Guide Page 73 of 131 If you see any error messages remedy the errors and re process the batch 9 2 Automatically build text objects from template This is a description of the procedure to automatically build a batch of Text objects from template using Batch Builder 2 BB Use this method if you have a large number of objects over 10 that need to be created and your source files are in directories that are not broken by object Procedure summary OO al ON Oe es te a Create a new project Enter DRS deposit settings Create object template Add directives to template Move copy files into template directories Add object name prefix to file names or supply a mapping txt file Create new object batch Process the batch What you need before you start Prepare a dozen of text files and put them in a directory of your choice somewhere on local hard disk or network drive Decide what you will use for Owner Supplied Names for your objects and the files they consist of For instance you could use local classification or local accession numbers See section 3 for more information about owner supplied names Make sure you either provide object name prefix for each file to specify which objects it should be assigned to The sy
121. have more files derived from the current one Save your work Project gt Save on main menu 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 In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose HIGHUSE for Usage Class 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 In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Revised June 2 2013 Batch Builder 2 Beta User Guide Page 52 of 131 d Choose LOWUSE for Usage Class 5 Copy files into Batch Builder template directories on disk can be done inside or outside of Batch Builder The directories you created in BB have been created on disk in the project s template path project_name template In order to tell BB which object each file should end up with you need to either add object name prefixes to each file name or supply a mapping txt file that associates each fi
122. he object template Select an object directory or file directory in the Project Panel and then select the optional tab on the right Object metadata select the object directory open the optional tab Notable metadata types include Aleph ID for MODS import import descriptive metadata from Aleph You can also right click over the object directory in project panel to assign Aleph ID Admin category a curator assigned label such as an exhibit name project name etc that can be used to group together a set of objects or files Descriptive metadata fields MODS use only if not importing by Aleph ID or including external MODS file File metadata select a file directory open the optional tab Admin category a curator assigned label such as an exhibit name project name etc that can be used to group together a set of objects or files To import an object description from Aleph right click on the object directory and select Set Aleph ID Save your project Project gt Save on main menu 9 Process the batch a In the Project Panel tree right click on the batch you want to process batch with red letter B and select Create descriptors amp batch xml Or from the main menu select Batch gt Create descriptors amp batch xml Processing messages will appear in the messages pane When the batch is successfully processed you will see the following message FINISHED Creation of batch
123. herwise they will need to be manually deleted from the dropbox These include Any other subdirectories in the object directory e g pre archival workspace Properties files audio properties AES57 files used to indicate metadata for the original item or for audio content files xml MODS file mods xml Relationships file relationships csv Notes Object owner supplied names Object OSNs o Object OSNs are required in DRS 2 and must be unique within a DRS owner code Please keep that in mind when explicitly assigning objects names for example in the audio properties file or implicitly for example by the file names of the AES60 playlists URNs o An object level URN is automatically given to all objects These URNs will have a HUL DRS OBJECT authority path e g urn 3 HUL DRS OBJECT 175844 o File level URNs are automatically given to files with the role DELIVERABLE Revised June 2 2013 Batch Builder 2 Beta User Guide Page 98 of 131 These URNs will have a local authority path e g urn 3 FHCL Loeb Faids mus00023 11 Processing Batches Using Command Line Interface 11 1 Basic command line syntax 11 2 Switches 11 3 Deposit settings properties 11 4 Object properties 11 5 Directory properties The Batch Builder 2 installation package includes a command line interface tool CLI designed for automated deposit workflows that performs three actions e build build the descriptors and batch xml for a
124. if you have more than one object in the batch f Save your project Project gt Save on main menu 6 Copy files into batch object directories on disk done outside Batch Builder mow 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 Tf using mapping txt this is when you should copy it to the auxiliary object path in the project Tf 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 section Preparing externally generated METS file for import into Batch Builder 2 at the top of section 6 3 8 Rename the PDS METS file s to correspond to BB external mapping files naming scheme See section Preparing externally generated METS file for import into Batch Builder 2 at the top of section 6 3 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 Revise
125. 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 Tf using mapping txt this is when you should copy it to the auxiliary object path in the project Tf including external MODS descriptive metadata this is when you should copy it to the auxiliary object path in the project 7 Process the batch a 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 Processing messages will appear in the messages pane b When the batch is successfully processed you will see the following message FINISHED Creation of batch xml and descriptors complete for batch 8 Upload batch to dropbox a Open your SFTP client and log into your DRS2 training dropbox account b Change to the incoming directory c Upload the batch copy the entire batch directory to the incoming directory d Close the SFTP client Batch processing will start 9 Check load report in email a Open your email inbox b Look for message from drs2 support with subject DRS LOAD REPORT For a more readable report open the attached text file in Excel or just copy the file listing and paste into Excel If y
126. ight click on Object Template in Project Panel tree The new directory name will start with image but you can append a custom suffix 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 Revised June 2 2013 Batch Builder 2 Beta User Guide Page 39 of 131 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 a 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 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 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 A
127. ile Add a master directory a Right click on OBJECT TEMPLATE in the Project Panel on the left and select the add a directory menu option Type archival_master or a similar suffix that describes the role for your directory in the text box The directory name will start with image but the name you type will be appended to it So typing archival_master will result in a directory called image archival_master In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose LOWUSE for Usage Class Add additional metadata optional a b C d Select the new directory in the Project Panel on the left In the Content Panel select the optional tab Scroll down to Still Image File Metadata Enter any file level optional metadata in the form Role select ARCHIVAL_MASTER Add a nested directory for derivative e g a directory for deliverable images Right click on the directory you just created in the Project Panel on the left and select the add a directory menu option Revised June 2 2013 Batch Builder 2 Beta User Guide Page 26 of 131 g Type deliverable or a similar suffix that describes the role for your directory in the text box The directory name will start with image but the name you type will be appended
128. ile needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created File to object HAS COLOR PROFILE OBJECT file has an associated color profile object in the DRS A DRS ID or a DRS URN of the color profile object needs to be entered in the directory level Revised June 2 2013 Batch Builder 2 Beta User Guide Page 116 of 131 metadata panel in Content Panel of Batch Builder in order for this relationship to be created Note that the Color Profile Content Model is not supported by Batch Builder 2 yet HAS TARGET OBJECT file has an associated target object in the DRS A DRS ID or a DRS URN of the target image object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created Note that the Target Image Content Model is not supported by Batch Builder 2 yet HAS WORLD REFERENCE OBJECT file has an associated world file object in the DRS for GIS objects A DRS ID or a DRS URN of the world file object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS LICENSE file has an associated license object in the DRS A DRS ID or a DRS URN of the license object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS HARVA
129. ile s into corresponding object directori es y on disk Process the batch Upload batch to dropbox 12 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 filel tif filel 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 filel tif filel jp2 filel jpg filel txt filel xml o 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 filel__1 Jpg file2__2 4pg etc Check Section 1 2 2 of this Guide for more information about setting file name patterns in BB Alternatively instead of supplying appended sequence numbers you can provide them
130. iles BatchBuilder BatchBuilder 2 0 17 Type bathcbuildercli a build p project_directory_path b batch_directory_name e g batchbuildercli a build p E My Project b batchl Optional add additional parameters to the bathcbuildercli command to substitute batch object and directory level properties For more information see section 11 Processing Batches Using Command Line Interface Revised June 2 2013 Batch Builder 2 Beta User Guide Page 86 of 131 d When the batch is successfully processed you will see the following messages Building PREMIS file metadata Building HulDrsAdmin file metadata Success If you see any error messages at the end of batch processing remedy the errors and re process the batch you can disregard any errors showing during batch processing on command line as long as you get the final Success message 10 3 Build an advanced audio batch command line This is a description of the procedure to build an advanced audio batch using Batch Builder 2 advanced mode Use this method if you plan to deposit audio files along with additional supporting files containing technical and structural metadata about your audio such as ADL audio decision lists AES 57 technical metadata files and AES 60 structural files playlists for governing audio playback If you do not need to deposit these files with your audio use the procedures described in se
131. iles to Supply ownerSuppliedNames Page Sequence Numbers and Aleph IDs 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 or local accession numbers or an ALEPH ID Procedure Start at Step 5 if you are reusing a project to generate a new batch 1 Create new project in Batch Builder a From main menu select Project gt New b 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 c Click OK to continue Enter DRS deposit settings a Click on Deposit Settings in Project Panel tree b Enter deposit data in the form 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 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 Click on Object Template in Project Panel tree b Enter required object metadata in the form DRS Owner Code your owner code use all caps DRS
132. inux or CMD on Windows change to the BB installation directory e g cd C Program Files BatchBuilder BatchBuilder 2 0 17 Type bathcbuildercli a build p project_directory_path b batch_directory_name e g batchbuildercli a build p E My Project b batchl Optional add additional parameters to the bathcbuildercli command to substitute batch object and directory level properties For more information see section 11 Processing Batches Using Command Line Interface When the batch is successfully processed you will see the following messages Building PREMIS file metadata Revised June 2 2013 Batch Builder 2 Beta User Guide Page 42 of 131 Building HulDrsAdmin file metadata Success If you see any error messages at the end of batch processing remedy the errors and re process the batch you can disregard any errors showing during batch processing on command line as long as you get the final Success message 6 3 3 Use externally generated METS file to build structure rich PDS objects This is a description of the procedures to build structure rich PDS objects using externally generated METS files This method is best to use when additional structure i e custom section nodes needs to be added to a PDS object before DRS deposit Structure rich PDS objects can be built using the BB manual object building option as well as using the BB automatic object building option
133. ion 12 Using External Mapping Files to Supply ownerSuppliedNames Page Sequence Numbers and Aleph IDs for more information Decide what you will use for Owner Supplied Names OSNs for your object and the digital image files it consists of For instance you could use local classification or local accession numbers or an ALEPH ID Make sure that the object OSNs are supplied for each file by one of the following methods o Append the object prefix to each file name the syntax is ob jprefix fileBaseName __ pageSeq ext Set the desired file name pattern objects in the BB Options dialog see section 1 2 2 for more information o Supply an external mapping file that maps each file to object see section 12 1 for more information Procedure Start at Step 5 if you are reusing a project to generate a new batch 1 Create new project in Batch Builder a From main menu select Project gt New Revised June 2 2013 Batch Builder 2 Beta User Guide Page 38 of 131 b Enter project data C 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 PDS document value from the dropdown Click OK to continue 2 Enter DRS deposit settings a b Click on Deposit Settings in Project Panel tree Enter deposit data in
134. ised June 2 2013 Batch Builder 2 Beta User Guide Page 37 of 131 6 3 2 Automatically build PDS objects from template This is a description of the procedure to automatically build a batch of PDS Document objects from template using Batch Builder 2 BB Use this method if you have more than two PDS Document objects in your batch Procedure summary pt SON a ee ee a Create a new project Enter DRS deposit settings Create object template Add directories to template Move copy files into template directory Create an new object batch Process the batch What you need before you start Prepare a batch of page images and optionally accompanying machine readable text files 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 filel t if filel jp2 and filel jpg The file names of text files should match the file names of the page images files as well e g filel tif filel jp2 filel jpg filel txt Make sure all the files names have appended PDS sequence numbers The syntax used in BB2 fileBaseName __ sequence_number extension E g filel__1 jpg file2__ 2 jpg etc Alternatively instead of supplying appended sequence numbers you can provide them via the external mapping file called mapping txt See sect
135. ision lists and AES 60 structural metadata files for governing audio playback If you do not need to deposit ADL or AES 60 files with your audio use the procedures described in sections 10 1 or 10 2 instead Manually create objects without using the template In this method rather than using the template you fill out object and file metadata and create object directories for each individual object one object at a time 10 1 Manually create audio objects from template This is a description of the procedure to manually create a batch of Audio objects from template in Batch Builder 2 BB Use this method when only Audio objects need to be created processed in Batch Builder BB and deposited into the DRS If you have many over 10 objects to create use the procedure to build objects automatically Procedure summary SO oor ST OY Se eS Create a new project Enter DRS deposit settings Create object template Add directories to template Create new object batch Move copy files into corresponding directories on disk Process the batch Upload the batch to your dropbox Check the email report What you need before you start Prepare several audio files and put them in a directory of your choice somewhere on local hard disk or network drive If you have more than one audio file per recording e g an archival Revised June 2 2013 Batch Builder 2 Beta User Guide Page 78 of 131 master and a deliverable or an archival maste
136. ject Content Model select the still image value from the dropdown Project Description optional Any information relevant to the project will only remain locally Click OK to continue 2 Enter DRS deposit settings a b Click on Deposit Settings in Project Panel tree 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 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 3 Create object template Metadata added at this level will be applied to every object in a batch unless overridden by specific object metadata that you define in later steps a b Click on Object Template in Project Panel tree Enter required object metadata in the form DRS Owner Code your owner code use all caps DRS Billing Code your billing code use all caps Object Access the DRS access flag 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 nrsadmintest lib harvard edu 9012 nrs status html URN Resource Name Pattern use default value n to generate a unique number Revised June 2 2013 Bat
137. k href text mydoc__1 txt File path syntax note The file path style Linux Mac vs Windows in the x link attribute needs to correspond to the computer operating system on which BB is being run If BB is run on Windows the file path should use Windows style slashes Revised June 2 2013 Batch Builder 2 Beta User Guide Page 43 of 131 image arch image deliverable mydoc__1 jp2 If BB is run on Linux or Mac the file path should use the Linux Mac style slashes image arch image deliverable mydoc__1 jp2 b Optional The file name in xlink href needs to be modified if you plan to add an object OSN prefix to file names For every file referenced in xlink href attribute in the lt filesec gt section of the provided METS file The file names should be updated in the following way If original file names were mydoc__1 tif mydoc__1 jp2 and mydoc_1 txt and the object OSN prefix was added to the left and the page sequence number was added to the right so that the new file names are obj 1 mydoc__1 tif obj1 mydoc__1 jp2 and obj1 mydoc__1 txt the xlink href attributes should be updated to read xlink href 1mage arch obj1 mydoc__1 tif xlink href 1mage arch image deliverable obj1 mydoc__1 jp2 xlink href text obj1 mydoc__1 txt where obj1 is the object OSN prefix Name the PDS METS file s to correspond to BB naming scheme The METS file s should be named in the following way obj_name _mets xml Example If the original
138. k on your keyboard to select role ARCHIVAL_MASTER and role DELIVERABLE Note that in order to get a delivery URN on deposit an audio file needs to have a role DELIVERABLE set in BB If there are two or more audio files per object e g a separate file for archival master and a separate file for deliverable Create a directory for an archival master and nest one or more deliverable directories inside it this is needed for BB to determine the derivative relationship a Right click on Object Template in the Project Panel on the left to add a directory this will be the directory for archival master The directory name starts with audio but you can append a custom suffix In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose LOWUSE for Usage Class In the Content Panel switch to Optional tab scroll down to Audio File Metadata and select role ARCHIVAL_MASTER In the Project Panel on the left right click on the directory you just created and create another directory nested inside it this will be the directory for deliverable audio Once again append a custom suffix to directory name if needed e g audio deliverable In the content panel choose no from the dropdown list for the field First Generation in DRS Choose HIGHUSE for Usage Class
139. le extension For example the file at my_batch 19a326 my_object A299ff archival sub_dir1 file1 properties would contains metadata for the file at my_batch 19a326 my_object A299ff archival sub_dir1 filel wav Revised June 2 2013 Batch Builder 2 Beta User Guide Page 96 of 131 10 3 3 Batch Builder Execution The syntax is batchbuildercli sh advanced audio d path to object directory where the path to object directory is a relative or absolute path to the directory containing the content needed to build a single audio object For example batchbuildercli sh advanced audio d home prod content my_batch 19a326 obj 994533 The program will Create a directory at workspace moved_content Put a copy of the files that were in the misc directory in the workspace moved_content directory Zip up the contents of the misc directory and name it misc_files zip Create the object descriptor for the audio content o The AES57 file at original xml will be interpreted as technical metadata for the original item to be stored in a lt sourceMD gt element in the descriptor o If any AES60 files were included in the playlist directory o Build separate Text objects for each playlist The file name will be used as the object owner supplied name Create the object descriptor for each object The descriptor will be named object OSN _descriptor xml and will be written to the batch directory Relationships between the pl
140. le in project_dir _aux batch_name object_name directory The MODS file will be accessed by BB during batch processing when batch xml and object descriptor is created Examples of valid MODS 3 4 XML file http www loc gov standards mods mods guidance html Procedure for importing a MODS file Extracting MODS from HOLLIS or VIA using PRESTO If there is cataloging for an object in HOLLIS or VIA you can use PRESTO to extract a MODS version of the record Since metadata extracted with PRESTO conforms to MODS version 3 4 the MODS file will be accepted as is by the DRS2 batch loader without additional changes 1 Identify the ID of the record you want to extract 2 Construct a PRESTO request url for the record For HOLLIS http webservices lib harvard edu rest mods hollis record_id_goes_here For VIA http webservices lib harvard edu rest mods via record_id_goes_here 3 Paste the PRESTO request url into a browser The MODS XML file for the record will display If you don t see the XML view source 4 Use the browser s Save As option to save the xml file to a local directory Before using the file in Batch Builder you must rename it to obj_name _mods xml where obj_name is the object s owner supplied name OSN Note about VIA A PRESTO request for VIA will return the record with all components e g a work plus all surrogates Typically what you need for object level description in DRS2 is an individual surr
141. le with its future object See Naming Rules for Objects for how to add an object name prefix See Using mapping txt file for how to create a mapping file In the automatic workflow files with the same role archival master deliverable text layout are copied into the corresponding role based directory In a later step Batch Builder will use the object name prefix for each file to create object directories and move files for each object into these directories Copy your PDS METS file into the Note if you need to check where the 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 template directories in the Batch Builder project panel Tf using mapping txt this is when you should copy it to the auxiliary template path in the project Tf including external MODS descriptive metadata this is when you should copy it to the auxiliary template path in the project 6 Place PDS METS file s into corresponding template directory The file s should be placed into the directory project _aux template 7 Adjust PDS METS file s for ingest by BB See section Preparing externally generated METS file for import into Batch Builder 2 at the top of section 6 3 8 Rename the PDS METS file s to correspond to BB external mapping files naming scheme See section Preparin
142. list is in use Failure to supply a unique OSN in these cases will prevent access to these files There are three ways of supplying a file OSN 1 Use file name for file OSN When using this option set the file name pattern preferences for generating file OSNs in Batch Builder Options menu See Section 1 2 2 for more information 2 Supply file OSNs using an external mapping file To find out more about using mapping files see section 12 Using External Mapping Files to Supply ownerSuppliedNames Page Sequence Numbers and Aleph IDs of this document 3 Supply file OSNs on Command Line Interface CLI during batch processing For more details about CLI see Processing Batches Using Command Line Interface in this Guide Recommendations for file owner supplied names e Owner supplied names should not exceed 100 characters e Only alpha numeric characters and these symbols should be used underscores _ and hyphens Object owner supplied names Object owner supplied name object OSN serves as an identifier that can be used to link objects deposited into the DRS with local information about them such as local accession numbers or classification numbers Each object requires an owner supplied name Revised June 2 2013 Batch Builder 2 Beta User Guide Page 16 of 131 Tip Within a DRS owner code the object Owner Supplied Name must be unique There are four ways of supplying object OSNs 1 Enter Object OSN ma
143. m 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 Revised June 2 2013 Batch Builder 2 Beta User Guide Page 55 of 131 ees AN p p Create object template Add directories to template Add metadata Save your work Create a new object batch Move copy files into corresponding directories on disk 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 2 3 Create a new project Open BB by double clicking on the executable b From the Project menu select New c Inthe 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 Enter DRS deposit settings a Select Deposit Settings in Project Panel on the left and then enter inform
144. mage Project E P Still Image Project Project Description Deposit Settings 5 T TEMPLATE S O image archival_master i image production_master Content panel displays project level object C image deliverable jp2 level and directory level metadata as well as O image deliverable_jpeg ES image deliverable_gif contents of reports and configuration files that 2B batch_stil_img were selected in the left panel batch xml S 0 obj1 image archival_master Batch Name Pattern owner _ depasitAgent _ batchDin_ yyyyXmokdd descriptor xml amp 0 obj2 Success Email 5 H image archival_master vitaly_zakuta harvard edu Project panel displays project configuration components as well as batch directories associated with the project D Failure Email obi2 00000002xb TIF pa Revised June 2 2013 Batch Builder 2 Beta User Guide Page 10 of 131 The following image shows more details about the project panel Project Panel Project directory gt amp P still Image 2010 07 19 Deposit Settings Object template 5M emare p Batch directory a eee O image archmaster 5 B imgbatch_2010 07 19 n batch xml lt Batch xm I file for this batch Object direct pet tease ee eee E E o imgobject_w_rel_to_World_loc_file 5 0 image archmaster File directory a ee ae d obji 00000001xb T Object descriptor descriptor xml reports ____
145. mapping file 1 Create a text file called mapping txt If your batch contains multiple objects file mappings for all objects can go in this one file 2 Add a line of mapping values for every file to be mapped using the syntax relative_file_path file_OSN PDS_sequence_number optional object_OSN optional AlephID optional Revised June 2 2013 Batch Builder 2 Beta User Guide Page 112 of 131 Example that maps file OSN only image archivalmaster 379129 tif ac1234 image archivalmaster image deliverable 379 129 jpg ac5678 3 Save the mapping txt file Add the mapping file to the batch 1 If using the manual object workflow a Cc Create the batch with objects Step 5 in the batch procedure This will generate batch directory structure on disk Copy mapping txt into the object directory inside the BB project s auxiliary _aux path project_dir _aux batch_name object_name If you have file mappings for multiple objects in a batch place a copy of the same file into each corresponding object directory inside the BB project s auxiliary _aux path Continue with your batch procedure 2 If using the automatic object workflow a C Add directories to the template and copy content files into those directories Steps 4 5 in the batch procedure Place mapping txt into the template directory in the BB project s auxiliary _aux path project_dir _aux template Continue with your batch p
146. ment_PDFs In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose HIGHUSE for Usage Class Add additional metadata optional a Select the new directory in the Project Panel on the left b In the Content Panel select the optional tab C Scroll down to Still Image File Metadata Revised June 2 2013 Batch Builder 2 Beta User Guide Page 68 of 131 d Enter any file level optional metadata in the form 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 Add additional metadata optional a b c d Select the new directory in the Project Panel on the left In the Content Panel select the optional tab Scroll down to Still Image File Metadata Enter any file level optional metadata in the form Role select ARCHIVAL_MASTER Save your work Project gt Save on main menu 6 Copy files into Batch Builder template directory on disk can be done outside Batch Builder a b C The directories you created in BB have been created on disk in the project s template path project_name template In order to tell BB which object each file should end up with you need to either add object name prefixes to ea
147. menu select Project gt New b 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 appropriate value opaque from the dropdown c Click OK to continue Enter DRS deposit settings a Click on Deposit Settings in Project Panel tree b Enter deposit data in the form 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 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 a Click on Object Template in Project Panel tree Revised June 2 2013 Batch Builder 2 Beta User Guide Page 59 of 131 b Enter required object metadata in the form DRS Owner Code your owner code use all caps DRS Billing Code your billing code use all caps Object Access the DRS access flag Set value to N no access c Enter optional admin and descriptive metadata to the object template Click the optional tab Notable metadata at this level d Admin category assign a category to every object A curator assigned label such as an exhibit name project name e
148. n removing Unselected by default If this option is checked the object and directory contents are removed from disk when removed from within BB This applies to Template directories as well When this option is not selected directories will remain on your local computer but will disappear from the BB2 project window Revised June 2 2013 Batch Builder 2 Beta User Guide Page 6 of 131 e Copy files when dragging and dropping onto project tree Selected by default BB 2 introduces drag and drop functionality for files If this option is checked when files are dragged and dropped from a directory on disk onto a file directory in the BB Project Panel the files are copied rather than moved 1 2 2 File name pattern options for generating file OSNs Batch Builder allows users to set file name pattern options to be used when either automatically building objects from template or creating objects manually Note that this option should not be used in conjunction with using external mapping files to supply file OSNs an alternate method of supplying file OSNs The following file name pattern can be set these persist for each Batch Builder project 7 Derive File OSN from File Name Full file name pattern objectNamePrefix baseName__pageSeq ext objectNamePrefix only required in automatic object creation ___ pageSeg only required in PDS object batches Use full file name minus ext as file OSN Use baseName as file OSN Use base
149. n the DRS A DRS ID or a DRS URN of the license object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS HARVARD POLICY file has an associated Harvard Policy object in the DRS A DRS ID or a DRS URN of the Harvard Policy object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS STATUTE file has an associated statute object in the DRS A DRS ID or a DRS URN of the statute object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS DOCUMENTATION OBJECT file has an associated documentation object in the DRS A DRS ID or a DRS URN of the documentation object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created Object to object HAS LICENSE object has an associated license object in the DRS A DRS ID or a DRS URN of the license object needs to be entered in the object level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS HARVARD POLICY object has an associated Harvard Policy object in the DRS A DRS ID or a DRS URN of the Harvard Policy object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order
150. n the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose LOWUSE for Usage Class In the Content Panel switch to Optional tab scroll down to Audio File Metadata and select role ARCHIVAL_MASTER In the Project Panel on the left right click on the directory you just created and select the add a directory menu option In the text box type deliverable or a similar suffix that describes the role for your directory In the Project Panel on the left select the directory you just created In the Content Panel choose no from the dropdown list for the field First Generation in DRS Choose HIGHUSE for Usage Class Revised June 2 2013 Batch Builder 2 Beta User Guide Page 80 of 131 8 9 1 In the Content Panel switch to Optional tab scroll down to Audio File Metadata and select role DELIVERABLE Note that in order to get a delivery URN on deposit an audio file needs to have a role DELIVERABLE set in BB m If you have more deliverables that are derived from the archival master an mp3 deliverable and an mp4 deliverable for instance right click on the topmost audio directory you created add a custom suffix if needed and follow steps g i once again Save your work Project gt Save on main menu Create new object batch a Select Batch gt New from the main menu
151. next to the Batch icon to expand it it will show the icon for the new object 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 additional optional metadata for example descriptive metadata roles or and relationships that will apply to your object For more about optional metadata see sections 14 Adding Relationships 15 Adding Descriptive Metadata 16 Adding Licenses Documentation and Other Supporting Content Note that metadata entered at the object level will override metadata entered at the template level Repeat if you have more than object 6 Move copy files 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 a b Copy the files into corresponding file directories in the object directory Repeat if you have more than one object 7 Process the batch a 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 Builder will start processing the batc
152. ng record in ALEPH Batch Builder uses this number to pull metadata from the corresponding ALEPH record into the MODS section of the object descriptor This switch can be used with action build Example aleph ob3j1 12345 0bj2 67890 Note that no other methods of entering aleph id or MODS should be used for the batch if this switch is invoked such as mapping files with ALEPH IDs user supplied MODS files descriptive metadata entered in the GUI or ALEPH IDs supplied in the GUI otherwise BB will throw an error or silently fail to write the new ALEPH ID into the descriptor batchprop property value property value property value optional overrides specified project deposit settings for a given batch The batchprop argument must be wrapped in quotes to ensure that the entire string is passed correctly to Batch Builder Each property value pair should be separated by a comma Repeatable batch property values should be as property value pairs separated by a comma e g batchprop successEmail success 1 example com successEmail success2 example com objectprop object_name property value property value optional overrides specified object metadata properties for given objects The objectprop argument must be wrapped in quotes to ensure that the entire string is passed correctly to Batch Builder Each property value pair should be separated by a comma dirprop object_name directory_path pr
153. nships csv file the paths need to be in the form supported by the OS you are running Batch Builder on Derivative audio content relationships deliverable performances file 1 mp3 HAS_SOURCE RELATIVE_PATH production sub_dir1 file1 wav deliverable performances file2 mp3 HAS_ SOURCE RELATIVE_PATH production sub_dir1 filel wav deliverable performances file3 mp3 HAS_SOURCE RELATIVE_PATH production sub_dir1 file2 wav Revised June 2 2013 Batch Builder 2 Beta User Guide Page 92 of 131 deliverable performances file4 mp3 HAS_ SOURCE RELATIVE_PATH production sub_dir1 file2 wav Place this file at the same file system level as the object directory e g my_batch 19a326 my_object A299ff audio properties relationships csv Note that the following relationships are automatically determined by Batch Builder and should not be listed in the relationships csv file HAS_DOCUMENTATION relationships between audio files and audio decision lists deposited at the same time HAS_PRESENTATION relationships between audio deliverable files and AES60 playlist objects deposited at the same time If manually supplying descriptive metadata create a MODS file called mods xml complying with MODS schema versions 3 4 or earlier See http www loc gov standards mods for more information about MODS metadata and schemas Place this file at the same file system level as the object directory e g my_batch 19a326 my_object A29
154. ntax is obj osn file_name extension or provide object assignment for your file in an external mapping file For more details about providing object prefixes for your files see section 1 2 2 For more details about external mapping files see section 12 1 Procedure 1 2 Create a new project a Open BB by double clicking on the executable b From the Project menu select New c Inthe 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 text from the dropdown click OK to continue Enter DRS deposit information a Select Deposit Settings in Project Panel on the left and then enter information in the Content Panel on the right b Enter email address es for DRS Reports to be sent to Revised June 2 2013 Batch Builder 2 Beta User Guide Page 74 of 131 0 mf o rh Type the email in Success Email field and press Enter on the keyboard Type the email in Failure Email field and press Enter on the keyboard For more email addresses repeat c and d Choose success method email is the most commonly used Enter HUID of the person who will be making DRS deposits will be recorded in DRS metadata for each batch 3 Create object template called batch template in BB 1 a Select Object Template in Project Panel on the left and then enter in
155. nually when creating a new object in Batch Builder Note that you have to create a batch first before you can create a new object For the procedure see a subsection Manually create content model objects from template in a section on how to create object batches of a given content model in this Guide e g 5 1 Manually create still image objects from template in section 5 Creating and processing still image object batches 2 Have BB create object OSNs for you when it is building object batches automatically from template In this case you need to add object name prefix to file names the syntax is 1 for all objects except PDS Document Objects object_osn filename extension 2 for PDS Document Objects object_osn filename _ _ pageSeq extension or supply mapping txt file in order for BB to associate files with objects For the procedure see a subsection Automatically build content model objects from template in a section on how to create object batches of a given content model in this Guide e g 5 2 Automatically build still image objects from template in section 5 Creating and processing still image object batches See also Section 1 2 2 for additional information on setting file name patterns in the BB Options dialog 3 Supply object OSN using Command Line Interface CLI during batch processing Note that to use this option you need to have an existing o
156. ny metadata entered at the object level will override metadata entered at the template level In the Command Line Interface a In the command line window Terminal on Mac or Linux or CMD on Windows change to the BB installation directory e g cd C Program Files BatchBuilder BatchBuilder 2 0 17 Type bathcbuildercli a buildtemplate p project_directory_path b batch_directory_name Example batchbuildercli a buildtemplate p E My Project b batch1 Note that batch_directory_name is the name of your new batch directory to be created by BB If the batch creation is successful you will see the following messages Initializing BB Done Creating batchl and objects from files in the template Success 7 Process the batch You can process your batch in the Graphical User Interface GUD or using the Command Line Interface CLI In the Graphical User Interface a 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 Builder will start processing the batch When the batch is successfully processed you will see the following message FINISHED Creation of batch xml and descriptors complete for batch If you see any error messages remedy the errors and re process the batch In the Command Line Interface a In the command line window Terminal on Mac or L
157. o deposit supporting content to the DRS follow the creating a batch procedure in this guide for one of the following DRS content models e Still Image e Document e Text After you created your supporting content batch choose one of the following roles for your supporting objects before they are processed by BB select one of these roles in the Content Panel on the right while the object is selected in the Project Panel on the left e DOCUMENTATION e DONOR_AGREEMENT e FINDING_AID e HARVARD_POLICY e LICENSE e STATUTE Process the batch and deposit it to the DRS Once your supporting content batch is deposited get the DRS ID or the DRS URN of your supporting object from the batch report and after you created your regular content batch select your object in the BB Project Panel on the left and enter the ID of URN of the supporting object into one of the following relationship fields in BB in the Content Panel on the right under the Optional tab before processing the batch e Harvard Policy Other Rights Documentation block in Content Panel under the Optional tab e License Other Rights Documentation block in Content Panel under the Optional tab e Statute Other Rights Documentation block in Content Panel under the Optional tab e Has Documentation last field at the bottom of the Content Panel under the Optional tab Process your regular content batch and deposit it to the DRS You objects are now linked to the supporting
158. o object directories Before this can happen you need to rename your files to add special object name file prefixes or provide mapping files that associate files with their objects See section 8 2 for the procedure Manually create objects without using the template In this method rather than using the template you fill out object and file metadata and create object directories for each individual object one object at a time This method is useful when object properties such as Owner Code Billing Code and URN authority path are different for each object Because this option will be rarely used it is not currently documented 8 1 Manually create document objects from template This is a description of the procedure to create a simple batch of Document PDF objects from template in Batch Builder 2 BB Use this method when only several document objects need to be created processed in Batch Builder BB and deposited into the DRS If you have many over 10 objects to create use the procedure to build objects automatically Procedure summary OY AW ee Ge a Create a new project Enter DRS deposit settings Create object template Add directories to template Create a new object batch Move copy files into corresponding directories on disk Process the batch What you need before you start Prepare several PDF files and put them in a directory of your choice somewhere on local hard disk or network drive Decide what y
159. object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created Object to object HAS LICENSE object has an associated license object in the DRS A DRS ID or a DRS URN of the license object needs to be entered in the object level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS HARVARD POLICY object has an associated Harvard Policy object in the DRS A DRS ID or a DRS URN of the Harvard Policy object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS STATUTE object has an associated statute object in the DRS A DRS ID or a DRS URN of the statute object needs to be entered in the directory level metadata panel in Content Panel of Batch Builder in order for this relationship to be created HAS DOCUMENTATION OBJECT object has an associated documentation object in the DRS A DRS ID or a DRS URN of the documentation object needs to be entered in the object level metadata panel in Content Panel of Batch Builder in order for this relationship to be created Revised June 2 2013 Batch Builder 2 Beta User Guide Page 121 of 131 15 Adding Descriptive Metadata 15 1 Importing an Aleph record 15 2 Entering data in the GUI 15 3 Importing from a MODS file In DRS 2 descriptive metadata can be added to an object It i
160. objects Text objects and Opaque objects in FDS http fdstest lib harvard edu 9001 fds deliver file_id E g http nrstest harvard edu 903 1 urn 3 H LIB 216776 To view Audio objects in SDS http sdstest lib harvard edu 9007 sds audio file_id E g http sdstest lib harvard edu 9007 sds audio 1028926 Click on the Flash Player button to play the audio in your browser To view objects using URNs http nrstest harvard edu 903 1 urn 3 nrs_authority_path resource_name E g http nrstest harvard edu 903 1 urn 3 HUL OIS 194271 Revised June 2 2013
161. ocess the batch you can disregard any errors showing during batch processing on command line as long as you get the final Success message 9 Creating and Processing Text Object Batches 9 1 Manually create text objects from template 9 2 Automatically create text objects from template There are three methods you can use to create Text objects in Batch Builder 1 Manually create objects from template This is best when you have only one or two Text objects to work with In this scenario you generate in BB an object structure for each object and then copy files into it done outside BB See section 8 1 for the procedure Automatically build objects from template This method is best for large batches of objects over 10 objects In this scenario BB generates object structure for each of your objects and moves files into object directories Before this can happen you need to rename your files to add special object name file prefixes or provide mapping files that associate files with their objects See section 8 2 for the procedure Manually create objects without using the template In this method rather than using the template you fill out object and file metadata and create object directories for each individual object one object at a time 9 1 Manually create text objects from template This is a description of the procedure to manually create a batch of Text objects from template in Batch Builder 2 BB Use
162. ogate description Before inserting a VIA MODS file into your batch you may need to edit the file to remove surrogate descriptions that do not apply to the object you are depositing Full details about using PRESTO are available in the PRESTO Data Lookup User Guide http hul harvard edu ois systems webservices lookup userguide Creating MODS from scratch using a template It is easiest to create a MODS file from scratch by starting with a valid MODS template and inserting your descriptions For DRS2 beta testing you can use a MODS full record example from the Library of Congress MODS web site http www loc gov standards mods mods guidance html 1 Create a text file called obj_name _mods xml where obj_name is the object s owner supplied name OSN 2 Select a sample MODS record on the LC site http www loc gov standards mods v3 mods userguide examples html Copy the entire LC MODS record and paste into your local MODS file 4 Add descriptions to the template as needed Remove elements that are not needed 5 Save the file Revised June 2 2013 Batch Builder 2 Beta User Guide Page 124 of 131 Adding a MODS file to the batch 1 If using the manual object workflow a c Create the batch with objects Step 5 in the batch procedure This will generate batch directory structure on disk Copy the MODS file into the object directory inside the BB project s auxiliary _aux path project_di
163. ome active e Stop creation of batch xml stops the creation of batch that is being currently processed this command is only active while a batch is being processed Object menu P Batch Builder Image Batch from FAL batch1 Project Batch Object View Help a a messages e New create new object this command is only active if you first select a batch icon of a given batch in which object needs to be created in the BB2 Project Panel Create a new batch with objects from template e Create a new batch with objects from template create a new batch of objects automatically from template See the Automatically build object type from template section for a given object type in this Guide for procedure E g 5 2 Automatically build still image objects from template View menu all Batch Builder Image Batch from FAL Project Batch Object Yiew Help a ci R Options Clear messages M messages Reload tree Toolbar e Options view the options dialog See section 1 2 Setting options for more information e Clear messages clears messages from the messages panel e Reload tree reloads the Project Panel tree useful when you want to see the latest changes made in the project panel and R e Toolbar show hide toolbar with action icons Revised June 2 2013 Batch Builder 2 Beta User Guide Page 12 of 131 Help menu Project Batch Object View Help a c
164. on in the Content Panel on the right b Enter email address es for DRS Reports to be sent to c Type the email in Success Email field and press Enter on the keyboard d Type the email in Failure Email field and press Enter on the keyboard e For more email addresses repeat c and d f Choose success method email is the most commonly used g Enter HUID of the person who will be making DRS deposits will be recorded in DRS metadata for each batch Create object template called batch template in BB 1 a Select Object Template in Project Panel on the left and then enter information in the Content Panel on the right b Enter DRS Owner Code for objects you will be depositing use all caps c Enter DRS Billing Code for objects you will be depositing use all caps d Select DRS Access Flag value for objects you will be depositing Use P for Beta testing e Enter the URN Authority Path for your objects Look up your Path here if needed http nrsadmintest lib harvard edu 9012 nrs status html use all caps f Enter URN Resource Name Pattern Use the default value of n for Beta testing g Optional Switch to optional tab in the Content Panel to enter any additional optional metadata for example descriptive metadata roles or and relationships that will apply to your objects For more about optional metadata see sections 14 Adding Relationships 15 Adding Descriptive Metadata
165. operty value property value optional overrides specified file metadata property values for given files The dirprop argument must be wrapped in quotes to ensure that the entire string is passed correctly to Batch Builder Each property value pair should be separated by a comma 11 3 Deposit settings properties batch properties Syntax batchprop property value property value property value e projectName substitutes passed string for the existing BB project name e projectDescription substitutes passed string for the existing content of the project description field Revised June 2 2013 Batch Builder 2 Beta User Guide Page 100 of 131 e batchName substitutes passed string for the default batch name not the batch directory name E g batchprop batchName mybatch E g batchprop batchName depositAgent batchDir ss e successEmail substitutes passed string for success email s emails should be separated by comma without any blank space in E g batchprop successEmail myname example com myname2 example2 com between e failureEmail substitutes passed string for failure email s E g batchprop failureEmail myname example com myname2 example2 com e successMethod substitutes passed string for the successMethod specified in deposit settings panel in the GUI The options E g batchprop successMethod ema are email all dropbox il e depositAgen
166. or the procedure Automatically build objects from template This method is best for large batches of objects over 10 objects In this scenario BB generates object structure for each of your objects and moves files into object directories Before this can happen you need to rename your files to add special object name file prefixes or provide mapping files that associate files with their objects See section 5 2 for the procedure Manually create objects without using the template In this method rather than using the template you fill out object and file metadata and create object directories for each individual object one object at a time This method is useful when object properties such as Owner Code Billing Code and URN authority path are different for each object Because this option will be rarely used it is not currently documented 5 1 Manually create still image objects from template This is a description of the procedure to manually create a batch of Still Image objects from template in Batch Builder 2 BB This method is a good choice when creating a batch with a small number of objects To create a batch with many objects over 10 the automatic object creation procedure may be more efficient Procedure summary ne 00 al Oy a a eS a Create a new project Enter DRS deposit settings Create object template Add directories to object template Create a new batch and objects Move copy files into corresponding
167. ority2 nameNamePart2 nameNamePartType2 nameDisplayForm2 nameA ffiliation2 MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information 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 Revised June 2 2013 Batch Builder 2 Beta User Guide Page 104 of 131 information nameType3 name Authority3 nameNamePart3 nameNamePartT ype3 nameDisplayForm3 nameA ffiliation3 MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods user
168. ors and re process the batch you can disregard any errors showing during batch processing on command line as long as you get the final Success message Revised June 2 2013 Batch Builder 2 Beta User Guide Page 77 of 131 10 Creating and Processing Audio Object Batches 10 1 Manually create audio objects from template 10 2 Automatically build audio objects from template 10 3 Build an advanced audio batch There are four methods you can use to create Audio objects in Batch Builder 1 Manually create objects from template This is best when you have only one or two Audio objects to work with In this scenario you generate in BB an object structure for each object and then copy files into it can be done outside BB See section 10 1 for the procedure Automatically build objects from template This method is best for large batches of objects over 10 objects In this scenario BB generates object structure for each of your objects and moves files into object directories Before this can happen you need to rename your files to add special object name file prefixes or provide mapping files that associate files with their objects See section 10 2 for the procedure Use Batch Builder advanced audio functionality to build an advanced audio batch Use this method if you plan to deposit audio files along with additional supporting files containing technical and structural metadata about your audio such as ADL audio dec
169. ou see any error messages remedy the errors and re process the batch Revised June 2 2013 Batch Builder 2 Beta User Guide Page 23 of 131 5 2 Automatically build still image objects from template This is a description of the procedure to automatically build a batch of still image objects from template using Batch Builder 2 BB Use this method if you have a large number of objects more than 10 that need to be created and your source files are not broken into directories by object Procedure summary 3O GO a CON Sw ee a Create a new project Enter DRS deposit information Create the object template Add directories to the object template Repeat steps in 4 for additional nested directories if needed Save your work Move copy images into the object template Create a new object batch Process the batch What you need before you start Prepare digital images 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 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 image 1 tif image 1 jp2 and image 1 jpg Decide what you will use for owner supplied names for image objects and the digital image files they consist of For instance you could use local classification or local accession numbers Consult section 3 Naming rules for files objects and directories of this
170. ou will use for Owner Supplied Names for Document objects and the digital files PDFs they consist of 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 Revised June 2 2013 Batch Builder 2 Beta User Guide Page 63 of 131 Procedure Start at Step 5 if you are reusing a project to generate a new batch 1 Create new project in Batch Builder a b C From main menu select Project gt New 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 TIP use project as part of the directory name to make it easier to identify later e g software_documentation_project Content Model select the document value from the dropdown Project Description optional Any information relevant to the project will only remain locally Click OK to continue 2 Enter DRS deposit settings d e Click on Deposit Settings in Project Panel tree 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 appear on DRS deposit reports Success Email type email and press enter Failure Email type email and press enter Succe
171. over 10 that need to be created and your source files are not broken into directories by object Procedure summary SO 2008 St Oy ON ee Dl a Create a new project Enter DRS deposit settings Create object template Add directories to template Move copy files into template directories Add object name prefix to file names or supply a mapping txt file Create new object batch Process the batch Upload the batch to your dropbox 10 Check the load report in email What you need before you start Prepare audio files 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 object e g an archival master and a deliverable or an archival master a production master and a deliverable make sure the file names match e g music l aif music 1 wav and music 1 mp3 Consult Naming Rules section of this Guide for more information on file and directory naming Decide what you will use for Owner Supplied Names for your objects and the files they consist of For instance you could use local classification or local accession numbers See section 3 of this Guide for more information about owner supplied names Make sure you either provide object name prefix for each file to specify which objects it should be assigned to The syntax is obj osn file_name extension or provide object assignment for your file in an external mapping file For more details about pr
172. oviding Revised June 2 2013 Batch Builder 2 Beta User Guide Page 82 of 131 object prefixes for your files see section 1 2 2 For more details about external mapping files see section 12 1 Procedure 1 Create a new project a Open BB by double clicking on the executable b From the Project menu select New C 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 audio from the dropdown click OK to continue 2 Enter DRS deposit settings a s a p Select Deposit Settings in Project Panel on the left and then enter information in the Content Panel on the right Enter email address es for DRS Reports to be sent to Type the email in Success Email field and press Enter on the keyboard Type the email in Failure Email field and press Enter on the keyboard For more email addresses repeat c and d Choose success method email is the most commonly used Enter HUID of the person who will be making DRS deposits will be recorded in DRS metadata for each batch 3 Create object template called batch template in BB 1 a Select Object Template in Project Panel on the left and then enter information in the Content Panel on the right Enter DRS Owner Code for objects you will be depositing use all caps c Enter DRS
173. p 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 nameNamePartT ype MODS Metadata see Revised June 2 2013 Batch Builder 2 Beta User Guide Page 103 of 131 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 nameA ffiliation 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 nameAuth
174. ple Type of problem File not found drs2dev dropboxes ois2dev incoming MissingDataFile WhatISaidBefore image beethoven3 jpg Cause The specified file could not be found in the batch Upload the missing file re upload batch xml then disconnect from the dropbox 8 Batch directory directory path contains no objects Sample Type of problem Batch directory drs2dev dropboxes ois2dev incoming DefectiveBatchDotXML contains no objects Cause The specified directory is missing from the batch Re process in Batch Builder and upload the new batch to the dropbox 9 Descriptor file failed XML schema validation Sample Type of problem Descriptor file failed XML schema validation cvc complex type 2 4 a Invalid content was found starting with element amdSecXXXXXXXXXXXXXX One of http www loc gov METS metsHdr http www loc gov METS dmdSec http www loc gov METS amdSec http www loc gov METS fileSec http www loc gov METS structMap is expected Cause The specified descriptor xml file failed schema validation due to invalid content Re process in Batch Builder and upload the new batch to the dropbox 10 Could not parse batch xml Sample Type of problem Could not parse batch xml Cause This error condition indicates xml in the batch file is not well formed and is usually related to bad character data Revise the file and upload again Revised June 2 2013 Batch Builder 2 Beta User Guide Page 131
175. ppear on DRS deposit reports 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 3 Create object template Metadata added at this level will be applied to every object in a batch unless overridden by specific object metadata that you define in later steps a b C Click on Object Template in Project Panel tree Enter required object metadata in the form DRS Owner Code your owner code use all caps DRS Billing Code your billing code use all caps Object Access the DRS access flag 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 nrsadmintest lib harvard edu 9012 nrs status html URN Resource Name Pattern use default value n to generate a unique number Switch to optional tab to enter any optional metadata for example descriptive metadata roles and relationships that will apply to your objects For more about optional metadata see sections 14 Adding Relationships 15 Adding Descriptive Metadata 16 Adding Licenses Documentation and Other Supporting Content 4 Add directories to template In automatic object workflow you create role based directories archival master deliverable and in a later step Ba
176. project Enter DRS deposit settings Create object template Add directories to template Create a new object batch Move copy files into corresponding batch directories on disk Process the batch Upload batch to dropbox 208 po Sl OY ee e a Check load report in email What you need before you start e 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 filel tif filel jp2 Revised June 2 2013 Batch Builder 2 Beta User Guide Page 33 of 131 and filel jpg The file names of text files and XML layout Alto files should match the file names of the page images files e g filel tif filel jp2 filel jpg filel txt filel xml Make sure all the files names have appended PDS sequence numbers The syntax used in BB2 fileBaseName __ sequence_number extension E g filel__1 Jpg file2__2 4pg etc Check Section 1 2 2 of this Guide 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 12 Using External Mapping F
177. r _aux batch_name object_name If you have MODS files for multiple objects in a batch do the same for each Continue with your batch procedure If using the automatic object workflow a C Add directories to the template and copy content files into those directories Steps 4 5 in the batch procedure Place the MODS file into the template directory in the BB project s auxiliary _aux path project_dir _aux template If you have MODS files for multiple objects in a batch place all of them in the template directory Continue with your batch procedure When BB processes the batch an INFO message displays in the message panel when the MODS file is discovered e g INFO Imported XML from object skating_mods xml Revised June 2 2013 Batch Builder 2 Beta User Guide Page 125 of 131 16 Adding Licenses Documentation and Other Supporting Content In DRS 2 supporting content such as licenses documentation finding aids donor agreements etc can be deposited along with the regular content and linked to from the regular content In order to link regular content objects to supporting content in the DRS the supporting content needs to be deposited first After supported content is deposited the supporting object DRS ID or DRS URN can be used to link it to the regular content Use the corresponding relationships fields in BB to link regular objects to supporting content when creating a regular content batch T
178. r a production master and a deliverable make sure file names match e g music 1l aif music 1 wav and music 1 mp3 Consult Section 3 of this Guide for more information on file and directory naming e Decide what you will use for Owner Supplied Names for your objects and the files they consist of For instance you could use local classification or local accession numbers See Section 3 for more information about owner supplied names Procedure 1 Create a new project a b C Open BB by double clicking on the executable From the Project menu select New 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 audio from the dropdown click OK to continue 2 Enter DRS deposit settings a z o ao mh Select Deposit Settings in Project Panel on the left and then enter information in the Content Panel on the right Enter email address es for DRS Reports to be sent to Type the email in Success Email field and press Enter on the keyboard Type the email in Failure Email field and press Enter on the keyboard For more email addresses repeat c and d Choose success method email is the most commonly used Enter HUID of the person who will be making DRS deposits will be recorded in DRS metadata for each batch 3 Create object template called
179. ra comma needs to be inserted between the FILE OSN value and Object OS Example audio_archival master 379129 aif FILEOSN1 Obj1 audio_archival master 4541 102 aif FILEOSN2 Obj2 audio_archival master audio_deliverable 379129 mp3 FILEOSN1 Obj 1 audio_archival master audio_deliverable 4541102 mp3 FILEOSN2 Obj2 7 Create a new object batch You can create your new object batch in the Graphical User Interface or using the Command Line Interface CLI In the Graphical User Interface a From the Object menu in BB select Create a new batch with objects from template enter the name of the batch directory to be created on disk and click OK A new batch icon will be added to the Project Panel on the right icon with a red letter B and new objects will be built that are going to be part of this batch Revised June 2 2013 Batch Builder 2 Beta User Guide Page 85 of 131 In the Project Panel click on the next to the Batch icon of the batch you just created to expand the tree it will show the icons for the new objects a blue letter O Optional Select each object icon in the Project Panel and edit any needed metadata for instance if each object has a separate corresponding Aleph record you can switch to the Optional tab in the Content Panel on the right while the object icon is selected in the Project Panel on the left and enter the Aleph ID for each object in the Aleph ID for MODS import field
180. rocedure 3 When BB processes the batch an INFO message displays in the message panel when the mapping file is discovered for example INFO found mapping txt in C drs2 beta2 training B B BB2 projects 2 0 190 image proj ect _aux batch brueghel skaters 3 object skaters 3 12 2 Using object_mapping txt file File Name ob ject_mapping txt Function The objects contained in the batches processed by Batch Builder will inherit the property values such as Aleph IDs and object owner supplied names specified in the file note that this file is not used for automatic object building This file is accessed by Batch Builder during batch processing generating the batch xml file and the descriptor Placement There is one object_mapping txt file per project It needs to be placed in project_dir _aux template directory It is read in once when the project is opened If you created and placed the file while BB was open you will need to restart BB so that the file can be accessed during batch processing Syntax object_directory_name ALEPH_number Object_Owner_Supplied_Name e Object directory name Required The name of the directory in which object is contained E g birdsofasia Revised June 2 2013 Batch Builder 2 Beta User Guide Page 113 of 131 e Alephid Optional Aleph ID of the HOLLIS record where the object is described Batch Builder imports MODS descriptive metadata from the HOLLIS record specifie
181. s stored in the object descriptor file There are three ways to add descriptive metadata 1 Have Batch Builder import descriptive metadata from an existing ALEPH record 2 Enter descriptive metadata in the Batch Builder GUI 3 Import descriptive metadata from a MODS file 15 1 Importing an Aleph record Batch Builder provides three ways of importing descriptive metadata from an existing ALEPH record 1 Specify Aleph ID in a mapping file see Section 12 Using External Mapping Files for more information 2 Specify Aleph ID on command line see Section 11 Processing Batches Using Command Line Interface for more information 3 Enter Aleph ID in Batch Builder GUI either in object template metadata or in object metadata This option is described below To enter Aleph ID in Batch Builder GUI 1 Obtain the Aleph ID of the record 2 In BB select the object template or the object in the Project Panel on the left Optional shortcut Note that if you are selecting an object you can right click on the object and choose Set Aleph ID from the right click context menu A data entry box will pop up where you can enter the Aleph ID this doesn t work if you are selecting object template You can then skip steps 3 and 4 below i GEScriptor xmi l T o JPCDPEO1076 Add Directory 0 JPCDPEO 1077 Rename Object 0 JPCDPEO 1078 0 JPCDPEO 1079 0 JPCDPEO 1080 Set Aleph ID PS an ee wee ee Sasasa S
182. shack URIs You can alternatively use the same string formatting used in the BB GUI Name for the file not necessarily unique whether or not the file is the closest version in the DRS to the original capture or creation one of yes no unspecified whether or not the file is the recommended file to use for generating future deliverables one of yes no unspecified BIT_REDUCED DENOISED Key actions taken on the file before it was deposited to the DRS comma delimited list of one or more of CROPPED BIT_REDUCED BRIGHTNESS_ADJU STED COLOR_CORRECTE D CONTRAST_ADJUS TED DENOISED DESKEWED DOWN_MIXED DYNAMIC_RANGE_ COMPRESSED EQUALIZED GAMMA_CORRECT Revised June 2 2013 Batch Builder 2 Beta User Guide Page 94 of 131 ED LEVEL_ADJUSTED PHASE_INVERTED PROCESSED SAMPLERATE_CON VERTED SHARPENED quality one of 1 2 3 4 5 6 7 8 9 10 usageClass One of HIGHUSE LOWUSE Estimate of how frequently LOWUSE the file will be accessed by library users methodology any text Notes about the methods performed and or tools used in the creation processing or preparation of the content prior to DRS deposit Locally defined measure of quality role comma delimited list DELIVERABLE of one or more of ARCHIVAL_MASTER CONTAINER DELIVE RABLE DOCUMENT ATION LICENSE LO G ORIGINAL_ORDER PAGE_COORDINAT ES PAGE_IMAGE PA GE_TEXT PRODUCT ION_MASTER STYLE _SHEET TARGET_DE SCRIPTION TARGET
183. ss Method choose how you will receive load report Deposit Agent type your HUID 3 Create object template Metadata added at this level will be applied to every object in a batch unless overridden by specific object metadata that you define in later steps a b Click on Object Template in Project Panel tree Enter required object metadata in the form DRS Owner Code your owner code use all caps DRS Billing Code your billing code use all caps Object Access the DRS access flag 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 nrsadmintest lib harvard edu 9012 nrs status html URN Resource Name Pattern use default value n to generate a unique number Switch to optional tab to enter any optional metadata for example descriptive metadata roles and relationships that will apply to your objects For more about optional metadata see sections 14 Adding Relationships 15 Adding Descriptive Metadata 16 Adding Licenses Documentation and Other Supporting Content Revised June 2 2013 Batch Builder 2 Beta User Guide Page 64 of 131 4 Add directories to template a Right click on Object Template in the Project Panel on the left and select the add a directory menu option Type in a name for your directory in the te
184. ssage will include dropbox name batch directory and batch name along with a message describing the cause of the failure All the digital files associated with an error batch are left in the depositor s batch directory while the batch xml file and the LOADING file are deleted To retry the batch update any corrupt or missing digital files and upload the new batch xml file After you disconnect from the SFTP session your batch will be queued for reloading Below are some common batch loader error scenarios and messages 1 Error in batch xml header Errors in the header of the batch xml file can cause processing to fail before the loader can read the failure email addresses In this case the loader will report the error only to DRS staff in LTS If you submit a batch but receive no load report or error send a message to the DRS2 team in LTS using this form http nrs harvard edu urn 3 HUL OIS drs2help 2 Couldn t find billing code for id billing code Sample Type of problem Couldn t find billing code for id HBS BAKR KRESS_001 Cause The specified billing code is invalid Correct the billing code in Batch Builder and regenerate the batch 3 Owner supplied name OSN already exists for owner code owner code Sample Type of problem Owner supplied name randy pdsobject7 already exists for owner code HUL TEST Cause The specified owner supplied name has already been defined within the specified owner code Correct the OSN in B
185. sssesesssersees 125 18 Interpreting Load Reports sscscossssscssssssssssssssssssssssssssssssssssesesescssees 126 18 1 Successful load teports seniorien a a 126 18 2 Farlure load reports miren ie nen eee eae eked ei ena 129 19 Viewing Your Deposited Objects sscsscsccssssccssscssssscssssscssssssessscesees 131 Revised June 2 2013 Batch Builder 2 Beta User Guide Page 4 of 131 1 Setting Up Batch Builder 1 1 Installing Batch Builder 1 2 Setting options This section provides an overview of Batch Builder features and describes requirements for file names and batch directories 1 1 Installing Batch Builder Batch Builder BB is a Java based application compatible with Windows Mac and Linux operating systems The Batch Builder application package includes a Graphical User Interface GUID and a separate Command Line Interface CLI for automated deposit workflows The application package is bundled as a zip file which must be downloaded unzipped and installed on your computer The Batch Builder 2 Beta zip archive can be downloaded from http hul harvard edu ois systems drs BatchBuilder 2 current zip Recommended System Requirements e Operating System Windows XP Vista 7 Mac OS X 10 5 8 or higher Linux e Processing Power Intel Core 2 13 i5 17 AMD Athlon II Phenom II e Physical Memory 3 GB RAM or higher requires 64 bit Operating system e Java version 1 6 0 or higher Download the latest version
186. t substitutes passed string for the deposit agent HUID specified in deposit settings panel E g batchprop depositAgent 12345 Example C Program Files BatchBui 678 lder BatchBuilder 2 0 14 gt batchbuildercli a build p C Documents and Settings user Desktop stil b batch3 batchprop limage imgs frm via nomods 20110714 bat chName mybatch depositAgent batchDir ss successEmail suc cess me me failureEmail failure me me successMethod email itAgent 12345678 11 4 Object properties Syntax objectprop depos object_namel property value property value object_name2 property value property value etc List of overridable object properties Property Name Definition ownerCode DRS Owner Code billingCode DRS Billing Code accessFlag DRS Access Flag adminCategory Administrative Category ID can be looked up in Word Shack by searching for Admin Category display value captionBehavior IDS PDS Caption Behavior captionUnitName IDS PDS Caption Unit Name captionDescription IDS PDS Caption Description metsLabel METS Label display value currently displays in citation label of PDS Document objects Revised June 2 2013 Batch Builder 2 Beta User Guide Page 101 of 131 methodology Object methodology nonPublicNote Value for the non public note field processingLevel Obje
187. t the right way to rename an object after it was created in BB is to use this menu option Renaming the object directory on disk outside BB is not sufficient and will lead to errors when trying to open the project in BB afterward Object directory context menu Right clicking on the directory icon will open a context menu where you can add a directory nested inside the current directory or remove the current directory 5 B batch1 ee 0 olvwork85592 z i image Add Directory descr i batch xm Bahse 3 Naming Rules for Objects Files and Directories File names on disk Object and batch directory names on disk File owner supplied names Object owner supplied names File names on disk For all files in an object e Maximum number of characters per file name is 100 LTS recommends that file names be kept to 64 characters or less and that the complete_directory_path file_name for each file be kept to 255 characters or less e Valid characters in file names are letters digits underscores _ and hyphens e File names should not contain spaces Files that share a derivative relationship e g a production master tif file and its related deliverable jpg or jp2 file should share the same file name in order for Batch Builder to determine that the relationship exists e g clocktower tif and clocktower jpg Revised June 2 2013 Batch Builder 2 Beta User Guide Page 15 of 131 The file n
188. t to a designated email address or written to the dropbox or both based on preferences specified by the lt successEmail gt and lt successMethod gt elements in the batch xml e If delivered by email the load report message o Will have a Subject line containing the following information Subject DRS LOAD REPORT owner owner_code batch dir batch_directory_name batch batch_name DB batch_id o Will contain the following sections Batch Summary File listing File listing text file attachment e If written to the dropbox the load report text file o Will be located in the top level batch directory with a file name that conforms to the following pattern LOADREPORT_ batch directory name o Will contain these sections Batch Summary File listing Revised June 2 2013 Batch Builder 2 Beta User Guide Page 127 of 131 Remember that object descriptor files descriptor xml are part of each batch in DRS2 For every object in the batch there will be a corresponding descriptor file and these files will be included in the load report summary and file listing About the batch summary The batch summary section includes summary information about the batch Contents of this section include e Batch directory name e Batch name e Depositor e Batch id e Owner s e Batch drop off time e Time waiting to start load e Loading start time e Loading end time e Total load time e Number of objects deposited e
189. tc that can be used to group together a set of objects or files 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 a Add directory right click on Object Template in Project Panel tree Content directories are prefixed with content Documentation directories are prefixed with documentation But you can append a custom suffix to directory name 5 Add metadata click to select the new directory then add metadata to the form a Required First Generation in DRS select yes Usage Class select LOWUSE b Optional Role There are no roles for content files but you can select either DOCUMENTATION or LICENSE roles for documentation files Select any role that applies 6 Save your work Project gt Save on main menu 7 Copy files into Batch Builder template directory on disk The directories you created in BB have been created on disk in the project s template path project_name template In the automatic workflow files are copied into a directory in the template path In a later step Batch Builder will use the object name prefix for each file to create object dir
190. tch Builder will create the objects for you For one image file per object Add directory a Right click on OBJECT TEMPLATE in the Project Panel on the left and select the add a directory menu option Type in a name for your directory in the text box The directory name will start with image but the name you type will be appended to it Tip to make it easier to read start your directory name with an underscore _ So typing _tifs_and_jpegs will result in a directory called image_tifs_and_jpegs Revised June 2 2013 Batch Builder 2 Beta User Guide Page 25 of 131 In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose HIGHUSE for Usage Class Add additional metadata optional a b C d Select the new directory in the Project Panel on the left In the Content Panel select the optional tab Scroll down to Still Image File Metadata Enter any file level optional metadata in the form 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 object e g archival master deliverable you need to create a directory for the master file and a nested sub directory for each derivative f
191. te 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 Tf using mapping txt this is when you should copy it to the auxiliary object path in the project Tf including external MODS descriptive metadata this is when you should copy it to the auxiliary object path in the project 7 Process the batch a 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 b Processing messages will appear in the messages pane c When the batch is successfully processed you will see the following message FINISHED Creation of batch xml and descriptors complete for batch 8 Upload batch to dropbox a Open your SFTP client and log into your DRS2 dropbox account b Change to the incoming directory c Upload the batch copy the entire batch directory to the incoming directory d Close the SFTP client Batch processing will start 9 Check load report in email a Open your email inbox b Look for message from drs2 support with subject DRS LOAD REPORT For a more readable report open the attached text file in Excel or just copy the file listing and paste into Excel Rev
192. ternal MODS descriptive metadata this is when you should copy it to the auxiliary template path in the project 6 Create a new object batch You can create your new object batch in the Graphical User Interface or using the Command Line Interface CLI In the Graphical User Interface a From the Object menu in BB select Create a new batch with objects from template enter the name of the batch directory to be created on disk and click OK A new batch icon will be added to the Project Panel on the right icon with a red letter B and new objects will be built that are going to be part of this batch b In the Project Panel click on the next to the Batch icon of the batch you just created to expand the tree it will show the icons for the new objects a blue letter O c 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 that applies specifically to your object for example descriptive metadata or Aleph ID administrative categories etc Note that any optional metadata that applies to all objects in the batch should be entered in the object template before your batch is created For more about optional Revised June 2 2013 Batch Builder 2 Beta User Guide Page 41 of 131 metadata see sections Adding Relationships Adding Descriptive Metadata Adding Licenses Documentation and Other Supporting Content Note that a
193. text file in Excel or just copy the file listing and paste into Excel 7 Creating and Processing Opaque Object Batches 7 1 Manually build opaque objects from template 7 2 Automatically build opaque objects from template There are two methods you can use to create Opaque objects in Batch Builder 1 Manually create objects from template This is best when you have less than 5 objects to work with In this scenario you generate in BB an object structure for each object and then copy files into it done outside BB See section 7 1 for the procedure 2 Automatically build objects from template This method is best for large batches of objects 5 or more objects per batch In this scenario BB generates object structure for each of your objects and moves files into object directories Before this can happen you need to rename your files to add special object name file prefixes or provide mapping files that associate files with their objects See section 7 2 for the procedure Note that an opaque object can have only one directory named content where all the content files are stored Inside the content directory there can be additional nested directory structures However the word content is reserved and cannot be used in the name of any directories that are part of the opaque object 7 1 Manually build Opaque objects from template This is a description of the procedure to manually create a batch of opaque objects fro
194. the form 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 3 Create object template 4 Note Metadata added at this level will be applied to every object in a batch unless overridden by specific object level metadata that you define in later steps a b Click on Object Template in Project Panel tree Enter required object metadata in the form DRS Owner Code your owner code use all caps DRS 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 nrsadmintest lib harvard edu 9012 nrs status html URN Resource Name Pattern default value n will generate a unique number Enter optional admin and descriptive metadata to the object template Click the optional tab IDS URN for Deliverable JPG and JP2 Select Yes if you need IDS URNs for all deliverable images in the batch Add directories to template In automatic object workflow you create role based directories archival master deliverable and in a later step Batch Builder will create the objects for you For one image file per page image a Add directory r
195. tion 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 ccessCondition 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 accessConditionT ype MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information recordInfoRecordIdentifier MODS Metadata see Revised June 2 2013 Batch Builder 2 Beta User Guide Page 107 of 131 http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more recordInfoSource 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 fora URN role Object role Example 1 C Program Files BatchBuilder BatchBuilder 2 0 14 gt batchbuilder
196. tructure rich PDS objects 42 7 Creating and Processing Opaque Object Batches ssccssssccssssscssrecsees 54 7 1 Manually build Opaque objects from template 0 0 ee eeeeeeeeeneeeeeeeseeeneeeneees 54 7 2 Automatically build Opaque objects from template eee eeeeseeseeereeeneeeneees 57 8 Creating and Processing Document PDF Object Batches ssscee 62 8 1 Manually create document objects from template eee eeeeseecsteceeceeeeeeeees 62 8 2 Automatically create document objects from template eels eeeeceseceeeeees 65 9 Creating and Processing Text Object Batches cssccssssccssssccssssccsssseeees 70 9 1 Manually create text objects from template 00 0 eee eee eeeeeeeeeeeeeseeeaeeeneeenaees 70 9 2 Automatically build text objects from template eee ee eeeeeereeereeereeeeeeneees 73 10 Creating and Processing Audio Object Batches scsssccsssscesssceseeees 77 10 1 Manually create audio objects from template eseeseeeeeeeeeeeeeereereeresreesesrressn 77 10 2 Automatically build audio objects from template eee eeeeeeeereeeneeeneeeeees 81 10 3 Build an advanced audio batch command line eee eeecceceeesreeceeeeeeeeeeeneees 86 10 3 1 Command line syntaxi sive deine Rakha lite shine else intee tite 86 LOPS 22PreparatlOmi sdc c ciscchessilictecslscchesdaleantesiavcesssacdstes NE ENEE eN EE konie aeiee 86 10 3 3 Batch Builder Execution nininini eita
197. 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 Click to select new batch in Project Panel tree Look for red letter B Create new object from template select Object gt 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 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 sections Adding Relationships Adding Descriptive Metadata Adding Licenses Documentation and Other Supporting Content Note that any metadata entered at the object level will override metadata entered at the template level Repeat the previous steps to create additional objects if you have more than one object in the batch Revised June 2 2013 Batch Builder 2 Beta User Guide Page 36 of 131 f Save your project Project gt Save on main menu 6 Copy files into batch object directories on disk done outside Batch Builder ta n Page image files go into an object s image directory Text files go in a text directory Layout files go in a layout directory No
198. via the external mapping file called mapping txt See section 12 Using External Mapping Files to Supply ownerSuppliedNames Page Sequence Numbers and Aleph IDs 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 or local accession numbers or an ALEPH 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 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 1 Create new project in Batch Builder a From main menu select Project gt New b 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 Revised June 2 2013 Batch Builder 2 Beta User Guide Page 45 of 131 C browse for or create a directory Content Model select the value PDS document from the dropdown Click OK to continue 2 Enter DRS deposit settings a b Click on Deposit Settings in Project Panel tree Enter deposit data in the form Success Email typ
199. vised June 2 2013 Batch Builder 2 Beta User Guide Page 69 of 131 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 14 Adding Relationships 15 Adding Descriptive Metadata 16 Adding Licenses Documentation and Other Supporting Content Note that any metadata entered at the object level will override metadata entered at the template level Save the project to have BB2 write the new metadata values to the internal configuration files In the Command Line Interface a In the command line window Terminal on Mac or Linux or CMD on Windows change to the BB installation directory e g cd C Program Files BatchBuilder BatchBuilder 2 0 33 Type bathcbuildercli a buildtemplate p project_directory_path b batch_directory_name e g batchbuildercli a buildtemplate p E My Project b batchl Note that the batch directory name is the name of your new batch directory to be created by BB If the batch creation is successful you will see the following messages Initializing BB Done Creating batchl and objects from files in the template Success 10 Process the batch You can process your batch in the Graphical User Interface G
200. wn list for the field First Generation in DRS Revised June 2 2013 Batch Builder 2 Beta User Guide Page 47 of 131 d 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 a Create new batch select Batch gt 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 b Click to select new batch in Project Panel tree Look for red letter B c Create new object from template select Object gt 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 d 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 sections Adding Relationships Adding Descriptive Metadata Adding Licenses Documentation and Other Supporting Content Note that any metadata entered at the object level will override metadata entered at the template level e Repeat the previous steps to create additional objects
201. ww 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 Revised June 2 2013 Batch Builder 2 Beta User Guide Page 102 of 131 information titleInfoPartNumber titleInfoPartName titleInfoNonSort titleInfoType2 titleInfoTitle2 titleInfoSubTitle2 MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information MODS Metadata see http www loc gov standards mods v3 mods userguide elements html for more information 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 htt
202. x or CMD on Windows change to the BB installation directory e g cd C Program Files BatchBuilder BatchBuilder 2 0 17 Type bathcbuildercli a build p project_directory_path b batch_directory_name e g batchbuildercli a build p E My Project b batchl Optional add additional parameters to the bathcbuildercli command to substitute batch object and directory level properties For more information see section 11 Processing Batches Using Command Line Interface When the batch is successfully processed you will see the following messages Revised June 2 2013 Batch Builder 2 Beta User Guide Page 54 of 131 Building PREMIS file metadata Building HulDrsAdmin file metadata Success If you see any error messages at the end of batch processing remedy the errors and re process the batch you can disregard any errors showing during batch processing on command line as long as you get the final Success message 11 Upload batch to dropbox a Open your SFTP client and log into your DRS2 training dropbox account b Change to the incoming directory c Upload the batch copy the entire batch directory to the incoming directory d Close the SFTP client Batch processing will start 12 Check load report in email a Open your email inbox b Look for message from drs2 support with subject DRS LOAD REPORT For a more readable report open the attached
203. xml and descriptors complete for batch 10 Upload batch to dropbox Open your SFTP client and log into your DRS2 dropbox account Change to the incoming directory Upload the batch copy the entire batch directory to the incoming directory Close the SFTP client Batch processing will start 11 Check load report in email a Open your email inbox Revised June 2 2013 Batch Builder 2 Beta User Guide Page 61 of 131 b Look for message from drs2 support with subject DRS LOAD REPORT c Fora more readable report open the attached text file in Excel or just copy the file listing and paste into Excel Revised June 2 2013 Batch Builder 2 Beta User Guide Page 62 of 131 8 Creating and Processing Document PDF Object Batches 8 1 Manually create document objects from template 8 2 Automatically create document objects from template There are three methods you can use to create Document objects in Batch Builder 1 Manually create objects from template This is best when you have only one or two Document objects to work with In this scenario you generate an object structure in BB for each object and then copy files into the structure can be done outside BB See section 8 1 for the procedure Automatically build objects from template This method is best for large batches of objects over 10 objects In this scenario BB generates object structure for each of your objects and moves files int
204. xt box The directory name will start with document but the name you type will be appended to it Tip to make it easier to read start your directory name with an underscore _ So typing _diary_pdfs will result in a directory called document_diary_pdfs In the Project Panel on the left select the directory you just created In the Content Panel on the right choose yes from the dropdown list for the field First Generation in DRS Choose HIGHUSE for Usage Class Add additional metadata optional a b c d Select the new directory in the Project Panel on the left In the Content Panel select the optional tab Scroll down to Document Object Metadata Enter any file level optional metadata in the form Role use Ctrl Click to select ARCHIVAL_MASTER and role DELIVERABLE Note that in order to get a delivery URN on deposit a file needs to have a role DELIVERABLE set in BB 5 Save your work Project gt Save on main menu 6 Create new batch with objects Metadata added at this level can be applied to a specific object or specific file directory a Create new batch select Batch gt 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 Select the batch with the red letter B in the Project Pan
205. y Place PDS METS file s into corresponding template directory Adjust PDS METS file for ingest to BB Rename the PDS METS file to correspond to BB external mapping files naming scheme Create a new object batch 10 Process the batch 11 Upload batch to dropbox 12 Check load report in email What you need before you start e Prepare a batch of page images and optionally accompanying machine readable text files 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 Revised June 2 2013 Batch Builder 2 Beta User Guide Page 49 of 131 archival master a deliverable and a thumbnail make sure file names match e g filel tif filel jp2 and filel jpg The file names of text files should match the file names of the page images files as well e g filel tif filel jp2 filel jpg filel txt o 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 e Make sure all the files names have appended PDS sequence numbers The syntax used in BB2 filename __ sequence_number extension E g filel__1 jpg file2_ 2 jpg etc Alternatively instead of supplyin

Download Pdf Manuals

Related Search

Related Contents

Dynabeads® mRNA DIRECT™ Micro Kit User Guide  Zum  Moyno® 500 Pump (Service Manual  Juste une petite couchepiqûre, ça ne fera pas mal... et c`est pour  PSE-32HD - Skyfood Equipment LLC    Sony CPD-110EST User's Manual  Bedienungsanleitung  Lightning DSPC-8681E Quad-TMS320C6678 DSP PCI  Beko HTZG 64112 SW  

Copyright © All rights reserved. Failed to retrieve file