📋 SearchWO.cshtml Documentation

Welcome to the comprehensive documentation for IrbyImaging/Views/JDE/SearchWO.cshtml. This Razor view is part of the IrbyImaging UI project and provides a powerful interface for searching and listing Work Orders using ASP.NET Core and Syncfusion EJ2 controls.


📑 Table of Contents

  1. 🎯 Overview & Purpose
  2. 🛠️ Dependencies & Technologies
  3. 🔑 View Model & Data Models
  4. 🔍 Search Form Section
  5. 🌳 Syncfusion TreeGrid Section
  6. ⚙️ JavaScript Functions & Events
  7. 🎨 Styles & Custom CSS
  8. 📦 Scripts & Initialization
  9. 🚀 Usage Examples
  10. 📈 UML Diagram
  11. ✅ Conclusion

🎯 Overview & Purpose

The SearchWO.cshtml view enables users to:

  • Filter Work Orders by various criteria (Type, Status, Number, Job, Name, Reference).
  • Display results in a hierarchical TreeGrid with sorting, filtering, paging, and export capabilities (Excel, CSV, PDF, Print).
  • Quick-search within the grid via a separate search box.

This view seamlessly integrates server-side ASP.NET Core form submission with client-side Syncfusion EJ2 components for a rich UI experience.


🛠️ Dependencies & Technologies

Category Details
Framework ASP.NET Core MVC (.cshtml Razor View)
UI Library Syncfusion EJ2: TreeGrid, Button
JavaScript Vanilla JS, jQuery, Select2, Syncfusion EJ2 scripts
CSS/Styling Bootstrap 5, Select2 CSS
Validation ASP.NET Core Tag Helpers (asp-action, AntiForgeryToken)
Data Source ViewBag.datasource (populated by controller as JSON)

🔑 View Model & Data Models

Model: IrbyImaging.UI.Models.WorkOrders

This ViewModel likely contains:

  • List<WorkOrder> Items
  • Search criteria properties (WorkOrderType, Status, WorkOrderNumber, JobNumber, Name, Reference)

Data Model: WorkOrder
Key fields bound to the TreeGrid:

Field Description
Name Work Order Name
WorkOrderNumber Unique WO identifier
WorkOrderType Category/type of WO
Job.JdeNumber Linked Job number (JDE)
Job.Name Linked Job name
Status Current WO status
Reference External reference
EstimatedHours Planned hrs for the WO
EstimatedAmount Budgeted amount
DateAssigned Assignment date
DateStart Start date
DateComplete Completion date

🔍 Search Form Section

<form asp-action="SearchWO" class="form-horizontal typeSearch" id="validation-form" method="post">
  @Html.AntiForgeryToken()
  @Html.ValidationSummary(true, "", new { @class = "text-danger" })
  <!-- search fields below -->
</form>

Search Filters:

Label Input Type Name Options / Placeholder
Work Order Type Select WorkOrderType Capital, Emergency, Project...
Status Select Status Open, Closed, Cancelled...
Work Order Number Text WorkOrderNumber “Enter WO Number”
Job Number Text JobNumber “Enter Job Number”
Name Text Name “Enter WO Name”
Reference Text Reference “Enter WO Reference”
  • ValidationSummary displays model validation errors.
  • AntiForgeryToken ensures CSRF protection.

🌳 Syncfusion TreeGrid Section

<ejs-treegrid id="TreeGrid"
    load="load"
    dataSource="ViewBag.datasource"
    childMapping="Children"
    allowSorting="true"
    allowFiltering="true"
    allowPaging="true"
    allowExcelExport="true"
    allowPdfExport="true"
    toolbar="@(new List<string>() { "ExcelExport", "CsvExport", "PdfExport", "Print" })"
    width="100%" height="100%">
  <!-- paging, filtering, columns config -->
</ejs-treegrid>

Key Configurations

  • childMapping="Children": Defines the hierarchical relation.
  • toolbar: Export & Print options.
  • allow*: Toggles for filtering, sorting, paging, reordering, wrapping, and exporting.
  • Columns:
Field Header Text Width Features
Name Name 150 filter, sort
WorkOrderNumber WO# 220 filter, sort
WorkOrderType Type 160 filter, sort
Job.JdeNumber Job# 220 filter, sort
Job.Name JobName (template) 220 link template, filter, sort
Status Status 200 filter, sort
Reference Reference 170 filter, sort
EstimatedHours Hours 200 filter, sort
EstimatedAmount Amount 150 filter, sort
DateAssigned Date Assigned 150 date format
DateStart Date Start 150 date format
DateComplete Date Complete 90 date format

⚙️ JavaScript Functions & Events

1. Column Date Format on Load

function load(args) {
  this.columns[9].format = { type: 'date', format: 'MM/dd/yyyy' };
  this.columns[10].format = { type: 'date', format: 'MM/dd/yyyy' };
  this.columns[11].format = { type: 'date', format: 'MM/dd/yyyy' };
}

– Formats the Date columns on the grid initialization.

2. Job Name Template

<script id="jobtemplate" type="text/x-template">
  <div class="image" id="edit">
    <a target="_blank" href="/Jobs/Details/${JobId}">${Job.Name}</a>
  </div>
</script>

– Renders the Job Name as a clickable link opening details in a new tab.

3. Quick-Search Handler

document.getElementById('Search').addEventListener('click', function () {
  var val = document.getElementById('searchText').value;
  var treegrid = document.getElementById('TreeGrid').ej2_instances[0];
  treegrid.search(val);
});

– Filters the TreeGrid rows based on the search box input.

4. Export Toolbar Click Handling

function toolbarClick(args) {
  var treeGridObj = document.getElementById("TreeGrid").ej2_instances[0];
  // Excel Export
  if (args.item.id.endsWith('_excelexport')) {
    treeGridObj.excelExport({ isCollapsedStatePersist: collapsedStatePersist });
  }
  // PDF Export
  else if (args.item.id.endsWith('_pdfexport')) {
    treeGridObj.pdfExport({ isCollapsedStatePersist: collapsedStatePersist });
  }
  // CSV Export
  else if (args.item.id.endsWith('_csvexport')) {
    treeGridObj.csvExport();
  }
}

– Persists collapsed state during exports.

5. Collapsed State Toggle

var collapsedStatePersist = true;
function onChange(args) {
  collapsedStatePersist = args.checked;
}

– Enables/disables keeping node collapse/expand state across exports.


🎨 Styles & Custom CSS

#property td div.e-checkbox-wrapper {
  padding-left: 0px !important;
  padding-top: 0px !important;
}

– Adjusts checkbox padding in property grids (if used elsewhere).


📦 Scripts & Initialization

<!-- Core JS -->
<script src="~/js/app.js"></script>
<script src="~/libs/jquery/jquery.min.js"></script>
<script src="~/libs/bootstrap/js/bootstrap.bundle.min.js"></script>
<script src="~/libs/simplebar/simplebar.min.js"></script>
<script src="~/libs/node-waves/waves.min.js"></script>
<!-- Additional Plugins -->
<script src="~/libs/bootstrap-datepicker/js/bootstrap-datepicker.min.js"></script>
<script src="~/libs/tinymce/tinymce.min.js"></script>
<script src="~/libs/jquery.repeater/jquery.repeater.min.js"></script>
<script src="~/js/pages/task-create.init.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/select2.min.js"></script>
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/select2.min.css" rel="stylesheet" />
<script>
  $(document).ready(function () {
    $('.js-example-basic-single').select2();
  });
</script>
  • Select2 initialization for any <select> elements with .js-example-basic-single.
  • _ValidationScriptsPartial: ASP.NET Core’s built-in client-side validation.

🚀 Usage Examples

  1. Search by Work Order Type & Status

    • Select “Corrective - Field” and “Work Order Open”
    • Click Search Work Orders
    • Results appear in TreeGrid.
  2. Quick-search within Grid

    • Type “Engine” in the search box (top-right of grid)
    • Click Search (Syncfusion Button)
    • TreeGrid filters all records containing “Engine” in any column.
  3. Export Results

    • Click Excel Export (toolbar)
    • Downloaded file reflects current filters & collapsed state.

📈 UML Diagram

flowchart TD
  A[User] -->|POST /SearchWO| Controller(SearchWO)
  Controller -->|ViewModel| SearchWO.cshtml
  SearchWO.cshtml -->|Renders Form| A
  SearchWO.cshtml -->|Renders TreeGrid| SyncGrid
  SyncGrid -->|Requests Data| ViewBag.datasource
  A -->|Interacts JS| SearchWO.cshtml
  SearchWO.cshtml -->|Exports| Excel/CSV/PDF

✅ Conclusion

The SearchWO.cshtml view provides a feature-rich interface for querying and displaying Work Orders in a hierarchical grid. Leveraging ASP.NET Core’s Razor engine, Syncfusion EJ2, and JavaScript, it delivers:

  • Powerful search and filter capabilities
  • Rich export options
  • Clean UI with Bootstrap & Select2

Feel free to extend the view by adding new columns, custom templates, or integrating additional Syncfusion features like row editing or context menus. Happy coding! 🚀