1

Packaging Content with Bagger

Customized instructions for the Mandatory Deposit of Serials available Only Online

Version 2.1.2, 04/12/2012

2

What is Bagger

• The Bagger application was created for the U.S. Library of Congress as a tool to produce a package of data files according to the BagIt specification

• BagIt is “a hierarchical file packaging format for the exchange of generalized digital content. A "bag" has just enough structure to safely enclose descriptive "tags" and a "payload" but does not require any knowledge of the payload's internal semantics.”http://tools.ietf.org/html/draft-kunze-bagit-05

• BagIt enables senders and recipients to verify that digital content retained its integrity during the course of a transfer

3

BagIt Structure

1. The basic structure of a BagIt bag is:1. A directory called <bagname>

2. The <bagname> directory contains a subdirectory called data (it must be called “data”). This subdirectory is where the content files are placed

3. The <bagname> directory contains at least two files:1. A manifest that lists the checksum and path for each content file stored in the /data

subdirectory

2. A filed called bagit.txt that indicates the bagit version and character encoding used for creating the bag

4. The <bagname> directory may also contain an optional bag-info.txt file that contains information about the bag contents

myfirstbag/ | -- data | \-- 27613-h | \-- images | |-- q172.png | \-- q172.txt |-- manifest-md5.txt | 49afbd86a1ca9f34b677a3f09655eae9 data/27613-h/images/q172.png | 408ad21d50cef31da4df6d9ed81b01a7 data/27613-h/images/q172.txt

\-- bagit.txt BagIt-version: 0.96 Tag-File-Character-Encoding: UTF-8

4

Determining whether or not to use Bagger

• The following must be true in order for you to use Bagger:

• You are on a desktop machine (windows, linux, mac)

• The content you want to package is accessible through the desktop you are using. That is, it is stored on:

• the local hard drive

• another device attached via USB/firewire,

• CD/DVD• a server whose content is available via NFS or samba*

*Note: if your content is on a server elsewhere and you are interacting with it via windows mapped drive, you might encounter errors or slowness while using Bagger. The ideal situation for bagger is content that is local

5

Determining

– You are running java 1.6 (a.k.a. java6)– To test this, open a web browser and go to http://www.javatester.org/version.html If

you have java6, you will see a pink box with the version number (see image below)– If you do not have the correct version, you can download the correct version from

http://www.oracle.com/technetwork/java/javase/downloads/index.html *note: you need admin privileges to your machine in order to install it properly

Determining whether or not to use Bagger (cont’d)

Pink box with java version 1.6

6

Downloading and Using Bagger

1. Once you have determined that Bagger will be useful to you, go to: http://sourceforge.net/projects/loc-xferutils/files/loc-bagger/ and download the file bagger-2.1.2.zip to your machineNote: You do not need to log into sourceforge in order to download content

2. Unzip the bagger-2.1.2.zip to extract the files contained in it

7

Add the cadedep profile to Bagger{ "Source-Organization" : { "fieldRequired" : true }, "Organization-Address" : { "fieldRequired" : true }, "Contact-Name" : { "fieldRequired" : true }, "Contact-Phone" : { "fieldRequired" : true }, "Contact-Email" : { "fieldRequired" : true }, "External-Description" : { "fieldRequired" : true }, "External-Identifier" : { "fieldRequired" : true }, "Bag-Group-Identifier" : { "fieldRequired" : true }, "Bag-Count" : { "defaultValue" : "NA" }, "Journal-Title" : { "fieldRequired" : true }, "SR-Number" : { "fieldRequired" : true }, "ISSN" : { "fieldRequired" : false }, "LC-Project" : { "defaultValue" : "edep" }, "LC-Items" : { "fieldRequired" : false }}

1. If you received a file called cadedep-profile.json along with these instructions, skip to step 6

2. The cadedep profile looks like this (see right)

3. If you are viewing this presentation in powerpoint, place your cursor in the box to the right and select all the text

4. Paste the selected text into a text editor such as notepad

5. Select “Save as” and use name “cadedep-profile.json” and save as type “All files (*.*)”Note: if you save it as a txt file, it might end up with an additional .txt extension on it that would keep it from working with Bagger

6. Copy the file cadedep-profile.json to your /user/bagger or /Documents and Settings/user/bagger directory**You will see other profiles there, including eDeposit, World Digital Library and NDNP. The eDeposit profile does not include the extra fields in cadedep, but it can be used in place of cadedep if necessary

8

Open Bagger

1. Once you have decided on your profile and taken needed steps to set up the profile on your computer, you are ready to create a bag

2. Go to your bagger-2.1.2 directory

3. In windows: Double-click on the bagger.bat Windows Batch file to open BaggerIn Linux/Ubuntu: Execute the bagger.sh file

2

3

9

Bagger Splash Screen

10

What you see when Bagger Opens

11

1. Select “Create New Bag” 2. The “New Bag Dialog” box will pop up. Select Bag Version 0.96 and cadedep

profile

Step 1: Create a Bag

1

2

12

Bag Window

1. After you create a new bag using the cadedep profile, this is what you will see*Note: The field order might be different from what is shown below. This is fine. Order doesn’t matter

13

Step 2: Add Information for Bag-Info

1. Fill out the fields as indicated above. (note: not all fields on right are displayed in the screenshot above. You can use the scroll bar in the Bag-Info window in Bagger to scroll down to see the continuation of your bag-info file)

Organization-Address: 101 Main St., Sometown, VA 22010LC-Project: edepSR-Number: 1-484267820Source-Organization: Foo PressExternal-Description: Journal of Foo Studies: Vol. 1, Issue 1LC-Items: 1 issue, 12 articlesProfile-Name: cadedepBag-Count: NAContact-Name: Joe FooContact-Phone: 202-707-xxxxContact-Email: joe.foo@foopress.comExternal-Identifier: http://foopress.com/jfs/vol1iss1.htmlBag-Group-Identifier: 1-484267820Journal-Title: Journal of Foo StudiesISSN: [ISSN]

14

Step 3: Add Content Files to the Bag

1. Click on the Green + sign to add files to your bag. This will open “Add File or Directory” window2. In the “Add File or Directory” window, browse to the content on your machine and select it (if you

want to include multiple files and/or directories, hold down the Ctrl while making your selection) If you are sending zipped folders, unzip them before adding those folders to the payload.

3. Click “Open” to add those files to the bag

1

2 & 3

15

Add Content Files to the Bag cont’d

1. The files/directories you added will appear in the “Payload” section of the main window

2. Please note, if you are planning to upload your files via the eCO web page, there is a limit of 900MB per session. Please ensure that each bag is 900MB or less. You can check this by viewing the bag-size field in the profile. This field is not visible until you have saved the bag.

12

16

Step 4a: Save the Bag

1. Click on the “Save Bag As” icon at the top of the main screen. This will bring up the “Save Bag Dialog” window

2. Click on the “Browse” button in the “Save Bag Dialog” window to choose where on your computer to save the bag

3. Use the SR# for the bag name

1

2

17

Step 4b: Select How to Save the Bag

1. Save in: [this is the path and bag name you created in the previous step]2. Holey Bag: [leave blank]3. Serialize type: [Select zip—you will be creating a zipped bag]4. Generate tag manifests: Yes [default, checked]5. Tag Manifest Algorithm: md5 [default]6. Generate Payload Manifest: Yes [default, checked]7. Payload Manifest Algorithm: md5 [default]8. Click OK to save the bag.

You will see popups that indicate the job is running and whether or not the bag was successfully created and verified

18

Bag Saved

1. If the bag contains all the information required by the cadedep profile, the green “Profile Compliant” box will be checked

1

19

Making Sure a Bag is Valid and Complete

1. A bag is considered complete if every file listed in the manifests is present, and if every file is accounted for in a manifest.

2. A bag is considered valid if it is complete and if each checksum matches the checksums at the time the bag was created

20

Step 5: Validate the Bag

1. Validating the bag will ensure that the bag was created properly according to the BagIt spec that the checksum values of the content files match the values from when the bag was created

2. Click on the “Validate Bag” icon to check the validity of the bag.3. You can see if the bag is Complete, Valid and Profile Compliant in the “Console”

section of the window

2

3

21

Bag Saved

1. Once Bagger indicates that your bag was created and successfully verified, you should see a zip file (named like SR-Number.zip) in the path where you placed it

2. The bag and its contents are what is compressed within the zip file

1

2

22

Close Bag

1. Click on Close Bag to close the bag you just created

2. If asked to save the existing bag, select Yes

1

2

23

Send the zipped bag to the Library of Congress

1. Follow the instructions provided in the email sent with your Notice for Mandatory Deposit.

2. For more detailed instructions on uploading files via the eCO website, please see the Mandatory Deposit Tutorial. Once your files have been uploaded, please remember to select the upload complete button on your title profile. This will transfer your files to Library.

24

TROUBLESHOOTING

25

"Could not find the main class. Program will exit"

1. If you got this error after double clicking on the bagger2.1.2.jar file to start Bagger, then double click on the bagger.bat file to open the program instead

26

“An error occurred during startup”

1. If you added the cadedep-profile.json file to your /user/bagger or /Documents and Settings/user/bagger directory and you get a message that says “An error occurred during startup”, it could be due to a mistake in the json file.

2. If this happens, remove the cadedep-profile.json file from the /user/bagger directory and try to run Bagger again. If it opens without error, there is something wrong with the cadedep-profile.json file itself. Repeat the steps on slide 6 to see if it will work

3. If it continues not to work, then delete the cadedep-profile.json file from your /user/bagger directory and create a bag using the edep profile instead. (This profile comes included in bagger)

27

If Bag-Info Field Names or values are missing after Save Bag or when previously created bag is opened in Bagger

1. This is an error in the display that is being corrected. The values themselves should still appear in the actual bag-info.txt file, so the bag is correct.

2. To verify that the fields are present in the actual bag-info.txt file, open the bag-info.txt file in a text editor. You should see all the information, even if it does not show up in the Bagger software display