🚢 IrbyImaging/Views/Docks/Index.cshtml Documentation

Welcome to the detailed documentation for the Index.cshtml view in the IrbyImaging project. This page renders the Dock List, provides search/filter capabilities, and integrates with DataTables for rich table functionality.


📑 Table of Contents

  1. Overview & Purpose
  2. Model & ViewModel
  3. Dependencies & Technologies
  4. Layout & Page Metadata
  5. User Interface Components
  6. Action Links (CRUD & History)
  7. Scripts & Plugins
  8. UML Diagram
  9. Usage Examples
  10. Conclusion

🔍 Overview & Purpose

This Razor View (Index.cshtml) displays a list of Docks in a paginated, exportable table.
Key features:

  • Dynamic count of total docks by status.
  • Search by keyword.
  • Filter by dock Status (an AssetStatus enum).
  • Export table data to CSV, Excel or Print via DataTables buttons.
  • Action links for Details, Update and History.

📦 Model & ViewModel

@model DockListViewModel

DockListViewModel (inferred):

Property Type Description
Docks IEnumerable Collection of dock items to display.
Status AssetStatus Currently selected status filter (enum).

DockViewModel (inferred properties):

  • MakeAndModel : string
  • SerialNumber : string
  • OwnerId : Guid (links to Employee)
  • OwnerFullName : string
  • PurchaseDate : DateTime
  • Status : AssetStatus
  • Id : Guid

🔧 Dependencies & Technologies

Category Libraries / Frameworks
ASP.NET Core MVC Razor Views, Tag Helpers
Styling & Layout Bootstrap 4, DataTables CSS
JavaScript Plugins jQuery, DataTables, DataTables Buttons
Icons Font Awesome
Project Utilities IrbyImaging.Utility.AssetStatus

🎨 Layout & Page Metadata

@{
    ViewData["Title"] = "Dock List";
    Layout = "~/Views/Shared/_ATSLayout.cshtml";
}
  • Title: Renders “Dock List” in <title> tag.
  • Layout: Inherits from the shared _ATSLayout.cshtml.

🖥️ User Interface Components

1. Header & Title

<h2>
  @Html.DisplayFor(m => m.Status) Docks 
  <span style="color:blue">@Model.Docks.Count()</span>
</h2>
  • Displays the current filter status (e.g., “Active Docks”) and the total count.

2. “Add New Dock” Button

<a asp-action="Create" class="btn btn-success irby-green">
  ➕ Add New Dock
</a>
  • Navigates to DocksController.Create to add a new dock.

3. Search & Filter Form

<form asp-action="Index" method="get">
  <div class="input-group">
    <input type="text" name="search" class="form-control" placeholder="Search for..." />
    <div class="col-lg-4" style="float:right;">
      @Html.DropDownListFor(m => m.Status, 
          Html.GetEnumSelectList<AssetStatus>(), 
          new { @class = "form-control dropdown" })
    </div>
    <span class="input-group-addon">
      <button type="submit" class="btn btn-primary irby-blue">
        <i class="fa fa-search"></i> Search
      </button>
    </span>
  </div>
</form>
  • Search Box: Free-text search.
  • Status Dropdown: Filters by AssetStatus.
  • Submit Button: Triggers GET /Docks/Index?search=…&Status=….

4. Data Table

<table id="docksDatatable" class="table table-striped table-bordered dt-responsive nowrap">
  <thead>
    <tr>
      <th>Make/Model</th>
      <th>Serial Number</th>
      <th>Assigned To</th>
      <th>Purchase Date</th>
      <th>Status</th>
      <th>Details</th>
      <th>Update</th>
      <th>History</th>
    </tr>
  </thead>
  <tbody>
    @foreach(var item in Model.Docks) {
      <tr>
        <td>@item.MakeAndModel</td>
        <td>@item.SerialNumber</td>
        <td>
          <a asp-controller="Employees" asp-action="Details" asp-route-id="@item.OwnerId">
            @item.OwnerFullName
          </a>
        </td>
        <td>@item.PurchaseDate.ToShortDateString()</td>
        <td>@item.Status</td>
        <td>
          <a href="@Url.Action("Details","Docks",new { id=item.Id })" 
             class="btn-sm btn-info">
            Details <img src="~/details.png" width="20" />
          </a>
        </td>
        <td>
          <a href="@Url.Action("Edit","Docks",new { id=item.Id })" 
             class="btn-sm btn-warning">
            Update <img src="~/update.png" width="23" />
          </a>
        </td>
        <td>
          <a href="@Url.Action("History","Docks",new { id=item.Id })" 
             class="btn-sm btn-primary">
            History <img src="~/history.png" width="23" />
          </a>
        </td>
      </tr>
    }
  </tbody>
</table>

Table Columns:

Column Description
Make/Model Dock manufacturer and model
Serial Number Unique serial identifier
Assigned To Employee name with link to Employee 🧑‍💼
Purchase Date Date the dock was purchased
Status Current AssetStatus
Details/Update/History Action buttons for record navigation

⚙️ Scripts & Plugins

@section Scripts {
  <!-- jQuery & DataTables JS -->
  <script src="https://code.jquery.com/jquery-3.5.1.js"></script>
  <script src="https://cdn.datatables.net/1.10.25/js/jquery.dataTables.min.js"></script>
  <script src="https://cdn.datatables.net/buttons/1.7.1/js/dataTables.buttons.min.js"></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/jszip/3.1.3/jszip.min.js"></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/pdfmake/0.1.53/pdfmake.min.js"></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/pdfmake/0.1.53/vfs_fonts.js"></script>
  <script src="https://cdn.datatables.net/buttons/1.7.1/js/buttons.html5.min.js"></script>
  <script src="https://cdn.datatables.net/buttons/1.7.1/js/buttons.print.min.js"></script>

  <!-- Bootstrap & Helpers -->
  <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>

  <script type="text/javascript">
    $(document).ready(function () {
      $('#docksDatatable').DataTable({
        dom: 'Bfrtip',
        buttons: ['csv', 'excel', 'print']
      });
    });
  </script>
}
  • DataTables: Enables sorting, paging, and button-driven export.
  • Buttons: CSV, Excel, Print.
  • Bootstrap Bundle: UI utilities.

💠 UML Diagram

classDiagram
    class DockListViewModel {
      +IEnumerable~DockViewModel~ Docks
      +AssetStatus Status
    }
    class DockViewModel {
      +string MakeAndModel
      +string SerialNumber
      +Guid OwnerId
      +string OwnerFullName
      +DateTime PurchaseDate
      +AssetStatus Status
      +Guid Id
    }
    DockListViewModel "1" o-- "*" DockViewModel

🛠️ Usage Examples

  1. Rendering the View

    public IActionResult Index(string search, AssetStatus? Status)
    {
        var docks = _dockService.GetAll(search, Status);
        var vm = new DockListViewModel {
            Docks = docks,
            Status = Status ?? AssetStatus.All
        };
        return View(vm);
    }
    
  2. Filtering by Status

    • Select Active from the dropdown and click Search → reloads with only active docks.
  3. Exporting Data

    • Click Excel in the table toolbar → downloads .xlsx of current table view.

🏁 Conclusion

The Index.cshtml for Docks provides a robust, interactive interface to:

  • List, Search, and Filter dock assets
  • Navigate to detail, edit, and history pages
  • Export your data in various formats

By leveraging DataTables, Bootstrap, and ASP.NET Core MVC, it delivers a smooth user experience with minimal custom code. 🎉