📄 BulkUpload.cshtml Documentation
File Path: IrbyImaging/Views/Imaging/BulkUpload.cshtml
Purpose: A Razor view for bulk uploading documents (with metadata) to the Imaging module using Dropzone.js, Bootstrap, jQuery and other UI libraries.
🚀 Table of Contents
- Overview & Purpose
- Key Functional Areas
- Dependencies & Technologies
- Model & ViewModel Binding
- Markup Structure
- Scripts & Styles Sections
- Dropzone Initialization & Events
- API Endpoints Overview
- Sequence Diagram (UML)
- Usage Example
- Conclusion
1. Overview & Purpose
This Razor view renders a Bulk Upload interface that allows users to:
- Enter a document description (
DocumentNotes). - Select a document type (
DocumentType) from a predefined list. - Drag & drop or click-to-upload multiple files.
- Submit documents & metadata as a batch.
It leverages Dropzone.js for a seamless drag‑and‑drop experience, along with Bootstrap components and jQuery plugins for date pickers, rich text, and dynamic form repeaters.
2. Key Functional Areas
| Area | Description |
|---|---|
| Model Binding | Binds to IrbyImaging.Models.DocumentImaging for metadata fields. |
| Layout & Title | Uses the shared layout (_Layout.cshtml) and sets the page title. |
| Styles Section | Includes CSS for datepicker & dropzone. |
| Dynamic Form (Repeater) | Prepares a repeater for multiple document items (commented out / structure placeholder). |
| Dropzone Container | A <div class="dropzone"> that handles file selection & preview. |
| Submit Button | A button (#uploadfile) that triggers the Dropzone upload queue. |
| Scripts Section | Loads all necessary JS libraries & initializes Dropzone with event hooks. |
3. Dependencies & Technologies
| Library / Framework | Purpose | Source Path / CDN |
|---|---|---|
| ASP.NET Core Razor | View engine | Built‑in |
| jQuery | DOM manipulation | ~/libs/jquery/jquery.min.js |
| Bootstrap | UI Components & layout | ~/libs/bootstrap/js/bootstrap.bundle.min.js |
| Dropzone.js | Drag & Drop file upload | https://cdnjs.cloudflare.com/ajax/libs/dropzone/5.5.1/dropzone.js |
| Bootstrap Datepicker | Date selection UI | ~/libs/bootstrap-datepicker/js/bootstrap-datepicker.min.js |
| TinyMCE | Rich text editor (initialized elsewhere) | ~/libs/tinymce/tinymce.min.js |
| jquery.repeater | Dynamic form lists | ~/libs/jquery.repeater/jquery.repeater.min.js |
| MetisMenu, Simplebar, Waves | Sidebar & UI utilities | ~/libs/metismenu, ~/libs/simplebar, ~/libs/node-waves |
| Custom Scripts | App‑specific logic | ~/js/app.js, ~/js/pages/task-create.init.js |
4. Model & ViewModel Binding
@model IrbyImaging.Models.DocumentImaging
...
@{ var doc = string.Empty; doc = ViewBag.Doc; }
- Model:
DocumentImagingcontains properties:DocumentNotes(string)DocumentType(string)- Possibly other fields (e.g.,
Id,CreatedDate, etc.)
- ViewBag.Doc: An optional string passed from controller to pre‑populate or display referenced document info.
5. Markup Structure
<div class="row">
<div class="col-lg-12">
<div class="card">
<div class="card-body">
<h4 class="card-title mb-4">Upload Document</h4>
<!-- Document Description -->
<div class="row mb-4">
<label class="col-form-label col-lg-2">Document Description</label>
<div class="col-lg-10">
<textarea name="DocumentNotes"
asp-for="DocumentNotes"
class="form-control"
rows="3"
placeholder="Enter description..."></textarea>
</div>
</div>
<!-- Document Type Dropdown -->
<div class="mb-3 row">
<label class="col-md-2 col-form-label">Select Document Type</label>
<div class="col-md-10">
<select name="DocumentType" asp-for="DocumentType" class="form-select">
<option>Select Type</option>
<!-- ...many <option> items... -->
</select>
</div>
</div>
<!-- Dropzone Upload Area -->
<div class="row mb-4">
<label class="col-form-label col-lg-2">Attach Documents</label>
<div class="col-lg-10">
<div class="dropzone" name="mainFileUploader">
<div class="fallback">
<input name="file" type="file" multiple />
</div>
<div class="dz-message needsclick">
<div class="mb-3">
<i class="display-4 text-muted bx bxs-cloud-upload"></i>
</div>
<h4>Drop files here or click to upload.</h4>
</div>
</div>
</div>
</div>
<!-- Submit Button -->
<div class="row justify-content-end">
<div class="col-lg-10">
<button type="submit" id="uploadfile" class="btn btn-primary">Submit</button>
</div>
</div>
</div>
</div>
</div>
</div>
6. Scripts & Styles Sections
Styles
@section styles{
<link href="~/libs/bootstrap-datepicker/css/bootstrap-datepicker.min.css" rel="stylesheet">
<link href="~/libs/dropzone/min/dropzone.min.css" rel="stylesheet" />
}
Scripts
@section scripts{
<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/metismenu/metisMenu.min.js"></script>
<script src="~/libs/simplebar/simplebar.min.js"></script>
<script src="~/libs/node-waves/waves.min.js"></script>
<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="https://cdnjs.cloudflare.com/ajax/libs/dropzone/5.5.1/dropzone.js"></script>
<script src="~/js/pages/task-create.init.js"></script>
7. Dropzone Initialization & Events
<script type="text/javascript">
Dropzone.autoDiscover = false;
window.onload = function () {
var myDropzone = new Dropzone(".dropzone", {
url: "/Imaging/Upload",
autoProcessQueue: false,
addRemoveLinks: true,
uploadMultiple: true,
parallelUploads: 25,
maxFiles: 25
});
// Trigger upload on button click
$('#uploadfile').click(function () {
myDropzone.processQueue();
});
// Append metadata to payload
myDropzone.on("sending", function (file, xhr, formData) {
formData.append("DocumentNotes", $("#DocumentNotes").val());
formData.append("DocumentType", $("#DocumentType").val());
formData.append("Files", file);
});
// Clean up after all uploads
myDropzone.on("queuecomplete", function () {
myDropzone.removeAllFiles(true);
});
// On each file complete, redirect to SaveDocument
myDropzone.on("complete", function (file) {
myDropzone.removeAllFiles(true);
window.location.href = '@Url.Action("SaveDocument","Imaging")?fileName=' + file.name;
});
};
</script>
Key Points:
autoProcessQueue: falselets us bundle metadata before starting.processQueue()is manually invoked on submit.- Events:
- sending: Append extra form data.
- queuecomplete: Reset the dropzone UI.
- complete: Redirect to
SaveDocumentwith query param.
8. API Endpoints Overview
| Endpoint | HTTP Verb | Description |
|---|---|---|
/Imaging/Upload |
POST | Receives files + metadata. Saves them in backend. |
/Imaging/SaveDocument?fileName=... |
GET | Finalizes or shows confirmation for the saved file. |
9. Sequence Diagram (UML)
sequenceDiagram
participant U as User
participant V as BulkUpload View
participant DZ as Dropzone.js
participant C as ImagingController
participant DB as Database/Storage
U->>V: Navigate to /Imaging/BulkUpload
V-->>U: Renders form & Dropzone area
U->>DZ: Drop files, fill notes & type
U->>V: Click "Submit"
V->>DZ: processQueue()
DZ->>C: POST /Imaging/Upload (files + metadata)
C->>DB: Save files & meta
DB-->>C: Success
C-->>DZ: HTTP 200
DZ->>U: On complete -> redirect to SaveDocument
U->>C: GET /Imaging/SaveDocument?fileName=...
C-->>U: Confirmation / details
10. Usage Example
-
Controller Action
public IActionResult BulkUpload() { ViewBag.Doc = "Optional pre-loaded doc"; return View(); } [HttpPost] public async Task<IActionResult> Upload(List<IFormFile> Files, string DocumentNotes, string DocumentType) { // Save files and metadata // ... return Ok(new { Message = "Uploaded" }); } public IActionResult SaveDocument(string fileName) { // Display success / next steps return View("Success", model: fileName); } -
Navigate to
/Imaging/BulkUploadin your browser. -
Fill in the Document Description & Select Type.
-
Drag & drop or click to add up to 25 files.
-
Click Submit → your files & metadata are posted to
/Imaging/Upload. -
Upon completion → you are redirected to
/Imaging/SaveDocument.
11. Conclusion
This BulkUpload.cshtml view provides a rich, user‑friendly interface for batch uploading documents with metadata. By combining ASP.NET Core Razor, Dropzone.js, Bootstrap, and various jQuery plugins, it ensures:
- Ease of use: drag & drop + fallback for older browsers.
- Flexibility: handle multiple file uploads in parallel.
- Extensibility: easily add more metadata fields or validations.
Happy Uploading! 🎉
End of Documentation