artefactual-sdps / temporal-activities

Temporal activities is a library of general purpose activities
Apache License 2.0
1 stars 0 forks source link

Feature: add a reusable, configurable temporal activity for file format validation #20

Open fiver-watson opened 5 months ago

fiver-watson commented 5 months ago

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

Describe alternatives you've considered

Continuing to create custom temporal child workflows for every client? :thinking:

Additional context

It should also make use of any reusable patterns for displaying task outcomes in the Enduro UI that might be developed as part of this Enduro issue 949

Proposed outcome messages:

SUCCESS:

FAILURE:

PREMIS EVENT example:

<premis:event xmlns:premis="http://www.loc.gov/premis/v3" xsi:schemaLocation="http://www.loc.gov/premis/v3 http://www.loc.gov/standards/premis/v3/premis.xsd" version="3.0">
            <premis:eventIdentifier>
              <premis:eventIdentifierType>UUID</premis:eventIdentifierType>
              <premis:eventIdentifierValue>24c64e71-610a-4714-b79d-2a15294ca8a9</premis:eventIdentifierValue>
            </premis:eventIdentifier>
            <premis:eventType>validation</premis:eventType>
            <premis:eventDateTime>2024-05-09T14:19:50+00:00</premis:eventDateTime>
            <premis:eventDetailInformation>
              <premis:eventDetail>name="validate SIP file format against controlled list"</premis:eventDetail>
            </premis:eventDetailInformation>
            <premis:eventOutcomeInformation>
              <premis:eventOutcome>Pass</premis:eventOutcome>
              <premis:eventOutcomeDetail>
                <premis:eventOutcomeDetailNote>Format allowed</premis:eventOutcomeDetailNote>
              </premis:eventOutcomeDetail>
            </premis:eventOutcomeInformation>
            <premis:linkingAgentIdentifier>
              <premis:linkingAgentIdentifierType>URI</premis:linkingAgentIdentifierType>
              <premis:linkingAgentIdentifierValue>https://github.com/artefactual-sdps/temporal-activities/</premis:linkingAgentIdentifierValue>
            </premis:linkingAgentIdentifier>
          </premis:event>
fiver-watson commented 4 months ago

NOTE: after a meeting today (2024-06-05) with SFA to gather feedback on PoC#1, I have edited the desired solution bullet points in the description above, to add 👍

SFA tried running a SIP type not yet supported (a SIARD sample). In reviewing the sample package, we discovered that there are formats included in there that are disallowed for VECTEUR AIPs / SIPs. Consequently, it seems like there will be different allowed / disallowed formats for different SIP types. We should take that into account when designing and developing this feature.