ArchivesSpace Reports
Overview
On December 19, 2014, the ArchivesSpace User Advisory Council Reports Subgroup agreed to develop a list of potential reports for ArchivesSpace modules and functions that do not exist in the Archivists' Toolkit. These "conceptual reports" should describe the report, record what the report will accomplish, and indicate the data to be included.
(mdc: just a quick note that we'll also need to add additional options/parameters to carry-over reports from the AT. e.g. group by classification groups in an accessions/resources report; whole/part extents; etc)
Notes about this guide to ArchivesSpace reports:
- Identifier may refer to an identifier for a Resource, Accession, or Digital Object.
- Record Type refers to the top level material description records: Accessions, Resources, and Digital Objects.
Report Components
For each report specification, the following components are included to provide an overview of the contents of each report.
Title
Title of the report.
Description
A brief text account of the report.
Use Case
A written description of how ArchivesSpace users will make use of the report.
Data
ArchivesSpace data to be used in the report.
Parameters
Parameters by which ArchivesSpace users may customize each report.
- Date range
Users may limit report data to a single date or range of dates that the RAD records were created, not modified. - Repository
Users may limit report data to a specific repository. - Location
Users may limit report data to a specific location, limited by Building, Floor, Room, or Area. - Graphs Only
Users may elect to run a report with graphs only. - Data Only
Users may elect to run a report with data only. - Record Type
Users may limit report data to a specific type of record: Resource, Accession, or Digital Objects. - Extent Type
User may limit report data to a specific type of extent: Linear Feet, Gigabytes, etc. - Identifier
User may limit report data to a specific Resource, Accession, or Digital Object.
Primary Sort
The primary way the ArchivesSpace data is sorted to form a section of the report.
Secondary Sort
The secondary way the ArchivesSpace data is sorted to for a subsection of the report.
Elements
Each ArchivesSpace report should include the following elements:
- Title of report
- Repository
- Location
- Date Range
- Contents
- Summary
- Sections (if applicable)
- Page numbers
Style Guide
Additionally, each ArchivesSpace report should be styled as follows:
- Tables should have repeating table headings across multiple pages.
- Table data should be sorted by RAD Identifier.
- Each report section (defined by the primary and secondary sort) should begin on a new page.
- Frequency data analysis/summary should be displayed in a bar chart.
- Ratio data analysis/summary should be displayed in a pie chart.
- Longitudinal data analysis/summary should be displayed in a line chart.
Template
See the ArchivesSpace Report Template for an example of the elements and their styling.
Report Specifications
Rights Statements
Title | Description | Use Case | Data | Parameters | Primary Sort | Secondary Sort |
---|---|---|---|---|---|---|
Rights Statements: Restrictions | List of restricted resources, accessions, and digital objects generated with active Rights Statements. |
|
| Rights Type | Record Type | |
Rights Statements: Institutional Policy | List of Institutional Policy rights statements associated with resource or accession records. Report generated when Rights Type is Institutional Policy in Rights Statements module. |
|
| Record Type | ||
Rights Statements: Intellectual Property | List of intellectual property rights associated with resource or accession records. Report generated when Rights Type is Intellectual Property in Rights Statements module. |
|
| Record Type | ||
Rights Statements: Licenses | List of License Rights Statements associated with resource or accession records. Report generated when Rights Type is License in Rights Statements module. |
| ||||
Rights Statements: Statutes | List of Statute Rights Statements associated with resource or accession records. Report generated when Rights Type is Statute in Rights Statements module. |
|
Collection Management
Title | Description/Use Case | Use Case | Data | Parameters | Primary Sort | Secondary Sort |
---|---|---|---|---|---|---|
Collection Management: Overview | List of all Accessions, Resources, and Digital Objects with data entered in the Collection Management module. |
|
| Record Type | None | |
Collection Management: Processing Priority | List of Accessions, Resources, and Digital Objects. | Determine processing priorities. |
|
| Priority | Record Type |
Collection Management: Processing Status | Determine work assignments. |
|
| Processing Status | Record Type |