Difference between revisions of "UM error handling"

From Archivematica
Jump to navigation Jump to search
Line 16: Line 16:
  
 
== Normalization errors ==
 
== Normalization errors ==
#The dashboard will report normalization errors when
+
#The dashboard will report normalization errors when: [[Image:normalize2g.png|600px|right|thumb|'''Figure 3'''  Click on the report icon to open the normalization report]]
 
#*Normalization is attempted but fails
 
#*Normalization is attempted but fails
 
#*No normalization is attempted and the file is not in a recognized preservation or access format
 
#*No normalization is attempted and the file is not in a recognized preservation or access format
#When normalization fails, the SIP continues processing until it reaches the normalization approval step. At this point, the user can click on the report icon next to the Actions drop-down menu to see a summary report of the normalization.
+
#When normalization fails, the SIP continues processing until it reaches the normalization approval step. At this point, the user can click on the report icon next to the Actions drop-down menu to see a summary report of the normalization ('''figure 3''').
 +
#The report shows what has been normalized, what is already in an acceptable preservation and access format, and what has failed normalization or is not in a recognized preservation or access format (figure 4). For example, the file LAND2.BMP was normalized successfully to both a preservation and an access format; the file oakland03.jp2 was found to be in an acceptable preservation format already but it was necessary to generate an access copy for it.
  
 
== DIP upload error ==
 
== DIP upload error ==
 
#If the user accidentally enters a non-existing permalink, the upload DIP micro-service will fail and an error report like the following will appear in the tasks report ('''figure X'''): [[Image:uploadDIPerrorg.png|600px|right|thumb|'''Figure X'''  An error report showing that the DIP upload protocol was unable to find the permalink entered by the user]]
 
#If the user accidentally enters a non-existing permalink, the upload DIP micro-service will fail and an error report like the following will appear in the tasks report ('''figure X'''): [[Image:uploadDIPerrorg.png|600px|right|thumb|'''Figure X'''  An error report showing that the DIP upload protocol was unable to find the permalink entered by the user]]

Revision as of 18:03, 27 January 2012

Main Page > Documentation > User manual > User manual 0.8 > Error handling

General description

Archivematica anticipates that a number of different types of errors can occur during processing. Some of them will result in processing being halted and the transfer or SIP being moved to the failed directory in the file browser. For others, processing can continue: for example, a normalization failure is reported and the user is given the opportunity to continue processing the SIP.

Dashboard error reporting

  1. When a micro-service fails or encounters an error, the micro-service background turns from green to pink and a "failed" icon appears next to the transfer or SIP name (figure 1).
    Figure 1 The dashboard showing a transfer has failed the Virus scan micro-service and has been moved to the failed directory
  2. Note that the transfer shown in figure 1 has been moved to the failed directory.
  3. Click the tasks icon (the gear icon on the right-hand side) to open up an error report (figure 2). These reports are generally standard and predictable for certain types of errors and are useful for trouble-shooting. Note that the failed file(s) will always appear at the top of the report.
    Figure 2 An error report showing that a virus has been found in a file

Normalization errors

  1. The dashboard will report normalization errors when:
    Figure 3 Click on the report icon to open the normalization report
    • Normalization is attempted but fails
    • No normalization is attempted and the file is not in a recognized preservation or access format
  2. When normalization fails, the SIP continues processing until it reaches the normalization approval step. At this point, the user can click on the report icon next to the Actions drop-down menu to see a summary report of the normalization (figure 3).
  3. The report shows what has been normalized, what is already in an acceptable preservation and access format, and what has failed normalization or is not in a recognized preservation or access format (figure 4). For example, the file LAND2.BMP was normalized successfully to both a preservation and an access format; the file oakland03.jp2 was found to be in an acceptable preservation format already but it was necessary to generate an access copy for it.

DIP upload error

  1. If the user accidentally enters a non-existing permalink, the upload DIP micro-service will fail and an error report like the following will appear in the tasks report (figure X):
    Figure X An error report showing that the DIP upload protocol was unable to find the permalink entered by the user