Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

This template is based on a document about the Custom Reports requirement for PAHMA and UCJEPS.  Content is included below to provide an example of the level of detail recommended.

To use this document: While viewing the document and logged in, open up Page Operations in the left panel, select Info, and click on the Copy command (in the Operations area).  Change the title to match your requirement area, and edit document.

Needed by whom and when

Basic statements about who needs the functionality and by when.

Museum XPAHMA: Some functions needed by the time they move to CollectionSpace as their production system

Overview

We know we will need to build custom reports locally.

Note: Fields that have been renamed in the user interface or added as custom fields need to show up on reports (canned, custom, or ad hoc) with the titles that make sense to the museum user.

Question: For scope clarification, list questions here.when?

Overview

PAHMA (and presumably other collections) have objects that are associated with historical events or periods.  Beyond basic associations, they would like the system to have intelligence about historical events and be able to associate other objects in the collection that are dated to that period but not specifically associated with a historical event.

Note: In a conversation on October 20, 2010, Michael Black said this was not a high priority.

Question: Is this a question about specific events or rather periods or eras?

Question: What is the information schema for historical events (name, start date, end date, description, notes)?

User stories for definition

Please feel to rewrite these or eliminate completely!  Then move to the prioritized headings below.

Custom reports: Developer can create a custom report and run it, producing a printed file or PDF that can be given to museum.

Custom reports: Developer can create a simple custom report and add it to the user interface so museum staff can run it themselves.  Report requires no input (e.g., acquisitions in last 7 days).

Custom reports: Developer can create a complex custom report (e.g., requires user input to specify a value used in the report) and add it to the user interface so museum staff can run it themselves.  Report requires input from user (e.g., acquisitions in last variable number of days).

Custom reports: User can run ad hoc report against their CollectionSpace instance.

Custom reports: User can develop a custom report and save it for later use.

Custom reports: User can develop and save a custom report and share it with other usersHistorical events controlled vocabulary: User can manage historical events or periods in a controlled vocabulary.

Historical events controlled vocabulary: User can associate objects with historical events.

Historical events controlled vocabulary: System will have some intelligence to associate historical periods with dates and facilitate searching the collection.

Prioritization of user stories

As definitions and priorities are clarified, the user stories above should be moved into relative order below.

Must have for 1.x-MUSEUM (when they go live in system)

Placeholder for required functionality.  As a general rule, functionality that you need and use now should go here or where you have existing data.  However, this is up to the museum.  We will have to balance requirements against resources and timelines.

Placeholder

MUSEUM could wait six to twelve months

What could wait?  These will be re-prioritized at a later date.

Placeholder

MUSEUM would like to have this eventually

These are nice to have but not a near term requirement.

...