Run a campaign

Campaigns play a central role as they help to generate and validate unique IIIF paths to referenced images. The initial CSV file should be correctly configured to help Teklia Spider build valid links.

Configure columns

Once you have created a campaign, a page will help you configure the columns of the CSV file.

Three cases are supported to generate IIIF paths:

  • Defining an Exact path for a row referencing a single image.

  • Defining both Range start and Range end for a row referencing a range of images.

  • Defining an IIIF manifest path referring to a IIIF manifest listing images.

Paths to images are url encoded (e.g. / will be replaced by %2F). They cannot be prefixed with the IIIF server base URL (e.g. https://archi.ve/iiif/2/) nor suffixed by a IIIF endpoint (e.g. /full/full/0/default.jpg). You can remove these values from the metadata CSV defining paths to images, and set IIIF server base URL at campaign’s level in case it is based on an external IIIF server.

IIIF manifest ingestion requires to define parameters related to the external IIIF server used. You can refer to the IIIF manifest section for more information.

Column type Count Values interpretation

Exact path

{0,1}

Exact path to an image (e.g. image_0001.jpg).

IIIF manifest

{0,1}

path to a IIIF manifest (e.g. ark:/1337/vta42/manifest).

Metadata

{0,…​n}

Stored as a metadata ({column name: value}).

Path prefix

{0,1}

Used as a prefix before each image link.

Range start

{0,1}

Path of the first image of a range (e.g. image_0001.jpg).

Range end

{0,1}

Path of the last image of a range (e.g. image_1337.jpg).

Skip

{0,…​n}

Ignored.

Town

{0,1}

Name of the French municipality (Required on Socface projects).

Year

{0,1}

Exact year, between 1700 and 2100 (Required on Socface projects).

Top folder

{0,1}

Named used to group documents (Required on Heritus projects).

Once you think the columns are correctly configured, you can click on Save changes.

Campaign configuration

IIIF manifest

IIIF manifest links can either be complete URLs or suffixes (e.g. ark:/1337/vta42/manifest). In case the file only contains suffixes, you may want to set IIIF manifests base URL to the URL prefix. You can look for collectivities website in order to found the valid base URL for prefixes.

Once both values are correctly set, Teklia Spider will generate links. However, you must set IIIF server base URL in order to see the generated links (e.g. https://archive-collectivity.net/iiif/). This behavior is necessary to link a campaign to a specific IIIF server and ensure images’s path are linked to this server.

Most of time, errors on images generated from an external server are beyond repair.

Ingest images

When a campaign is correctly configured, a list of links will be automatically generated from the first lines of the CSV.

Some attributes are required (e.g. Town and Year for Socface projects, Top folder for Heritus projects) to validate images. An image that is missing one of those attributes will directly be marked as erroneous during the validation process. Metadata should also be defined carrefuly, as they mean valuable information and will be exported to Arkindex.

Once you are sure about the configuration, you can run the validation process on the entire file by clicking on Ingest images.

Campaign links generation

Supervise images validation

When you start the ingestion task on a campaign, you will be redirected to the image statistics page. At the beginning, you may see no data, as the ingestion is done in an asynchronous job.

Campaign ingestion

If you reload the page (e.g. by pressing F5), you will see a progress in images validation:

Image validation

Celery tasks

Tasks related to the ingestion process are visible from https://socface.teklia.com/workers/. The page is accessible via a session-based logging, if you miss the credential please ask an administrator.

The interface displays all the jobs in real time and may contain additional error tracebacks.