Development of Digital Archive IT System Technical Requirements
Development of Digital Archive IT System Technical Requirements
Development of Digital Archive IT System Technical Requirements
1
6.1 References ..................................................................................................................................37
6.2 Definitions...................................................................................................................................38
6.3 List of Acronyms .........................................................................................................................40
2
1 INTRODUCTION
This document is related to the project Maps for National Development and European Integration
where Statens kartverk1 (The Norwegian Mapping Authority) is supporting both Administration for
Geodetic and Real Property Affairs in Bosnia and Herzegovina: Republic Administration for Geodetic and
Real Property Affairs (RSGA)2 and Federal Administration for Geodetic and Real Property Affairs (RSGA)3
with developing digital archives.
The complementary project "Capacity Building for Improvement of Land Administration and Procedures
in Bosnia and Herzegovina" (CILAP)4, financed by Lantmteriet5, focuses on strengthening and
development of the land administration institutions and business processes, human resources, education
and training in using of modern survey technology, development of a legislation framework, property and
land valuation system, an work processes utilizing new, modern digital archives.
1.1 Purpose
The purpose of this document is to provide the necessary background information, business needs,
system scope, and high-level technical specifications for the outsourcing of the detailed design,
development and the implementation of a Digital Archive IT system, to be installed at RSGA.
1 http://www.statkart.no
2 http://www.rgurs.org
3 http://www.fgu.com.ba
4 http://www.cilap-project.org
5 http://www.lantmateriet.se
3
Describe the system architecture,
Specify the overall system requirements,
Specify the non-functional requirements.
The contractor has the obligation to implement the metadata for each of the classes of archive
documents listed and described in chapter 4.6. The contractor, will consider technical requirements
information contained in this document and all other information that the RSGA will provide during
implementation. If the contractor needs other information for the modifications of metadata, the RSGA
will provide clarifications upon request. In case there is a need for metadata modifications during the
project implementation the contractor can propose changes to the metadata specifications, which need
to be accepted by the RSGA.
6 Archive documents, files, maps and documents from FGA internal systems.
7 RSGA internal systems are listed in 4.1.1.2.
4
7. Data/Document Search & Access
The system needs to provide advanced search capabilities based on the document itself (if the document
can be read), document metadata and spatial query (if the related metadata has a spatial component8),
all according to the UML metadata models. The access to documents should be controlled through
dynamic user rights that can be applied to a single document or a set of documents and are controlled by
the administrator. Document access should be provided as read only (access only through the
application), watermarked document download, compressed document downloads and original
document download. The system needs to track user activity in regards to system usage and provide the
administrator with reporting capabilities.
8
Term spatial component in this documents implies MBR (minimum bounding rectangle) of the space
covered by documents content.
5
2 GENERAL ARCHITECTURE PRINCIPLES
Architecture of a software-intensive system is the structure or structures of the system, which comprise
software elements, the externally visible properties of those elements, and the relationships among
them. The system architecture defines four different aspects of system:
1. Static structures
Specify the design-time form of a system, i.e. its internal design-time elements (modules, services,
classes, computers, routers) and their arrangement.
2. Dynamic structures
Specify how the system actually works and what the system does in response to external (or internal)
stimulus. Dynamic structures define run-time elements of system and their interactions.
3. Externally visible behavior
Specifies what a system does from the viewpoint of an external observer, i.e. defines the functional
interactions between the system and its environment.
4. Quality properties
An externally visible, nonfunctional properties of a system such as performance, security, or scalability.
System architecture is an abstraction - an architecture description captures architecture. The architecture
description is inherently multi-view. No single view is sufficient to capture architecture because
architecture is multi-disciplinary, with multiple stakeholders and multiple architecture-related concerns
that the architect must deal with. The viewpoints (perspectives on the architecture) are separated from
views (what is captured in the description of a specific architecture from the perspective of a viewpoint
for a system of interest). This distinction is motivated by the body of existing practice that defines
viewpoints for a number of architecture-related concerns. There should be a viewpoint for each view -
the viewpoint explains the conventions being used in that view.
According to [1] an architecture description contains the following:
Identification of the stakeholders for the architecture and the system of interest,
Identification of the architecture-related concerns of those stakeholders,
A set of architecture viewpoints defined so that all of the stakeholder concerns are covered by
that set of viewpoints,
A set of architecture views, such that there is one view for each viewpoint,
A set of architecture models from which the views are composed.
Figure 2.1 depicts concepts pertaining to the practice of architecture description when applying
ISO/IEC/IEEE 42010 Standard [1] to produce architecture description expressing architecture for the
system-of-interest.
A system is built to address the needs, concerns, goals and objectives of its stakeholders. Stakeholders of
a system have concerns with respect to the system-of-interest considered in relation to its environment.
A concern could be held by one or more stakeholders. Concerns arise throughout the life cycle from
system needs and requirements, from design choices and from implementation and operating
considerations. A concern could be manifest in many forms, such as in relation to one or more stakeholder
needs, goals, expectations, responsibilities, requirements, design constraints, assumptions,
dependencies, quality attributes, architecture decisions, risks or other issues pertaining to the system.
The system architecture is comprised of a number of architecture elements and their relationships, and
can be documented by an architecture description.
An architecture description documents architecture for its stakeholders and demonstrates to them that
it has met their needs. It includes one or more architecture views.
6
A viewpoint defines the aims, intended audience, and content of a class of views and defines the concerns
that views of this class will address.
7
3 ARCHITECTURE DECISIONS AND RATIONALE
The decision on global system architecture is influenced by a number of relevant factors and architectural
principles - all of them have been considered and excessively discussed with RSGA and a centralized
multitier system should be implemented. The two factors that have primarily influenced the global
system architecture are: organization of geodetic administration and telecommunication infrastructure.
RSGA is centralized institution, so the DA of RSGA will be implemented as a centralized system (Fig. 3.1).
8
4 VIEWS AND MODELS
4.1 Context view
The Context view describes relationships, dependencies and interactions between DA system and its
environment - the people, systems and external entities with which it interacts. It defines what the system
does and does not do; where the boundaries are between it and the outside world; and how the DA
system interacts with other systems and organizations across these boundaries.
4.1.1 Concerns
4.1.1.1 System scope and responsibilities
This concern does not extend to a complete definition of the systems requirements. System scope
encompasses:
Capturing, storing, managing and distribution of archival data,
Preserving all archive information in a central repository and make them available for an
identified group of users and potential customers,
Data, metadata and spatial search capabilities for all data stored,
Supporting regular and ad hoc extracts to the publishing repository,
Support for integration and communication with other systems via SOA.
4.1.1.2 Identity of external entities and services
There are several existing and future systems that should be able to integrate with DA. This is why the
main business functionalities of the DA should be exposed to other systems. The bidder has no
responsibility for developing the service interfaces in the existing RSGA internal systems the
corresponding system providers will develop them.
4.1.1.3 Identity and responsibilities of external interfaces
RSGA internal systems mentioned in may have one or more of the following responsibilities:
Data provider the system that supplies data directly to DA.
Data consumer the system that receives data directly from DA.
Service consumer the system that request some action of DA.
4.1.2 Stakeholders
Stakeholder concerns for the Context viewpoint are listed in Table 4.1:
Acquires
Developers
System administrator
Users
Acquires
Developers
System administrator
Users
10
4.4 Functional model
UML component diagram (Fig 4.2) describes OAIS-compliant functional model9.
9Potenital bidders are allowed to propose alternative UML model which provide equivalent functional
capabilities.
11
Information structure and content the structure and content of the information that DA stores,
manages and distributes.
Information flow the way that information moves around system and is accessed, modified and
distributed by its components.
Stakeholder concerns for the Information viewpoint are listed in Table 4.3:
Acquires
Developers
System administrator
Users
10Archive documents do not include documents from the exisitng internal systems listed in 4.1.1.2.
However, DA component shall be able to manage documents from these systems.
12
Static information structures models (i.e. metadata specification) for these document classes are
presented in sections 4.6.1 4.6.12. These are the foundation for specifying the structure of the
metadata. The final set of metadata will be defined during the implementation of the project.
4.6.1 Austrian Land Register and Land Cadaster
The most important metadata (describing all document types) are as follows:
level political municipalities mandatory, one of many predefined values,
cadastral municipality mandatory, one of many predefined values,
document type mandatory, one of many predefined values,
document name mandatory,
number of files number of images or pages in a document mandatory,
note not mandatory.
Depending on the document type, the following metadata can appear:
1. Plans and sketches (Planovi i skice)
contents mandatory, one of many predefined values,
nomenclature not mandatory.
Fig 4.3. Austrian Land Register and Land Cadaster UML class diagram
13
4.6.2 Land Cadaster, Topographic Maps, Geodetic Points and Ortophoto
The most important metadata (describing all document types) for Land Cadaster are as follows:
level political municipalities mandatory, one of many predefined values,
cadastral municipality mandatory, one of many predefined values,
document type mandatory, one of many predefined values,
content mandatory, one of many predefined values,
document name not mandatory for all document types,
number of files number of images or pages in a document mandatory,
note not mandatory,
year not mandatory for all document types, one of many predefined values,
land possession list mandatory only for land possession list document type, one or many,
census list mandatory only for census list document type,
document number mandatory,
list of changes not mandatory, one or many,
parcel number not mandatory, one or many,
party mandatory, one or many,
subject type mandatory, one or many,
PL number, one or many.
Fig 4.4. Land Cadaster, Topographic Maps and Ortophoto UML class diagram
The most important metadata for Topographic Maps are as follows:
14
document type mandatory, one of many predefined values,
content mandatory, one of many predefined values,
document name mandatory,
number of files number of images or pages in a document mandatory,
note not mandatory,
year mandatory, one of many predefined values,
nomenclature mandatory.
15
4.6.4 Revision
The most important metadata (describing all document types) for Revision are as follows:
level political municipalities mandatory, one of many predefined values,
cadastral municipality mandatory, one of many predefined values,
document type mandatory, one of many predefined values,
document name not mandatory for all document types,
number of files number of images or pages in a document mandatory,
note not mandatory.
11
one of the following is mandatory: possession list, cadastral-registry slip/sheet, immobilities list
12
one of the following is mandatory: possession list, cadastral-registry slip/sheet, immobilities list
13
one of the following is mandatory: possession list, cadastral-registry slip/sheet, immobilities list
14
one of the following is mandatory: document number, registration number
15
one of the following is mandatory: document number, registration number
16
nomenclature mandatory,
number of files number of images or pages in a document mandatory,
note not mandatory.
4.6.10 Books
The most important metadata (describing all document types) for Books are as follows:
17
level political municipalities mandatory, one of many predefined values,
document type mandatory, one of many predefined values,
field mandatory, one of many predefined values,
document name not mandatory for all document types,
year mandatory,
number of files number of images or pages in a document mandatory,
note not mandatory.
Developers
System administrators
Testers
18
Fig 4.10. Deployment at RSGA
19
5 REQUIREMENTS
5.1 General Technical Requirements
20
The DA must support
creation of new content
types through an
administrative interface.
GTR-4 OAIS The system shall be conforming Optional
to OAIS framework.
21
Database Application Web server Client
server server
DA storage / DA Web DA Web
Web browser
database services application
External
system
Client of DA
Web services
22
described in 4.3 (Functional
view) and Fig. 5.2.
23
associated metadata,
and relationships
Query of content
Access control on
content (permissions)
Versioning of content
Content renditions
Locking
Events
Rules/Actions
FR-8 Content transformation The system shall be able to Mandatory
perform the following content
transformations:
Image to image (lossy
and lossless
compression)
24
FR-13 Searching and retrieval The system shall support Mandatory
searching and retrieval based
on:
General criteria
Targeted criteria
Metadata
QR Code
Bar Code
Enable spatial queries
involving region of
interest and documents
MBR
FR-14 Define spatial region of interest The system shall enable users to Mandatory
define simple spatial region of
interest by:
Importing CSV file
Importing GML file
Defining MBR by user
input
Defining circle
FR-15 Backup and restore The system shall support backing Mandatory
up and restoring DA content
repository
FR-16 Printing, mailing and exporting The system shall support Mandatory
printing, mailing and exporting:
Part of a document
Part of a image
Single document
Aggregate documents
Document sets
FR-17 Monitoring The system shall have a module Mandatory
for overall system monitoring
FR-20 Viewing Map display The system shall enable the Mandatory
viewing (map display) of geo-
referenced maps/imagery.
25
Access should be
blocked to other users
while work is being
performed on the
document.
Multiple users should be able to
view and modify (or markup) a
document at the same time in a
collaboration session.
26
documents for importing with
control number of documents
contained in metadata.
The system shall be able to
update madatada through bulk
import.
Examples of data prepared for
bulk import can be obtained on
request.
FR-35 Access to documents There are users that are allowed Mandatory
to search the DA, but are not
allowed to see the document,
before their request for
accessing the document is not
approved. All requests to
documents should be logged. All
approvals/disapprovals should
also be logged.
DA should expose at least the following three services listed in Table 5.3.
authenticate Web service client Web service client TRUE and access
authentication credentials token or FALSE
28
searchContent Search Part of Metadata/METS, Metadata/METS
content/document access token
16 Delay between a keystroke action by the user and the completion of the system operation measured
at RSGA HQ, on a standard client desktop workstation equivalent to Intel i3 processor.
29
NFR-SC-6 Scalability The system shall be scalable to Mandatory
handle up to twice the currently
planned number of users.
NFR-CS-8 GUI character sets The GUI shall support Latin Mandatory
alphabet.
Errors handling
NFR-EH-1 Errors and warnings The error and warning messages Mandatory
shall be informative and identify
the errors completely as
possible.
30
NFR-DSC-4 Source code Developed source code and all Mandatory
related customization for DA
shall be delivered to RSGA. All
software rights to the developed
source code will be transferred
to RSGA.
NFR-DSC-5 Data model Indexing metadata The final and implemented data Mandatory
model (metadata for indexing)
should be delivered as:
UML class diagram
XML schema(s)
Object catalogue
Project implementation
31
project proceeds to the next
stage.
NFR-SDL-1 Pilot and final versions The DA system shall be delivered Mandatory
in two versions
Pilot version
Final version
The specification of the Pilot
version shall be specified in
detail during the Inception stage
of the project, and accepted by
RSGA. Both versions shall be
tested and accepted (FAT and
UAT) prior to installation on the
production environment.
32
NFR-IT-3 Test plan The supplier shall deliver a test Mandatory
plan of all tests to be included in
the FAT. This plan shall follow
IEEE 829-2008 guidelines. The
test plan shall contain
Test scenarios
Detailed test cases
NFR-IT-4 Test scenario The supplier shall prepare a list Mandatory
of test scenarios, which shall
contain a short description of
real use cases or workflows to be
tested.
The list of scenarios shall be
approved by RSGA.
NFR-IT-5 Test and training environment The supplier shall develop Mandatory
testing, training and
development environments,
separated from the production
system.
Training
33
NFR-TR-1 Training materials The training shall include the Mandatory
preparation of all training
materials (including printed
materials) and handouts. All
training materials shall be
available in the official B&H
languages. Part of the system
documentation can be prepared
in English only.
NFR-TR-2 Involve RSGA staff The supplier shall involve RSGA Mandatory
staff when developing
administration and user
manuals.
34
- 1st level support: 1h
- 2nd level support: 1 day
- 3rd level support: 7 days
NFR-WS-3 Support The support during the warranty Mandatory
shall be implemented via a
three-level support:
1st level support by a
super-user who can give
rapid help to the users
experiencing a problem
with the system.
2nd level support by an
analyst who can analyze
problems that cannot be
solved by the
experienced user, or
analyze the need for
improved functionality
in depth, and prepare
related specifications
for subsequent changes
to the source code.
3rd level support by a
developer who can
make changes to the
source code related to
removing errors,
including new
functionality.
NFR-WS-4 Maintenance The supplier is obliged - if Mandatory
requested by RSGA to enter
into a maintenance contract
after the warranty period has
expired.
Economic requirements
35
36
6 APPENDICES
6.1 References
[1] ISO/IEC/IEEE 42010:2011, Systems and software engineering Architecture description
[2] Rozansky, N. and Woods E., Software Systems Architecture: Working With Stakeholders
Using Viewpoints and Perspectives, Addison-Wesley, 2011
[3] Object Management Group, UML, http://www.uml.org
[4] Oskar Henriksen AS, Federal Administration for Geodetic and Real Property Affairs - ICT Strategy,
2014
[5] Oskar Henriksen AS, Republic Administration for Geodetic and Real Property Affairs of Republic
Srpska - ICT Strategy, 2014
[6] Republic Authority for Geodetic and Real Property Affairs: Digital Archive Strategy, 2014
[7] The Consultative Committee for Space Data Systems, Reference Model for an Archival
Information System (OAIS), 2012
[8] The Open Group Architecture Framework (TOGAF), http://www.opengroup.org/togaf/
[9] The Open Group, TOGAF Version 9.1, Van Haren Publishing, 2013
[10] Weske, M. Business Process Management: Concepts, Langauges and Architectures,
Springer, 2012
37
6.2 Definitions
Abstraction
The technique of providing summarized or generalized descriptions of detailed and complex content.
Abstraction, as in "level of abstraction", can also mean providing a focus for analysis that is concerned
with a consistent and common level of detail or abstraction. Abstraction in this sense is typically used in
architecture to allow a consistent level of definition and understanding to be achieved in each area of the
architecture in order to support effective communication and decision-making. It is especially useful
when dealing with large and complex architectures as it allows relevant issues to be identified before
further detail is attempted.
Actor
A person, organization, or system that has a role that initiates or interacts with activities. Actors may be
internal or external to an organization.
Application
A deployed and operational IT system that supports business functions and services; for example, a
payroll. Applications use data and are supported by multiple technology components but are distinct
from the technology components that support the application.
Architecture
A formal description of a system, or a detailed plan of the system at component level, to guide its
implementation. Architecture is created solely to meet stakeholders needs.
Architecture element
Fundamental piece from which a system will be constructed.
Concerns
The key interests that are crucially important to the stakeholders in a system, and determine the
acceptability of the system. Concerns may pertain to any aspect of the system's functioning,
development, or operation, including considerations such as performance, reliability, security,
distribution, and evolvability.
Dynamic structure
Defines run-time elements of software system and their interactions.
Stakeholder
An individual, team, or organization (or classes thereof) with interests in, or concerns relative to, the
outcome of the architecture. Different stakeholders with different roles will have different concerns.
Static structure
Defines internal design-time elements of software system and their arrangement.
System
A collection of components organized to accomplish a specific function or set of functions.
System stakeholder
An individual, team, or organization (or classes thereof) with interests in, or concerns relative to, a system.
UML Class Diagram
Static structure diagram that describes the structure of a system systems classes, their metadata,
operations and the relationships among objects.
UML Use Case Diagram
Representation of a user's interaction with the system.
38
User
Any person, organization, or functional unit that uses the services of an information processing system.
View
The representation of a related set of concerns. A view is what is seen from a viewpoint. An architecture
view may be represented by a model to demonstrate to stakeholders their areas of interest in the
architecture.
Viewpoint
A definition of the perspective from which a view is taken. It is a specification of the conventions for
constructing and using a view (often by means of an appropriate schema or template).
Workflow
Automation of business process, in whole or part, during which documents, information, or tasks are
passed from one participant to another for action, according to a set of procedural rules.
System workflow
A system workflow consists of activities that are implemented by software systems without any user
involvement.
Human interaction workflow
A human interaction workflow is a workflow in which humans are actively involved and interacts with
information systems.
Workflow management system
A software system that defines, creates, and manages the execution of workflows through the use of
software, running on one or more workflow engines, which is able to interpret the process definition,
interact with workflow participants, and, where required, invoke the use of IT tools and applications.
39
6.3 List of Acronyms
41