Dashboard administration tab¶
This page describes dashboard user administration in Archivematica via the dashboard. For higher level, technical administrative documentation, please see Administrator manual.
The Archivematica administration pages, under the Administration tab of the dashboard, allows you to configure application components and manage users.
On this page:
- Processing configuration
- Transfer source locations
- AIP storage locations
- Processing storage usage
- AtoM DIP upload
- ArchivesSpace DIP upload
- Archivists Toolkit DIP upload
- PREMIS agent
- REST API
The processing configuration administration page of the dashboard provides you with an easy form to configure the default ‘processingMCP.xml’ that’s added to a SIP or transfer if it doesn’t already contain one. When you change the options using the web interface the necessary XML will be written behind the scenes.
- For the approval (yes/no) steps, the user ticks the box on the left-hand side to make a choice. If the box is not ticked, the approval step will appear in the dashboard.
- For the other steps, if no actions are selected the choices appear in the dashboard
Specific processing configurations available on this page are:
Select whether or not to send transfers to quarantine (yes/no) and decide how long you’d like them to stay there (below).
Approve normalization, sending the AIP to storage, and uploading the DIP without interrupting the workflow in the dashboard.
Store the AIP without interripting the workflow in the dashboard.
Select whether or not Archivematica should transcribe files.
Select whether or not Archivematica should generate a transfer structure report (see Process the transfer)
Select if Archivematica should create one SIP from the transfer and continue processing or send the transfer to backlog.
Select whether to extract packages as well as whether to keep and/or delete the extracted objects and/or the package itself.
Select Normalization options (see Normalize).
Select whether or not Archivematica should remind you to add metadata at the appropriate point during ingest.
Select whether or not to Examine contents.
Select which format identification tool and command to run in both/either transfer and/or ingest to base your normalization upon.
Select which format identification tool and command to run for Submission documentation and metadata.
Select whether packages should be deleted after extraction.
Select between 7z using lzma and 7zip using bzip or parallel bzip2 algorithms for AIP compression.
Select compression levels:
- 1 - fastest mode
- 3 - fast compression mode
- 5 - normal compression mode
- 7 - maximum compression
- 9 - ultra compression
Select one archival storage location where you will consistently send your AIPs and DIPs (if you are storing DIPs rather than sending them immediately to an access system.)
In the general configuration section, you can select interface options and set Storage Service options for your Archivematica client.
Here, you can hide parts of the interface that you don’t need to use. In particular, you can hide CONTENTdm DIP upload link, AtoM DIP upload link and DSpace transfer type.
Storage Service options
This is where you’ll find the complete URL for the Storage Service. See Storage Service for more information about this feature.
This page displays packages that failed during processing.
Clicking the date, name or UUID will display a report of the failure:
The Failure report can be removed from the Dashboard by clicking Delete.
Transfer source location¶
Archivematica allows you to start transfers using the operating system’s file browser or via a web interface. Source files for transfers, however, cannot be uploaded using the web interface; they must exist on volumes accessible to the Archivematica MCP server and configured via the Storage Service.
When starting a transfer you are required to select one or more directories of files to add to the transfer.
AIP storage locations¶
AIP storage directories are directories in which completed AIPs are stored. Storage directories can be specified in a manner similar to transfer source directories using the Storage Service.
You can view your transfer source directories in the Administrative tab of the dashboard under “AIP storage locations”.
Processing storage usage¶
This section of the Administration page displays various processing locations with their current usage of available space.
Administrators can use the “clear” buttons to delete the contents of these processing locations to make more room on their server.
AtoM DIP upload¶
Archivematica can upload DIPs directly to an AtoM website so that the contents can be accessed online. The AtoM DIP upload configuration page is where you specify the AtoM installation where you’d like to upload DIPs (and, if you are using Rsync to transfer the DIP files, the Rsync transfer details).
The required parameters are:
- Upload URL : the URL of the destination AtoM website.
- Login email : the email address used to log in to AtoM.
- Login password : the password used to log in to AtoM.
- AtoM version : the version of the destination AtoM website (find in Admin -> Settings -> Global).
Archivematica 1.5 has been tested with and is recommended for use with AtoM 2.2 and AtoM 2.3.
If you are using Rsync to send the DIP to AtoM, enter Rsync details:
- Rsync target : Destination value for rsync, e.g.
- Rsync command : Used to specify the remote shell manually, e.g.
ssh -p 22222 -l user
If you are not using Rsync, leave these fields blank.
If you would like to have additional details in failure reports, also enable debug mode by choosing “Yes”.
AtoM user interface
In the AtoM user interface, please take note of the following:
- The sword plugin (Admin –> Plugins –> qtSwordPlugin) must be enabled in order for AtoM to receive uploaded DIPs.
- Enabling Job scheduling (Admin –> Settings –> Job scheduling) in version 2.1 or lower is also recommended.
Levels of description
You can fetch levels of description from AtoM so that they can be used in SIP arrange. Click on Levels of Description, then Fetch from AtoM to get an updated list from the AtoM levels of description taxonomy.
If there are levels of description in the AtoM taxonomy that you prefer not to use in Archivematica SIP arrange, you can remove them using the red delete button. You can change the order that they appear in SIP arrange by using the up/down arrows in this screen.
You may need an administrator to configure AtoM for DIP uploads from Archivematica. For administrator instructions, see AtoM configuration in the Administrator manual
ArchivesSpace DIP upload¶
Before ingesting digital objects destined for ArchivesSpace, ensure that the ArchivesSpace DIP upload settings in the administration tab of the dashboard have been set.
These settings should be created and saved before digital objects destined for upload to ArchivesSpace are processed. Note that these can be set once and used for processing any number of transfers (i.e. they do not need to be re-set for each transfer).
- ArchivesSpace host: the IP address of the host database. Do not include
http:// or www. (i.e.
- ArchivesSpace backend port: the database port of the ArchivesSpace site
- ArchivesSpace administrative user: a username with administrative permissions in the ArchivesSpace site
- ArchivesSpace administrative user password: password for the above user
- Restrictions Apply: Selecting Yes will apply a blanket access restriction to all content uploaded from Archivematica to ArchivesSpace. Selecting No will send all content to ArchivesSpace without restrictions. Should you wish to enable the PREMIS-based restrictions functionality, choose “base on PREMIS” under “Restrictions Apply”. To add PREMIS rights, please see Add PREMIS rights and restrictions.
- XLink Actuate: XLink Actuate defines when digital object will be read and displayed
onLoadmeans that the digital object will be loaded and shown when the target resource loads.
onRequestmeans that the digital object will be loaded and shown when the user clicks on the digital object link.
- XLink Show: XLink Show defines where the browser will open the digital object.
Embedis selected by default - the digital object will be embedded in the resource page.
Newwill open the digital object in a new window or tab.
Replacewill open the digital object in the same window or tab.
- Use Statement: select a term from the Use Statement list in ArchivesSpace’s
Controlled Value Lists under the System menu. For example, if the uploaded materials
are original master images, for example, enter
image-masterin the Use statement field to apply the label
image-masterto all of the uploads.
- Object type: select a term from the Digital Object Type list in ArchivesSpace’s
Controlled Value Lists under the System menu. If the uploaded materials are sound
recordings, you could enter
sound_recordingin the Object type field to apply the label sound_recording to all of the uploads. For mixed media uploads, it is best to leave this field blank.
- Conditions governing access: Enter free-text conditions that govern access to the digital object.
- Conditions governing use: Enter free-text conditions that govern use of the digital object.
- URL prefix: URL of DIP object server as you wish it to appear in ArchivesSpace
- ArchivesSpace repository number: Insert the identifier for the ArchivesSpace repository to which you would like to upload DIPs here. Note that the default identifier for a single-repository ArchivesSpace instance is 2.
In order to save changes to the ArchivesSpace DIP upload configuration, you must enter the password before clicking save. Note that Archivematica will not show you an error if the password is not entered.
Archivists Toolkit DIP upload¶
Before ingesting digital objects destined for Archivists’ Toolkit, ensure that the Achivists’ Toolkit DIP upload settings in the administration tab of the dashboard have been set.
- These settings should be created and saved before digital objects destined for upload to Archivists Toolkit are processed. Note that these can be set once and used for processing any number of transfers (i.e. they do not need to be re-set for each transfer). The screenshots below show the template in the dashboard.
- Include the IP address of the host database (db host), the database port (db port), the database name (db name), the database user (db user), and the Archivists’ Toolkit user name (at username).
- Should you wish to enable the PREMIS-based restrictions functionality, choose “base on PREMIS” under “Restrictions Apply”. To add PREMIS rights, please see Add PREMIS rights and restrictions.
The PREMIS agent name and code can be set via the administration interface.
The PREMIS agent information is used in the METS files created by Archivematica to identify the agency performing the digital preservation events.
Archivematica includes a REST API for automating transfer approval. Artefactual recommends that a technical administrator configure the options for this feature.
To configure Archivematica to use the REST API for automation, see Administrator manual - REST API.
The dashboard provides a simple cookie-based user authentication system using the Django authentication framework. Access to the dashboard is limited only to logged-in users and a login page will be shown when the user is not recognized. If the application can’t find any user in the database, the user creation page will be shown instead, allowing the creation of an administrator account.
Users can be also created, modified and deleted from the Administration tab. Only users who are administrators can create and edit user accounts.
You can add a new user to the system by clicking the “Add new” button on the user administration page. By adding a user you provide a way to access Archivematica using a username/password combination. Should you need to change a user’s username or password, you can do so by clicking the “Edit” button, corresponding to the user, on the administration page. Should you need to revoke a user’s access, you can click the corresponding “Delete” button.