Functional requirements

Main Page > System Requirements > Functional requirements

Functional requirements state what the system must be able to do. The requirements provide:

• Parameters for designing the system.
• Criteria for testing the system (used in initial release and future iterations and upgrades).
• Planning guidelines for developing the system (improve existing or add new functionality).
• Documentation for standards compliance (link requirements to relevant international or national descriptive standards)
• A framework for structuring user-end documentation (step-by-step procedures for how to do things in the system).

Functional requirements are organized hierarchically, with core requirements, broken down into sub- and sub-sub-requirements. around the core functions of repositories holding archival material. ICA-AtoM currently focuses on two functions, breaking these down into sub- and sub-sub-requirements:

1. Establish intellectual and administrative control over archival materials
2. Provide an interface that supports user interaction with the system (create, read, update, delete, search

Each functional requirement includes the following information:

Requirement number	FR-x.x.x (unique tracking number assigned to requirement)
Requirement name	Descriptive name assigned to requirement.
Requirement specification	Brief description of requirement: system must do X.
Sub-requirements	If the requirement is broken down into sub-requirements, provides links to these.
Requirement quotation	Links to standards or other documents: why must the system be able to do X?
Associated metadata requirements	Links to functional requirements: what data must the system capture in order to be able to do X?
Associated quality requirements	Links to quality requirements: what design and interface features must the system have to do X well?
Associated technical requirements	Links to technical requirements: what system architecture, hardware / software configurations, and programming rules must the system implement to do X?
ICA-AtoM implementation	Brief description of how ICA-AtoM implements X.
Known issues	Brief indication of known problems or limitations in the current version of ICA-AtoM that should be addressed in future releases.
User Manual sections	Links to the User manual sections that provide step-by-step instructions for doing X.

Establish intellectual and administrative control over archival materials

Requirement number	FR-1
Requirement name	Establish intellectual and administrative control over archival materials
Requirement specification	The system must: Support the arrangement and description of archival materials in order to make them accessible.
Sub-requirements	1.1 Implement a system of control 1.2 Implement descriptive standards 1.3 Create and control description records 1.4 Describe archival materials 1.5 Describe actors 1.6 Describe archival institutions

---

Implement a system of control

Requirement number	FR-1.1
Requirement name	Implement a system of control.
Requirement specification	The system must:
Sub-requirements	1.1.1 Support multi-level description 1.1.2 Accommodate different levels as the highest level of arrangement and description 1.1.3 Accommodate different systems for assigning reference codes

---

Support multi-level description

Requirement number	FR-1.1.1
Requirement name	Support multi-level description.
Requirement specification	The system must be able to:
Requirement quotation	ISAD(G) ISAAR(CPF) ISIAH
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Accommodate different levels as the highest level of arrangement and description

Requirement number	FR-1.1.2
Requirement name	Accommodate different levels as the highest level of arrangement and description.
Requirement specification	The system must be able to:
Requirement quotation	ISAD(G) ISAAR(CPF) ISIAH
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Accommodate different systems for assigning reference codes

Requirement number	FR-1.1.3
Requirement name	Accommodate different systems for assigning reference codes.
Requirement specification	The system must be able to:
Requirement quotation	ISAD(G) ISAAR(CPF) ISIAH
Associated metadata requirements
Associated quality requirements
Associated technical requirements
ICA-AtoM implementation
Known issues
User Manual sections

---

Implement descriptive standards

Requirement number	FR-1.2
Requirement name	Implement descriptive standards.
Requirement specification	The system must:
Sub-requirements	1.2.1 Support all ICA standards 1.2.2 Integrate with existing national or local standards 1.2.3 Accommodate different practices for the level of detail required 1.2.4 Separate description of archival materials from description of creators and repositories

Create and control description records

Requirement number	FR-1.3
Requirement name	Create and control descriptions
Requirement specification	The system must:
Sub-requirements	1.3.1 Accept contributions from multiple repositories 1.3.2 Assign unique identifiers to descriptions 1.3.3 Accommodate descriptions of different status (draft, finalized, superseded / obsolete 1.3.4 Prevent unauthorized creation, alteration or deletion of descriptions 1.3.5 Track changes to descriptions over time 1.3.6 Remove superseded or obsolete descriptions

Describe archival materials

Requirement number	FR-1.4
Requirement name	Describe archival materials.
Requirement specification	The system must:
Sub-requirements	1.4.1 Describe the intellectual and physical characteristics of archival materials in all media and record formats 1.4.2 Describe the context of archival materials 1.4.3 Describe the conditions governing access and use of archival materials 1.4.4 Ensure that information at the higher and lower levels of description is consistent 1.4.5 Identify the location of material described 1.4.6 Indicate the existence of related materials

Describe actors

Requirement number	FR-1.5
Requirement name	Describe actors.
Requirement specification	The system must:
Sub-requirements	1.5.1 Establish authorized headings for actors (names) [[#FR-1.5.2 | 1.5.2 Describe the characteristics and activities of actors.] 1.5.3 Identify relationships between actors and track changes over time 1.5.4 Identify archival materials related to actors 1.5.5 Identify actors that are also custodians of archival materials

Describe archival institutions

Requirement number	FR-1.6
Requirement name	Describe archival institutions.
Requirement specification	The system must:
Sub-requirements	1.6.1 Describe the mandate and structure of archival institutions 1.6.2 Describe the holdings of archival institutions 1.6.3 Provide the contact information of archival institutions 1.6.4 Describe the services provided by archival institutions

Template

Requirement number	MR-x
Requirement name	Name
Requirement specification	The system must: requirement1 requirement2
Requirement quotation	link to ISAD(G). link to ISAAR(CPF). link to ISIAH. link to ISDF. link to OSARIS.
Associated metadata requirements	link to metadata requirement.
Associated quality requirements	link to quality requirement.
Associated technical requirements	link to technical requirement.
ICA-AtoM implementation	discuss how ICA-AtoM implements requirement.
Known issues	discuss how any known problems with ICA-AtoM's current implementation / functionality.
User Manual sections	link to User Manual pages.