California State University, Chico
Office of the Vice Provost for Information Resources
[Application Functional Owner]
[Project Name]
Application (Web) Technical Specification
Version [x.y]
[MM/DD/YYYY]
[Project Name]
Application (Web) Technical Specification
California State University, Chico
Contents
INTRODUCTION .............................................................................................................................................. 3
PROJECT OBJECTIVES ...........................................................................................................................................3
DESIGN GUIDELINES AND APPROACH ............................................................................................................ 3
ASSUMPTIONS / CONSTRAINTS / STANDARDS ...........................................................................................................3
ARCHITECTURE ............................................................................................................................................... 3
SERVERS ...........................................................................................................................................................3
SOFTWARE ........................................................................................................................................................3
DEPLOYMENT AND CONFIGURATION .......................................................................................................................3
FUNCTIONAL USERS OF THE APPLICATION ..................................................................................................... 4
USE-CASES AND FUNCTIONALITY ................................................................................................................... 4
DATABASE DESIGN ......................................................................................................................................... 4
DATABASES .......................................................................................................................................................4
SERVICE ACCOUNTS OR USER PASS THROUGH ..........................................................................................................4
PROJECT OBJECTS ...............................................................................................................................................4
Tables .....................................................................................................................................................4
Views ......................................................................................................................................................4
Stored Procedures ..................................................................................................................................4
Functions ................................................................................................................................................4
Other Database Objects .........................................................................................................................5
Data Conversions ...................................................................................................................................5
REFERENCED OBJECTS..........................................................................................................................................5
Tables .....................................................................................................................................................5
Views ......................................................................................................................................................5
Stored Procedures ..................................................................................................................................5
Functions ................................................................................................................................................6
Other Database Objects .........................................................................................................................6
DATA CONVERSIONS............................................................................................................................................6
USER INTERFACE DESIGN................................................................................................................................ 6
LISTING OF PAGES OR GENERAL DESCRIPTION OF DESIGN OF USER INTERFACE ..................................................................6
SECURITY........................................................................................................................................................ 6
DATA SECURITY CLASSIFICATION LEVEL ...................................................................................................................6
RISK ANALYSIS....................................................................................................................................................7
USER COMMUNICATIONS .............................................................................................................................. 7
APPLICATION PROGRAM INTERFACES ............................................................................................................ 7
INCOMING DATA ................................................................................................................................................7
OUTGOING DATA................................................................................................................................................7
PERFORMANCE .............................................................................................................................................. 7
Information Resources- ADS
1 of 8
Last Updated 2/8/2016 10:25:00 AM
[Project Name]
Application (Web) Technical Specification
California State University, Chico
Revision History
[This document will be continuously updated from initial specification through deployment
and future maintenance updates]
Change Initiated By
Information Resources- ADS
Date
Reason for Changes
2 of 8
Version
Last Updated 2/8/2016 10:25:00 AM
[Project Name]
Application (Web) Technical Specification
California State University, Chico
Introduction
[A basic paragraph to describe the project; this will most likely be copied/pasted into all introduction sections of all
of the project’s documents. It should be high level and describe the business need that this project is fulfilling.]
Project Objectives
[General purpose and goals of this project]
Design Guidelines and Approach
ICSUAM 8070 sec. 1.2
[This section describes the principles and strategies to be used as guidelines when designing and implementing the
system. Define the project language, framework, and technologies to utilize. Specify where business logic resides;
db vs. app]
Assumptions / Constraints / Standards
[Describe any general design assumptions / constraints / standards related to any of the project’s design. Examples
of Assumptions/Contraints/Standards: able to use JavaScript, must be section 508 compliant, application must
successfully pass a vulnerability scan, application follows standadards for asp.net-MVC, theory-MVC, or
webforms….]
Architecture
ICSUAM 8070 sec. 1.3
[This section outlines the hardware architecture design of the project. Details what hardware will be utilized; can
be abstract; “Esys Web Stack.” Describe the system architecture, how the application interacts with other
applications. Not necessarily how the application itself works but, how the appropriate data is correctly passed
between applications.] [Visio drawing not required, but could be helpful.]
Servers
[Where will this program run and what servers will it directly use? Esys iis1 stack? Esys-mssql1?]
Software
[Where is the codebase? Github? Bay? How does a new developer get the codebase and start using it?]
Deployment and Configuration
[Does the application to be deployed in a non-standard manner?]
[Does it need to be coordinated with other areas on campus because of shutdown/restart requirements?]
[Does the application utilize #IF directives at compile time to ensure the proper configureation file attributes are
added or removed?]
Information Resources- ADS
3 of 8
Last Updated 2/8/2016 10:25:00 AM
[Project Name]
Application (Web) Technical Specification
California State University, Chico
Functional Users of the Application
[Define the users/roles of the project. E.g. All Faculty? Just Academic Advising Office? All students?]
Use-Cases and Functionality
[For each Users/Role, define all functionality that can be performed. E.g. list out all classes for a term. Or register
for summerO. Or save/modify data….]
Database Design
Databases
[What Database(s) will be utilized?]
Service Accounts or User Pass Through
[Are there application specific database service accounts and if so what are the accounts?]
Project Objects
[objects owned and created specifically for this application]
Tables
[List out all the tables to be built; Include Materialized Views in this listing. For each table; provide all columns
utilized and column types and specify the primary/foreign keys.]
Views
[List out all the views to be built. For each view; provide all columns and column types.]
Stored Procedures
[List out all the stored procedures to be built as follows:]
 [{SchemaName}.{PackageNameIfAny}.{ProcedureName}@{DatabaseName}]
o [Quick One Sentence description of what the stored procedure does]
o In: [List any input parameters and their types]
o Out: [List any output parameters and their types]
 [If output parameter is complex; list out all sub-Columns and types]
 [If output parameter is complex; list out all sub-Columns and types]
 [{SchemaName}.{PackageNameIfAny}.{ProcedureName}@{DatabaseName}]
o [Quick One Sentence description of what the stored procedure does]
o In: [List any input parameters and their types]
o Out: [List any output parameters and their types]
 [If output parameter is complex; list out all sub-Columns and types]
 [If output parameter is complex; list out all sub-Columns and types]
Functions
[List out all the functions to be built as follows:]
Information Resources- ADS
4 of 8
Last Updated 2/8/2016 10:25:00 AM
[Project Name]



Application (Web) Technical Specification
California State University, Chico
[{SchemaName}.{PackageNameIfAny}.{FunctionName}@{DatabaseName}]
o [Quick One Sentence description of what the function does]
o In: [List any input parameters and their types]
o Returns: [List the return type and what it represents]
 [If the return type is complex; list out all sub-Columns and types]
 [If the return type is complex; list out all sub-Columns and types]
[{SchemaName}.{PackageNameIfAny}.{FunctionName}@{DatabaseName}]
[Quick One Sentence description of what the function does]
o In: [List any input parameters and their types]
o Returns: [List the return type and what it represents]
 [If the return type is complex; list out all sub-Columns and types]
 [If the return type is complex; list out all sub-Columns and types]
Other Database Objects
[examples: sequences, SSL certificates, Database linked servers, or job scheduling]
List out all the sequences to be built. For each sequence; provide a description of how it is utilized, its starting
value, increment value, max value, if cycles, if re-usable, how much is cached…]
Data Conversions
[does the data need to be cleansed or modified from one system to another using an ETL process?]
Referenced Objects
[objects not owned by this application but referenced]
Tables
[List out all the tables to be built; Include Materialized Views in this listing. For each table; provide all columns
utilized and column types and specify the primary/foreign keys.]
Views
[List out all the views to be built. For each view; provide all columns and column types.]
Stored Procedures
[List out all the stored procedures to be built as follows:]
 [{SchemaName}.{PackageNameIfAny}.{ProcedureName}@{DatabaseName}]
o [Quick One Sentence description of what the stored procedure does]
o In: [List any input parameters and their types]
o Out: [List any output parameters and their types]
 [If output parameter is complex; list out all sub-Columns and types]
 [If output parameter is complex; list out all sub-Columns and types]
 [{SchemaName}.{PackageNameIfAny}.{ProcedureName}@{DatabaseName}]
o [Quick One Sentence description of what the stored procedure does]
o In: [List any input parameters and their types]
o Out: [List any output parameters and their types]
 [If output parameter is complex; list out all sub-Columns and types]
 [If output parameter is complex; list out all sub-Columns and types]
Information Resources- ADS
5 of 8
Last Updated 2/8/2016 10:25:00 AM
[Project Name]
Application (Web) Technical Specification
California State University, Chico
Functions
[List out all the functions to be built as follows:]
 [{SchemaName}.{PackageNameIfAny}.{FunctionName}@{DatabaseName}]
o [Quick One Sentence description of what the function does]
o In: [List any input parameters and their types]
o Returns: [List the return type and what it represents]
 [If the return type is complex; list out all sub-Columns and types]
 [If the return type is complex; list out all sub-Columns and types]
 [{SchemaName}.{PackageNameIfAny}.{FunctionName}@{DatabaseName}]
o [Quick One Sentence description of what the function does]
o In: [List any input parameters and their types]
o Returns: [List the return type and what it represents]
 [If the return type is complex; list out all sub-Columns and types]
 [If the return type is complex; list out all sub-Columns and types]
Other Database Objects
[examples: sequences, SSL certificates, Database linked servers, or job scheduling]
[List out all the sequences to be built. For each sequence; provide a description of how it is utilized, its starting
value, increment value, max value, if cycles, if re-usable, how much is cached…]
Data Conversions
[does the data need to be cleansed or modified from one system to another using an ETL process?]
User Interface Design
[Does the project need to use campus templates, mobile? Ajaxified? How does User interact with the project?]
Listing of pages or general description of design of User Interface
[Either supply a listing of pages or a general description of the user interface. Is this a single web page or or multidocument interface with a nested or separated user and administrative user interfaces?]
Security
ICSUAM 8070 sec. 1.5.5, 1.5.6
[How is information protected? Authentication system? Authorization system? Does the program send/give data
away? any uploads/downloads?]
Data Security Classification Level
ICSUAM 8070 sec. 1.1
[What is the data classification level that this application will be able to connect to or be exposing?]
[reference for Level of data (1-3):
http://www.csuchico.edu/isec/documents/Data%20Classification%20and%20Protection%20Standard.pdf ]
Information Resources- ADS
6 of 8
Last Updated 2/8/2016 10:25:00 AM
[Project Name]
Application (Web) Technical Specification
California State University, Chico
Risk Analysis
ICSUAM 8070 sec. 1.2
[Will the application intoroduce any unacceptable risks to the campus, data system, or other applications on the
same infrastructure?]
[Does the application and supporting environment comply with all applicable policies, standards and procedures?]
User Communications
[Does it send email? Does it call people? Send a text message? Does it log the communications?]
Application Program Interfaces
Incoming Data
[List any other programs/projects/vendorware/plugins that the project uses. Does the project use any web
services? Does it use data from another application? CuteEditor? Third party dll such as iTextSharp]
Outgoing Data
[List any services provided by this project and how an external program/project would use it]
[examples, web services, data exports]
Performance
[List any performance requirements such as; pages must load within 3 seconds, Database results must be cached,
etc….]
Information Resources- ADS
7 of 8
Last Updated 2/8/2016 10:25:00 AM