Difference between revisions of "0.7.1 How-To"

From Archivematica
Jump to navigation Jump to search
(Created page with 'This how to is provided in addition to the user manual. = Restore a SIP backup = TODO http://code.google.com/p/archivematica/issues/detail?id=546 = Modify workflow, to not genera...')
 
 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
This how to is provided in addition to the user manual.
+
This how-to is provided in addition to the [http://archivematica.org/manual user manual].
 +
= Restart Archivematica =
 +
== In a single client environment (If you're not sure, use this one.) ==
 +
* Stop the server. This will disconnect all the clients, forcing them to stop as well.
 +
<pre>sudo stop archivematica-mcp-server</pre>
 +
* Start the server.
 +
<pre>sudo start archivematica-mcp-server</pre>
 +
* Start the client.
 +
<pre>sudo start archivematica-mcp-client</pre>
 +
 
 +
== In a multi-client environment ==
 +
* Do single client envirnoment steps on the server (Server needs to be running before clients can connect).
 +
* Restart each of the clients.
 +
<pre>sudo start archivematica-mcp-client</pre>
 +
 
 
= Restore a SIP backup =
 
= Restore a SIP backup =
−
TODO
+
* Copy the SIP backup from the backup directory (Default location: ''/var/archivematica/sharedDirectory/SIPbackups/'' ) to a workspace, like your desktop.
−
http://code.google.com/p/archivematica/issues/detail?id=546
+
* Right click the SIP and run 'Set ownership and permissions'.
−
= Modify workflow, to not generate a DIP =
+
* Remove any added files (for example, log files that were generated during SIP processing) to return SIP to its original content.  
−
TODO
+
* Move the SIP to ''/receiveSIP/'' to re-process the SIP.
−
http://code.google.com/p/archivematica/issues/detail?id=608
+
 
 +
= Modify workflow to not generate a DIP =
 +
These changes will need to be made in the MCP config files, located: /etc/archivematica/MCPServer/mcpModulesConfig/
 +
 
 +
These steps will still appear in the dashboard, but their commands will be skipped.
 +
 
 +
The following modification will need to be done to these mcpModulesConfig/xml configs:
 +
* Create DIP directory
 +
** Set the exe Command to skip.
 +
<pre>
 +
        <exeCommand>
 +
            <command>
 +
                <skip>Yes</skip></pre>
 +
 
 +
* Normalize
 +
** Set the exe Command to skip. Note: this doesn't disable preservation normalization, which is done in the <verificationCommand>.
 +
<pre>
 +
        <exeCommand>
 +
            <command>
 +
                <skip>Yes</skip></pre>
 +
 
 +
* Copy METS to DIP directory
 +
** Set the exe Command to skip.
 +
<pre>
 +
        <exeCommand>
 +
            <command>
 +
                <skip>Yes</skip></pre>
 +
 
 +
* Generate DIP
 +
** Set the exe Command to skip.
 +
<pre>
 +
        <exeCommand>
 +
            <command>
 +
                <skip>Yes</skip></pre>
 +
 
 
= Change the checksum type used in the AIP bagit =
 
= Change the checksum type used in the AIP bagit =
−
TODO
+
open for editing: /etc/archivematica/MCPServer/mcpModulesConfig/Prepare AIP.xml
−
http://code.google.com/p/archivematica/issues/detail?id=590
+
<pre>sudo mousepad /etc/archivematica/MCPServer/mcpModulesConfig/Prepare\ AIP.xml</pre>
−
= External Disk Transfers =
+
 
−
TODO
+
In commands, in execCommand, change the argument for --payloadmanifestalgorithm from "sha512" to a bagit supported checksum algorythm, ie: md5, sha256, sha1.
−
http://code.google.com/p/archivematica/issues/detail?id=132
+
<pre><arguments>create "%SIPDirectory%%SIPName%-%SIPUUID%.zip" "%SIPLogsDirectory%" "%SIPObjectsDirectory%" "%SIPDirectory%METS.xml" "%SIPDirectory%metadata/" --writer zip --payloadmanifestalgorithm "sha512"</arguments></pre>
 +
Save and restart archivematica. http://archivematica.org/wiki/index.php?title=0.7.1_How-To#Restart_Archivematica
 +
 
 +
= Add/Remove Extensions from inPreservationFormat/inAccessFormat =
 +
open for editing: /usr/lib/archivematica/transcoder/transcoderNormalizer.py
 +
<pre>sudo mousepad /usr/lib/archivematica/transcoder/transcoderNormalizer.py</pre>
 +
 
 +
Update these two functions:
 +
<pre>def inAccessFormat():
 +
    ex=["CSS", "CSV", "HTML", "TXT", "XML", "XSL", \
 +
        "MP3", "PDF", "JPG", "MPG"]
 +
    return transcoder.fileExtension.__str__().upper() in ex
 +
 
 +
def inPreservationFormat():
 +
    ex=["CSS", "CSV", "HTML", "TXT", "XML", "XSL", \
 +
        "JP2", "PNG", \
 +
        "SVG", "WAV", "TIF", "PDF", "ODP", "TIF", "MXF", "ODT", "ODS", "MBOX", "IMBOX", "AI" ]
 +
    return transcoder.fileExtension.__str__().upper() in ex</pre>
 +
Notes:
 +
* The "\" indicates the array continues on the next line.
 +
* Extensions must be in upper case to work
 +
 
 +
= Add user to the archivematica group =
 +
<pre>sudo gpasswd -a "USERNAME" archivematica</pre>
 +
Where "USERNAME" is the user you wish to add to the group.
 +
 
 +
= Set or change the quarantine period =
 +
Open the root's crontab:
 +
<pre>sudo crontab -e</pre>
 +
Add this line if it doesn't exist. Change the 60 to the desired number of seconds for quarantine.
 +
<pre>* * * * * flock -xn /var/lock/quarantine.lock /usr/lib/archivematica/MCPServer/delay/delay.py 60 "/var/archivematica/sharedDirectory/watchedDirectories/quarantined"</pre>
 +
 
 +
= Change Agent Organization Name or Repository Code =
 +
<pre>sudo mousepad /var/archivematica/sharedDirectory/sharedMicroServiceTasksConfigs/createXmlEventsAssist/organization.ini</pre>
 +
change:
 +
<pre>
 +
[organization]
 +
yourAgentIdentifierType= repository code
 +
yourAgentIdentifierValue= ORG
 +
yourAgentName= Your Organization Name Here
 +
yourAgentType= organization
 +
</pre>
 +
</pre>

Latest revision as of 16:52, 8 August 2011

This how-to is provided in addition to the user manual.

Restart Archivematica[edit]

In a single client environment (If you're not sure, use this one.)[edit]

  • Stop the server. This will disconnect all the clients, forcing them to stop as well.
sudo stop archivematica-mcp-server
  • Start the server.
sudo start archivematica-mcp-server
  • Start the client.
sudo start archivematica-mcp-client

In a multi-client environment[edit]

  • Do single client envirnoment steps on the server (Server needs to be running before clients can connect).
  • Restart each of the clients.
sudo start archivematica-mcp-client

Restore a SIP backup[edit]

  • Copy the SIP backup from the backup directory (Default location: /var/archivematica/sharedDirectory/SIPbackups/ ) to a workspace, like your desktop.
  • Right click the SIP and run 'Set ownership and permissions'.
  • Remove any added files (for example, log files that were generated during SIP processing) to return SIP to its original content.
  • Move the SIP to /receiveSIP/ to re-process the SIP.

Modify workflow to not generate a DIP[edit]

These changes will need to be made in the MCP config files, located: /etc/archivematica/MCPServer/mcpModulesConfig/

These steps will still appear in the dashboard, but their commands will be skipped.

The following modification will need to be done to these mcpModulesConfig/xml configs:

  • Create DIP directory
    • Set the exe Command to skip.
        <exeCommand> 
            <command>
                <skip>Yes</skip>
  • Normalize
    • Set the exe Command to skip. Note: this doesn't disable preservation normalization, which is done in the <verificationCommand>.
        <exeCommand> 
            <command>
                <skip>Yes</skip>
  • Copy METS to DIP directory
    • Set the exe Command to skip.
        <exeCommand> 
            <command>
                <skip>Yes</skip>
  • Generate DIP
    • Set the exe Command to skip.
        <exeCommand> 
            <command>
                <skip>Yes</skip>

Change the checksum type used in the AIP bagit[edit]

open for editing: /etc/archivematica/MCPServer/mcpModulesConfig/Prepare AIP.xml 

sudo mousepad /etc/archivematica/MCPServer/mcpModulesConfig/Prepare\ AIP.xml

In commands, in execCommand, change the argument for --payloadmanifestalgorithm from "sha512" to a bagit supported checksum algorythm, ie: md5, sha256, sha1. 

<arguments>create "%SIPDirectory%%SIPName%-%SIPUUID%.zip" "%SIPLogsDirectory%" "%SIPObjectsDirectory%" "%SIPDirectory%METS.xml" "%SIPDirectory%metadata/" --writer zip --payloadmanifestalgorithm "sha512"</arguments>

Save and restart archivematica. http://archivematica.org/wiki/index.php?title=0.7.1_How-To#Restart_Archivematica

Add/Remove Extensions from inPreservationFormat/inAccessFormat[edit]

open for editing: /usr/lib/archivematica/transcoder/transcoderNormalizer.py 

sudo mousepad /usr/lib/archivematica/transcoder/transcoderNormalizer.py

Update these two functions: 

def inAccessFormat():
    ex=["CSS", "CSV", "HTML", "TXT", "XML", "XSL", \
        "MP3", "PDF", "JPG", "MPG"]
    return transcoder.fileExtension.__str__().upper() in ex

def inPreservationFormat():
    ex=["CSS", "CSV", "HTML", "TXT", "XML", "XSL", \
        "JP2", "PNG", \
        "SVG", "WAV", "TIF", "PDF", "ODP", "TIF", "MXF", "ODT", "ODS", "MBOX", "IMBOX", "AI" ]
    return transcoder.fileExtension.__str__().upper() in ex

Notes:

  • The "\" indicates the array continues on the next line.
  • Extensions must be in upper case to work

Add user to the archivematica group[edit]

sudo gpasswd -a "USERNAME" archivematica

Where "USERNAME" is the user you wish to add to the group.

Set or change the quarantine period[edit]

Open the root's crontab: 

sudo crontab -e

Add this line if it doesn't exist. Change the 60 to the desired number of seconds for quarantine. 

* * * * * flock -xn /var/lock/quarantine.lock /usr/lib/archivematica/MCPServer/delay/delay.py 60 "/var/archivematica/sharedDirectory/watchedDirectories/quarantined"

Change Agent Organization Name or Repository Code[edit]

sudo mousepad /var/archivematica/sharedDirectory/sharedMicroServiceTasksConfigs/createXmlEventsAssist/organization.ini

change: 

[organization]
yourAgentIdentifierType= repository code
yourAgentIdentifierValue= ORG
yourAgentName= Your Organization Name Here
yourAgentType= organization
Retrieved from "https://wiki.archivematica.org/index.php?title=0.7.1_How-To&oldid=4289"