Technical Architecture System Design Template
Technical Architecture System Design Template
Table of Contents
1. INTRODUCTION.............................................................................................................................................3 1.1 SYSTEM DESIGN SECTIONS ...........................................................................................................................3 1.2 TS OFFERS ASSISTANCE TO DEPARTMENTS ...................................................................................................3 2. SYSTEM DESIGN CHANGE LOG...............................................................................................................3 3. CONCEPTUAL SYSTEM DESIGN SECTION...........................................................................................5 3.1 CONCEPTUAL SYSTEM CHECKLIST.................................................................................................................5 3.2 FUNCTIONAL SYSTEM DESCRIPTION...............................................................................................................9 3.3 CONCEPTUAL SYSTEM DESIGN DESCRIPTION ................................................................................................10 4. PRELIMINARY SYSTEM DESIGN SECTION........................................................................................11 4.1 PRELIMINARY SYSTEM CHECKLIST...............................................................................................................11 4.2 PRELIMINARY SYSTEM DESIGN DESCRIPTION.................................................................................................13 5. DETAIL SYSTEM DESIGN SECTION......................................................................................................14 5.1 DETAIL SYSTEM DESIGN CHECKLIST............................................................................................................14 5.2 DETAIL SYSTEM DESIGN DESCRIPTION.........................................................................................................18
1. Introduction
The System Design Template has been designed to enable Departments to provide an increasing amount of detail to Technology Strategies (TS) over the life of a project. Departments 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 three sections. The sections of this template are described below in greater detail; in addition, they are summarized in Table 1: Project Approval Requirements. TS
1.1
Each section of the template must be completed to the extent possible for the Project Approval Gate being requested. If information is requested in a particular section that cannot be provided at the time of completion, then To Be Determined (TBD) should be specified. However, when the next section of the document is completed, then the information that was previously unavailable must be provided. Conceptual System Design Section: This section of the document is required to be submitted, reviewed, and approved by TSTS, prior to receiving Gate 2 (Execute and Build) Project Approval. Preliminary System Design Section: This section of the document is required to be submitted, reviewed, and approved by TS, prior to receiving Gate 2 (Execute and Build) Project Approval. Detail System Design Section: This section of the document is required to be submitted, reviewed, and approved by TS, prior to completing Gate 2 (Execute and Build) Project Approval. Normally, this documentation would be submitted as soon as the Detail System Design has been completed. Updated Detail System Design Section: An update to the detail design is required to be submitted, reviewed, and approved by TS, prior to receiving Gate 3 (Implementation) Project Approval. Any changes to the system design based on pilot testing must be incorporated. Once this approval has been issued, the Implementation phase may begin. Project Approval Gate Requirement Gate 2 Project Approval Gate 2 Project Approval Prior to completing Gate 2 Gate 3 Project Approval Template Section to be Completed Conceptual System Design Preliminary System Design Detail System Design Updated Detail System Design Table 1: Project Approval Requirements
1.2
One of the primary services that TS offers to the Departments is system design review and assistance. Involving TS as early as possible in the project (e.g. during RFP creation or system design) is key factor to the overall success of a project. This type of early involvement helps to ensure that the Department is complying with the organizations Technical Architecture. It also facilitates Project Approval.
Technical Architecture Submission for [project name] changes would be performed internally within TS. If Approval Review is required, TS will coordinate providing the information for review and approval to the State CIO. Notes: 1. Use of a word processing automated tracking change feature is required when resubmitting this document 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 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 TS that the project approval status be reconsidered by the State CIO. 3. If there are any questions as to whether or not a change is substantive enough to warrant review and approval, please contact TS staff at (919) 981-5555 for clarification. 4. Maintain a summary of changes in the table below. Change Log Summary Version and Description (For instructional purposes an example has been provided) Date submitted to TS for review Date approved by TS
3.1
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 TS.
Electronic Commerce Pilot Prior to Implementation Security - Regulatory or Privacy Requirements W3C Accessibility Compliance Section 508 Accessibility Compliance Estimated Total Number of Customers
Hosting Location
3.2
Provide a diagram (or diagrams) with corresponding narrative that depicts the functional aspects of the application. Corresponding narrative that describes each major functional area 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. Departments should delete the diagram provided and supply information specific to the application requesting approval.
G eneral L edger
B usiness D irect D eposits B illing B ank R econciliation Shipping
C itizens
R eporting
Note: Narrative describing the functional design of the application must be provided immediately following the diagram(s).
3.3
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 . Note: The diagram below has been provided for illustrative purposes only. Departments should delete the diagram provided and supply information specific to the application requesting approval.
Firewall 1
Firewall 2
Firewall 3
C itizen
W eb Server
Employee
Firew all 3 Single (or R educed) Sign-on Service ED I M essaging M iddlew are E xternal A gency A pplication C redit C ard Processing Service
Note: Narrative describing the conceptual design of the application must be provided immediately following the diagram(s).
4.1
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 TS.
Security Technologies
4.2
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 NCSTA . At this point, details such as scalability, availability, and secureability 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. Departments should delete the diagram provided and supply information specific to the application requesting approval.
Load Balancer
Web Server
VPN
Note: Narrative describing the preliminary design of the application must be provided immediately following the diagram(s).
5.1
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 TS.
Client Platforms
Client Richness
Application State
Virtualization Web Server Location Web Server Operating System Web Server Software Web Server - High Availability
Database Server Operating System Database Server Software Database Server High Availability
5.2
Provide a diagram (or diagrams) with corresponding narrative with that depicts an accurate, detailed, and complete description of the detail design for the entire application. 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 NCSTA . 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 webphone, PDA, or Blackberry) should be documented. Note: The diagram below has been provided for illustrative purposes only. Departments should delete the diagram provided and supply information specific to the application requesting approval.
Note: Narrative describing the detail design of the application must be provided immediately following the diagram(s).