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.

  1. Date range
    Users may limit report data to a single date or range of dates that the RAD records were created, not modified.
  2. Repository
    Users may limit report data to a specific repository.
  3. Location
    Users may limit report data to a specific location, limited by Building, Floor, Room, or Area.
  4. Graphs Only
    Users may elect to run a report with graphs only.
  5. Data Only
    Users may elect to run a report with data only.
  6. Record Type
    Users may
    limit report data to a specific type of record: Resource, Accession, or Digital Objects. 
  7. Extent Type
    User may limit report data to a specific type of extent: Linear Feet, Gigabytes, etc. 
  8. 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:

  1. Title of report
  2. Repository
  3. Location
  4. Date Range
  5. Contents
  6. Summary
  7. Sections (if applicable)
  8. Page numbers

Style Guide

Additionally, each ArchivesSpace report should be styled as follows:

  1. Tables should have repeating table headings across multiple pages.
  2. Table data should be sorted by RAD Identifier.
  3. Each report section (defined by the primary and secondary sort) should begin on a new page.
  4. Frequency data analysis/summary should be displayed in a bar chart.
  5. Ratio data analysis/summary should be displayed in a pie chart.
  6. 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

TitleDescriptionUse CaseDataParametersPrimary SortSecondary Sort
Rights Statements: RestrictionsList of restricted resources, accessions, and digital objects generated with active Rights Statements.
  1. Identifier
  2. Title
  3. Rights Type
  4. Restrictions
  5. Restrictions Start Date
  6. Restrictions End Date
  1. Date range
  2. Repository
  3. Location
  4. Graphs Only
  5. Data Only
  6. Record Type
  7. RAD Identifier
Rights TypeRecord Type
Rights Statements: Institutional PolicyList of Institutional Policy rights statements associated with resource or accession records. Report generated when Rights Type is Institutional Policy in Rights Statements module.
  1. Identifier
  2. Title
  3. Materials
  4. Permissions
  5. Restrictions
  6. Restrictions Start Date
  7. Restrictions End Date
  1. Date range
  2. Repository
  3. Location
  4. Graphs Only
  5. Data Only
  6. Record Type
  7. RAD Identifier
Record Type
Rights Statements: Intellectual PropertyList of intellectual property rights associated with resource or accession records. Report generated when Rights Type is Intellectual Property in Rights Statements module.
  1. Identifier
  2. Title
  3. IP Status
  4. IP Expiration Date
  5. Jurisdiction
  6. Permissions
  7. Restrictions
  8. Restrictions Start Date
  9. Restrictions End Date
  1. Date range
  2. Repository
  3. Location
  4. Graphs Only
  5. Data Only
  6. Record Type
  7. RAD Identifier
Record Type
Rights Statements: LicensesList of License Rights Statements associated with resource or accession records. Report generated when Rights Type is License in Rights Statements module.
  1. Identifier
  2. Title
  3. License Identifier Terms
  4. Permissions
  5. Restrictions
  6. Restrictions Start Date
  7. Restrictions End Date



Rights Statements: StatutesList of Statute Rights Statements associated with resource or accession records. Report generated when Rights Type is Statute in Rights Statements module.
  1. Identifier
  2. Title
  3. Statute Citation
  4. Jurisdiction
  5. Permissions
  6. Restrictions
  7. Restrictions Start Date
  8. Restrictions End Date



Collection Management

TitleDescription/Use CaseUse CaseDataParametersPrimary SortSecondary Sort
Collection Management: Overview

List of all Accessions, Resources, and Digital Objects with data entered in the Collection Management module.


  1. Identifier
  2. Title
  3. Resource Type
  4. Cataloged Note
  5. Priority
  6. Processing Status
  7. Extent
  8. Extent Type
  9. Rights Determined?
  1. Date range
  2. Repository
  3. Location
  4. Graphs Only
  5. Data Only
  6. Record Type
Record TypeNone
Collection Management: Processing Priority

List of Accessions, Resources, and Digital Objects.

Determine processing priorities.
  1. Identifier
  2. Title
  3. Priority
  4. Extent
  5. Extent Type
  1. Date range
  2. Repository
  3. Location
  4. Graphs Only
  5. Data Only
  6. Record Type

Priority


Record Type

Collection Management: Processing Status
Determine work assignments.
  1. Identifier
  2. Title
  3. Processing Status
  4. Extent
  5. Extent Type
  1. Date range
  2. Repository
  3. Location
  4. Graphs Only
  5. Data Only
  6. Record Type
Processing StatusRecord Type