Skip to main content

Using SAF Builder


File at the Ready

SAF Builder uses CSV files

The first column in the CSV file needs to be filename (All lowercase)

The rest of the file can be created like a normal SHAREOK file. This means, include the last field osu.filename as the last field.

If a record has supplemental material (attached items), use double pipes ( || ) in the filename column to separate the files. Place the main file first and the supplement files after it. 

Running SAF Builder

If you are on a Windows 10 machine, right-click your Windows icon on your taskbar. On the screen that pops up, click Run.

A Window pops up and asks what you would like to Open:

Type in cmd. This will bring up a Command Prompt window.

  • Note: At this point, the premise is that you have already downloaded and installed SAFBuilder and are ready to use it. If not, please go to the link to the guide below.
  • Note: If you want to use this program, you have to understand some basic command line scripting

Once the Command Prompt opens up, change the directory (cd) to the folder where you installed your SAFBuilder.

  • example: If installed on Desktop, to get from C:\Users\me>, I type cd Desktop\SAFBuilder-master. My new location will be C:\Users\me\Desktop\SAFBuilder-master>

To use the program in Windows, make sure that the slash (back-slash vs. forward slash) is the correct one.

To run SAFBuilder, you need to run the .bat file against the .csv file. You are now in the correct location to run the .bat file, but you need to target the .csv file with an absolute path and the argument -c, which calls for the file.

  • example:

C:\Users\me\Desktop\SAFBuilder-master>safbuilder.bat -c T:\Digitization\filename.csv

Once the command has been run, you will have a new folder, labeled SimpleArchiveFormat, in your folder where your .csv file is located. This folder will contain the number of folders per item listed in your .csv file. Each folder should contain at least four records:

  • the listed item being uploaded
  • a file labeled contents with no extension
  • dublin_core.xml
  • metadata_osu.xml

Check for any errors.

Zip SimpleArchiveFormat:

  • Right-click the folder SimpleArchiveFormat, hover over 7-Zip and select Add to "SimpleArchiveFormat.zip"

Batch Import (ZIP)

Go to https://shareok.org

Login to SHAREOK

Under the Content Administration menu, on the left side, click on Batch Import (ZIP). You will be greeted with this screen:

You can either click on the Choose File button and locate your file, or you can grab your newly created ZIP folder and dragged it on top of the Choose File button.

Select the collection that the files will be going into.