Administrator manual 1.2 - Revision history

Courtney: /* Storage service */

2014-08-07T23:20:49Z

Storage service

Courtney: /* How to Configure a Location */

2014-08-07T23:19:43Z

How to Configure a Location

Courtney: /* Users */

2014-08-07T23:19:02Z

Users

Courtney: /* Change the port in the web server configuration */

2014-08-07T23:17:43Z

Change the port in the web server configuration

Courtney: /* Locations */

2014-08-07T23:16:00Z

Locations

Mdemeo: /* Storage service */ Document package/space/location structure

2014-08-07T23:10:56Z

Storage service: Document package/space/location structure

Mdemeo: /* Users */ Clarify difference between user types

2014-08-07T22:54:46Z

Users: Clarify difference between user types

Mdemeo: /* Types of FPR entries */ Add Transcription section

2014-08-07T22:31:21Z

Types of FPR entries: Add Transcription section

Mdemeo: /* Types of FPR entries */ Indent Identification by an extra header level

2014-08-07T22:10:25Z

Types of FPR entries: Indent Identification by an extra header level

Mdemeo: Document extraction commands

2014-08-07T21:47:35Z

Document extraction commands

@@ Line 162: / Line 162: @@
 # Save the Location settings.
 # The new location will now be available as an option under the appropriate options in the Dashboard, for example as a Transfer location (which must be enabled under the Dashboard "Administration" tab) or as a destination for AIP storage.
 = Dashboard administration tab =

@@ Line 153: / Line 153: @@
 == How to Configure a Location ==
-For Spaces of the type "Local Filesystem," Locations are basically directories (or more accurately, paths to directories). You can create Locations for Transfer Source, Currently Processing, or AIP Storage directories.
+For Spaces of the type "Local Filesystem," Locations are basically directories (or more accurately, paths to directories). You can create Locations for Transfer Source, Currently Processing, or AIP and DIP Storage.
 To create and configure a new Location:

@@ Line 141: / Line 141: @@
 Only registered users can long into the storage service, and the Users page is where users can be created or modified.
-The storage service has two types of users: administrative users, and regular users. In the 0.4.0 release of the storage service, the only distinction between the two types is for email notifications; administrators will be notified by email when special events occur, while regular users will not.
+The storage service has two types of users: administrative users, and regular users. The only distinction between the two types is for email notifications; administrators will be notified by email when special events occur, while regular users will not.
 === Settings ===

@@ Line 55: / Line 55: @@
 change 8000 to whatever port you prefer to use.
-Keep in mind that in a default installation of Archivematica 1.0, the dashboard is running in Apache on port 80.  So it is not possible to make nginx run on port 80 on the same machine.  If you install the storage service on its own server, you can set it to use port 80.
+Keep in mind that in a default installation of Archivematica, the dashboard is running in Apache on port 80.  So it is not possible to make nginx run on port 80 on the same machine.  If you install the storage service on its own server, you can set it to use port 80.
 Make sure to adjust the dashboard UUID in the Archivematica dashboard under Administration -> General.

@@ Line 31: / Line 31: @@
 === Locations ===
-A location is a subdivision of a [[#space|space]]. Each location is assigned a specific ''purpose'', such as AIP storage or transfer backlog, in order to provide an organized way to structure content within a space.
+A location is a subdivision of a [[#space|space]]. Each location is assigned a specific ''purpose'', such as AIP storage, DIP storage, transfer source or transfer backlog, in order to provide an organized way to structure content within a space.
 == Archivematica Configuration ==

@@ Line 17: / Line 17: @@
 [[File:SS1-0.png|700px|center|thumb|Home page of Storage Service]]
-TODO Discuss how spaces and locations fit into each other, pipelines fit to locations, spaces=config, locations=purpose, packages in locations
+== Storage Service entities and organization ==
 == Archivematica Configuration ==

@@ Line 579: / Line 579: @@
      outdir = sys.argv[2]
      sys.exit(main(package, outdir))
 </pre>

@@ Line 581: / Line 581: @@
 </pre>
-==== Identification Tools ====
+==== Identification ====
 The identification tool properties in Archivematica control the ways in which Archivematica identifies files and associates them with the FPR's version records. The current version of the FPR server contains two tools: a script based on the [http://www.openplanetsfoundation.org/ Open Planets Foundation's] [https://github.com/openplanets/fido/ FIDO] tool, which identifies based on the IDs in PRONOM, and a simple script which identifies files by their file extension. You can use the identification tools portion of FPR to customize the behaviour of the existing tools, or to write your own.
-==== Identification Commands ====
+===== Identification Commands =====
 Identification commands contain the actual code that a tool will run when identifying a file. This command will be run on every file in a transfer.
@@ Line 596: / Line 598: @@
 When coding a command, you should expect your script to take the path to the file to be identifed as the first commandline argument. When returning an identification, the tool should print a single line containing ''only'' the identifier, and should exit 0. Any informative, diagnostic, and error message can be printed to stderr, where it will be visible to Archivematica users monitoring tool results. On failure, the tool should exit non-zero.
-==== Identification Rules ====
+===== Identification Rules =====
 These identification rules allow you to define the relationship between the output created by an identification tool, and one of the formats which exists in the FPR. This must be done for the format to be tracked internally by Archivematica, and for it to be used by normalization later on. For instance, if you created a FIDO configuration which returns MIME types, you could create a rule which associates the output "image/jpeg" with the "Generic JPEG" format in the FPR.

← Older revision		Revision as of 21:47, 7 August 2014
Line 521:		Line 521:

	When creating a characterization command, the "output format" should be set to "XML 1.0".		When creating a characterization command, the "output format" should be set to "XML 1.0".
		+
		+	==== Extraction ====
		+
		+	Archivematica supports extracting contents from files during the transfer phase.
		+
		+	Many transfers contain files which are packages of other files; examples of these include compressed archives, such as ZIP files, or disk images. Archivematica provides a transcription microservice which comes with several predefined rules to extract packages, and which is fully customizeable by Archivematica administrators. Administrators can write new commands, and assign existing formats to run for other file formats.
		+
		+	===== Writing a new extraction command =====
		+
		+	Writing an extraction command is very similar to writing an [[Administrator_manual_1.2#Identificaton Command\|identification command]] or a [[Administrator_manual_1.2#Normalization Command\|normalization command]].
		+
		+	An extraction command is passed two arguments: the ''file to extract'', and the ''path to which the package should be extracted''. Similar to [[Administrator_manual_1.2#Normalization Command\|normalization commands]], these arguments will be interpolated directly into "bashScript" and "command" scripts, and passed as positional arguments to "pythonScript" and "asIs" scripts.
		+
		+	{\|
		+	\|Name (bashScript and command)\|\|Commandline position (pythonScript and asIs)\|\|Description\|\|Sample value
		+	\|-
		+	\|%outputDirectory%\|\|First\|\|The full path to the directory in which the package's contents should be extracted\|\|/path/to/filename-uuid/
		+	\|-
		+	\|%inputFile%\|\|Second\|\|The full path to the package file\|\|/path/to/filename
		+	\|}
		+
		+	Here's a simple example of how to call an existing tool (7-zip) without any extra logic:
		+
		+	<pre>7z x -bd -o"%outputDirectory%" "%inputFile%"</pre>
		+
		+	This Python script example is more complex, and attempts to determine whether any files were extracted in order to determine whether to exit 0 or 1 (and report success or failure):
		+
		+	<pre>
		+	from __future__ import print_function
		+	import re
		+	import subprocess
		+	import sys
		+
		+	def extract(package, outdir):
		+	# -a extracts only allocated files; we're not capturing unallocated files
		+	try:
		+	process = subprocess.Popen(['tsk_recover', package, '-a', outdir],
		+	stdout=subprocess.PIPE, stderr=subprocess.PIPE, stdin=subprocess.PIPE)
		+	stdout, stderr = process.communicate()
		+
		+	match = re.match(r'Files Recovered: (\d+)', stdout.splitlines()[0])
		+	if match:
		+	if match.groups()[0] == '0':
		+	raise Exception('tsk_recover failed to extract any files with the message: {}'.format(stdout))
		+	else:
		+	print(stdout)
		+	except Exception as e:
		+	return e
		+
		+	return 0
		+
		+	def main(package, outdir):
		+	return extract(package, outdir)
		+
		+	if __name__ == '__main__':
		+	package = sys.argv[1]
		+	outdir = sys.argv[2]
		+	sys.exit(main(package, outdir))
		+	</pre>

	==== Identification Tools ====		==== Identification Tools ====