Image Files Delivery

Image files delivery¶

Access to the delivery folder¶

To get access to the delivery folder for your users, please contact openscience@unibe.ch.

Users need to have an existing Campus Account (CA) for employees at the University of Bern. Users need to use their Campus Account credentials to connect to the delivery folder on the Campus Storage share.

Operating System	Path to the delivery folder
Windows	\\nas-ub.unibe.ch\ub-iiif\delivery
Linux, Mac	smb://nas-ub.unibe.ch/ub-iiif/delivery

Prepare a delivery for an import¶

Warning

Important note about naming of your image files

You can name your image files as you like but the name of an image file needs to be unique within a project. As example you can not have two files named image001.tif within a project.

Warning

Important note about the size of your image files

The server can handle a maximal image size of 32'000 x 32'000 pixels. Both width and hight must not exceed 32'000 pixels, otherwise your import task will fail.

Import of multiple images to a specific sequence¶

Create the sequence if it does not already exist. (See Collection View).
Prepare a folder on your storage which contains all images you want to import to a specific sequence. This folder must not have any subfolders.
Use Bagger to create a BagIt compatible folder on your storage.
Choose a meaningful name for the BagIt folder, we recommend to use the project slug (See Project view) as prefix (e.g. my-project_first_import_test).
Move the folder created with Bagger to the delivery folder
Create a new import task for your project, select the transferred folder and don't forget to select the sequence in which you want to import the images (See Create a new import task).
After a successful import task, your data will be deleted from the delivery folder. If an import task fails, the data will stay on the delivery folder (and be deletet after 1 month).

Import of multiple images to multiple sequences¶

Prepare a folder on your storage

Create a hierarchy of subfolders containing the names of the desired collections. Create subfolders with the names of the desired sequences and place the images to be imported there - these subfolders must not contain any further subfolders. There is no need to create a folder with the name of the root collection, the previously created folder can be considered as root.
Example of such a hierarchy:

./prepared-folder
    ./Collection 1
        ./Sequence 1
            ./seq1_image001.tif
            ./seq1_image002.tif
            ./seq1_image003.tif
    ./Collection 1
        ./Sub-Collection 1
            ./Sequence 2
                ./seq2_image001.tif
                ./seq2_image002.tif
            ./Sequence 3
                ./seq3_imageA.tif
                ./seq3_imageB.tif
                ./seq3_imageC.tif
                ./seq3_imageD.tif
        ./Sub-Collection 3
            ./Sequence 4
                ./seq4_image.tif
    ./Sequence 5           <= Note: this sequence will be in the root collection
        ./seq5_1.tif
        ./seq5_2.tif
        ./seq5_3.tif

Use Bagger to create a BagIt compatible folder on your storage.
Choose a meaningful name for the BagIt folder, we recommend to use the project slug (See Project view) as prefix (e.g. my-project_first_import_test).
Move the folder created with Bagger to the delivery folder
Create a new import task for your project, and select the transferred folder (See Create a new import task).
After a successful import task, your data will be deleted from the delivery folder. If an import task fails, the data will stay on the delivery folder (and be deletet after 1 month).

Info

During the import the system will lookup collections and sequences by folder name. If a collection or sequence is not found the system will create a new one with the folder name.

What is BagIt?¶

BagIt is a set of hierarchical file system conventions designed to support disk-based storage and network transfer of arbitrary digital content. A \"bag\" consists of a \"payload\" (the arbitrary content) and \"tags\", which are metadata files intended to document the storage and transfer of the bag. A required tag file contains a manifest listing every file in the payload together with its corresponding checksum. The name, BagIt, is inspired by the \"enclose and deposit\" method, sometimes referred to as \"bag it and tag it\".

Source: https://en.wikipedia.org/wiki/BagIt

Use Bagger to create a BagIt compatible folder¶

See https://github.com/LibraryOfCongress/bagger for downloading and starting the Library of congress Bagger application.

Open the Bagger application
Click on the "Create Bag in Place" Icon
Click on the "..." Icon behind "Select Date"
Open the prepared folder (See Prepare a delivery for an import), ensure you are inside the folder. And click on "Open"
Click on "OK"
The bag is created and you will receive a success message, click on the "OK" button
The Bagger window is now updated
If you open the prepared folder in the file explorer you will now see, that there is a "data" folder where your prepared files/folder where moved and you will see the text files created by Bagger.
Close the Bagger software and move the prepared folder to the file delivery folder (See Access to the delivery folder)
After transfer of the prepared folder you can start the import (See Create a new import task)

Known Bagger problems¶

Negative time¶

It seems that Bagger won't accept negative file created or modified time stamps.

Depending on your operating system, Bagger won't accept date time stamps which are too old.

E.g. on Linux the time stamps are saved in an integer which represents the seconds gone from 01.01.1970 00:00:00 (UTC). Time stamps before this date/time are represented with a negative integer.

This can happen, when the creation date of the scanned item itself is saved in the creation or modified time stamp of the created file.

In this case you need to update the time stamps of your files.

Special characters in the path to the prepared folder¶

It seems that Bagger won't be able to open a prepared folder when there are some special characters in the path (e.g. if the path is in a OneDrive folder). In this case move your prepared to your local disk and ensure that there are no special characters in the path. We also recommend that you only use A-Z, a-z, 0-9, - and _ in the name of your prepared folder.