UM error handling 1.0 - Revision history

Evelyn at 20:58, 17 February 2014

2014-02-17T20:58:10Z

Courtney: /* Email error report */

2013-10-11T19:30:00Z

Email error report

Courtney: /* Email error report */

2013-10-11T19:27:12Z

Email error report

Courtney: /* Failure reports in Administration tab */

2013-10-11T19:24:37Z

Failure reports in Administration tab

Courtney: /* Failure reports in Administration tab */

2013-10-11T19:24:15Z

Failure reports in Administration tab

Courtney at 00:07, 2 October 2013

2013-10-02T00:07:56Z

Courtney at 23:50, 1 October 2013

2013-10-01T23:50:36Z

Courtney: Created page with "Main Page > Documentation > User manual > User manual 1.0 > Error handling == General description == Archivematica anticipates that a number of di..."

2013-10-01T00:18:22Z

Created page with "Main Page > Documentation > User manual > User manual 1.0 > Error handling == General description == Archivematica anticipates that a number of di..."

New page

[[Main Page]] > [[Documentation]] > [[User Manual|User manual]] > [[User manual 1.0]] > 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.

If you don't find an answer here or elsewhere in the user manual, please try searching the public [https://groups.google.com/forum/?fromgroups#!forum/archivematica user forum]. Someone may have had the same problem before and been offered a solution. If you do not find the answer there, feel free to ask us a question. The best questions to the list include as much information as possible about the error. This means offering us information about the system(s) you're using, the content of your transfer(s), and copying the task information (click on the cog icon on the same line as the micro-service job where the error occurred) and show arguments data output. See task information and show arguments data for the same error, below.

[[Image:TaskNewWindow-10.png|600px|center|thumb| Task output in new tab after clicking on cog icon]]

[[Image:ShowArgExpanded.png|600px|center|thumb| Show arguments expanded in task tab]]

</div>

<div class="clearfix">

</div>

== Dashboard error reporting ==
#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'''). Clicking on the micro-service will expand to show the specific job that contains an error ('''figure 2'''). [[Image:PinkChecksumFail.png|600px|right|thumb|'''Figure 1''' The dashboard showing a transfer has failed at the Verify transfer checksums micro-service and has been moved to the ''failed'' directory]]
[[Image:PinkFailMSexpandJob.png|600px|right|thumb|'''Figure 2''' The Verify transfer checksums micro-service expanded to show the failed job]]
#Note that the transfer shown in figure 1 has been moved to the ''failed'' directory and processing has been halted.
#Click the tasks icon (the gear icon on the right-hand side) to open up an error report ('''figure 3'''). 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.[[Image:ErrorRptFailVirusScan-10.png|600px|right|thumb|'''Figure 3''' An error report showing that a virus has been found in a file]]

</div>

<div class="clearfix">

</div>
== Email error report ==
#If the user has an email address associated with their user account, the dashboard can email a failure report ('''figure 4''').
[[Image:EmailFail-10.png|600px|right|thumb|'''Figure 4''' An emailed failure report showing an error at Verify bag micro-service]]
</div>

<div class="clearfix">

</div>

== Normalization errors ==
#The dashboard will report normalization errors when:
#*Normalization is attempted but fails
#*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 ('''figure 5''') of the normalization and/or
#*click Review in parentheses next to the micro-service to view the normalization results in a directory structure in a new browser tab ('''figure 6''').
#The report ('''figure 5''') 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. If normalization has failed, you can click on "yes" to see a task report of the error in a new tab ('''figure 7''').
#The review ('''figure 6''') allows the user to either open the objects in the browser when there is an appropriate plug-in or download the objects and open them using a local application.
#The user may choose to continue processing the SIP despite any normalization errors.
#The user may choose to redo normalization ('''figure 8'''), as well. For instance, if the user chose to normalize based on FITS-JHOVE results and experienced failures, the user may wish to redo normalization and choose to normalize based on FITS-DROID results instead ('''figure 9''').

[[Image:NormReporterror-10.png|600px|right|thumb|'''Figure 5''' Normalization report showing failed normalization attempts]]
[[Image:RvrNorm-10.png|600px|right|thumb|'''Figure 6''' Review normalization results in a new tab]]
[[Image:Normreporterrortask-10.png|600px|right|thumb|'''Figure 7''' Task output for failed normalization job]]
[[Image:Normdropdown-10.png|600px|right|thumb|'''Figure 8''' Redo normalization option in drop-down menu of Approve normalization job]]
[[Image:SelectFormatIdTool-10.png|600px|right|thumb|'''Figure 9''' Choose format identification tool from which to base normalization actions]]
</div>

<div class="clearfix">

</div>

== DIP upload error ==

# Archivematica will allow the user to continue to attempt to upload the DIP if a mistake was made entering the permalink ('''figure 10''').
[[Image:DIPUploadTryAgain-10.png|600px|right|thumb|'''Figure 10''' Warning that permalink was incorrect, allows user to retry upload DIP]]
</div>

<div class="clearfix">

</div>

== Other common error behaviours ==

#Verify metadata directory checksums: if the checksums in the ''metadata'' directory cannot be verified (i.e. if a file is missing or corrupted) the micro-service will fail and the transfer will be moved in the ''failed'' directory.
#Scan for viruses: if a virus is found the micro-service will fail and the transfer will be moved in the ''failed'' directory.
#Characterize and extract metadata: if FITS processing fails, the micro-service will fail and the transfer will continue processing.
#Remove thumbs.db file: if Archivematica is unable to remove a thumbs.db file, the micro-service will fail and the SIP will continue processing.
#Normalize submission documentation to preservation format: if normalization fails, the micro-service will fail and the SIP will continue processing.

</div>

<div class="clearfix">

</div>

== Rejecting a transfer or SIP ==

At any of the workflow approval points the user can choose to reject a transfer, SIP, AIP or DIP (depending on where the information object is in the workflow). This will move the transfer or SIP to the ''Rejected'' directory (accessible from the file browser) and will stop all processing on it. The transfer or SIP will still be listed in the dashboard, however. See '''Removing a transfer or SIP from the dashboard''', below, to remove it from the dashboard.

</div>

<div class="clearfix">

</div>

== Removing a transfer or SIP from the dashboard ==

To remove a transfer or SIP from the dashboard, click on the red "Remove" icon in the dashboard as shown in '''figure 11'''. [[Image:RemoveSIPDash-10.png|600px|right|thumb|'''Figure 11''' Click on the red ''Remove'' icon to remove a transfer or SIP from the dashboard, then click "Confirm"]]

@@ Line 34: / Line 34: @@
 == Email error report ==
-#If the user has an email address associated with their user account, the dashboard can email a failure report ('''figure 4'''). An e-mail is generated if the transfer or ingest cannot be completed, not if an error occurs which does not halt processing.
+#If the user has an email address associated with their user account, the dashboard can email a failure report ('''figure 4'''). An e-mail is generated if the transfer or ingest cannot be completed, not if an error occurs which does not halt processing. Please note that the server must have mail delivery enabled in order to receive error emails without additional configuration.
 [[Image:EmailFail-10.png|600px|right|thumb|'''Figure 4'''  An emailed failure report showing an error at Verify bag micro-service]]
 </div>

@@ Line 30: / Line 30: @@
 == Failure reports in Administration tab ==
-You can now view failure reports in the Administration tab of the dashboard. See [Administrator_manual_1.0#Failures|Administrator manual - Failures] for more information
+You can now view failure reports in the Administration tab of the dashboard. See [[Administrator_manual_1.0#Failures|Administrator manual - Failures]] for more information
 == Email error report ==

@@ Line 30: / Line 30: @@
 == Failure reports in Administration tab ==
-You can now view failure reports in the Administration tab of the dashboard. See [[Administrator_manual_1.0#Failures|Administrator manual - Failures] for more information
+You can now view failure reports in the Administration tab of the dashboard. See [Administrator_manual_1.0#Failures|Administrator manual - Failures] for more information
 == Email error report ==

@@ Line 6: / Line 6: @@
 If you don't find an answer here or elsewhere in the user manual, please try searching the public [https://groups.google.com/forum/?fromgroups#!forum/archivematica user forum]. Someone may have had the same problem before and been offered a solution. If you do not find the answer there, feel free to ask us a question. The best questions to the list include as much information as possible about the error. This means offering us information about the system(s) you're using, the content of your transfer(s), and copying the task information (click on the cog icon on the same line as the micro-service job where the error occurred) and show arguments data output. See task information and show arguments data for the same error, below.
-[[Image:TaskNewWindow-10.png|600px|center|thumb| Task output in new tab after clicking on cog icon]]
+[[Image:TaskNewWindow-10.png|600px|thumb| Task output in new tab after clicking on cog icon]]
-[[Image:ShowArgExpanded.png|600px|center|thumb| Show arguments expanded in task tab]]
+[[Image:ShowArgExpanded.png|600px|thumb| Show arguments expanded in task tab]]
-</div>
+</br>
 == Dashboard error reporting ==
@@ Line 22: / Line 18: @@
 #Click the tasks icon (the gear icon on the right-hand side) to open up an error report ('''figure 3'''). 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.[[Image:ErrorRptFailVirusScan-10.png|600px|right|thumb|'''Figure 3'''  An error report showing that a virus has been found in a file]]
-</div>
+</br>
-<div class="clearfix">
+== Failure reports in Administration tab ==
-== Failure reports in Administration tab ==
+You can now view failure reports in the Administration tab of the dashboard. See [[Administrator_manual_1.0#Failures|Administrator manual - Failures]] for more information.
-You can now view failure reports in the Administration tab of the dashboard. See [[Administrator_manual_1.0#Failures|Administrator manual - Failures]] for more information
+</br>
 == Email error report ==
@@ Line 38: / Line 32: @@
 [[Image:EmailFail-10.png|600px|right|thumb|'''Figure 4'''  An emailed failure report showing an error at Verify bag micro-service]]
-</div>
+</br>
 == Normalization errors ==
@@ Line 62: / Line 53: @@
 [[Image:Normdropdown-1.png|600px|right|thumb|'''Figure 8'''  Redo normalization option in drop-down menu of Approve normalization job]]
 [[Image:SelectFormatIdTool-1.png|600px|right|thumb|'''Figure 9'''  Choose format identification tool from which to base normalization actions]]
-</div>
+</br>
 == DIP upload error ==
@@ Line 72: / Line 60: @@
 # Archivematica will allow the user to continue to attempt to upload the DIP if a mistake was made entering the permalink ('''figure 10''').
 [[Image:DIPUploadTryAgain-10.png|600px|right|thumb|'''Figure 10'''  Warning that permalink was incorrect, allows user to retry upload DIP]]
-<div class="clearfix">
+</br>
 == Other common error behaviours ==
@@ Line 86: / Line 71: @@
 #Normalize submission documentation to preservation format: if normalization fails, the micro-service will fail and the SIP will continue processing.
-</div>
+</br>
 == Rejecting a transfer or SIP ==
@@ Line 96: / Line 77: @@
 At any of the workflow approval points the user can choose to reject a transfer, SIP, AIP or DIP (depending on where the information object is in the workflow). This will move the transfer or SIP to the ''Rejected'' directory (accessible from the file browser) and will stop all processing on it. The transfer or SIP will still be listed in the dashboard, however. See '''Removing a transfer or SIP from the dashboard''', below, to remove it from the dashboard.
-</div>
+</br>
 == Removing a transfer or SIP from the dashboard ==
 To remove a transfer or SIP from the dashboard, click on the red "Remove" icon in the dashboard as shown in '''figure 11'''. [[Image:RemoveSIPDash-10.png|600px|right|thumb|'''Figure 11'''  Click on the red ''Remove'' icon to remove a transfer or SIP from the dashboard, then click "Confirm"]]

@@ Line 33: / Line 33: @@
 == Email error report ==
 #If the user has an email address associated with their user account, the dashboard can email a failure report ('''figure 4''').
 [[Image:EmailFail-10.png|600px|right|thumb|'''Figure 4'''  An emailed failure report showing an error at Verify bag micro-service]]
@@ Line 42: / Line 43: @@
 == Normalization errors ==
 #The dashboard will report normalization errors when:
 #*Normalization is attempted but fails
@@ Line 53: / Line 55: @@
 #The user may choose to redo normalization ('''figure 8'''), as well. For instance, if the user chose to normalize based on FITS-JHOVE results and experienced failures, the user may wish to redo normalization and choose to normalize based on FITS-DROID results instead ('''figure 9''').
-[[Image:NormReporterror-10.png|600px|right|thumb|'''Figure 5'''  Normalization report showing failed normalization attempts]]
+[[Image:NormReporterror-1.png|600px|right|thumb|'''Figure 5'''  Normalization report showing failed normalization attempts]]
 [[Image:RvrNorm-10.png|600px|right|thumb|'''Figure 6'''  Review normalization results in a new tab]]
 [[Image:Normreporterrortask-10.png|600px|right|thumb|'''Figure 7'''  Task output for failed normalization job]]
-[[Image:Normdropdown-10.png|600px|right|thumb|'''Figure 8'''  Redo normalization option in drop-down menu of Approve normalization job]]
+[[Image:Normdropdown-1.png|600px|right|thumb|'''Figure 8'''  Redo normalization option in drop-down menu of Approve normalization job]]
-[[Image:SelectFormatIdTool-10.png|600px|right|thumb|'''Figure 9'''  Choose format identification tool from which to base normalization actions]]
+[[Image:SelectFormatIdTool-1.png|600px|right|thumb|'''Figure 9'''  Choose format identification tool from which to base normalization actions]]
 </div>
@@ Line 78: / Line 80: @@
 #Verify metadata directory checksums: if the checksums in the ''metadata'' directory cannot be verified (i.e. if a file is missing or corrupted) the micro-service will fail and the transfer will be moved in the ''failed'' directory.
 #Scan for viruses: if a virus is found the micro-service will fail and the transfer will be moved in the ''failed'' directory.
-#Characterize and extract metadata: if FITS processing fails, the micro-service will fail and the transfer will continue processing.
+#Characterize and extract metadata: if FITS processing fails, the micro-service will fail and the transfer will continue processing. Similarly, if a tool within FITS fails, like JHOVE, you will see the pink error bar but be able to continue processing.
 #Remove thumbs.db file: if Archivematica is unable to remove a thumbs.db file, the micro-service will fail and the SIP will continue processing.
 #Normalize submission documentation to preservation format: if normalization fails, the micro-service will fail and the SIP will continue processing.