Future Developer Notes
These notes are for future developers who follow in my footsteps. Those
who may be curious as to what are the proper steps to generating the
documentation found on this web for the Work Request project.
It would be important to keep the documents in sync with the
database.
The documents I am referring to consist of the following:
- Visio Entity Relationship Diagram
- Work Request Table List
- C# Source code for Data Access Layer
- An entire folder name WorkRequestDAL full of C# classes
- T-SQL Stored Procedures for the Data Layer
- WorkRequest_LLBL_StoredProcedures.sql
- Source Code Documentation Web
- An entire web folder named WorkRequestDAL
Each of these are generated, but a specific order should be maintained
The tools needed are as follows:
- Visio 2002 Architect
- Visual Studio.NET
- LLBLGen
- FrontPage 2000
Steps to follow:
Generate the Diagrams
- Use Visio,
- Open the WRERD.vsd diagram
- Make any database changes required
- Error Check
- Select Database->Model->Error Check
- Fix any errors
- Save changes
- Update or Generate DDL script
- Select Database->Generate
- Select Database->Update
- Pick WRERD.ddl as the output file
Generate the Table Report
- Generate Report
- Select Database->Report
- Select Table Report from the List of Report Types
- Press Finished
- Press Export to RTF
- Select the file WorkRequestTables.rtf
Update the Database from the DDL
- Use a Visual Studio.NET Data Project
- Create a change or create script from the WRERD.ddl file
- Simply rename it and drop it into the VS solution explorer
- Create a connection to the WorkRequest Database
- Right click and Run the script
Create the Data Access Layer
- Run LLBLGEN
- found C:\Program Files\Solutions Design\LLBLGen\Executable
- Select the server and database to use, hit connect
- Select the tables to generate classes for
- Enter the following workspace
- PROTOCOL.Covington.WorkRequest.DAL
- Prefix the Stored Procedures with sp_
- Enter/Select the location to output the DAL and SP
- \Project\WorkRequest\WorkRequestDAL
- \Project\WorkRequest\SP
- Press Start Generation
- Close the LLBLGen utility
Create the Data Access Layer Project
- Run Visual Studio.NET
- Drag the generated C# source files into a DAL project
- Compile
- Drag the generated SP file into a Data Project
- WorkRequest_LLBL_StoredProcedures.sql
- Right click and Select RUN ON this script as well
Create the Data Access Layer C# Documentation Web
- Run Visual Studio.NET
- From the Tools Menu select C# Documentation Web Builder
- Point the utility to the proper website location
- Complete API documentation will be generated automatically
| 
