Web Interface

Web interface for administration

Access to the administration web interface

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

The upload can only be carried out by persons with a Campus Account (CA) for employees: Users need to create a SWITCH edu-ID account and link their Campus Account to the SWITCH edu-ID account. You need to provide the University of Bern email address.

The web interface for administration can be accessed under https://iiif.ub.unibe.ch.

Click on "Sign in" on the top right corner and use your SWITCH edu-ID account to sign in.

If you don't have permission to access the web interface you will receive a 403 Forbidden error - otherwise you will see the following menu:

Projects

This menu item provides you with an overview of the projects to which you are entitled:

Action "Show"

This button opens the Project View and displays the Project Tree on the right side.

Action "Edit"

Here you can change the name and slug of your project, as well as the maximum image compression quality and the maximum edge height and width for the import.

The Slug is relevant if you want to access the IIIF Image API with the source file name of the image (See Using the IIIF Image API).

The maximum image compression quality setting is per default 92%. This optimizes the loading time of the images in the viewer and therefore requires less storage space on the IIIF server. Users will not notice any visual difference between the images. You can change this setting higher or lower, ex. maximum 100% or maximum 85%.

The maximum edge height & width of pixels for the import setting is undefined per default. This means that number of pixels in height and width available before the import is imported. If desired, you can specify a maximum number of pixels for the width or height of your images to be imported before importing.

Please note that both are maximum settings. Images that have lower value before import than the maximum value set during import will keep their original value and will not be artificially scaled up.

Note

Recommended settings for importing: For common formats, we generally recommend importing with a maximum edge length of 10’000 pixels and the default Image Compression Quality of max. 92%. In any case, you should carry out test uploads (with different settings if necessary) before the actual upload.

Action "Delete"

Warning

This action will delete the whole project including all collections, sequences and images of this project

After clicking on "Delete" you have to confirm the action:

Project Tree

As soon as you selected a project in the projects overview page (action "Show") and as long as you are navigating trough the projects collections and sequences you will see the project tree on the right side, which indicates where you are within the project and allows you to quickly jump trough the hierarchy of the project.

Project View

This will show you the project information (id, name, slug, links to the presentation API and the root collection) and also the actions "Edit" and "Delete" which are the same as on the projects overview page.

Action “Search In Project” In the bar you can search for collections, subcollections, sequences and images within your project. Metadata are not searchable with the search bar.]

Presentation API

The buttons will open the URL which delivers the JSON information for the root collection of the project as defined in the IIIF Presentation API v2.1 or v3.

Root collection

This link will open the information page about the root collection (See Collection View)

Action "Edit"

Here you can change the name and slug of your project.

The Slug is relevant if you want to access the IIIF Image API with the source file name of the image (See Using the IIIF Image API).

Action "Delete"

Warning

This action will delete the whole project including all collections, sequences and images of this project

After clicking on "Delete" you have to confirm the action:

Collection View

This view shows you the collection information (project, parent collection, id, name, links to the presentation API, child collections and sequences) and also the actions "Edit", "Move", "Delete", "Export image details", "Add child collection" and "Add sequence".

When the current collection is the root collection, the actions "Move" and "Delete" are not available.

When there are no images found in the collection tree starting from this collection, the "Export image details" button is not available.

Project

A link to the project information (See Project View).

Parent Collection

A link to the parent collection - only if the current collection is not the root collection (See Collection View)

Id

The UUID of the current collection

Name

The name of the current collection

Presentation API

The buttons will open the URL which delivers the JSON information for the current collection as defined in the IIIF Presentation API v2.1 or v3.

Child collections

Links to child collections of the current collection (See Collection View)

Sequences

Links to the sequences of the current collection (See Sequence View)

Action "Edit"

Here you can change the name of the collection.

Action "Move"

When clicking on this button, you will see a pop-up with a tree view of all the collections in the project (except the current one). To move the current collection, click on one of the displayed ones and it will be moved there as a child.

Action "Delete"

Warning

This action will delete the whole collection including all children,sequences and images of this collection

After clicking on "Delete" you have to confirm the action:

Action "Export image details"

Clicking on "Export image details" will generate a CSV with the image details for all images found inside sequences of this collection and in all sequences of successor collections (going down the whole collection tree from this collection on).

Action "Add child collection"

This action adds a new collection as child to the current collection.

Action "Add sequence"

This action adds a new sequence to the current collection.

Sequence View

This view shows you the sequence information (project, parent collection, id, name, number of images, links to the presentation API and containing images) and also the actions "Edit", "Move", "Delete" and "Export image details".

Project

A link to the project information (See Project View).

Collection

A link to the parent collection (See Collection View).

Id

The UUID of the current sequence

Name

The name of the current sequence

# Images

The number of images in the current sequence

Presentation API

The buttons will open the URL which delivers the JSON information for the current sequence (manifest) as defined in the IIIF Presentation API v2.1 or v3.

Images

Links to the images of the current collection (See Image View).

Action "Edit"

Here you can change the name of the sequence.

Action "Move"

When clicking on this button, you will see a pop-up with a tree view of all the collections in the project. To move the current sequence, click on one of the displayed collections and it will be moved there as a child.

Action "Delete"

Warning

This action will delete the whole sequence including all images of this sequence

After clicking on "Delete" you have to confirm the action:

Action "Export image details"

Clicking on "Export image details" will generate a CSV with the image details for all images inside the current sequence.

Image View

This view shows you the image information (project, parent collection, parent sequence, id, source file name, source file size, generated JPEG sizes, links to the image API) and the image itself.

Project

A link to the project information (See Project View).

Collection

A link to the parent collection of the sequence containing the current image (See Collection View).

Sequence

A link to the sequence containing the current image (See Sequence View)

Id

The UUID of the current image

Source file name

The name of the originally imported file

Source file size

The file size of the originally imported file

Generated JPEG sizes

The file size of the generated high quality JPEG files.

There are four pre-generated files: 100%, 75%, 50%, 25% (resolution)

Image API (info)

The buttons will open the URL which delivers the JSON information for the current image (info) as defined in the IIIF Image API v2.1 or v3.

Full image

The buttons will open the URL which delivers the full image in the highest available resolution as defined in the IIIF Image API v2.1 or v3.

Action "Delete"

Warning

This action will delete the current image and its four pre-generated files from the sequence and storage

After clicking on "Delete" you have to confirm the action:

Tasks

This menu item provides you with the possibility to create an import task and getting an overview over the open, completed and failed tasks for the projects you are entitled for.

Whenever the system needs to perform an action that cannot be executed immediately (synchronously), a task is created for this purpose. A task can contain further sub-tasks and, if necessary, generate new tasks.

The administration interface user can generate explicitly an import task and implicitly image deletion tasks (by deleting a sequence, collection or project which contains one or more images).

Create a new import task

This functionality is used to import image files which you delivered on the share or to upload metadata from a csv file on your local system.

Note

Before you start importing, make sure that the project settings are correctly adjusted for your project. How to customize your project settings and corresponding recommendations can be found at Action "Edit" in projects.

First, select the type of data you want to import (Images or Metadata), the project to which you want to import the data and finally click on "Next".

Images import task

Note

See Image files delivery for more information on how to prepare and deliver your image files.

If you selected "images" in previous step, in this step you need to select the path of your folder on the file delivery share. Depending on how you prepared your image files you need to specify a sequence, see prepare-a-delivery-for-an-import.

If you want to override existing images, check the "Override Images" box - otherwise the system will not import existing images but create a warning for each such image in the corresponding task.

Warning

Please be aware that you should only use this function in exceptional cases because the GUID changes: - Links to images that are used with the GUID must be adapted. - Links generated with project slug and filename will continue to work. - Within the Presentation API (manifest), the links to the images are automatically adjusted.

Click "Start" to add a new import task for your import to the Task overview.

Metadata import task

Note

See Metadata for more information on how to prepare and deliver your metadata.

If you selected "metadata" in the previous step, now you need to select the file on your system containing the metadata you want to import. Click on "Choose File" to continue.

After clicking on "Choose File" your system will open a file explorer. Navigate to the desired file and select it.

After selecting the desired file in the file explorer, the file name should appear on the form bar. Now click on "Start" to complete the metadata import task creation.

Task overview

Here you get an overview of all tasks in the projects for which you are entitled.

By clicking on the corresponding columns, you can change the sorting. By clicking on the filter icon, you get the possibility to filter the tasks according to certain criteria.

By clicking on the linked TaskID you will get to the corresponding Task view.

Task view

This view shows you the tasks information (Id, State, IsRunning, Started, Modified, Path, Logs and Subtasks).

The Task view for an incompleted import task will also provide you with a button to cancel the task.

Id

The Id of the Task in the database.

State

The current state of the task.

Possible states are

• New (Task was created but not started yet)
• Started (Task was started)
• Subtasks (Task is waiting for sub-tasks completion)
• Successful (Task was finished successful)
• Interrupted (Task was canceled by user)
• Failed (Task execution failed)

IsRunning

Indicates if the task is currently running or not.

Started

Date and time when the task was first started.

Modified

Date an time when the task information was last modified.

When the task is in state "Successful", "Interrupted" or "Failed" - this is the date and time when the task finally stopped running.

Path

The path associated with the Task (e.g. the import folder for the import task; the path to the source image file for an image validation or image creation task).

Logs

Here you will find task specific log entries. A log entry can have the following types:

• Info: Just gives you neutral information of some kind (e.g. task started)

• Success: Something in the task was successful (e.g. file validation, image generation)

• Warning: Something in the task needs your attention, task itself (and parent task) can still be successful

• Error: Something in the task went wrong, task itself (and parent task) will be failed

Subtasks

This list behaves exactly as the list described under task overview but contains only sub-tasks of the current task.

Storage

This view shows you the storage usage information per project you are entitled for (Current usage and avg usage per year).