π¦ IrbyImaging.UI.csproj Documentation
Welcome to the comprehensive documentation for the IrbyImaging.UI project file (IrbyImaging.UI.csproj). This file defines the build configuration, dependencies, and structure of the ASP.NET Core Web UI layer for the IrbyImaging solution.
π Table of Contents
- Overview & Purpose
- Project Configuration
2.1 Target Framework & SDK
2.2 Debug Settings - Dependencies & Technologies
3.1 Azure & Cloud Services π©οΈ
3.2 Reporting & Document Processing π
3.3 Data Access & Persistence ποΈ
3.4 Authentication & Security π
3.5 UI & Frontend Libraries π¨
3.6 Code Analysis & Testing π§ͺ
3.7 Other Notable Packages - Project References ποΈ
- Folder & File Inclusions π
- Sample Build & Run Instructions π
- Architecture & Integration (Mermaid UML)
- Conclusion β
1. Overview & Purpose
The IrbyImaging.UI project is the Web front-end layer of the IrbyImaging solution. It is built on .NET 9.0 using the Microsoft.NET.Sdk.Web SDK. This layer:
- Hosts Razor views, controllers, and static assets (
wwwroot). - Integrates with Azure Key Vault, Blob Storage, and other cloud services.
- Provides reporting (BoldReports), document processing (IronOCR, IronPDF), and Excel/Word automation (Syncfusion, ClosedXML).
- Handles authentication, authorization, and user interface logic.
- Leverages underlying BusinessLogic, DbContext, and Utility projects.
2. Project Configuration
<Project Sdk="Microsoft.NET.Sdk.Web">
<!-- General properties -->
<PropertyGroup>
<TargetFramework>net9.0</TargetFramework>
</PropertyGroup>
<!-- Debug configuration -->
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<DebugType>full</DebugType>
<DebugSymbols>true</DebugSymbols>
</PropertyGroup>
<!-- Content inclusion/exclusion, package references, project references, etc. -->
β¦
</Project>
2.1 Target Framework & SDK
- SDK:
Microsoft.NET.Sdk.Web - Target Framework: net9.0 (the latest .NET version), enabling:
- Minimal hosting model
- Performance improvements
- Modern C# 12 features
2.2 Debug Settings
When building in Debug mode (Debug|AnyCPU):
- DebugType:
fullβ includes full PDB data. - DebugSymbols:
trueβ enables symbol generation for step-through debugging.
3. Dependencies & Technologies
The UI project leverages a broad ecosystem of NuGet packages:
3.1 Azure & Cloud Services π©οΈ
| Package | Version |
|---|---|
| Azure.Extensions.AspNetCore.Configuration.Secrets | 1.3.2 |
| Azure.Security.KeyVault.Secrets | 4.7.0 |
| Azure.Storage.Blobs | 12.23.0 |
| Microsoft.Extensions.Azure | 1.9.0 |
| Microsoft.Extensions.Configuration.AzureKeyVault | 3.1.24 |
Use Case: Securely fetch configuration and secrets from Azure Key Vault; store and retrieve blobs.
3.2 Reporting & Document Processing π
| Package | Version | Purpose |
|---|---|---|
| BoldReports.AspNet.Core | 6.3.18 | Server-side reporting |
| BoldReports.Net.Core | 6.3.18 | Report rendering engine |
| ClosedXML | 0.104.2 | Excel file creation/manipulation |
| CsvHelper | 33.0.1 | CSV read/write |
| IronOcr | 2024.12.2 | Optical Character Recognition (OCR) |
| IronPdf | 2024.12.9 | PDF generation and manipulation |
| IronWebScraper | 2024.12.1 | Web scraping helper |
| IronXL.Excel | 2025.2.5 | Advanced Excel handling |
| iTextSharp | 5.5.13.4 | PDF processing |
| Syncfusion.* | 28.1.33+ | Word, PDF, Spreadsheet, EJ2 components |
Tip: BoldReports and Syncfusion require proper licensing. Use
Bold.LicensingandSyncfusion.Licensingto register.
3.3 Data Access & Persistence ποΈ
| Package | Version |
|---|---|
| Microsoft.EntityFrameworkCore | 9.0.0 |
| Microsoft.EntityFrameworkCore.SqlServer | 9.0.0 |
| Microsoft.EntityFrameworkCore.InMemory | 9.0.0 |
| Microsoft.EntityFrameworkCore.Tools | 9.0.0 |
| Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider | 5.1.0 |
| System.Data.SqlClient | 4.9.0 |
Integration: The UI layer can trigger EF Core Migrations, connect to SQL Server, and leverage Always Encrypted via Azure Key Vault.
3.4 Authentication & Security π
| Package | Version |
|---|---|
| Microsoft.AspNetCore.Authentication | 2.2.0 |
| Microsoft.AspNetCore.Authentication.OpenIdConnect | 9.0.0 |
| Microsoft.AspNetCore.Identity.EntityFrameworkCore | 9.0.0 |
| Microsoft.AspNetCore.Identity.UI | 9.0.0 |
| Microsoft.Identity.Web | 3.5.0 |
| Microsoft.Identity.Web.UI | 3.5.0 |
| Microsoft.Graph | 5.71.0 |
Scenario: Use OpenID Connect + Azure AD B2C / Entra ID for SSO. Microsoft Graph to integrate Outlook, Teams, etc.
3.5 UI & Frontend Libraries π¨
| Package | Version |
|---|---|
| dropzone | 4.3.0 |
| Microsoft.AspNetCore.Components.WebAssembly | 9.0.0 |
| Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation | 9.0.0 |
| Syncfusion.EJ2.AspNet.Core | 28.1.33 |
| Syncfusion.EJ2.PdfViewer.AspNet.Core.Windows | 28.1.33 |
| Syncfusion.EJ2.Spreadsheet.AspNet.Core | 28.1.33 |
| Syncfusion.EJ2.WordEditor.AspNet.Core | 28.1.33 |
Feature: Rich JavaScript components for data grids, pivot tables, PDF viewing, spreadsheets, drag-and-drop uploads, and Blazor support.
3.6 Code Analysis & Testing π§ͺ
| Package | Version |
|---|---|
| Microsoft.CodeAnalysis.* | 4.12.0+ |
| coverlet.collector | 6.0.2 |
| xunit.runner.visualstudio | 2.8.2 |
Use: Static code analysis, unit/integration testing, code coverage.
3.7 Other Notable Packages
- HtmlAgilityPack (1.11.71) β HTML parsing
- MimeKit & NETCore.MailKit β Email composition/sending
- Quartz (3.13.1) β Job scheduling
- Selenium.WebDriver & ChromeDriver β Automated UI testing
- Microsoft.Office.Interop.Outlook β Outlook automation
- TimeZoneConverter β Cross-platform TZ conversions
4. Project References ποΈ
This UI layer depends on three internal projects:
| Reference | Role |
|---|---|
..\IrbyImaging.BusinessLogic\*.csproj |
Core business rules & services |
..\IrbyImaging.DbContext\*.csproj |
EF Core DbContext & migrations |
..\IrbyImaging.BLUtility\*.csproj |
Shared utility/helper methods |
Together, they adhere to a clean architecture:
UI β BusinessLogic β DbContext
βοΈ BLUtility
5. Folder & File Inclusions π
<!-- Exclude a view from content to avoid duplication -->
<ItemGroup>
<Content Remove="Views\TimeEntry\TimesheetSearch.cshtml" />
<Compile Include="Views\TimeEntry\TimesheetSearch.cshtml" />
</ItemGroup>
<!-- Ensure folder placeholders exist in the project structure -->
<ItemGroup>
<Folder Include="Views\Reports\" />
<Folder Include="wwwroot\IrbySafety\" />
</ItemGroup>
- Views\TimeEntry\TimesheetSearch.cshtml
- Moved from
<Content>to<Compile>to enable strongly-typed Razor page compilation.
- Moved from
- Views\Reports & wwwroot\IrbySafety
- Ensure empty folders are tracked by Git / Visual Studio.
6. Sample Build & Run Instructions π
- Restore & Build
cd IrbyImaging.UI dotnet restore dotnet build - Environment Variables
Azure__KeyVault__Uriβ Key Vault URLConnectionStrings__Defaultβ SQL Server connection string
- Run Locally
dotnet run --launch-profile Development - Deploy
- Publish to Azure App Service or IIS.
- Ensure managed identity / service principal has Key Vault access.
7. Architecture & Integration (Mermaid UML)
graph TD
UI[IrbyImaging.UI]
BL[IrbyImaging.BusinessLogic]
DB[IrbyImaging.DbContext]
UTIL[IrbyImaging.BLUtility]
UI --> BL
BL --> DB
UI --> UTIL
subgraph External Services
KV[Azure Key Vault]
AS[Azure Blob Storage]
DBSQL[SQL Server]
end
UI --> KV
UI --> AS
DB --> DBSQL
- UI calls BusinessLogic for core operations.
- BusinessLogic interacts with DbContext for data.
- Utility provides cross-cutting helpers (e.g., logging, mapping).
- External services include Azure Key Vault, Blob Storage, and SQL Server.
8. Conclusion β
The IrbyImaging.UI.csproj is a robust, modern ASP.NET Core 9.0 project file that:
- Configures debug & release builds.
- Depends on a rich set of libraries for cloud integration, document/reporting, authentication, UI components, and testing.
- References internal layers following clean architecture.
- Enables advanced features like OCR, PDF generation, Excel automation, and scheduled jobs.
Use this documentation to understand the projectβs structure, dependencies, and best practices for building and running the UI layer of the IrbyImaging solution. Happy coding! π
Generated by AI Assistant