Difference between revisions of "Fixity checking and reporting"
Jump to navigation
Jump to search
(Created page with "Main page > Development documentation > Requirements > Fixity checking and reporting This wiki page describes requirements for gathering fixity check information ...") |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Main | + | [[Main Page]] > [[Documentation]] > [[Requirements]] > Fixity checking and reporting |
| + | |||
| + | <div style="padding: 10px 10px; border: 1px solid black; background-color: #F79086;">This page is no longer being maintained and may contain inaccurate information. Please see the [https://www.archivematica.org/docs/latest/ Archivematica documentation] for up-to-date information.</div><p> | ||
This wiki page describes requirements for gathering fixity check information from the [https://github.com/artefactual/fixity | Fixity app] and reporting through the Archivematica Storage Service. | This wiki page describes requirements for gathering fixity check information from the [https://github.com/artefactual/fixity | Fixity app] and reporting through the Archivematica Storage Service. | ||
| + | |||
| + | [[Category:Feature requirements]] | ||
==Requirements== | ==Requirements== | ||
| Line 8: | Line 12: | ||
* Add script to send email alerts to administrator(s) when a fixity check fails | * Add script to send email alerts to administrator(s) when a fixity check fails | ||
| + | |||
| + | ==Mockups== | ||
| + | |||
| + | ===Storage Service packages tab=== | ||
| + | |||
| + | [[File:Fixity_report_SS.png|700 px]] | ||
| + | |||
| + | Two columns are added to the Storage Service packages tab: | ||
| + | |||
| + | * Fixity Date, showing the date and time that the fixity check was run | ||
| + | * Fixity Result, showing the outcome (Succeeded or Failed) with links to tool output in cases of failures or errors (successful fixity scan reports are empty) | ||
| + | |||
| + | ===Fixity Results: Failed=== | ||
| + | |||
| + | Failures should be reported as such if they are actual fixity failures, or if there were errors in the tool. | ||
| + | |||
| + | '''In the case of a fixity failure''' the report should have the following: | ||
| + | |||
| + | * Date/time that fixity was run | ||
| + | * AIP UUID | ||
| + | * Which files (names, UUIDs) failed fixity check | ||
| + | |||
| + | '''In the case of an error''' the report should have the following: | ||
| + | |||
| + | * Date/time that fixity was run | ||
| + | * AIP UUID | ||
| + | * Nature of the error- for example: | ||
| + | |||
| + | "data/objects/no_such_file exists in manifest but not found on filesystem" | ||
| + | |||
| + | (Source: https://github.com/artefactual/archivematica-storage-service/blob/stable/0.7.x/storage_service/locations/models/package.py#L742-L762) | ||
Latest revision as of 16:24, 11 February 2020
Main Page > Documentation > Requirements > Fixity checking and reporting
This page is no longer being maintained and may contain inaccurate information. Please see the Archivematica documentation for up-to-date information.
This wiki page describes requirements for gathering fixity check information from the | Fixity app and reporting through the Archivematica Storage Service.
Requirements[edit]
- Modify Storage Service to record time and results of fixity checks by adding columns to packages tab
- Add script to send email alerts to administrator(s) when a fixity check fails
Mockups[edit]
Storage Service packages tab[edit]
Two columns are added to the Storage Service packages tab:
- Fixity Date, showing the date and time that the fixity check was run
- Fixity Result, showing the outcome (Succeeded or Failed) with links to tool output in cases of failures or errors (successful fixity scan reports are empty)
Fixity Results: Failed[edit]
Failures should be reported as such if they are actual fixity failures, or if there were errors in the tool.
In the case of a fixity failure the report should have the following:
- Date/time that fixity was run
- AIP UUID
- Which files (names, UUIDs) failed fixity check
In the case of an error the report should have the following:
- Date/time that fixity was run
- AIP UUID
- Nature of the error- for example:
"data/objects/no_such_file exists in manifest but not found on filesystem"