Versions Compared

Version Old Version 3 New Version Current
Changes made by

Alexis Rombaut

Alexis Rombaut

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: draw.io diagram "validator connectors" edited

This optional feature is part of version 25.2 and is subject to change

Introduction

The purpose of validator connectors is to allow for selective validation of certain /wiki/spaces/CS/pages/4340187164 by checking their validity and optionally their adherence to certain profiles (for example a PDF validator that only allows PDF 1/A files).

Configuration

A validation connector has the following additional properties beyond the general https://mediahaven.atlassian.net/wiki/spaces/CS/pages/4438884395/Module+Plugins#Properties

Property

Description

Default

Required

Example

Formats

  • The list of pronom formats for which to call this validator

  • An empty list implies all formats

[ ]

No

[“x-fmt/387”, “x-fmt/388”, “x-fmt/399”]

Premis event type

The premis event type to generate for finished validation

VALIDATION

No

VALIDATION.VERA-PDF

Workflow

During the Ingest Flows of the object, a new validation step is added that does the following

  1. Obtain the list of validation connectors that apply to the object (based on whether the module plugin is active for the organisation and applies to the source pronom format)

  2. For each validator

    1. Call the validator using the connector https://mediahaven.atlassian.net/wiki/spaces/CS/pages/4763779092/ValidatorValidation+Connectors#API-Contract asynchronously

  3. For each validator

    1. Asynchronous wait for the validation to complete

    2. Collect the response of the validator connector

    3. Log the result of the validator as one of the Events (include both positive and negative evaluations)

  4. If at least 1 validator declared the object invalid, reject the object as a whole

Info

The validation connectors work asynchronously because the validation can potentially take a long time to complete.

Schematic

Drawio sketch
mVer2
simple0
zoom1
inComment0
pageId4763779092
custContentId4763549746
diagramDisplayNamevalidator connectors
lbox1
contentVer23
revision23
baseUrlhttps://mediahaven.atlassian.net/wiki
diagramNamevalidator connectors
pCenter0
width1502.005859375
links
tbstyle
height687.2252197265625

API Contract

API

Method

Purpose

Properties

Validation Connector API

POST /validate

Starts the asynchronous validation of the object. Instantly returns the 200 OK to confirm the reception of the validation request.

  • The execution ID of the ingest workflow that is suspended

  • The metadata of an object

  • The URL of the original representation

Engine workflow REST API

POST /asynchronous/<execution-id>PUT records/:recordId/jobs/:jobId

with status Accept, Reject

Requires function TBD

  • Resume the asynchronously

paused workflow and provide

  • pending worker daemon job

  • Provides the validation result and message

  • Creates a premis event

  • The message (the validation message)

  • The job status (the validation result)

  • The premis event type

  • Custom properties