GENESYSSOURCE. How-to Pull Your Data through the Customer. A Cross-Platform Framework Quick-Start

Transcription

1 GENESYSSOURCE How-to Pull Your Data through the Customer A Cross-Platform Framework Quick-Start GENESYSSOURCE Antonio, Suite B Rancho Santa Margarita, Ca GenesysSource.com Created: Feb 9, 2017 Modified: September 24, 2018

2 Copyright Genesys Source. All rights reserved. Printed in USA. Genesys Source is a registered trademark of Genesys Source. Genesys Framework and Genesys Cloud Dev Environment are trademarks of Genesys Source. Microsoft, Azure, HoloLens, Hyper-V, Visual Studio, Windows and Xamarin are registered trademarks of Microsoft Corporation. All other product names and logos are trademarks and service marks of their respective companies. This document is provided as-is. Information in this document, including URL and other Internet website references, may change without notice. Genesys Source assumes no liability for damages incurred directly or indirectly from errors, omissions, or discrepancies between the product and this document. An attempt has been made to state all allowable values where applicable throughout this document. Any values or parameters used beyond those stated may have unpredictable results. Copyright Genesys Source Page 2 of 7

3 Contents Introduction...4 Why reusable business objects?...4 Why cross-platform, full-stack business objects?...4 Pre-requisites... 5 Add a new Field/Property to the Customer object... 5 Copyright Genesys Source Page 3 of 7

4 Introduction Genesys Source Framework is an open-source C# business object reusability framework...enabling your objects to be cross-platform, full-stack, CRUD-to-SQL/Services enabled, self-serializing, self-validating and self-tracking. Your business object DLLs are then consumable by your app, using any.net web or native technology, including MVC, Web API, UWP, Xamarin ios, Xamarin Android, Web Forms, WCF, Windows Service, Console Apps and CLR stored procedures. The goal is enabling developers to reuse business objects, painlessly...without the plumbing time and cost. Features of the Genesys Framework: CrudEntity base with CRUD-to-SQL data access, Create(), Read(Expression), Update() and Delete(). ViewModel (MVVM) and MvcController (MVC) base with CRUD-to-Services data access, CreateAsync(), ReadAsync(Expression), UpdateAsync() and DeleteAsync(). ModelEntity base with Serialize() for binding to screens in MVC, WPF, UWP, etc. SaveableDatabase and ReadOnlyDatabase for direct data access via EF -> SQL. Genesys.Extensions: Cross-platform common library. Why reusable business objects? Code reuse is an important theme in many of todays accepted software practices, such as N-tier and Object-oriented programming (OOP.) Typically, reusable software stacks and services have low technical debt and are cheaper to maintain over time. Reusable code settles over time and costs decrease. Your return on investment (RoI) is greater with reusable software stacks Conversely, the code duplication method tends to cost more over time, with high technical debt in the form of maintenance time and costs spiking per each duplicated item. Your costs go up over time, until the software is rewritten or retired. The Genesys Framework offers n-tier, reusable business objects, with a low learning curve. Reusability without the cost of doing it yourself, and without the uncertainty of an untested new code base. Why cross-platform, full-stack business objects? Microsoft.NET classes have a unique characteristic they can run almost anywhere on any popular platform and run in any software tier. This allows a.net entity class, like a Customer entity, to enjoy a 100% strongly-typed stack and consistency in properties and validation rules in web sites, web services, native apps, CLR stored procedures and in class libraries. With cross-platform full-stack entity objects, spelling errors and type errors show immediately as a compile error in a stored procedure, in a data access C# file, in a MVC controller everywhere that entity is used. Typing is maintained through the stack: Any SQL Data -> Framework.Database -> Framework.DataAccess -> Framework.Models -> Any.NET App Copyright Genesys Source Page 4 of 7

5 Genesys Framework takes advantage of run-anywhere to enable any business object to run in Web, Services, Desktop and Mobile. Take the Customer entity as an example: CustomerInfo.cs: Heavy Data Access Object (DAO) based on Entity Framework database-first. Supports CRUD-to-SQL methods of Create(), Read(Expression), Update(), Delete(). CustomerModel.cs: Lightweight screen and transport models. This class is cross-platform and runs in MVC, Web API, UWP, WPF, Xamarin ios, Xamarin Android, CLR Stored Procedures. CrudViewModel<CustomerModel>: MVVM ViewModel with CRUD-to-Services methods such as CreateAsync(), ReadAsync(Expression), UpdateAsync() and DeleteAsync(). customer.serialize(): JSON string is returned from any class that inherits CrudEntity or ModelEntity. This JSON can be controller generated and used by client-side web applications. Pre-requisites To get the most out of this article, the following skills are recommended: Moderate C# and.net, HTML and XAML Low-Moderate T-SQL and Database design Awareness of N-tier, MVC, MVVM and REST Visual Studio Community (or greater) from SQL Server Management Studio from Add a new Field/Property to the Customer object This procedure walks you through the process of adding, changing or deleting an entity field. Including the column in the database, the data access object, the model and a MVC View. 1 Open Framework-for-MVC.sln 2 Open Table & Add Column Tables\Customer\Customer.sql 3 Open View & Add Column Views\CustomerCode\CustomerInfo.s ql Copyright Genesys Source Page 5 of 7

6 1. Open the Framework-for-MVC.sln Visual Studio solution file - Default: C:\Source\Framework-for- MVC.sln 2. Navigate to and open Customer table: Framework.Database\Tables \CustomerCode\CustomerInfo.sql 3. Add a new field: NickName [NickName] NVARCHAR (50) CONSTRAINT [DF_Customer_NickName] DEFAULT ('') NOT NULL, 4. Navigate to and open Customer view: Framework.Database\Views \CustomerCode\CustomerInfo.sql 5. Add the NickName field: C.[NickName], 4 Publish FrameworkData to SQL Server 5 Open CustomerInfo.cs in Framework.DataAccess 6 Add NickName to CustomerInfo 6. Open SSDT publish screen: Framework.Database\Publish \PublishToDev.publish.xml - Ensure Target database connection is correct 7. Click Generate Script and review 8. Click Publish to push changes to SQL 9. Open CustomerInfo.cs - Framework.DataAccess\Customer 10. Add NickName by Copy/Paste the following property: public string NickName { get; set; } = string.empty; 7 Add NickName to ICustomer & Models 8 Add NickName to Framework.WebApp Search 9 Run! Copyright Genesys Source Page 6 of 7

7 11. Open Framework.Interfaces\Customer \ICustomer.cs 12. Add NickName property as a string - Notice all classes that implement ICustomer throw an error requiring ICustomer.NickName 13. Add NickName to all dependent models (CustomerModel and CustomerSearchModel) 14. Open Framework.WebApp \Views\CustomerSearch \CustomerSearchResults.cshtml 15. Add Nick Name to table header and body 16. Double-check the connection string, to make sure it is pointing to the proper database 17. Right-click Framework.WebApp project - > click Set as StartUp Project 18. Press F5 or to run 1: Adding NickName to Customer business object Copyright Genesys Source Page 7 of 7