Difference between revisions of "Category:Development documentation"

From Archivematica
Jump to navigation Jump to search
m (Tweak client script formatting)
m (Clarify section explanations)
 
(2 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
The Archivematica project consists of several projects working together:
 
The Archivematica project consists of several projects working together:
 
* Archivematica: Main repository containing the user-facing dashboard, task manager MCPServer and clients scripts for the MCPClient. Also referred to as a pipeline
 
* Archivematica: Main repository containing the user-facing dashboard, task manager MCPServer and clients scripts for the MCPClient. Also referred to as a pipeline
** [[Dashboard]]: User-facing web GUI written in Django. This is where Transfer and SIP process can be monitored and directed, and gives access to the backlog and archival storage.
+
** [[Dashboard]]: User-facing web GUI written in Django. This handles external systems & workflow configuration, Transfer and SIP process status & decisions, and gives access to the backlog and archival storage.
** [[MCPServer]]: Task manager using gearman that determines what scripts to run next and what to do on error
+
** [[MCPServer]]: Task manager using gearman that assigns tasks to MCPClients and determines workflow.
** [[MCPClient]]: Gearman worker that dispatches jobs to the various scripts
+
** [[MCPClient]]: Gearman worker that dispatches jobs to the various scripts.
 
*** Client scripts: The actual scripts that do the processing. Most are written in Python, some in bash or other tools.
 
*** Client scripts: The actual scripts that do the processing. Most are written in Python, some in bash or other tools.
* Storage Service: Responsible for moving files to Archivematica for processing, and from Archivematica into storage
+
* [[Storage Service]]: Responsible for moving files to Archivematica for processing, and from Archivematica into storage. It is the more permanent record of AIPs & backlogged transfers and where they’re stored.
 
* [[ Format_policy_registry_requirements | Format Policy Registry]]: Submodule shared between Archivematica and the Format Policy Registry (FPR) server that displays and updates FPR rules and commands
 
* [[ Format_policy_registry_requirements | Format Policy Registry]]: Submodule shared between Archivematica and the Format Policy Registry (FPR) server that displays and updates FPR rules and commands
 +
 +
Detailed feature descriptions live in the subcategory [[:Category:Feature requirements]].  These may be complete, in progress, or just ideas.  Documentation for old versions that is no longer valid in current Archivematica is moved to [[:Category:Deprecated]].
 +
 +
See also [[:Category:Process documentation]]

Latest revision as of 16:48, 27 March 2017

Main Page > Development > Development documentation

Archivematica is a web- and standards-based, open-source application which allows institutions to preserve long-term access to trustworthy, authentic and reliable digital content. Our target users are archivists, librarians, and anyone working to preserve digital objects.

The Archivematica project consists of several projects working together:

  • Archivematica: Main repository containing the user-facing dashboard, task manager MCPServer and clients scripts for the MCPClient. Also referred to as a pipeline
    • Dashboard: User-facing web GUI written in Django. This handles external systems & workflow configuration, Transfer and SIP process status & decisions, and gives access to the backlog and archival storage.
    • MCPServer: Task manager using gearman that assigns tasks to MCPClients and determines workflow.
    • MCPClient: Gearman worker that dispatches jobs to the various scripts.
      • Client scripts: The actual scripts that do the processing. Most are written in Python, some in bash or other tools.
  • Storage Service: Responsible for moving files to Archivematica for processing, and from Archivematica into storage. It is the more permanent record of AIPs & backlogged transfers and where they’re stored.
  • Format Policy Registry: Submodule shared between Archivematica and the Format Policy Registry (FPR) server that displays and updates FPR rules and commands

Detailed feature descriptions live in the subcategory Category:Feature requirements. These may be complete, in progress, or just ideas. Documentation for old versions that is no longer valid in current Archivematica is moved to Category:Deprecated.

See also Category:Process documentation