Difference between revisions of "Processing report"

From Archivematica
Jump to navigation Jump to search
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Documentation]] > [[Requirements]] > Failure report requirements
+
[[Documentation]] > [[Requirements]] > Processing report requirements
  
 +
<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>
 +
 +
[[Category:Feature requirements]]
  
 
== Requirements ==
 
== Requirements ==
  
 
* Related issues: Issue 1274
 
* Related issues: Issue 1274
* xml report with print option that allows for elegant printing
+
* email report with print and download option that allows for elegant printing and saving
 
* user can select email address(es) in administration tab to receive report
 
* user can select email address(es) in administration tab to receive report
* tasks and reports are expandable, allowing for a summary report and a more extensive report, printable either way
+
* configurable via the processingMCP.xml file for each transfer
 
* list all micro-services (pass/fail indicated) but only expand tasks and jobs for fails
 
* list all micro-services (pass/fail indicated) but only expand tasks and jobs for fails
 
* all failures are reported whether they stall processing or not, but report indicates whether they stopped processing or not (see mockup)
 
* all failures are reported whether they stall processing or not, but report indicates whether they stopped processing or not (see mockup)
 +
* [optional] tasks and reports are expandable, allowing for a summary report and a more extensive report, printable either way
  
 
== Use Cases ==
 
== Use Cases ==
Line 20: Line 24:
 
== Mockups ==
 
== Mockups ==
  
The following mockup shows the first two pages of a multi-page processing report. Note that predominantly errors are shown in order to illustrate the expansion function; however, '''all micro-services completed must be listed''' as "completed successfully" or failed.
+
The following mockup shows the first two pages of a multi-page processing report. Note that predominantly errors are shown in order to illustrate the expansion function; however, '''all micro-services completed must be listed''' as "completed successfully" or "failed".
  
  
 
[[File:ErrorReport.png|800px|thumb|center|]]
 
[[File:ErrorReport.png|800px|thumb|center|]]
 
 
[[Category:Development documentation]]
 

Latest revision as of 17:23, 11 February 2020

Documentation > Requirements > Processing report requirements

This page is no longer being maintained and may contain inaccurate information. Please see the Archivematica documentation for up-to-date information.

Requirements[edit]

  • Related issues: Issue 1274
  • email report with print and download option that allows for elegant printing and saving
  • user can select email address(es) in administration tab to receive report
  • configurable via the processingMCP.xml file for each transfer
  • list all micro-services (pass/fail indicated) but only expand tasks and jobs for fails
  • all failures are reported whether they stall processing or not, but report indicates whether they stopped processing or not (see mockup)
  • [optional] tasks and reports are expandable, allowing for a summary report and a more extensive report, printable either way

Use Cases[edit]

Some Archivematica users will configure their system to process from end to end without stopping. These users will wish to view a processing report showing passes and failures during processing, with the option of seeing details about any error(s). They may also wish to print or save their reports for local statistical reporting.

Workflows[edit]

Mockups[edit]

The following mockup shows the first two pages of a multi-page processing report. Note that predominantly errors are shown in order to illustrate the expansion function; however, all micro-services completed must be listed as "completed successfully" or "failed".


ErrorReport.png