Professional Documents
Culture Documents
Solution Architecture: Technical Document
Solution Architecture: Technical Document
Technical Document
Date: <dd/mmm/yyyy>
Version: <nn.nn>
Submission Details
SUBMISSION DETAILS..........................................................................................................................1
1. GLOSSARY OF TERMS................................................................................................................3
INTRODUCTION...................................................................................................................................4
1.1 SYSTEM DESIGN SECTIONS........................................................................................................4
1.2 TSG OFFERS ASSISTANCE TO PUBLIC SECTOR ORGANISATION.................................................5
2. SYSTEM DESIGN CHANGE LOG..............................................................................................6
Project Type: A system being submitted for Solution Architecture Assessment for
New System the first time which has never been approved.
Project Type: An Upgrade of the System refers to an addition/change of any of the
Upgrade System component/s, or any other change possible within the existing
System Solution Architecture which has already been approved.
Cold Site A cold site is the most inexpensive type of backup site for an
(In the context of Backups) organization to operate. It does not include backed up copies of data
and information from the original location of the organization, nor
does it include hardware already set up. The lack of hardware
contributes to the minimal startup costs of the cold site, but requires
additional time following the disaster to have the operation running
at a capacity close to that prior to the disaster.
Warm Site A warm site is, quite logically, a compromise between hot and cold.
(In the context of Backups) These sites will have hardware and connectivity already established,
though on a smaller scale than the original production site or even a
hot site. Warm sites will have backups on hand, but they may not be
complete and may be between several days and a week old. An
example would be backup tapes sent to the warm site by courier.
Hot Site A hot site is a duplicate of the original site of the organization, with
(In the context of Backups) full computer systems as well as near-complete backups of user
data. Real time synchronization between the two sites may be used
to completely mirror the data environment of the original site using
wide area network links and specialized software. Following a
disruption to the original site, the hot site exists so that the
organization can relocate with minimal losses to normal operations.
Introduction
The Solution Architecture Template has been designed to enable Public Sector Organisation
(PSO) to provide an increasing amount of detail to the Technology and Systems Governance
(TSG) over the life of a project. PSO requesting Project Approval will be required to complete
this template, section by section, during the various phases of a project. To facilitate this
process, this template has been separated into four sections.
Each section of the template must be completed to the extent possible for the Project
Approval Gate being requested. It is also understood that in certain situations there might be
checklist items which for various reasons might not be possible to be compiled. In this case,
the form should be filled in with the following acronyms according to the prescribed scenario.
One of the primary services that TSG offers to PSOs is system design review and assistance.
Involving TSG as early as possible in the project (e.g. during RFP creation or system design)
is a key factor to the overall success of a project. This type of early involvement helps to
ensure that the project complies with the necessary standards and policies. It also facilitates
Project Approval. If you would like to request TSG assistance, or have any questions
concerning the completion of this document, please send an email on eau.mita@gov.mt
Any moderate or significant changes to the system design must be resubmitted to TSG
for review and approval prior to making any actual implementation change(s). In most cases,
the review and approval of any changes would be performed internally within TSG.
Notes:
1. Use of a word processing automated change tracking feature is required when
resubmitting this document in order to simplify the review and approval process. Once a
version of the document has been approved, then that version of the document should be
saved for archival purposes. Prior to submitting a new version of the document, all prior
tracked changes should be accepted. This process for resubmission can then be
repeated as many times as necessary until the final approval has been issued.
2. Failure to resubmit changes for review and approval could result in a
recommendation by TSG that the project approval status be reconsidered. If there are
any questions as to whether or not a change is substantive enough to warrant review
and approval, please send an email on eau.mita@gov.mt for clarification.
3. Maintain a summary of changes in the table below.
The Basic Solution Profile Section has been designed to capture only the most essential
information required for the Initial Project Approval.
Mission Criticality (in the Which local law / directive mandate the creation of a solution?
context of Government’s
business)
What are the repercussions of not implementing the solution?
(Example: Penalties, Disruption to Government’s ICT / Business Strategy. Clearly provide the
necessary documentation to substantiate your case)
NOTE: If breakdown of the above values is available, kindly attach with the
submission.
Disclaimer: Any technologies listed below have been provided solely for convenience,
the information provided is not intended to be exhaustive nor does it indicate product
endorsement by TSG.
List/ Verify that the solution adheres to the ICT ICT Policies and Directive can be found at http://ictpolicies.gov.mt.
Policies/Directives
Highlight any deviations (providing detailed description) to the Policies/
Such as: Directives found in the above URL.
o GMICT X 0071:2010 Adopted Specifications
o CIMU S0051 Website Standard
o CIMU P 0012:2003 Third party Web hosting
services Policy
Estimated Total Number of Customers Total: __________
By Audience:
Citizen: ______ Employee: _____ Business:______ Other:______
Note: For systems were functionality will be delivered over time specify amounts by
implementation phase.
The quoted figures should serve as guidelines and should be provided on an estimate basis. The figures are
also subjective to the type of application (i.e. whether the solution is a client server application or web based
application).
Solution Architecture Document Template Version: 1.0 Page 9 of 36
Technology Strategy and Governance
Malta Information Technology Agency
Telephone: (+356) 21234710 Facsimile: (+356) 21234701
Web Site: www.mita.gov.mt
Conceptual System Checklist Responses - Select all that apply
Project Type __ New System __ Upgrade System
Note: For systems were functionality will be delivered over time specify amounts by
implementation phase.
Estimated Annual Customer Growth Rate Percentage: _________
By Audience:
Citizen: ______ Employee: _____ Business:______ Other:______
Electronic Form
Performance Requirements Section Please list down any performance requirements related to the following
classes of performance clearly highlighting the scenario, the value and unit
of measurement, method of measurement.
response times (how fast the system handle individual requests, what
a real user would experience)
throughput (how many requests the system can handle)
concurrency (how many users or threads work simultaneously)
Note: Fill as deemed necessary
Production Hours of Operation __ Citizen
__ Normal Business Hours (e.g. 8:00 am to 5:00 pm)
__ Extended Business Hours (specify): _______________
__ 24 X 7
__ Employee
__ Normal Business Hours (e.g. 8:00 am to 5:00 pm)
__ Extended Business Hours (specify): _______________
__ 24 X 7
__ Government/Business Partner(s)
__ Normal Business Hours (e.g. 8:00 am to 5:00 pm)
__ Extended Business Hours (specify): _______________
__ 24 X 7
Production Availability Expectations on a Kindly highlight any peaks and troughs of the service being rendered?
monthly basis e.g. Every end of the month there is a peak due to the license renewal
process.
Scheduled Downtime:
__ Minutes (specify amount):________
__ Hours (specify amount):__________
Service Restoration:
__ Minutes (specify amount):________
__ Hours (specify amount):__________
__ Traditional
Target Hosting Environment __ Shared eGovernment Web Hosting Environment managed & supported
by MITA - This applies for existing systems only i.e. solution
updates/ upgrades
NOTE: If more than one hosting mode is selected please supply more
information about the role of each hosting layer
__ myForms
Shared Service for creating electronic forms and the respective workflows
for the delivery of citizen centric eServices
__ myAlerts/ mGov
Shared alerting services used to deliver Short Message Services (SMS)
and email notifications.
__ eID
A shared service which allows citizens and businesses to identify
themselves via the government’s Web portal or telephone contact centre to
securely access any number of available e-Services, regardless of which
organization provides the service.
__ CDR
Shared Service providing access to Corporate Data.
__ Corporate identity
A Shared Service for the provision of Identity to the Public Administration.
System Usage of 3rd Party Service Identify and list any interactions required with 3 rd party services
in the table below:
Service Name Service Provider
Provide a diagram (or diagrams) with corresponding narrative that depicts the functional
aspects of the application. Corresponding narrative that describes each major functional area
Solution Architecture Document Template Version: 1.0 Page 13 of 36
Technology Strategy and Governance
Malta Information Technology Agency
Telephone: (+356) 21234710 Facsimile: (+356) 21234701
Web Site: www.mita.gov.mt
of the application must also be supplied. Describe how the system will be used and operated.
Describe both the type of users of the system as well as any business interfaces that may be
necessary.
Note: The diagram below has been provided for illustrative purposes only. PSOs
should delete the diagram provided and supply information specific to the application
requesting approval.
External
Business Direct Bank Agency
Deposits Reconciliation Interfaces
(Specify)
Billing Shipping
Citizens Reporting
Note: Narrative describing the functional design of the application must be provided
immediately following the diagram(s).
If the bank approves the transaction, any steps needed to complete the transaction (e.g.
dispensing cash or accepting an envelope) will be performed, and then a receipt will be
printed. Subsequently the customer will be asked whether he/she wishes to do another
transaction.
Solution Architecture Document Template Version: 1.0 Page 15 of 36
Technology Strategy and Governance
Malta Information Technology Agency
Telephone: (+356) 21234710 Facsimile: (+356) 21234701
Web Site: www.mita.gov.mt
If the bank reports that the customer's PIN is invalid, the Invalid PIN extension will be
performed and then an attempt will be made to continue the transaction. If the customer's
card is retained due to too many invalid PINs, the transaction will be aborted, and the
customer will not be offered the option of doing another.
If a transaction is cancelled by the customer, or fails for any reason other than repeated
entries of an invalid PIN, a screen will be displayed informing the customer of the reason for
the failure of the transaction, and then the customer will be offered the opportunity to do
another.
The customer may cancel a transaction by pressing the Cancel key as described for each
individual type of transaction below. All messages to the bank and responses back are
recorded in the ATM's log.
A withdrawal transaction can be cancelled by the customer pressing the Cancel key any time
prior to choosing the Euro amount.
N.B. The above example is showing only a small part of the functionality of the above use
case diagram. This section should include a description of the high level functionality
illustrated in the above diagram.
Provide a diagram (or diagrams) with corresponding narrative that depicts an accurate
description of the conceptual design for the entire application. The design must document
how each of the requirements specified in the functional design will be conceptually
accomplished. The conceptual design must align with the Principles, Practices, and
Standards that are published in the http://ictpolicies.gov.mt and
https://www.mita.gov.mt/page.aspx?pageid=228 portals respectively.
Note: The diagram below has been provided for illustrative purposes only. PSOs
should delete the diagram provided and supply information specific to the application
requesting approval.
Hardened Internal
Internet DMZ Internal Network
Network
Firewall 2
Firewall 1
Firewall 3
Web Application Database
Citizen Employee Server Server
Server
Firewall 3
Note: Narrative describing the conceptual design of the application must be provided
immediately following the diagram(s).
Disclaimer: Any technologies listed below have been provided solely for convenience,
the information provided is not intended to be exhaustive nor does it indicate product
endorsement by TSG.
Platform Specific:
__ .NET Remoting
__ EJB/RMI – IIOP
__ Other (specify):
Solution Architecture Document Template Version: 1.0 Page 18 of 36
Technology Strategy and Governance
Malta Information Technology Agency
Telephone: (+356) 21234710 Facsimile: (+356) 21234701
Web Site: www.mita.gov.mt
Preliminary System Checklist Responses – Select all that apply
System Integration Technologies __ XML __ Web Services __ Messaging __ EDI __ CORBA
(Both for service provisioning and service __ IIOP __ Adaptors __ Secure FTP
consumption) __ Proprietary API via __________
__ Other (specify):
Secure transport :
e.g. SSL/TLS, IPSEC
Secure Storage:
e.g. Data Encryption - __ Column __ Row __ Table __ Database
using AES encryption
e.g. Cookie Encryption using AES encryption
Provide the security technologies which have been used in the mentioned
contexts. The government adopted specifications related to Encryption
and signing algorithms can be found on http://ictpolicies.gov.mt/
The Development Quality Description section has been designed to capture how quality
aspects such as portability, maintainability, extensibility, supportability and re-usability shall be
reflected in the software part of the proposed solution.
Portability
The ability for a solution to be migrated/ installed on a different environment other then the original one, without the need of
any code changes.
Maintainability
Ease of extending the solution functionality, fixing of errors etc.
Extensibility
The ability for the solution to be extended with ease and with minor modifications (future proof solution).
Supportability
The ability for the solution to be more efficient in terms of product maintainability thus reducing operational costs (installation,
configuration and monitoring) maintaining business continuity.
Re-usability
The ability to use modified or unmodified solution components (subroutines etc.) in other solutions.
Provide a diagram (or diagrams) with corresponding narrative that depicts an accurate and
detailed description of the preliminary design for the entire application. The design must
document how each of the requirements specified in the conceptual design will be logically
accomplished. The preliminary design must align with the Principles, Practices, and
Standards that are published in the http://ictpolicies.gov.mt and
https://www.mita.gov.mt/page.aspx?pageid=228 portals respectively.
At this point, properties such as scalability, availability, and security posture should be
reflected. External network connection speeds (for both the citizen and employee) should be
documented. The supporting application should perform at acceptable levels when utilizing
lowest common access speeds. Specify any known hardware and software details (brand,
model, version, etc) for clients, servers, and other network infrastructure; programming
languages selected, and deployment location (i.e. server location where code is deployed).
Interfaces must be identified.
Note: The diagram below has been provided for illustrative purposes only. PSOs should
delete the diagram provided and supply information specific to the application requesting
approval.
Transaction Zone 3
Zone 0/1 Zone 2
Zone (Hardened Internal
Internet (Internal Network)
(Hardened DMZ) Network)
Transaction Zone Firewall
Citizen
Zone 3 Firewall
(5000
Load Balancer
Transactions Employee DB
Per day Web Desktop Appl. Server
Server (N=300) Server
SSL (Mirror)
(Cluster)
Note: Narrative describing the preliminary design of the application must be provided
immediately following the diagram(s).
The Service Quality Description section has been designed to capture how quality aspects
such as Performance/Throughput, Security, Integrity, Reliability, Availability, Scalability,
Manageability, Serviceability and Recoverability shall be reflected in the proposed solution.
Fill in the applicable section hence reflecting how the solution shall be delivered.
Performance/Throughput
Response times: how fast the system handles individual requests in terms of user experience.
Throughput: how many requests the system can handle.
Concurrency: how many users or threads work simultaneously
List down the mechanism/s that the solution uses to achieve/ support the above mentioned factors where applicable
Security
Authentication: The substantiation of the identity of a person or entity related to the system in some way.
Authorization: The definition and enforcement of permitted capabilities for a person or entity whose identity has been
established.
Audit: The ability to provide forensic data attesting that the system was used in accordance with stated security policies.
Assurance: The ability to test and prove that the system has the security attributes required to uphold the stated
security policies.
Asset Protection: The protection of information assets from loss or unintended disclosure, and resources from
unauthorized and unintended use.
Administration: The ability to add and change security policies, add or change how policies are implemented in the
system, and add or change the persons or entities related to the system.
List down the mechanism/s that the solution uses to achieve/ support the above mentioned factors
Integrity
The capability for an application to bring data or a function from one application program together with that of another
application program.
List down the mechanism/s that the solution uses to achieve/ support the above mentioned factors
Reliability
The ability for a system to be aware of the hardware and software components to determine where and why failure is high
and consequently is able to apply actions in order to reduce failure.
List down the mechanism/s that the solution uses to achieve/ support the above mentioned factors
Availability
The ability of the system to function without service interruption or depletion despite abnormal or malicious events.
List down the mechanism/s that the solution uses to achieve/ support the above mentioned factors
Scalability
A property of a solution or process, which indicates its ability to either handle growing amounts of work (in terms of work load
capacity – computational power etc.) in a graceful manner or the ability and ease of enhancing the solution to handle new
Solution Architecture Document Template Version: 1.0 Page 22 of 36
Technology Strategy and Governance
Malta Information Technology Agency
Telephone: (+356) 21234710 Facsimile: (+356) 21234701
Web Site: www.mita.gov.mt
requirements.
List down the mechanism/s that the solution uses to achieve/ support the above mentioned factors
Manageability
The building blocks of manageability can be viewed as
Diagnosable: Ability for Solution to provide auditing functionality to enable easy tracing and diagnosis of errors/ issues .
Disaster-recoverable: The ability for the solution to recover from run-time crashes; considerations should also include data
recovery aspects.
List down the mechanism/s that the solution uses to achieve/ support the above mentioned factors
Serviceability
The ease and extent of changes that can be affected without interrupting the application and the environment, consequently
affecting availability.
List down the mechanism/s that the solution uses to achieve/ support the above mentioned factors
Recoverability
The ability towards a fast, easy, and reliable recovery of business data from virtually any disruption or event.
List down the mechanism/s that the solution uses to achieve/ support the above mentioned factors
The Detail System Design Section has been designed to capture only the most essential
information required at this point to obtain Detailed Design approval. While the items listed
are not intended to be an exhaustive list of the possible technologies that may be utilized in
the implementation of an application, it does reflect some of the more common choices as
well as important items that should be considered during the design phase.
Disclaimer: Any technologies listed below have been provided solely for convenience,
the information provided is not intended to be exhaustive nor does it indicate product
endorsement by TSG.
__ Rich Client
Maximum Configuration:
Number of Servers: __ CPUs/Server: __ CPU Type: __________
CPU Speed: _____ Amount of RAM: ____
Provide a diagram (or diagrams) with corresponding narrative with that depicts an accurate,
detailed, and complete description of the detail design for the entire system. The design must
document how each of the requirements specified in the preliminary design will be physically
accomplished. The detailed design must align with the Principles, Practices, and Standards
that are published in the http://ictpolicies.gov.mt and https://www.mita.gov.mt/page.aspx?
pageid=228 portals respectively.
Almost all details should be known at this point in the design process, including specific
hardware related information utilized by the hosting service provider. Design objectives such
as Reliability, Availability, Scalability, Secureability, Interoperability, and use of Common
Infrastructure should be adequately reflected in the physical design. All aspects of the
application, network, security, and integration architecture, as well as any other pertinent uses
of technology to solve specific business requirements (e.g. document imaging, channel
support for the numerous client form factors such as smart phone, PDA etc) should be
documented.
Note: The diagram below has been provided for illustrative purposes only. PSOs
should delete the diagram provided and supply information specific to the application
requesting approval.
Query Response
Number of Physical Servers
Rack Space required (in rack Height Units)
Air Flow Direction (e.g. Front-bottom-up, etc)
Total Heat Dissipation (Btu/Hr)
Total Power Consumption (kVA)
Operating Temperature (degrees Celsius)
Query Response
Number of Guests
Query for each Guest Response
CPU (GHZ)
RAM (GB)
Hard disk space (GB)
Number of Network interfaces
Bandwidth needed for each interface (KBps)
Frequency of backups(daily/weekly/monthly)
Can server be shut down during the backup
process? (Yes/No)
Operating System (Windows Linux x64/x86)
Database Management Server (e.g. SQL;
Oracle( if any)
Access Access
Access Required for each required required TCP/UDP
Guest from to port Access required both ways
Anti Virus (updates of AV)
Netbios
OS Updates
DNS
Remote support (RDP/SSH)
Internet Access
HTTP
HTTPS
SMTP
POP3
IMAP
IMAPS
Provide a detailed system design reflecting the Presentation Layer, Business Layer and Data
Access Layer.
The services provides an SMTP relay from the consumer to gov.mt domains and other domains registered
through ICANN domain registration services, including subdomains and have the appropriate Mail Exchanger
DNS Mechanisms in place.
The transmission of data through the consumption of this service is not secured through the use of TLS/SSL
certificates, therefore it is the responsibility of the consumer to encrypt data.
2. Interfaces provided
3. List of Functionality
List of functionality that is available within the interfaces defined in Section 3 Property 2
4. Standards
The following is a table with a list of standards relevant to the provision of this service.
Standard Information
SMTP http://tools.ietf.org/html/rfc5321
TLS/SSL http://tools.ietf.org/html/rfc5246
DNS http://www.ietf.org/rfc/rfc1035.txt
SNMP http://www.snmp.com/protocol/
5. Location of Documentation
The physical/virtual location of the technical design, including interfacing documentation and architecture blueprint
of this adapter
How does this adapter support transaction, provide for compensation, or does not provide transactional facility at
all
The Service Level Agreements (SLA) and other terms and conditions related to the consumption of this service
The adapter is monitored through MITA central monitoring services via SNMP. The uptime availability is available
through the MITA hosting services. Each consumer should not send more than 10 mails per second when
messages do not exceed 10 Kilobytes each.
3. Quality of Service
What are the quality checks that were carried out during the design, development and deployment of this adapter?
This adapter was designed according to IETF specifications and best practices. It is based on IP protocols to
ensure scalability and re-usability. The implementation is controlled by the MITA Change Management process.
4. Auditing Information
What are the auditing mechanisms in place, if available at all, including the data elements that are recorded for
auditing purposes? Include the Data Protection measures that are in place according to GMICT policy and
Legislation
5. Defined processes
List the processes that are available in order to apply for usage, disconnection or modifications of this adapter, as
well as processes related to the consumer accessibility to the adapter.
Requests for consumption of this adapter are controlled by MITA SMD. A change request is required to open port
25 from the Private Runtime Environment to the service as defined under interfaces.
Requests for access to the adapter are identified through the architecture blueprint to be presented according to
Architecture Blueprint requirements available at https://www.mita.gov.mt/page.aspx?pageid=228. Project
Manager is responsible to trigger change management process.