Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update references to UI elements and simplify headings #4

Open
wants to merge 1 commit into
base: base
Choose a base branch
from
Open

Update references to UI elements and simplify headings #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 28 additions & 45 deletions index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,13 @@
---
layout: docs
title: "Rockefeller Archive Center Aurora User Documentation"
title: "Aurora User Documentation"
---

Aurora is a web application that receives, virus checks, and validates transfers of digital archival records, and allows archivists to appraise and accession those records.

For technical documentation including how to install Aurora, see the README in the base branch of the aurora repository on the [RAC's GitHub site](https://github.com/RockefellerArchiveCenter).
For technical documentation including how to install Aurora, see the README in the base branch of the Aurora repository on the [RAC's GitHub site](https://github.com/RockefellerArchiveCenter).

## Viewing transfers

### Dashboard

The homepage of Aurora is a dashboard that provides key metrics about transfer activity including related graphs and charts. A context switcher allows users to access the dashboard for either their own transfer activity or their organization's activity. Archivists can switch between dashboards for all active organizations.

## Transfers Page
## Transfer status

Aurora provides a searchable, sortable table to view information about all transfers. A button allows the download of a CSV file containing the data from the transfer table. Users can view the status of each transfer, which is updated as it moves through the process. There are 9 possible statuses:

Expand All @@ -27,19 +21,18 @@ Aurora provides a searchable, sortable table to view information about all trans
8. In Accession Queue
9. Accession Complete

### Transfer details
## Transfer details

Users can view more details about a particular transfer by clicking on its row in the table. The detail page provides, as applicable:
Users can view details about a particular transfer by clicking on its name in the main transfers table. The detail page provides, as applicable:
- Identifiers
- Error messages
- Log including error messages
- Metadata
- Manifest
- Log
- Rights statements
- Appraisal note
- Appraisal note from an archivist, if applicable
- Associated rights statements
- Manifest of files in the transfer

## Appraisal
Archivists can review a queue of the valid transfers to ensure they are relevant to the collecting scope. The upfront validation provided by Aurora (particularly the BagIt Profile validation) should prevent most out-of-scope records from being received, but this step allows a manual check by users with the appropriate permissions (see Users section) who may:
Archivists can review a queue of the valid transfers to ensure they are relevant to the collecting scope. The initial validation provided by Aurora (particularly the BagIt Profile validation) should prevent most out-of-scope records from being received, but this step allows a manual check by users with the appropriate permissions (see Users section) who may:

1. View transfer details
2. Add an appraisal note (optional)
Expand All @@ -48,36 +41,26 @@ Archivists can review a queue of the valid transfers to ensure they are relevant
When an archivist rejects a transfer, the donor account that submitted that transfer will receive an email notification that the transfer has been rejected, which will include the text of the appraisal note.

## Accessioning
Once transfers have been accepted in the appraisal queue, they are moved to the accessioning queue, where multiple transfers can be grouped together into a single accession if they have the same organization, record creators and record type. Archivists with the necessary permissions can create accession records with data about one or (usually) more transfers, and point them to specific ArchivesSpace resource records.

Information about each accession is saved in the Saved Accessions tab, where archivists can view a table with information about each accession and click on an accession for more details.

## Administration
Aurora provides the ability to manage organizations and users accounts with those organizations.
Once transfers have been accepted in the Appraisal Queue by an archivist, they are moved to the Accessioning Queue, where multiple transfers are be grouped together into a single accession if they have the same organization, record creators and record type. Archivists with the necessary permissions can create accession records with data about one or (usually) more transfers, and point them to specific ArchivesSpace resource records.

### Organizations
Information about each accession is saved in the Saved Accessions page, where archivists and donors can view a table with information about each accession and click on an accession for more details.

Organizations can be created or deleted by archivists with the necessary permissions. In addition, Aurora allows for the management of the BagIt Profile and PREMIS Rights Statements associated with the organizations.
## Organization administration
Aurora provides the ability to manage organizations and users accounts with those organizations. Organizations can be created or deleted by archivists with the necessary permissions. In addition, Aurora allows for the creation and management of the BagIt Profile and PREMIS Rights Statements associated with the organizations.

#### BagIt Profiles
### BagIt Profiles

[BagIt Profiles](https://github.com/bagit-profiles/bagit-profiles) allow for detailed validation of metadata elements included in a transfer. Aurora allows archivists to create, edit, delete and view these profiles, and provides a JSON representation of the Profile against which transfers can be validated. Each organization can only have one BagIt Profile.
[BagIt Profiles](https://github.com/bagit-profiles/bagit-profiles) allow for detailed validation of metadata elements included in a transfer. Aurora enables archivists to create, edit, delete and view these profiles, and provides a JSON representation of the Profile against which transfers are validated. Each organization can only have one BagIt Profile.

#### PREMIS Rights

[PREMIS Rights Statements](https://www.loc.gov/standards/premis/understanding-premis.pdf) allow archivists to specify, in a machine-actionable way, what can and cannot be done with digital records based on the donor agreements. Aurora allows archivists to create, edit and delete one or more PREMIS Rights Statements, and associate them with record types. Record types are specified in the organization's BagIt Profile.
### PREMIS Rights
[PREMIS Rights Statements](https://www.loc.gov/standards/premis/understanding-premis.pdf) allow archivists to specify, in a machine-actionable way, what can and cannot be done with digital records based on donor agreements. Aurora allows archivists to create, edit and delete one or more PREMIS Rights Statements, and associate them with specific record types. Record types are specified in the organization's BagIt Profile.

For details on PREMIS and the RAC's local implementation, see the [Rockefeller Archive Center PREMIS Rights Statements Guidelines](http://docs.rockarch.org/premis-rights-guidelines/).

### Users

Aurora supports management of user accounts, and allows archivists with appropriate permissions to add users, declare user accounts active or inactive, associate them with an organization, and assign them to groups (to specify their roles and permissions).

#### User roles and permissions

Aurora implements the following user roles and associated permissions:
## User administration
Aurora supports management of user accounts and allows archivists with appropriate permissions to add users, declare user accounts active or inactive, associate them with an organization, and assign them to groups (to specify their roles and permissions). Aurora implements the following user roles and associated permissions:

#### Read-only users
### Read-only users

All users (including those form donor organizations) have a few basic permissions:

Expand All @@ -90,11 +73,11 @@ All users (including those form donor organizations) have a few basic permission
* View own user profile
* Change own password

#### Archivist users
### Archivist users

In addition to the permissions for **All Users**, users who are archivists have the following additional permissions:

##### All archivists
#### All archivists
* View all dashboards
* View all transfers
* View all organizations
Expand All @@ -104,20 +87,20 @@ In addition to the permissions for **All Users**, users who are archivists have
* View appraisal queue
* View accessioning queue

##### Appraisal archivist
#### Appraisal archivist

In addition to the permissions of **All Archivists**, Appraisal Archivists have the following additional permissions:

* Accept or reject transfers
* Add appraisal notes to transfers

##### Accessioning archivist
#### Accessioning archivist

In addition to the permissions of **All Archivists**, Accessioning Archivists have the following additional permissions:

* Create accession records

##### Managing archivist
#### Managing archivist

In addition to the permissions of **All Archivists**, Managing Archivists have the following additional permissions:

Expand All @@ -129,7 +112,7 @@ In addition to the permissions of **All Archivists**, Managing Archivists have t
* Add/edit rights statements
* Add/edit Bag-It Profiles

##### System administrator
#### System administrator

In addition to the permissions of **All Archivists**, System Administrators have the following additional permissions:

Expand All @@ -144,6 +127,6 @@ In addition to the permissions of **All Archivists**, System Administrators have

## Developer resources

Aurora comes with a RESTful API, built using the Django Rest Framework. Users can interact with the API using a command-line client, but the application also includes a browsable API interface and the JSON API schema.
Aurora comes with a RESTful API, built using the Django Rest Framework. Users can interact with the API using a command-line client.

For more information, see the [README](https://github.com/RockefellerArchiveCenter/aurora/blob/base/README.md) in Aurora's GitHub repository.