EPrintsPreservation

From PreservWiki

(Difference between revisions)
Jump to: navigation, search
Current revision (18:04, 18 February 2009) (edit) (undo)
(Setting up your own Risk Analysis Service)
 
(4 intermediate revisions not shown.)
Line 4: Line 4:
The new EPrints preservation page uses underlying DROID classification data which has been indexed in the EPrints repository to construct this page of the formats contained in your repository and the risks associated to these formats. This picture ([http://www.preserv.org.uk/img/formats_risks2.png]) shows the interface in a fully working state.
The new EPrints preservation page uses underlying DROID classification data which has been indexed in the EPrints repository to construct this page of the formats contained in your repository and the risks associated to these formats. This picture ([http://www.preserv.org.uk/img/formats_risks2.png]) shows the interface in a fully working state.
 +
 +
This interface code for EPrints 3.2 is now available at http://files.eprints.org/422/ and is now optimized to handle large amounts of data. New screenshots of the test repository are available [http://www.preserv.org.uk/img/typical_closed.png] and [http://www.preserv.org.uk/img/typical_open.png].
==Other Images==
==Other Images==
Line 17: Line 19:
* JAVA
* JAVA
* DROID (Available from the National Archives UK)
* DROID (Available from the National Archives UK)
-
* update_pronom_puids droid classification tool for EPrints 3.2 (will be available with EPrints 3.2)
+
* The preserv2/EPrints Preservation toolkit from http://files.eprints.org/422/
* A web connection to retrieve the PRONOM identification data from The National Archives UK.
* A web connection to retrieve the PRONOM identification data from The National Archives UK.
-
With EPrints 3.2 installed we have the Storage Controller which provides a new low level object in EPrints, the "file" object. Using this file object we can iterate over all the files which are related to EPrints and using DROID obtain a PRONOM identifier for the file. This is then stored as a pronom_uid against that file object in EPrints.
+
With EPrints 3.2 installed we have the Storage Controller which provides a new low level object in EPrints, the "file" object. Using this file object we can iterate over all the files which are related to EPrints and using DROID obtain a PRONOM identifier for the file. This is then stored as a pronomid against that file object in EPrints.
-
The update_pronom_puids is a perl script which does this for you within your EPrints 3.2 install, note that some configuration of paths is needed to tell the script where DROID is located.
+
After installation the classification and caching tool should be run regularly to update the file classifications, file counts and risk scores.
 +
 
 +
At the time of writing the risk scores interface to PRONOM is not publicly available. By following the instructions below you can set up your own simple one.
==Stage 2 : Viewing data ==
==Stage 2 : Viewing data ==
Line 28: Line 32:
From the EPrints interface login as a repository administrator and click the Admin link. From this page select the Formats/Risks button.
From the EPrints interface login as a repository administrator and click the Admin link. From this page select the Formats/Risks button.
-
If the public risk analysis service is available at that time then you are done, else follow Stage 3.
+
==Setting up your own Risk Analysis Service==
-
 
+
-
==Stage 3 : Setting up a Risk Analysis Service==
+
Requirements additional to stage 1
Requirements additional to stage 1
Line 38: Line 40:
Set up and run the PRONOM Stub code on a machine and then we need to edit the FormatsRisks.pm file in EPrints to point it at this URL where the client is running.
Set up and run the PRONOM Stub code on a machine and then we need to edit the FormatsRisks.pm file in EPrints to point it at this URL where the client is running.
-
As the eprints user edit perl_lib/EPrints/Plugin/Screen/Admin/FormatsRisks.pm
+
As the eprints user edit eprints/archive_name/cfg/cfg.d/pronom.pl and
Change:
Change:
-
$unstable = 0;
+
$c->{"pronom_unstable"} = 0;
 +
 
to:
to:
-
$unstable = 1;
+
$c->{"pronom_unstable"} = 1;
Find the line:
Find the line:
-
format_table = $plugin->get_format_risks_table();
+
if (!($risks_url eq ""))
 +
 
and add this line directly before it (replacing example.org:4444 with the actual location on the web of your PRONOM stub server):
and add this line directly before it (replacing example.org:4444 with the actual location on the web of your PRONOM stub server):
$risks_url = "http://example.org:4444";
$risks_url = "http://example.org:4444";
Now you should be able to go to Stage 2
Now you should be able to go to Stage 2

Current revision

The plan for the work has moved to EPrintsPreservationThePlan

Contents

The *NEW* EPrints Preservation Interface

The new EPrints preservation page uses underlying DROID classification data which has been indexed in the EPrints repository to construct this page of the formats contained in your repository and the risks associated to these formats. This picture ([1]) shows the interface in a fully working state.

This interface code for EPrints 3.2 is now available at http://files.eprints.org/422/ and is now optimized to handle large amounts of data. New screenshots of the test repository are available [2] and [3].

Other Images

[4] - The original interface before style was added. [5] - The new interface with an open tab.

How it Works & How it links in to all Preserv Work

Stage 1 : Droid Classification

Requirements

  • EPrints 3.2 (currently not available publicly)
  • JAVA
  • DROID (Available from the National Archives UK)
  • The preserv2/EPrints Preservation toolkit from http://files.eprints.org/422/
  • A web connection to retrieve the PRONOM identification data from The National Archives UK.

With EPrints 3.2 installed we have the Storage Controller which provides a new low level object in EPrints, the "file" object. Using this file object we can iterate over all the files which are related to EPrints and using DROID obtain a PRONOM identifier for the file. This is then stored as a pronomid against that file object in EPrints.

After installation the classification and caching tool should be run regularly to update the file classifications, file counts and risk scores.

At the time of writing the risk scores interface to PRONOM is not publicly available. By following the instructions below you can set up your own simple one.

Stage 2 : Viewing data

From the EPrints interface login as a repository administrator and click the Admin link. From this page select the Formats/Risks button.

Setting up your own Risk Analysis Service

Requirements additional to stage 1

  • The PronomStubCode available from [6] which contains a sample implementation of the Risk Analysis Service for PRONOM.
  • JAVA

Set up and run the PRONOM Stub code on a machine and then we need to edit the FormatsRisks.pm file in EPrints to point it at this URL where the client is running.

As the eprints user edit eprints/archive_name/cfg/cfg.d/pronom.pl and

Change:

 $c->{"pronom_unstable"} = 0;

to:

 $c->{"pronom_unstable"} = 1;

Find the line: if (!($risks_url eq ""))

and add this line directly before it (replacing example.org:4444 with the actual location on the web of your PRONOM stub server):

 $risks_url = "http://example.org:4444";

Now you should be able to go to Stage 2

Personal tools