Documentation for Developers: Difference between revisions
Jump to navigation
Jump to search
| (43 intermediate revisions by 4 users not shown) | |||
| Line 6: | Line 6: | ||
==Development== | ==Development== | ||
=== Development Environment === | === Development Environment === | ||
* [[Setup of Development environment | * [[Quick Setup of Development environment]] | ||
=== Programming === | === Programming === | ||
====General==== | |||
* [[Coding Standard and Guidelines]] | * [[Coding Standard and Guidelines]] | ||
* [[Error and Exception Handling Policy]] | |||
* [[Explanation of Directory Structure and Rules]] | * [[Explanation of Directory Structure and Rules]] | ||
==== Development ==== | |||
* [[Useful hints regarding coding in CSharp/.net]] | * [[Useful hints regarding coding in CSharp/.net]] | ||
* [[Development with Code Generation]] | * [[Development with Code Generation]] | ||
* [[Build system with our own NAnt tools and tasks]] | * [[Build system with our own NAnt tools and tasks]] | ||
* [[Preventing/getting around circular dependency problems]] | * [[Preventing/getting around circular dependency problems]] | ||
==== Database-related==== | |||
* Architecture Information | |||
** [[Overview openPETRA architecture#Database_System|Database System]] / [[Database access architecture]] | |||
** Two diagrams at the right ------------------------------> | |||
[[File:OpenPETRA_Data_RDBMS_Abstraction_only_Diagram.png|200px|thumb|right|openPETRA Database Abstraction Layer Diagram]] | |||
[[File:Petra_NET_Data_Access_Layer.png|200px|thumb|right|Data Access Layer]] | |||
* [[Using OpenPetra's DataAccess Objects]] | |||
* [[DB Access Exception Handling]] | |||
* [[Automatic DB Transaction Handling]] | |||
* [[Co-ordinated DB Access (Thread-safe DB Access)]] | |||
* [[Working with multiple DB Connections]] | |||
* [[Stopping of Running DB Queries]] | |||
* [['Preparing' SQL Statements And Specifying SQL Statement Time-outs]] | |||
* [[Specifying 'standard' / 'default' / 'base' data for DB Tables]] | |||
* [[DataSets: Ensuring you deliver 'unchanged' data to the Client]] | |||
* PostgreSQL-specifics | |||
** [[PostgreSQL: Sequences Not Tied to DB Transactions]] | |||
====Other Topics==== | |||
* [[User Defaults]] | |||
* [[System Settings (Maintain Table Screen)]] | |||
* [[Working with OpenPetra Security]] | |||
* [[Retrieving the 'SiteKey' of an OpenPetra installation]] | |||
=== Development Cycle === | === Development Cycle === | ||
| Line 26: | Line 53: | ||
=== Getting Started === | === Getting Started === | ||
* [[HowTo develop a new screen]] | * [[HowTo develop a new screen]] | ||
* [[HowTo develop a new report]] | * [[HowTo develop a new report]] | ||
* [[Report Designer]] | * [[Report Designer]] | ||
| Line 36: | Line 62: | ||
=== Tips and Tricks === | === Tips and Tricks === | ||
* [[Specifying custom settings in Config Files for Development]] | * [[Specifying custom settings in Config Files for Development]] | ||
* [[Developing the Javascript Client]] | |||
* [[Homepage]] | |||
== OpenPetra Software Architecture == | == OpenPetra Software Architecture == | ||
| Line 44: | Line 71: | ||
* [[n-tier architecture]] | * [[n-tier architecture]] | ||
* [[Database access architecture]] | * [[Database access architecture]] | ||
=== Client Side === | === Client Side === | ||
* [[Printing]] | * [[Printing]] | ||
* Specific Screens | |||
** [[Exchange Rates (Design and Test)]] | |||
== Bug Tracking == | == Bug Tracking == | ||
| Line 56: | Line 82: | ||
== Database Structure Documentation == | == Database Structure Documentation == | ||
* | We have DB model documentation online available in two formats, both of which are auto-generated with each release: | ||
* [http://openpetraorg.sourceforge.net/dbdoc/index.html Our own format] (see also [[SQL Diagram creation]]) | |||
** There is a [http://openpetraorg.sourceforge.net/dbdoc/img/img_AccountsPayable.html?a_ap_document diagram for the Accounts Payable sub system] | ** There is a [http://openpetraorg.sourceforge.net/dbdoc/img/img_AccountsPayable.html?a_ap_document diagram for the Accounts Payable sub system] | ||
** We need volunteers do design more diagrams! Please also have a look at the old 2.1 diagrams ([http://openpetraorg.sourceforge.net/Petra21DBDiagrams.zip download 9 png files in a zip file]). | *** We need volunteers do design more diagrams! Please also have a look at the old 2.1 diagrams ([http://openpetraorg.sourceforge.net/Petra21DBDiagrams.zip download 9 png files in a zip file]). | ||
* [http://openpetraorg.sourceforge.net/schemaSpy/index.html SchemaSpy format] | |||
** features quite nice automatically drawn relationship diagrams once you select a certain DB table. That can also be shown for the whole DB if you simply go to the ‘Relationships’ Tab on the index page (though that diagram is HUGE as the OpenPetra DB currently holds >300 DB Tables!). | |||
* [[Base and Demo databases]] | * [[Base and Demo databases]] | ||
* [[Specifying 'standard' / 'default' / 'base' data for DB Tables]] | |||
[[ | |||
== Project Infrastructure == | == Project Infrastructure == | ||
* Have a look at [[wordpress]]. The OpenPetra Website is running on Wordpress. | * Have a look at [[wordpress]]. The OpenPetra Website is running on Wordpress. | ||
* Continuous integration with [[ | * Continuous integration with [[Continuous Integration with LightBuildServer|LightBuildServer]] | ||
* [[Branches and Releases of OpenPetra]] | |||
Latest revision as of 21:04, 11 Mayıs 2022
Projects
Please read about what needs to be done, and how to take charge of a project here:
Summary of Projects
Development
Development Environment
Programming
General
- Coding Standard and Guidelines
- Error and Exception Handling Policy
- Explanation of Directory Structure and Rules
Development
- Useful hints regarding coding in CSharp/.net
- Development with Code Generation
- Build system with our own NAnt tools and tasks
- Preventing/getting around circular dependency problems
- Architecture Information
- Database System / Database access architecture
- Two diagrams at the right ------------------------------>
- Using OpenPetra's DataAccess Objects
- DB Access Exception Handling
- Automatic DB Transaction Handling
- Co-ordinated DB Access (Thread-safe DB Access)
- Working with multiple DB Connections
- Stopping of Running DB Queries
- 'Preparing' SQL Statements And Specifying SQL Statement Time-outs
- Specifying 'standard' / 'default' / 'base' data for DB Tables
- DataSets: Ensuring you deliver 'unchanged' data to the Client
- PostgreSQL-specifics
Other Topics
- User Defaults
- System Settings (Maintain Table Screen)
- Working with OpenPetra Security
- Retrieving the 'SiteKey' of an OpenPetra installation
Development Cycle
- Build System for OpenPetra
- Releases and Patching
- Building and maintaining customized versions of OpenPetra
- Migrating data from legacy systems
- Working with NUnit tests
Getting Started
Tools Used
This is a list of software that we use; some of it you will already have installed when you did your Setup of Development environment.
Tips and Tricks
- Specifying custom settings in Config Files for Development
- Developing the Javascript Client
- Homepage
OpenPetra Software Architecture
- Overview openPETRA architecture
- Taken from the old Petra wiki. Should be merged with the other articles!
- n-tier architecture
- Database access architecture
Client Side
- Printing
- Specific Screens
Bug Tracking
See Tracking of Bugs
Database Structure Documentation
We have DB model documentation online available in two formats, both of which are auto-generated with each release:
- Our own format (see also SQL Diagram creation)
- There is a diagram for the Accounts Payable sub system
- We need volunteers do design more diagrams! Please also have a look at the old 2.1 diagrams (download 9 png files in a zip file).
- There is a diagram for the Accounts Payable sub system
- SchemaSpy format
- features quite nice automatically drawn relationship diagrams once you select a certain DB table. That can also be shown for the whole DB if you simply go to the ‘Relationships’ Tab on the index page (though that diagram is HUGE as the OpenPetra DB currently holds >300 DB Tables!).
Project Infrastructure
- Have a look at wordpress. The OpenPetra Website is running on Wordpress.
- Continuous integration with LightBuildServer
- Branches and Releases of OpenPetra