Metrics requirements - Revision history

Sallain at 22:26, 11 February 2020

2020-02-11T22:26:49Z

Hbecker: Move to feature requirements category

2017-03-23T19:40:50Z

Move to feature requirements category

Courtney: /* Use Cases */

2013-02-05T21:43:50Z

Use Cases

Courtney: /* Use Cases */

2013-02-05T21:43:35Z

Use Cases

Courtney: /* Use Cases */

2013-02-05T21:22:20Z

Use Cases

Courtney: /* Data Model */

2013-02-01T22:37:14Z

Data Model

Courtney: /* Use Cases */

2013-02-01T22:35:59Z

Use Cases

Courtney: /* Use Cases */

2013-02-01T22:34:06Z

Use Cases

Courtney: /* Description */

2013-02-01T22:32:46Z

Description

Courtney: Created page with "Documentation > Requirements > Metrics requirements == Description == * The Archivematica team is currently gathering metrics requirements to support digital reposi..."

2013-02-01T21:51:30Z

Created page with "Documentation > Requirements > Metrics requirements == Description == * The Archivematica team is currently gathering metrics requirements to support digital reposi..."

New page

[[Documentation]] > [[Requirements]] > Metrics requirements

== Description ==

* The Archivematica team is currently gathering metrics requirements to support digital repository management. The question we would like to answer is: what kinds of metrics would be useful to Archivematica users (e.g. performance/usage statistics, AIP/DIP monitoring, file format statistics, etc.).

We would really appreciate your input on this. Please be as specific as possible. For instance:

number of file format X ingested per month
total disk size of ingests added per year
number of failed normalizations per format x
name of person who processed an AIP

Our goal is to get a sense of the foundational elements necessary to fulfill future reporting requirements that we will need to build into Archivematica ... eventually. We are of course limited by available funding and time. We will prioritize the metrics and do our best to get as much as we can into upcoming releases given available funding and time.

* Related issues: [[https://projects.artefactual.com/issues/1537 #1537]]

= Requirements =

== Use Cases ==

== Mockups ==

== Data Model ==

== Workflow ==

== GUI ==

== API ==

[[Category:Development documentation]]

← Older revision		Revision as of 22:26, 11 February 2020
Line 1:		Line 1:
	[[Documentation]] > [[Requirements]] > Metrics requirements		[[Documentation]] > [[Requirements]] > Metrics requirements
		+
		+	<div style="padding: 10px 10px; border: 1px solid black; background-color: #F79086;">This page is no longer being maintained and may contain inaccurate information. Please see the [https://www.archivematica.org/docs/latest/ Archivematica documentation] for up-to-date information.</div><p>

	[[Category:Feature requirements]]		[[Category:Feature requirements]]

@@ Line 1: / Line 1: @@
 [[Documentation]] > [[Requirements]] > Metrics requirements
 == Description ==
@@ Line 43: / Line 44: @@
 For AIPs:
--AIP name - In METS structMap: <div TYPE="directory" LABEL="[AIPname]-[UUID]">
+* AIP name - In METS structMap: <div TYPE="directory" LABEL="[AIPname]-[UUID]">
--AIP UUID - In METS structMap: <div TYPE="directory" LABEL="[AIPname]-[UUID]">
+* AIP UUID - In METS structMap: <div TYPE="directory" LABEL="[AIPname]-[UUID]">
--AIP storage location - Not in METS file
+* AIP storage location - Not in METS file
--Date placed in storage - Not in METS file
+* Date placed in storage - Not in METS file
--Date updated (when we have AIP versioning) - will be in METS header <metsHdr CREATEDATE="2013-05-09T15:00:00" LASTMODDATE=”2014-02-09T21:00:00>
+* Date updated (when we have AIP versioning) - will be in METS header <metsHdr CREATEDATE="2013-05-09T15:00:00" LASTMODDATE=”2014-02-09T21:00:00>
--AIP size - Not in METS file
+* AIP size - Not in METS file
--Related DIP - Not in METS file
+* Related DIP - Not in METS file
--DIP storage location - Not in METS file
+* DIP storage location - Not in METS file
--DIP size - Not in METS file
+* DIP size - Not in METS file
--Date DIP uploaded - Not in METS file
+* Date DIP uploaded - Not in METS file
 For transfer backups:
--Transfer name <div TYPE="directory" LABEL="[Transfername]-[UUID]">
+* Transfer name <div TYPE="directory" LABEL="[Transfername]-[UUID]">
--Transfer UUID <div TYPE="directory" LABEL="[Transfername]-[UUID]">
+* Transfer UUID <div TYPE="directory" LABEL="[Transfername]-[UUID]">
--Transfer size - Not in METS file
+* Transfer size - Not in METS file
--Transfer storage location - Not in METS file
+* Transfer storage location - Not in METS file
--Date placed in storage - Not in METS file
+* Date placed in storage - Not in METS file

@@ Line 31: / Line 31: @@
 # AIP average, median & max directory depth and directory breadth
 # File size distribution, file size distribution per format
-# Migration monitoring: Display not just file format but also version/specification
+# Preservation and access normalization monitoring: Display not just file format but also version/specification
 == Mockups ==

@@ Line 16: / Line 16: @@
 == Use Cases ==
-* Output reports on:
+The following are some use cases generated by the Archivematica team and contributed by Archivematica users.
 # number of file format X ingested per month
@@ Line 22: / Line 24: @@
 # number of failed normalizations per format x
 # name of person who processed an AIP
 == Mockups ==

@@ Line 18: / Line 18: @@
 * Output reports on:
-number of file format X ingested per month
+# number of file format X ingested per month
-total disk size of ingests added per year
+# total disk size of ingests added per year
-number of failed normalizations per format x
+# number of failed normalizations per format x
-name of person who processed an AIP
+# name of person who processed an AIP
 == Mockups ==

← Older revision		Revision as of 22:37, 1 February 2013
Line 27:		Line 27:

	== Data Model ==		== Data Model ==
		+
		+	-Logged-in user (should be captured as PREMIS agent)
		+	-UUID of the Archivematica instance (should be captured as PREMIS agent)
		+	-Possibly also environment data: what machines did Archivematica live on, what versions of all the tools were installed (already in PREMIS events), what version of Archivematica was used (already in software agent).
		+
		+	For AIPs:
		+	-AIP name - In METS structMap: <div TYPE="directory" LABEL="[AIPname]-[UUID]">
		+	-AIP UUID - In METS structMap: <div TYPE="directory" LABEL="[AIPname]-[UUID]">
		+	-AIP storage location - Not in METS file
		+	-Date placed in storage - Not in METS file
		+	-Date updated (when we have AIP versioning) - will be in METS header <metsHdr CREATEDATE="2013-05-09T15:00:00" LASTMODDATE=”2014-02-09T21:00:00>
		+	-AIP size - Not in METS file
		+	-Related DIP - Not in METS file
		+	-DIP storage location - Not in METS file
		+	-DIP size - Not in METS file
		+	-Date DIP uploaded - Not in METS file
		+
		+	For transfer backups:
		+	-Transfer name <div TYPE="directory" LABEL="[Transfername]-[UUID]">
		+	-Transfer UUID <div TYPE="directory" LABEL="[Transfername]-[UUID]">
		+	-Transfer size - Not in METS file
		+	-Transfer storage location - Not in METS file
		+	-Date placed in storage - Not in METS file

	== Workflow ==		== Workflow ==

← Older revision		Revision as of 22:34, 1 February 2013
Line 16:		Line 16:
	== Use Cases ==		== Use Cases ==

		+	* Output reports on:
		+
		+	** number of file format X ingested per month
		+	** total disk size of ingests added per year
		+	** number of failed normalizations per format x
		+	** name of person who processed an AIP

	== Mockups ==		== Mockups ==

@@ Line 6: / Line 6: @@
 * The Archivematica team is currently gathering metrics requirements to support digital repository management. The question we would like to answer is: what kinds of metrics would be useful to Archivematica users (e.g. performance/usage statistics, AIP/DIP monitoring, file format statistics, etc.).
-We would really appreciate your input on this. Please be as specific as possible. For instance:
+* Our goal is to get a sense of the foundational elements necessary to fulfill future reporting requirements that we will need to build into Archivematica ... eventually. We are of course limited by available funding and time. We will prioritize the metrics and do our best to get as much as we can into upcoming releases given available funding and time.
 * Related issues: [[https://projects.artefactual.com/issues/1537 #1537]]