Using Issues for Quality Control - Revision history

Drn@ecs.soton.ac.uk: Switched to API page for bin/issues_audit.

2022-03-05T12:53:06Z

Switched to API page for bin/issues_audit.

Tomasz.neugebauer@concordia.ca: /* Behind the scenes */

2015-08-21T17:41:41Z

‎Behind the scenes

Pm705 at 23:51, 21 March 2010

2010-03-21T23:51:24Z

Pm705 at 23:50, 21 March 2010

2010-03-21T23:50:11Z

Pm705 at 16:13, 8 February 2010

2010-02-08T16:13:53Z

Tmb: /* Checklist for Repository Administrators */

2009-11-23T17:22:32Z

‎Checklist for Repository Administrators

Tmb: /* Checklist for Repository Administrators */

2009-11-23T17:22:03Z

‎Checklist for Repository Administrators

Tmb: /* Plugin Reference (EPrints 3.1) */

2009-11-23T17:19:02Z

‎Plugin Reference (EPrints 3.1)

Tmb: /* Issues plugins */

2009-11-23T17:17:46Z

‎Issues plugins

Tmb: /* issues.xml */

2009-11-23T17:13:00Z

‎issues.xml

@@ Line 104: / Line 104: @@
 * Issues Recorded
-Any XML-defined issues are displayed in the "Current Issues" section immediately. A command line script called "[[issues_audit]]" must be run to process the plugin-based issues - any identified are recorded and will then appear in the "Issues Recorded" section, '''Note there is a special plugin which checks for each of the XML-defined issues - see Plugin Reference below - hence XML defined issues can appear in both the "Current Issues" and "Recorded Issues" sections'''. '''Note that this script must be run regularly in order for the "Issues Search" to function correctly'''. Therefore, the "Current Issues" section reflects the "live" issues for the item whereas the "Issues Recorded" section lists the issues that were reported the last time the issues_audit script was run.
+Any XML-defined issues are displayed in the "Current Issues" section immediately. A command line script called "[[API:bin/issues_audit|bin/issues_audit]]" must be run to process the plugin-based issues - any identified are recorded and will then appear in the "Issues Recorded" section, '''Note there is a special plugin which checks for each of the XML-defined issues - see Plugin Reference below - hence XML defined issues can appear in both the "Current Issues" and "Recorded Issues" sections'''. '''Note that this script must be run regularly in order for the "Issues Search" to function correctly'''. Therefore, the "Current Issues" section reflects the "live" issues for the item whereas the "Issues Recorded" section lists the issues that were reported the last time the issues_audit script was run.
 ===issues.xml===

@@ Line 104: / Line 104: @@
 * Issues Recorded
-Any XML-defined issues are displayed in the "Current Issues" section immediately. A command line script called "issues_audit" must be run to process the plugin-based issues - any identified are recorded and will then appear in the "Issues Recorded" section, '''Note there is a special plugin which checks for each of the XML-defined issues - see Plugin Reference below - hence XML defined issues can appear in both the "Current Issues" and "Recorded Issues" sections'''. '''Note that this script must be run regularly in order for the "Issues Search" to function correctly'''. Therefore, the "Current Issues" section reflects the "live" issues for the item whereas the "Issues Recorded" section lists the issues that were reported the last time the issues_audit script was run.
+Any XML-defined issues are displayed in the "Current Issues" section immediately. A command line script called "[[issues_audit]]" must be run to process the plugin-based issues - any identified are recorded and will then appear in the "Issues Recorded" section, '''Note there is a special plugin which checks for each of the XML-defined issues - see Plugin Reference below - hence XML defined issues can appear in both the "Current Issues" and "Recorded Issues" sections'''. '''Note that this script must be run regularly in order for the "Issues Search" to function correctly'''. Therefore, the "Current Issues" section reflects the "live" issues for the item whereas the "Issues Recorded" section lists the issues that were reported the last time the issues_audit script was run.
 ===issues.xml===

← Older revision		Revision as of 23:51, 21 March 2010
Line 1:		Line 1:
−	[[Category:~~Upgrading~~]]	+	[[Category:Howto]]
	EPrints 3.1 introduced a new tool to assist with the quality control process: EPrints can automatically identify potential issues with items in the repository, and bring them to the attention of the repository editor or administrator. This page describes how to use the new tool and provides a behind-the-scenes look at how it works, including configuration and code examples.		EPrints 3.1 introduced a new tool to assist with the quality control process: EPrints can automatically identify potential issues with items in the repository, and bring them to the attention of the repository editor or administrator. This page describes how to use the new tool and provides a behind-the-scenes look at how it works, including configuration and code examples.

← Older revision		Revision as of 23:50, 21 March 2010
Line 1:		Line 1:
−	[[Category:~~Howto~~]]	+	[[Category:Upgrading]]
	EPrints 3.1 introduced a new tool to assist with the quality control process: EPrints can automatically identify potential issues with items in the repository, and bring them to the attention of the repository editor or administrator. This page describes how to use the new tool and provides a behind-the-scenes look at how it works, including configuration and code examples.		EPrints 3.1 introduced a new tool to assist with the quality control process: EPrints can automatically identify potential issues with items in the repository, and bring them to the attention of the repository editor or administrator. This page describes how to use the new tool and provides a behind-the-scenes look at how it works, including configuration and code examples.

← Older revision		Revision as of 16:13, 8 February 2010
Line 1:		Line 1:
		+	[[Category:Howto]]
	EPrints 3.1 introduced a new tool to assist with the quality control process: EPrints can automatically identify potential issues with items in the repository, and bring them to the attention of the repository editor or administrator. This page describes how to use the new tool and provides a behind-the-scenes look at how it works, including configuration and code examples.		EPrints 3.1 introduced a new tool to assist with the quality control process: EPrints can automatically identify potential issues with items in the repository, and bring them to the attention of the repository editor or administrator. This page describes how to use the new tool and provides a behind-the-scenes look at how it works, including configuration and code examples.

@@ Line 221: / Line 221: @@
 ==Checklist for Repository Administrators==
-# Add any additional item level issues to issues.xml
+# Define any additional item level issues in issues.xml
 # Develop plugins for other issues as required
 # Schedule issues_audit script to run regularly using cron

@@ Line 195: / Line 195: @@
 [[Image:Issues_extra.png]]
-===Plugin Reference (EPrints 3.1)===
+===Plugin Reference===
 {| border="1" cellspacing="0" cellpadding="10"
 !Name
 !Description
 |-
 |ExactTitleDups.pm
 |Finds items with identical titles, records issue on each matching item
 |-
 |SimilarTitles.pm
 |Find items with similar titles, records issue on each matching item
 |-
 |XMLConfig.pm
 |Apply rules in issues.xml to each item, record each issue
 |}
-''Note all default plugins are located in perl_lib/EPrints/Plugin/Issues/
+'''All default plugins are located in perl_lib/EPrints/Plugin/Issues/
 ===Checklist for Repository Administrators===

@@ Line 131: / Line 131: @@
 ===Issues plugins===
-The default EPrints Issues plugins can be found in <pre>perl_lib/EPrints/Plugin/Issues/</pre>. Local repository plugins should be stored in <pre>archives/ARCHIVEID/cfg/plugins/EPrints/Plugin/Issues/</pre>.
+The default EPrints Issues plugins can be found in ''perl_lib/EPrints/Plugin/Issues/''. Local repository plugins should be stored in ''archives/ARCHIVEID/cfg/plugins/EPrints/Plugin/Issues/''.
 Each plugin receives a list of EPrints to test. Plugins can implement some or all of the following methods:
-* process_item_in_list - record issues/details for whole list
+* '''process_item_in_list''' - record issues/details for whole list
-* item_issues - return a list of issues for the given item
+* '''item_issues''' - return a list of issues for the given item
-* process_at_end - add any additional issues after the list has been processed
+* '''process_at_end''' - add any additional issues after the list has been processed
- If the plugin implements process_item_in_list this will be called for item in the list, otherwise, item_issues will be called for each item in the list. process_at_end will be called after the whole list has been processed.
+If a plugin implements '''process_item_in_list'' this will be called for each item in the list, otherwise, '''item_issues''' will be called for each item in the list. '''process_at_end''' will be called after the whole list has been processed.
-'''Example 1''' Excerpt from the default ExactTitleDups plugin
+'''Example 1''' Use '''process_item_in_list''' to keep a record of all the titles encountered; check for duplicate titles in '''process_at_end''' and create issue for each matching item (code excerpts from the EPrints 3.1.3 default ExactTitleDups.pm plugin):
   sub process_item_in_list
@@ Line 170: / Line 170: @@
+   }
-This plugin uses process_item_in_list to keep a record of all the titles it encounters. process_at_end then checks for duplicate titles and creates and issue for each matching item.
+'''Example 2''' Implement the item_issues method to check for PDF documents where the depositor has accidentally uploaded more than 1 file.
   sub item_issues

@@ Line 107: / Line 107: @@
 ===issues.xml===
-Issues that relate to the properties of an individual item are defined in the configuration file <pre>archives/ARCHIVEID/cfg/issues.xml</pre>.
+Issues that relate to the properties of an individual item are defined in the configuration file ''archives/ARCHIVEID/cfg/issues.xml''.
 The issues.xml file uses the [[EPrints_Control_Format|EPrints Control Syntax]] and [[EPScript|EPrints Script]] to define a series of tests that can be carried out on an item's metadata to work out which issues an item has. Each issue is then defined using an "<issue>..</issue>" construct.