ODOT Default Web Application Architecture

Total Page:16

File Type:pdf, Size:1020Kb

ODOT Default Web Application Architecture The Ohio Department of Transportation (ODOT) Division of Information Technology ODOT Default Web Application Architecture Filename:ODOT Web Application Architecture.doc Version: 8.0 Author: Michael Jordan Last Modified: 11/16/2017 Project Site: Document Summary: Prepared by the ODOT Division of Information Technology (DoIT) [Document Header] Contents 1 Introduction ......................................................................................................................... 3 1.1 About This Document ..................................................................................................... 3 1.2 Document Location ......................................................................................................... 3 2 Architecture ......................................................................................................................... 4 2.1 A Layered Approach ....................................................................................................... 4 2.1.1 User Interface Layer ............................................................................................... 4 2.1.2 Domain Layer ......................................................................................................... 4 2.1.3 Service Layer .......................................................................................................... 5 3 Technologies ....................................................................................................................... 6 3.1 Microsoft .NET Platform.................................................................................................. 6 3.1.1 C# ........................................................................................................................... 6 3.1.2 ASP.NET ................................................................................................................ 6 3.2 AJAX ............................................................................................................................... 6 3.3 Third Party Libraries ....................................................................................................... 7 3.3.1 Bing Maps API ........................................................................................................ 7 3.3.2 Spring.NET – Lightweight Dependency Injection API ............................................ 7 3.3.3 ExtJs ....................................................................................................................... 7 3.3.4 log4net .................................................................................................................... 8 4 Visual Studio Projects ........................................................................................................ 8 5 How To ................................................................................................................................. 9 5.1 How to use the AdoTemplate in Spring.Net to perform database queries and transactions .............................................................................................................................. 9 5.2 How to create a Visual Studio Project template automatically using the batch program9 [Version], [Date] 1 [Document Header] Document History Version Date Author Description 1.0 12/28/2007 Michael Jordan Initial Version 2.0 7/17/2008 Michael Jordan Removed references to the NHibernate OR mapping framework. 3.0 6/17/2010 Michael Jordan Updated the version references of the ExtJS and Spring libraries to current 4.0 11/4/2011 Michael Jordan Removed some additional NHibernate references. Added additional text related to rich JavaScript business objects. Corrected some spelling issues. 5.0 10/18/2013 Michael Jordan Updated to reflect use of .Net 4.0 Updated to reflect use of ExtJs 4.X Updated to reflect use of Html5 Update Virtual Earth to Bing Maps 6 07/01/2013 Michael Jordan Updated to include both ExtJs 4.x and 5.x 7 004/27/2017 Michael Jordan Updated ExtJs 5.x and referencing SQL Server as preferred backend database 8 11/16/2017 Michael Jordan Updated document location section Added Technology Constraints and Appendix sections Added Architecture Justifications section Updated Ajax and ASP.Net verbiage in the Technologies section Added support for stored procedures Added Security Authentication and Authorization section [Version], [Date] 2 [Document Header] 1 Introduction 1.1 About This Document The purpose of this document is to describe the default architecture used in development web applications at the Ohio Department of Transportation. Many of these same concepts apply to client/server based application development as well. 1.2 Document Location The latest version of this document is available from the following site. The following table provides the website and folder location of the document. Application Site http://portal.dot.state.oh.us/Divisions/DoIT/SoftProd/client/Software%20 Development%20Practices Document Folder http://portal.dot.state.oh.us/Divisions/DoIT/SoftProd/client/Software%20 Development%20Practices/Forms/AllItems.aspx Filename ODOT Web Application Architecture.doc [Version], [Date] 3 [Document Header] 2 Architecture 2.1 A Layered Approach The default architectural approach used at ODOT for web applications involves a standard 3-tiered model for partitioning application logic. The three primary layers are User Interface Layer, Domain Layer, and Service Layer. The implementation of these various layers uses the C# programming language from the Microsoft .NET platform. The use of well-defined application layers allows applications to be modified and extended without necessarily requiring significant code re-rewrites. For example by having the data access logic located in the Service layers it makes it possible to replace the implementation without necessarily requiring any changes to the user interface. The following sections provide a brief description of these application layers and an indication of the type of application logic that should be implemented within each. 2.1.1 User Interface Layer This layer contains code that is specific to the user interface interactions (i.e. responding to user event, button clicks, click on links, form submission, etc). For web application this logic will be implemented in C# as ASP.Net MVC Controllers returning Json data in response to AJAX calls from the client. When server side view logic is necessary then the system can leverage either the ASPX or (preferably) the Razor view engines. For the most part though, all view logic will be implemented using the ExtJs JavaScript framework and the server side controllers would be APIs returning Json/XML data in response to AJAX calls. Use of the ExtJs (5.x) JavaScript user interface library is required for consistency in user interface development as well as for the rich set of user interface components offer by this library. The structure of the ExtJs JavaScript files should follow the Application Architecture recommended by the ExtJs vendor: http://docs.sencha.com/extjs/5.1/application_architecture/application_architecture.html Use of Web 2.0 style development techniques (i.e. AJAX based requests) to provide dynamic client side functionality is encouraged where appropriate. This is accomplished by using the AJAX libraries built into the ExtJs JavaScript framework. Note: One caveat to this is when building a feature rich JavaScript application it may be necessary for performance reasons to build a rich client side domain model in JavaScript. In this case these JavaScript classes would be considered an extension of the Domain layer as indicated below and could contain business logic that runs client side in the browser. 2.1.2 Domain Layer This is a Visual Studio class library project that compiles to a DLL called ODOT.<app name>.Domain.dll. The core of the application requirements will be modeled as Domain objects. Domain objects are C# classes that represent the key business concepts within the application (i.e. Users, Projects, Purchase Orders, Coordinates, etc.). This layer contains the primary business logic of the application (calculations, relationships among domain [Version], [Date] 4 [Document Header] entities, etc). The exception to this would be business logic that spans multiple objects within a given database transaction in which case that logic would be located in a Service Layer method that would coordinate the logic required among the various domain entities. The Domain Layer is generated in its own .NET Assembly/dll which will contain all the domain entities for the application as well as interface definitions for the service layers (implemented as C# interface classes). The implementation of the service interfaces will reside in the Server Layer Assembly. By decoupling the domain layer from the service assembly we can swap out different service implementation without affecting either the Domain Layer or the User Interface Layer. 2.1.3 Service Layer This is a Visual Studio class library project that compiles to a DLL called ODOT.<app name>.Service.dll. For ODOT web applications the Service Layer contains the transactional boundaries for the application and the data access logic (Create, Read, Update, and Delete logic). The Service Layer should be generated as its own .Net Assembly and it should provide an implementation of the service interfaces defined in the Domain Layer assembly. Most of the business logic of the application should be contains within the Domain entities
Recommended publications
  • Sencha Touch and Ext JS Developer Description
    Sencha Touch and Ext JS Developer Description: Health Outcomes Worldwide (HOW), a diverse and rapidly growing Canadian company seeks a motivated developer to work with an agile virtual team creating cutting-edge web and mobile applications for use by healthcare professionals. HOW provides solutions used by nurses in healthcare environments across Canada. The mobile application is a hybrid HTML5 (Sencha Touch)/Cordova solution designed for tablet devices (iOS and Android). Plans for a revamped browser-based solution (using ExtJS 5) are also in development. The selected developer will play an integral role in both mobile and desktop solution design and development using Sencha tools. The ideal candidate will have: • 4+ years of extensive experience with Sencha Ext JS framework and 2+ experience with Sencha Touch framework. • In-depth knowledge of javascript. • Experience building iOS, Android, Windows and Blackberry apps with PhoneGap/ Cordova platform. • Solid knowledge of HTML5, CSS3, EcmaScript 6 and their integration in a standards-based fashion with each other. • Proficiency with the DOM and asynchronous event programming model. • Experience with cross-platform (PC/Mac, desktop, laptop, tablet) and cross-browser (IE, Firefox, Chrome, Safari) development. • Experience with AJAX, JSON and RESTful web services. • Server-side development with ASP.NET WebForms, ASP.NET MVC and Node.js. • Database design and programming using MS SQL Server and SQLite. • Familiarity with Design Patterns, particularly Model-View-Controller (MVC). • Experience with mobile development and Touch interfaces. • Solid understanding and experience with Agile software development methodologies. Qualified, interested parties should submit a resume to [email protected].
    [Show full text]
  • 85324630.Pdf
    About NetTantra NetTantra is a creative technology and design company based out of India, US and UK. We provide web based solutions and mobile solutions to various industries like manufacturing, consulting, education. We have expertise in various sectors of the web including an array of server-side languages, OpenSource CMS/Blog frameworks, Linux/UNIX system administration, production server backup and recovery solutions, cloud infrastructure set-up and much more. Our expertise in providing WordPress based solutions has been acclaimed by many of our clients and the OpenSource community. We also provide cloud based solutions like migrating existing applications and building cloud applications for public or private cloud setups. We are known among our clients for on-time delivery and extraordinary quality of service. In mobile based solutions, we have expertise in developing native applications for iOS and Android platforms. We also develop cross-platform mobile applications using Sencha Touch and jQuery Mobile frameworks. 2 of 14 pages Why Hire Us ✔ Technology ◦ We have expertise in the most cutting edge tools and technologies used in the industry with special focus on OpenSource Technologies ◦ We pay special attention to web and network security for all projects ◦ Our team follows highly optimized project delivery life cycles and processes ✔ Cost ◦ We offer the best price to quality ratio ✔ Infrastructure ◦ Advanced workstations ◦ Cutting edge computing and network systems ◦ Power packed online servers ◦ Smart communications systems ◦ Conference halls, CBT and video learning facilities ◦ High-speed uninterrupted Internet connection ✔ Quality of Service ◦ Guaranteed client satisfaction ◦ Real-time customer support with the least turn-around in the industry ◦ Pre-sales technical and business related support to partners and agencies ✔ Ethics and Principles ◦ We ensure confidentiality in all our dealings.
    [Show full text]
  • Qooxdoo Interview Questions and Answers Guide
    Qooxdoo Interview Questions And Answers Guide. Global Guideline. https://www.globalguideline.com/ Qooxdoo Interview Questions And Answers Global Guideline . COM Qooxdoo Job Interview Preparation Guide. Question # 1 What is Qooxdoo? Answer:- qooxdoo is an open source Ajax web application framework. It is an LGPL- and/or EPL-licensed multipurpose framework that includes support for professional JavaScript development, a graphical user interface (GUI) toolkit and high-level client-server communication. Read More Answers. Question # 2 Is qooxdoo freely available? Answer:- Yes. qooxdoo is Open Source, dual-licensed under LGPL/EPL, i.e. the "GNU Lesser General Public License (LGPL)" and the "Eclipse Public License (EPL)". As a recipient of qooxdoo, you may choose which license to receive the code under. Read More Answers. Question # 3 Who developed qooxdoo? Answer:- qooxdoo was initiated and is maintained by 1&1, the world's biggest web hosting company. There is a team of full-time core developers as well as many committers and contributors. Read More Answers. Question # 4 Which browsers are supported? Answer:- A qooxdoo application runs in all major web browsers - with identical look & feel. Read More Answers. Question # 5 Does qooxdoo come with a server? Answer:- No. If you already have an existing backend that serves HTTP (or HTTPS) requests, it's probably fine to continue using it. Optionally qooxdoo offers several RPC servers for an elegant client-server communication. BTW, during development of your client application the local file system often is sufficient, without the need to use a real server. Read More Answers. Question # 6 What languages and technologies do we need to know? Answer:- Not many.
    [Show full text]
  • Preview Extjs Tutorial (PDF Version)
    About the Tutorial ExtJS stands for Extended JavaScript. It is a JavaScript framework and a product of Sencha, based on YUI (Yahoo User Interface). It is basically a desktop application development platform with modern UI. This tutorial gives a complete understanding of Ext JS. This reference will take you through simple and practical approaches while learning Ext JS. Audience This tutorial has been prepared for beginners to help them understand the concepts of ExtJS to build dynamic web UI. Prerequisites For this tutorial, the reader should have prior knowledge of HTML, CSS, and JavaScript coding. It would be helpful if the reader knows the concepts of object-oriented programming and has a general idea on creating web applications. Execute ExtJS Online For most of the examples given in this tutorial you will find a Try it option. Make use of this option to execute your ExtJS programs on the spot and enjoy your learning. Try the following example using the Try it option available at the top right corner of the following sample code box − <!DOCTYPE html> <html> <head> <link href="https://cdnjs.cloudflare.com/ajax/libs/extjs/6.0.0/classic/theme- classic/resources/theme-classic-all.css" rel="stylesheet" /> <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/extjs/6.0.0/ext-all.js"></script> <script type="text/javascript"> Ext.onReady(function() { Ext.create('Ext.Panel', { renderTo: 'helloWorldPanel', height: 100, i width: 200, title: 'Hello world', html: 'First Ext JS Hello World Program' }); }); </script> </head> <body> <div id="helloWorldPanel"></div> </body> </html> Copyright & Disclaimer Copyright 2017 by Tutorials Point (I) Pvt.
    [Show full text]
  • Ext JS 4 Next Steps
    Ext JS 4 Next Steps The Ext JS 4 library is one of the most powerful libraries for building Rich Internet Applications. Through this book we have learned how the library works and what capabilities it has. Now that we have a full working application and have learned how to use the library, we must know that there are a lot of other things around this awesome library. In this chapter we will see what other concepts may help us to improve our development process when using Ext JS 4. In this chapter we will cover the following topics: • The Ext JS 4 API documentation • Using JSDuck • Want to go mobile? • The Sencha forums The Ext JS 4 API documentation Ext JS 4 has some of the best documentation; it is easy to use and very powerful. The Sencha team has always put so much effort when delivering their frameworks' documentation, but the Ext JS 4 and Sencha Touch 2 APIs are a state of art in documentation. Ext JS 4 Next Steps When we are new to Ext JS 4, one of the most important things we have to know is how the API works. We don't need to memorize each class and class methods, we just need to know where to find them. The following screenshot shows the Sencha Docs structure: In the Sencha Docs we have five main regions. On the left-hand side we have the package tree list with all the packages and classes Ext JS 4 has in its library. In the top right-hand corner we have the search component where we can search almost anything like classes, methods, guides, xtypes, and more.
    [Show full text]
  • Java Script Libraries
    Java Script Libraries www.LifeMichael.com What is JavaScript? ● The JavaScript code is executed within the scope of the web browser. ● JavaScript is an object oriented programming language with functional programming capabilities. © 2010 Haim Michael. All Rights Reserved. Sample <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <title></title> <script src="mycode.js" type="text/javascript"></script> </head> <body> bla bla <script type="text/javascript"> alert("sum="+sum(3,4)); </script> </body> </html> © 2010 Haim Michael. All Rights Reserved. Sample function sum(numA,numB) { return numA+numB; } © 2010 Haim Michael. All Rights Reserved. Sample © 2010 Haim Michael. All Rights Reserved. Ajax ● We can develop JavaScript code that perform the HTTP interaction with the server side. © 2010 Haim Michael. All Rights Reserved. DOM ● The JavaScript programming language allows us to interact with the web page DOM and even change it. © 2010 Haim Michael. All Rights Reserved. CSS ● CSS files are responsible for the look & feel of our web site. We can use Java Script to introduce changes in the look & feel CSS properties. © 2010 Haim Michael. All Rights Reserved. CSS body {background-color:yellow} h2 {color:red} simple.css © 2010 Haim Michael. All Rights Reserved. CSS <html> <head> <title>demo</title> <link rel="stylesheet" type="text/css" href="simple.css"/> </head> <body> <h1>great places</h1> <h2>jogaga</h2> <h2>gongogo</h2> </body> </html> © 2010 Haim Michael. All Rights Reserved. CSS © 2010 Haim Michael. All Rights Reserved. HTML5 ● HTML5 new coming standard is mainly about JavaScript. The new coming HTML5 specification defines various JavaScript APIs for performing various useful operations.
    [Show full text]
  • The Well Project Mobile App Case Study
    www.armedia.com [email protected] The Well Project Mobile App Case Study unique and extensive focus on women. Since 2002, The Well Project has worked to achieve this goal by developing new resources to educate, nurture and support the international community of HIV+ women, their loved ones, and their healthcare providers. Customer The Well Project them in reaching a broader audience, increase the agility of their messaging, and further cement the community - style feel of their Solution Mobile Application Development Objective: To create a mobile application that not onl y promotes informational articles but also serves as community of support for Products Drupal WCM WordPress WCM PhoneGap Framework This Project Goal had Several parts: Sencha Touch Webkit -Build an app optimized for community engagement that would User Interface provide the ability for information to be spread on a global and Web 2.0 (HTML 5 / CSS 3 / JavaScript) viral scale. Thus, The Well Project Mobile App was built to: o Provide users with the ability to comment on blog posts written by other women from around the world from their mobile device. o Provide users with the ability to share Articles or Blog posts with others In an age of ever changing technology, we “ o Provide the ability for users to be able to access realized we needed to expand our resources to information when they are not able to access Internet “ provide for women in need of HIV/AIDS informa- through their mobile devices by giving posts marked as tion world wide, and we were excited to work favorites the ability to be stored locally.
    [Show full text]
  • Mastering Ext JS
    Mastering Ext JS Learn how to build powerful and professional applications by mastering the Ext JS framework Loiane Groner BIRMINGHAM - MUMBAI Mastering Ext JS Copyright © 2013 Packt Publishing All rights reserved. No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews. Every effort has been made in the preparation of this book to ensure the accuracy of the information presented. However, the information contained in this book is sold without warranty, either express or implied. Neither the author, nor Packt Publishing, and its dealers and distributors will be held liable for any damages caused or alleged to be caused directly or indirectly by this book. Packt Publishing has endeavored to provide trademark information about all of the companies and products mentioned in this book by the appropriate use of capitals. However, Packt Publishing cannot guarantee the accuracy of this information. First published: July 2013 Production Reference: 1010713 Published by Packt Publishing Ltd. Livery Place 35 Livery Street Birmingham B3 2PB, UK.. ISBN 978-1-78216-400-5 www.packtpub.com Cover Image by Asher Wishkerman ([email protected]) Credits Author Project Coordinator Loiane Groner Hardik Patel Reviewers Proofreader Aafrin Chris Smith Vincenzo Ampolo Yiyu Jia Indexer Hemangini Bari Joel Watson Graphics Acquisition Editor Abhinash Sahu Edward Gordon Production Coordinator Lead Technical Editor Shantanu Zagade Anila Vincent Cover Work Technical Editors Shantanu Zagade Arvind Koul Worrell Lewis Vaibhav Pawar Amit Ramadas About the Author Loiane Groner lives in São Paulo, Brazil and has over eight years of software development experience.
    [Show full text]
  • Introducción a Sencha Touch
    Introducción a Sencha Touch Índice 1 Introducción..................................................................................................................2 2 Sencha Touch vs. JQuery Mobile.................................................................................3 3 Instalar Sencha Touch.................................................................................................. 4 4 Estructura de carpetas...................................................................................................5 5 Código HTML básico de una aplicación......................................................................6 6 Instanciar una aplicación.............................................................................................. 8 7 Comprobando los resultados...................................................................................... 10 8 Todo en un único fichero............................................................................................11 9 Paneles y Layouts.......................................................................................................11 10 Identificadores.......................................................................................................... 13 11 Toolbars.................................................................................................................... 14 12 Docked items............................................................................................................ 15 13 Botones....................................................................................................................
    [Show full text]
  • Mobile Applications Development
    Mobile Applications Development www.LifeMichael.com (c) 2012 Haim Michael. All Rights Reserved. Table of Content 1. Web, Native & Hybrid Applications 2. Rapid Applications Development 3. The Hybrid Application Advantages 4. The Application Native Parts 5. Native Application Cases 6. Future Mobile Operating Systems 7. Summary, Questions & Answers (c) 2012 Haim Michael. All Rights Reserved. Web Applications ● HTML, CSS, JavaScript, Ajax, HTML5, jQuery, jQuery Mobile, Mootools, AngularJS, Sencha Touch, Google Charts API etc... (c) 2012 Haim Michael. All Rights Reserved. Native Applications ● Java ● Objective C ● C#, F# and VB.NET ● C++ (c) 2012 Haim Michael. All Rights Reserved. Hybrid Applications ● The hybrid mobile application is a relatively small native application that includes a small component that functions as a web browser. application Web Browser webkit www.webkit.org (c) 2012 Haim Michael. All Rights Reserved. Hybrid Applications ● The code written in Java Script running within the native application web browser component can invoke functions that belong to the native part. code in java code in java script public void doSomething() { Web Browser ... } doSomething() (c) 2012 Haim Michael. All Rights Reserved. Table of Content 1. Web, Native & Hybrid Applications 2. Rapid Applications Development 3. The Hybrid Application Advantages 4. The Application Native Parts 5. Native Application Cases 6. Future Mobile Operating Systems 7. Summary, Questions & Answers (c) 2012 Haim Michael. All Rights Reserved. RAD Tools ● We can either have a direct control over the code running on the android platform or take the easy way. Basic4Android (www.basic4ppc.com) RAD Studio XE2 (www.embarcadero.com) Tiggzi (www.tiggzi.com) Dragon RAD (www.dragonrad.com) (c) 2012 Haim Michael.
    [Show full text]
  • Technical Expertise
    www.ultantechnologies.com Technical Expertise Subject: Ultan Technologies Technical Expertise Author: Cathal Brady Date Published: 01/03/2016 Version Number: Version 1 www.ultantechnologies.com Contents 1 INTRODUCTION ..................................................................................................................... 1 2 .NET ....................................................................................................................................... 1 3 DATABASES ........................................................................................................................... 2 4 BIG DATA ............................................................................................................................... 2 5 JAVA ...................................................................................................................................... 3 6 PHP, RUBY, PYTHON .............................................................................................................. 3 7 FRONT END............................................................................................................................ 4 8 3RD PARTY INTEGRATION, APIs, PLUGINS ............................................................................. 4 9 CONTINUOUS INTEGRATION / BUILD AUTOMATION / VERSION CONTROL .......................... 4 10 MOBILE DEVELOPMENT ........................................................................................................ 5 11 CRM CUSTOMISATION .........................................................................................................
    [Show full text]
  • Building a Sencha Touch Application
    Building a Sencha Touch Application A Hands-On Tutorial for Mobile Applications Developers Book Version: 1.0 Copyright © 2011 Jorge Ramon All rights reserved. www.miamicoder.com About This Book Goals This book is about one of the best ways to get started with the Sencha Touch JavaScript framework. It will shorten the time it takes you to learn Sencha Touch, and it will give you great pointers that you can use when developing your own applications. What we will do in this book is build a Sencha Touch 1.1.1 application. To accomplish this, we are going to follow a simple approach that will teach you, among other things, how to capture user input through form elements, render data using lists, and store information on the device running the application. You need to master these practices in order to create successful applications. This book is not a comprehensive Sencha Touch reference. Here we will not cover all the features, strengths, and weaknesses of Sencha Touch. Rather, we will create a foundation that will help you take the next steps in your path to learning and using the framework. Here is a detailed view of what’s ahead of us: Table of Contents 1. Chapter 1: Introducing the Notes Application 1.1. The Notes App 1.2. Features of the Notes Application 1.3. Designing the Main Views 1.4. Beginning Construction 1.5. Where Are We? 2. Chapter 2: Building the Notes List 2.1. The Notes List’s Toolbar 2.2. The Notes Cache 1 2.3.
    [Show full text]