Difference between revisions of "UC-3.3"

From Archivematica
Jump to navigation Jump to search
(Created page with 'Main Page > Requirements > OAIS Use Cases > UC-3 Data Management > UC-3.3 Generate Reports from Data Management Database')
 
 
Line 1: Line 1:
 
[[Main Page]] > [[Requirements]] > [[OAIS Use Cases]] > [[UC-3|UC-3 Data Management]] > UC-3.3 Generate Reports from Data Management Database
 
[[Main Page]] > [[Requirements]] > [[OAIS Use Cases]] > [[UC-3|UC-3 Data Management]] > UC-3.3 Generate Reports from Data Management Database
 +
 +
{| border="1" cellpadding="10" cellspacing="0" width=90%
 +
| colspan="4" style="background-color:silver;"|
 +
===UC-3.3 Generate Reports from Data Management Database===
 +
|-
 +
|colspan="2" style="background-color:#E0FFFF;"|'''Summary'''
 +
|-
 +
|Number
 +
|UC-3.3
 +
|-
 +
|Name
 +
|Generate Reports from Data Management Database
 +
|-
 +
|-
 +
|Context
 +
|[[UC-3 | UC-3 Data Management]]
 +
|-
 +
|Sub-Use Cases
 +
|
 +
|-
 +
|Overview
 +
|
 +
Generate Report responds to requests from Ingest, Access or Administration for aggregated information from the Data Management Database. A request for information is received, one or more queries are executed on the database, the query results are formatted into a report, and the report is supplied to the requesting actor.
 +
|-
 +
|Actors
 +
|
 +
*Generate Report
 +
*Ingest>Generate AIP
 +
*Administration>Manage System Configuration
 +
*Access>Co-ordinate Access Activities
 +
*Access>Generate DIP
 +
|-
 +
|colspan="2" style="background-color:#E0FFFF;"|'''Description'''
 +
|-
 +
|Preconditions
 +
|
 +
UC-3.1 Administer Data Management Database (database policies have been implemented and database integrity is intact); and (as appropriate):
 +
*UC-1.3 Generation of AIP; ''or'',
 +
*UC-4.2 Managing System Configuration; ''or'',
 +
*UC-6.1 Submission of Query
 +
 +
|-
 +
|Trigger
 +
|
 +
*UC-1.3 step 5 - Ingest>Generate AIP requests report from Generate Report on information required to assemble the AIP; ''or'',
 +
*UC-6.1 step(s?) - Request for report from Access>Co-ordinate Access Activities and/or request for Descriptive Information from Access>Generate DIP; ''or'',
 +
*UC-4.2 step (?) - Administration>Manage System Configuration
 +
 +
|-
 +
|Successful outcome
 +
|
 +
A report containing the results of the requested query/queries is supplied to the requesting party.
 +
|-
 +
|Steps
 +
|
 +
#Generate Report receives report request from Ingest>Generate AIP, Access>Co-ordinate Access Activities, Access>Generate DIP or Administration>Manage System Configuration (OAIS page 4-9, s 4.1.1.4)
 +
#Generate Report executes queries (OAIS page 4-9, s 4.1.1.4)
 +
#Generate Report formats query results into report (OAIS page 4-9, s 4.1.1.4)
 +
#Generate Report transmits report to requester (OAIS page 4-9, s 4.1.1.4)
 +
|-
 +
|Exceptions
 +
|
 +
|-
 +
|colspan="2" style="background-color:#E0FFFF;"|'''Documentation'''
 +
|-
 +
|Citations
 +
|
 +
'''OAIS page 4-9, s 4.1.1.4'''
 +
 +
"The Generate Report function receives a report request from Ingest, Access or
 +
Administration and executes any queries or other processes necessary to generate the report
 +
that it supplies to the requester. Typical reports might include summaries of archive holdings
 +
by category, or usage statistics for accesses to archive holdings. It may also receive a report
 +
request from Access and provides descriptive information for a specific AIP."
 +
|-
 +
|Diagrams
 +
|
 +
|-
 +
|colspan="2" style="background-color:#E0FFFF;"|'''Notes'''
 +
|-
 +
|
 +
|
 +
re: step 1 -- Generate Report can receive requests for reports from Ingest>Generate AIP, Access>Co-ordinate Access Activities, Access>Generate DIP, and Administration>manage System Configuration. Do each of the requesters need to be distinguished in the use case steps? It seems if the request includes the information required as well as the reporting format it is to be assembled into, that the response can (and should)be independant from the requesting party.
 +
|}

Latest revision as of 11:26, 4 September 2009

Main Page > Requirements > OAIS Use Cases > UC-3 Data Management > UC-3.3 Generate Reports from Data Management Database

UC-3.3 Generate Reports from Data Management Database[edit]

Summary
Number UC-3.3
Name Generate Reports from Data Management Database
Context UC-3 Data Management
Sub-Use Cases
Overview

Generate Report responds to requests from Ingest, Access or Administration for aggregated information from the Data Management Database. A request for information is received, one or more queries are executed on the database, the query results are formatted into a report, and the report is supplied to the requesting actor.

Actors
  • Generate Report
  • Ingest>Generate AIP
  • Administration>Manage System Configuration
  • Access>Co-ordinate Access Activities
  • Access>Generate DIP
Description
Preconditions

UC-3.1 Administer Data Management Database (database policies have been implemented and database integrity is intact); and (as appropriate):

  • UC-1.3 Generation of AIP; or,
  • UC-4.2 Managing System Configuration; or,
  • UC-6.1 Submission of Query
Trigger
  • UC-1.3 step 5 - Ingest>Generate AIP requests report from Generate Report on information required to assemble the AIP; or,
  • UC-6.1 step(s?) - Request for report from Access>Co-ordinate Access Activities and/or request for Descriptive Information from Access>Generate DIP; or,
  • UC-4.2 step (?) - Administration>Manage System Configuration
Successful outcome

A report containing the results of the requested query/queries is supplied to the requesting party.

Steps
  1. Generate Report receives report request from Ingest>Generate AIP, Access>Co-ordinate Access Activities, Access>Generate DIP or Administration>Manage System Configuration (OAIS page 4-9, s 4.1.1.4)
  2. Generate Report executes queries (OAIS page 4-9, s 4.1.1.4)
  3. Generate Report formats query results into report (OAIS page 4-9, s 4.1.1.4)
  4. Generate Report transmits report to requester (OAIS page 4-9, s 4.1.1.4)
Exceptions
Documentation
Citations

OAIS page 4-9, s 4.1.1.4

"The Generate Report function receives a report request from Ingest, Access or Administration and executes any queries or other processes necessary to generate the report that it supplies to the requester. Typical reports might include summaries of archive holdings by category, or usage statistics for accesses to archive holdings. It may also receive a report request from Access and provides descriptive information for a specific AIP."

Diagrams
Notes

re: step 1 -- Generate Report can receive requests for reports from Ingest>Generate AIP, Access>Co-ordinate Access Activities, Access>Generate DIP, and Administration>manage System Configuration. Do each of the requesters need to be distinguished in the use case steps? It seems if the request includes the information required as well as the reporting format it is to be assembled into, that the response can (and should)be independant from the requesting party.

Retrieved from "https://wiki.archivematica.org/index.php?title=UC-3.3&oldid=260"