ConproSoft Technical Documentation¶
This documentation set describes the ConproSoft web solution as delivered, with a focus on:
- System architecture and core modules
- Configuration and deployment requirements
- Hosting and infrastructure assumptions
- Operational and administrative guidelines
- Support responsibilities and boundaries after handover
The application is an ASP.NET Web Forms solution using:
- .NET Framework 4.8
- IIS-hosted web application (
/appfolder) - SQL Server database accessed via the
MyCompanyconnection string - Metadata-driven framework controllers (
/app/controllers/*.xml) and business rules (/app/App_Code)
This documentation is intended for:
- The client’s IT/technical teams
- Hosting providers or infrastructure teams
- Future developers engaged for enhancements
- Operations and support staff responsible for monitoring and first-line troubleshooting
Use the navigation to access:
- Technical Documentation – Implementation and configuration detail
- Deployment & Migration – How to deploy, restore, and go live
- Operations & Administration – Ongoing tasks and checks
- Support Responsibilities – Who does what after transition
Quick Index¶
1. System Overview¶
High-level context on what the system does and how the major components fit together.
- System Overview: Overview context page
- Modules: Complete module catalogue and data model
- Core Functions: Major business processes and workflows
- Architecture Diagram: System architecture and data flow
- Application Layers: Presentation, application, and data layers
- Integrations with External Services: SMTP, external system integrations
2. System Components & Configurations¶
Where key system settings reside and how they can be updated.
- Overview of Configuration Files: web.config and touch-settings.json
- Email Configurations – Business Rules & Routing: Email setup and triggers
- System Constants / Settings Requiring Future Updates: Configurable constants and settings
- Scheduled Processes & Automated Routines: Background jobs and automation
- Environment-Specific Variables: Per-deployment configuration adjustments
3. Hosting & Infrastructure Requirements¶
Technical environment required for ConproSoft to run in a stable, client-managed setup.
- Required Hosting Environment (Windows / IIS): IIS and Windows Server requirements
- Required .NET Framework Version: .NET 4.8 specifications
- IIS AppPool Recommendations: Memory, pipeline mode, and settings
- SQL Server Requirements: Database version and configuration
- Folder Structure & File Permissions: Directory layout and NTFS permissions
- Backup Strategy & Recommended Frequency: Backup planning and retention
- Security Considerations: Firewalls, SSL, access control
4. Deployment & Migration Checklist¶
Step-by-step guidance for deploying or migrating the system.
- Pre-deployment Requirements: Prerequisites and preparation
- Step-by-Step Deployment Process: Complete deployment workflow
- Database Restore Procedure: Database backup and restore steps
- Updating Connection Strings: Configure database connection
- Configuring SMTP Settings: Email relay configuration
- Testing Key Functions After Deployment: Smoke tests and verification
- Go-live Checklist: Final pre-launch verification
5. Operational & Administrative Guidelines¶
Guidance for day-to-day operation and system maintenance.
- Common Administrative Tasks: Routine administration procedures
- User Account Management: User creation, roles, and access
- Email Troubleshooting Steps: Email delivery diagnostics
- Backup Verification: Testing backup integrity
- Monitoring System Health: Recommended monitoring tools
- What to Check if Something Stops Working: Initial incident response
- Typical Issues and Where to Look: Common problems and solutions
6. Support Responsibilities & Boundaries After Transition¶
Clarifying responsibilities once hosting moves to the client environment.
- Client Responsibility: Client's role and obligations
- Hosting Provider's Responsibility: Hosting provider's scope
- IT Provider's Responsibility: Internal IT team responsibilities
- Developer's Responsibility — Billable, On Request: Development support model
- Conditions for Future Development / Support Requests: Support request criteria