📄 IrbyImaging/Views/Docks/History.cshtml Documentation
📑 Table of Contents
- Overview & Purpose
- Dependencies & Technologies
- View Models & Data Models
- Key Functional Areas
- UI Structure & Markup Breakdown
- Helper Methods & Utilities
- Third‑Party Integrations & Assets
- Sample Code Blocks
- Usage Examples
- UML Class Diagram
- Conclusion
🔍 1. Overview & Purpose
History.cshtml is a Razor View in the IrbyImaging ASP.NET MVC application. It displays the change‐history and details for a specific Dock asset, providing users a timeline of:
- Asset Details (make/model, serial number, purchase date, status, notes)
- Activity Timeline (timestamps, comments, assignment changes, status changes)
- Navigation Buttons for common actions (Index, Details, Edit)
This view uses the HistoryListViewModel to bind data passed from the controller (e.g., DocksController.History action).
🛠️ 2. Dependencies & Technologies
| Technology / Library | Purpose |
|---|---|
| ASP.NET Core MVC / Razor | Server‑side templating and routing |
| Bootstrap 5 | Responsive grid & styling |
Boxicons (bx CSS icons) |
Timeline icons |
| MetisMenu | Sidebar menu functionality |
| SimpleBar | Custom scrollbar styling |
| Node‑Waves | Click‐ripple effect on buttons |
Layout used: ~/Views/Shared/_ATSLayout.cshtml
📊 3. View Models & Data Models
3.1 HistoryListViewModel
public class HistoryListViewModel
{
public int AssetId { get; set; }
public DockSummaryViewModel DocksList { get; set; }
public List<HistoryItemViewModel> Histories { get; set; }
}
3.2 DockSummaryViewModel
public class DockSummaryViewModel
{
public string MakeAndModel { get; set; }
// Other summary fields...
}
3.3 HistoryItemViewModel
public class HistoryItemViewModel
{
public DateTime Timestamp { get; set; }
public string Owner { get; set; }
public int OwnerId { get; set; }
public string Status { get; set; }
public string Reason { get; set; }
public object SomeAsset { get; set; } // e.g., domain entity
}
3.4 DomainClasses.Dock (unwrapped via SomeAsset)
namespace IrbyImaging.DomainClasses
{
public class Dock
{
public int ModelId { get; set; }
public string SerialNumber { get; set; }
public DateTime PurchaseDate { get; set; }
public string Status { get; set; }
public string Notes { get; set; }
// ... other fields
}
}
🚀 4. Key Functional Areas
-
Header & Layout
- Sets
ViewData["Title"] = "Dock History" - Uses shared layout
_ATSLayout.cshtml
- Sets
-
Asset Details Card
- Displays static info: Make/Model, SerialNumber, PurchaseDate, Status, Notes
-
Activity Timeline
- Iterates
Model.Histories - For each history entry it shows:
- Timestamp
- Comment (
Reason) - Assigned To (link to Employee details)
- Status
- Iterates
-
Action Buttons
- Index → list of all docks
- Details → details page of this dock
- Update → edit this dock
🏗️ 5. UI Structure & Markup Breakdown
@model HistoryListViewModel
@{
ViewData["Title"] = "Dock History";
Layout = "~/Views/Shared/_ATSLayout.cshtml";
}
<!-- Page Header -->
<h2 style="color: #11467e"><u>DOCK HISTORY</u></h2>
@{
// Grab first history item's asset details
var asset = Model.Histories.FirstOrDefault();
var assetDetail = asset.SomeAsset as IrbyImaging.DomainClasses.Dock;
}
<!-- Asset Details Card -->
<div class="card">
<div class="card-body">
<h1 class="card-title text-danger"><u><b>DETAILS</b></u></h1>
<h5><b>Make/Model:</b> <i class="text-primary">@Model.DocksList.MakeAndModel</i></h5>
<h5><b>Serial Number:</b> <i class="text-primary">@assetDetail.SerialNumber</i></h5>
<h5><b>Purchase Date:</b> <i class="text-primary">@assetDetail.PurchaseDate</i></h5>
<h5><b>Status:</b> <i class="text-primary">@assetDetail.Status</i></h5>
<h5><b>Notes:</b>
<pre><i class="text-primary">@assetDetail.Notes</i></pre>
</h5>
</div>
</div>
<!-- Activity Timeline -->
<div class="card">
<div class="card-body">
<h2 class="card-title text-danger"><u><b>ACTIVITY</b></u></h2>
<ul class="verti-timeline list-unstyled">
@foreach (var item in Model.Histories) {
<li class="event-list">
<div class="event-timeline-dot">
<i class="bx bx-right-arrow-circle"></i>
</div>
<div class="d-flex">
<div class="flex-shrink-0 me-3">
<i class="bx bx-time text-primary h5">@item.Timestamp</i>
</div>
<div class="flex-grow-1">
<div>
<i class="bx bx-notepad h5">
<i class="text-danger">Comment</i> - @item.Reason
</i>
</div>
<div>
<i class="bx bx-user h5">
<i class="text-danger">Assigned To</i> -
<a asp-controller="Employees" asp-action="Details" asp-route-id="@item.OwnerId">
@item.Owner
</a>
</i>
</div>
<div>
<i class="bx bx-analyse h5">
<i class="text-danger">Status</i> - @item.Status
</i>
</div>
</div>
</div>
</li>
}
</ul>
</div>
</div>
<!-- Action Buttons -->
<div>
<a asp-action="Index" class="btn btn-danger irby-red">Index List</a>
<a asp-action="Details" asp-route-id="@Model.AssetId" class="btn btn-success irby-blue">Details</a>
<a asp-action="Edit" asp-route-id="@Model.AssetId" class="btn btn-warning irby-orange">Update</a>
</div>
<!-- JS References -->
<script src="~/libs/bootstrap/js/bootstrap.bundle.min.js"></script>
<script src="~/libs/metismenu/metisMenu.min.js"></script>
<script src="~/libs/simplebar/simplebar.min.js"></script>
<script src="~/libs/node-waves/waves.min.js"></script>
🔧 6. Helper Methods & Utilities
@Html.DisplayFor(...)
Renders a display template for a model property (used in commented‐out table).asp-controller&asp-action
Tag‐helpers generating anchor links to other MVC actions..FirstOrDefault()
LINQ call to fetch the first history entry to display static dock details.
🌐 7. Third‑Party Integrations & Assets
| Library | File Path |
|---|---|
| Bootstrap 5 | ~/libs/bootstrap/js/bootstrap.bundle.min.js |
| MetisMenu | ~/libs/metismenu/metisMenu.min.js |
| SimpleBar | ~/libs/simplebar/simplebar.min.js |
| Node‑Waves | ~/libs/node-waves/waves.min.js |
| Boxicons | CSS class prefix bx for vector icons |
🧩 8. Sample Code Blocks
Activity List Loop
<ul class="verti-timeline list-unstyled">
@foreach (var item in Model.Histories) {
<li class="event-list">
<div class="event-timeline-dot">
<i class="bx bx-right-arrow-circle"></i>
</div>
<!-- Timestamp, Comments, Assignment, Status -->
<div class="d-flex"> … </div>
</li>
}
</ul>
Action Buttons
<a asp-action="Index" class="btn btn-danger irby-red">Index List</a>
<a asp-action="Details" asp-route-id="@Model.AssetId" class="btn btn-success irby-blue">Details</a>
<a asp-action="Edit" asp-route-id="@Model.AssetId" class="btn btn-warning irby-orange">Update</a>
🚀 9. Usage Examples
- Navigate to
/Docks/History/{assetId} - Controller populates
HistoryListViewModelwith:- Summary data (
DocksList) - Full list of
HistoryItemViewModel
- Summary data (
- View renders details card & timeline
- User clicks “Update” to change dock info or “Index List” to return to all docks
📈 10. UML Class Diagram
classDiagram
HistoryListViewModel --> DockSummaryViewModel : has
HistoryListViewModel --> HistoryItemViewModel : has*
HistoryItemViewModel o-- Dock : SomeAsset
class HistoryListViewModel {
+int AssetId
+DockSummaryViewModel DocksList
+List~HistoryItemViewModel~ Histories
}
class DockSummaryViewModel {
+string MakeAndModel
}
class HistoryItemViewModel {
+DateTime Timestamp
+string Owner
+int OwnerId
+string Status
+string Reason
+object SomeAsset
}
class Dock {
+int ModelId
+string SerialNumber
+DateTime PurchaseDate
+string Status
+string Notes
}
🎯 11. Conclusion
The History.cshtml Razor view delivers a clean, color‐coded interface for reviewing the lifecycle of a Dock asset in the IrbyImaging system. By leveraging ASP.NET MVC tag‑helpers, Bootstrap cards, and a vertical timeline, it allows users to:
- Quickly inspect asset details
- Trace activity & status changes over time
- Navigate seamlessly to related views (Index, Details, Edit)
This documentation should help front‑end and back‑end developers understand, maintain, and extend the dock history feature with clarity and confidence.
Happy coding! 🚀