Merge pull request #1480 from hotwax/cycle-count-v2

WIP Cycle count v2 migration

Author: dt2patel

documents/learn-hotwax-oms/business-processes/inventory-management.md

@@ -120,6 +120,6 @@ If a -5 variance is reported, inventory is decreased by 5 units
 
 This automated adjustment process helps maintain accurate system inventory and reduces the need for manual reconciliation.
 
-Learn more about [creating cycle count](/documents/retail-operations/inventory/cycle-count-legacy/draft-counts.md) and [performing cycle count](/documents/store-operations/inventory-count/directed-cycle-count.md).
+Learn more about [creating cycle count](/documents/retail-operations/inventory/cycle-count-legacy/draft-counts.md) and [performing cycle count](/documents/store-operations/cycle-count-legacy/directed-cycle-count.md).
 
 By following these practices and using HotWax Commerce's intuitive apps, retailers can maintain high levels of inventory accuracy and streamline their inventory management processes.

documents/retail-operations/SUMMARY.md

@@ -91,7 +91,12 @@
 * [Inventory Upload](inventory/inventory-upload/README.md)
   * [Schedule Restocking](inventory/inventory-upload/schedule-restock.md)
   * [Inventroy Import Method](inventory/inventory-upload/import-methods.md)
-* [Cycle Count](inventory/cycle-count-legacy/README.md)
+* [Cycle Count](inventory/cycle-count/README.md)
+  * [Assigned](inventory/cycle-count/assigned.md)
+  * [Pending Review](inventory/cycle-count/pending-review.md)
+  * [Closed](inventory/cycle-count/closed.md)
+  * [Bulk Upload](inventory/cycle-count/bulk-upload.md)
+* [Cycle Count Legacy](inventory/cycle-count-legacy/README.md)
   * [Draft Counts](inventory/cycle-count-legacy/draft-counts.md)
   * [Hard Counts](inventory/cycle-count-legacy/hard-count.md)
   * [View Assigned Counts](inventory/cycle-count-legacy/view-assigned-counts.md)

documents/retail-operations/inventory/cycle-count-legacy/draft-counts.md

@@ -29,7 +29,7 @@ A new Draft count will open up on a new page where you can begin setting up a ne
 4. **Assign a Facility**\
    Retailers must assign a cycle count facility to move a count from Draft to Assigned. Click `+ Assign` and select a facility from the modal.
 
-Once a count is ready to be assigned to a facility, click on the `send` button at the bottom right of the draft cycle count. The created draft will now appear in the assigned tab and on the [for the store team](https://docs.hotwax.co/documents/inventory/directed-cycle-count) of the `Cycle Count` App.
+Once a count is ready to be assigned to a facility, click on the `send` button at the bottom right of the draft cycle count. The created draft will now appear in the assigned tab and on the [for the store team](../../../store-operations/cycle-count-legacy/directed-cycle-count.md) of the `Cycle Count` App.
 
 {% embed url="https://youtu.be/C1Emwnm3P2I" %}
 

documents/retail-operations/inventory/cycle-count/README.md

@@ -0,0 +1,20 @@
+# Introduction
+
+The Cycle Count App is designed to help organizations maintain accurate inventory by tracking, verifying, and reconciling stock levels. It supports different types of counts, including Directed Cycle Counts for selected items, and Hard Counts for comprehensive facility-wide inventory verification.
+
+The app provides distinct views for Admins and Store Associates:
+
+* Admin View: Allows reviewing, approving, or rejecting counts, managing variance thresholds, and helping maintain inventory accuracy across the system.
+
+* [Store View](../../store-operations/inventory/cycle-count/README.md): Enables associates to perform counts, record quantities, and submit them for review.
+
+
+With built-in features like bulk actions, variance alerts, and timestamped tracking, the Cycle Count App keeps inventory accurate across your network.
+
+## Cycle count workflow
+
+1. [Plan your count with a preview](../../../store-operations/cycle-count/plan-cycle-count.md)
+2. [Create sessions and complete your count](../../../store-operations/cycle-count/start-complete-session.md)
+3. [Review counts at the store before submitting for review](../../../store-operations/cycle-count/count-progress-review.md)
+4. [Review and approve variances at head office](./pending-review.md)
+5. [Go back and review old counts and export](./closed.md)

documents/retail-operations/inventory/cycle-count/assigned.md

@@ -0,0 +1,133 @@
+# Assigned counts
+
+The assigned counts section allows you to monitor cycle counts that have been assigned to facilities and are currently pending completion. This view supports tracking progress, identifying delays, and managing workload across locations.
+
+Assigned counts remain in this stage until the responsible facility submits the count for review.
+
+## Required Permissions
+
+To access the `Assigned` view and manage assigned counts, users must have the following permission:
+
+* `COMMON_ADMIN`
+
+Without this permission, users will not be able to view or interact with assigned cycle counts.
+
+## Search, sort, and filter assigned counts
+
+The `Assigned` view includes search and filtering options:
+
+### Status filter
+
+Filter assigned counts by their current status:
+
+| Status | Description |
+| :---- | :---- |
+| `All` | Displays all assigned counts |
+| `Created` | Assigned but not yet started by the store |
+| `In progress` | Store has started counting but has not yet submitted |
+
+This helps quickly identify pending counts that require follow-up.
+
+### Type filter
+
+Filter counts based on type:
+
+| Type | Description |
+| :---- | :---- |
+| `All types` | Displays all assigned counts |
+| `Hard count` | Full inventory count |
+| `Directed count` | Targeted or partial inventory count |
+
+### Facility filter
+
+Narrow results to one or multiple facilities:
+
+* Search facilities by name.  
+* Select multiple locations.
+
+## Assigned counts list view
+
+Each count in the list provides the following information:
+
+* Count name  
+* Assigned facility  
+* Type  
+* Created date  
+* Due date  
+* Status (`Created` / `In progress`)
+
+
+This view provides a snapshot, allowing administrators to monitor the progress and deadlines across stores.
+
+## Assigned count detail page
+
+The assigned count detail page provides a view of a specific cycle count assigned to a store or facility.
+
+### Overview
+
+At the top of the page, you will find a summary of the assigned count. This section is divided into two areas: count details (left) and counting activity (right).
+
+#### Count details
+
+Clicking on a count displays the information provided during count creation:  
+* **Count name:** Name of the assigned count.  
+* **Assigned facility:** The store or location to which the count is assigned.  
+* **Start date:** The date and time when the count is scheduled to begin; update using the date picker.  
+* **Due date:** The target completion date for the count; update using the date picker.
+
+These fields define the timeline and location of the count and can be adjusted if scheduling changes occur.
+
+#### Counting activity
+
+This section shows system-generated timestamps reflecting real-time user activity at the assigned facility:
+
+* **First item counted:** Date and time when the first product in the assigned count was submitted.  
+* **Last item counted:** Most recent date and time a user entered or updated a count.
+
+These timestamps reflect actual system activity during product counting and help administrators assess whether the store has begun counting, whether work is ongoing or paused, and if follow-up is needed.
+
+### Product search
+
+A search bar is available directly below the overview section to quickly find specific items within the assigned count.
+
+* Enter any portion of a product name or code.  
+* Results instantly filter based on the entered text.  
+* This is helpful when reviewing large product lists.
+
+### Sorting items
+
+Use the `Sort by` dropdown to organize the product list:
+
+* **Alphabetic:** Sorts product names A to Z.  
+* **Variance:** Sorts products based on the variance recorded between counted and system quantities; sort ascending or descending to spot items needing review.
+
+### Counted item details
+
+The product list section displays all products included in the assigned count. For every product, the following information is shown:
+
+* Product image  
+* Product name  
+* Counted quantity (entered by the store user during the cycle count)  
+* System quantity (the quantity recorded in the system at the time of assignment)  
+* Variance (calculated difference between the counted quantity and the system quantity)
+
+This view allows reviewers to quickly identify how complete an item’s count is.
+
+### Viewing count session details
+
+To view the session details for an item, click the item in the list; the system opens the `Count session detail` panel for that specific item. The panel includes:
+
+* Session name  
+* User name (who performed the count)  
+* Quantity counted in that session  
+* Session start date and time  
+* Last updated date and time  
+  
+This detail helps track who counted the item and when it was recorded, providing traceability during cycle count audits.
+
+## Viewing additional product information
+
+Inside the `Count session detail` panel, select the `More options` icon. This displays:
+
+* Product information  
+* The last time the product was counted

documents/retail-operations/inventory/cycle-count/bulk-upload.md

@@ -0,0 +1,67 @@
+# Bulk upload
+
+The bulk upload feature makes it easy to create multiple cycle counts at once using a CSV file. Instead of entering products one by one, you can upload a formatted file, and the system will generate the corresponding cycle counts automatically. This is especially useful when working with large product lists.
+
+To begin, go to the `Cycle Count` app and select `Bulk upload`.
+
+On this page, you can:
+
+* Download a sample CSV template 
+* Use or create saved field mappings  
+* Upload new CSV files  
+* Review past uploads and track their status
+
+## Required permissions
+
+Access to the bulk upload feature requires the `COMMON_ADMIN` or `INV_COUNT_ADMIN` permission.
+
+## Steps to create a cycle count using bulk upload
+
+Before uploading, download a sample CSV to ensure the format and data align with required fields. Using the sample file helps prevent mapping errors during the upload process.
+
+1. Upload a CSV file
+
+* Click `Upload` and select a CSV file from your device.  
+* Once the file is uploaded, previously disabled controls on the screen become active.
+
+
+2. Map CSV fields
+
+After uploading your CSV, map each column to the correct system field so values like SKU, facility, or date are interpreted correctly. If unsure, check the table below to avoid errors and create your cycle count accurately.
+
+| Field name | Meaning | How to get the right value |
+| :---- | :---- | :---- |
+| `countImportName` | Unique name used to identify the cycle count and differentiate multiple uploads. | Use a meaningful naming format such as `Count-Jan-Store12` or `CycleCount-W1`. Avoid duplicates so tracking stays clean. |
+| `purposeType` | Type of cycle count being created. | Choose based on the count type: `HARD_COUNT` for a full physical count; `DIRECTED_COUNT` for a targeted or partial inventory count. |
+| `idType` | How the product will be identified in the system (for example, `SKU`, `UPCA`). | Check which identifier your system uses as the primary key. |
+| `idValue` | The product value based on the `idType` selected. | If you select `SKU` in `idType`, then `idValue` must contain product SKUs. |
+| `externalFacilityId` | External ID of the facility to which the count will be assigned. | Find this in the Facilities app under the external mappings section. |
+| `estimatedCompletionDate` | Due date by which the count should be completed. | Format: `MM-DD-YYYY`. |
+| `estimatedStartDate` | Date the cycle count is allowed to begin. | Format: `MM-DD-YYYY`. |
+
+3. Submit the upload
+
+     
+* After mapping successfully, click `Submit` to begin processing.
+
+## Recently uploaded counts
+
+Below the `Submit` button, you’ll find the recently uploaded counts section. This displays all bulk uploads along with their processing status.
+
+Each record includes:
+
+* Uploaded file name  
+* System-generated uploaded cycle count ID  
+* Status  
+* Action menu (three dots), where users can view details or cancel uploads still in `Pending` status
+
+### File status indicators
+
+| Status | Description |
+| ----- | ----- |
+| `Pending` | The file is currently being processed. |
+| `Processed` | The system successfully created the respective cycle counts. |
+| `Cancelled` | The upload was cancelled before completion. |
+| `Error` | The file encountered an error during import. Resolve it by reviewing the error description in the modal. |
+
+Once processing is complete, the cycle counts from the bulk upload appear under the `Assigned` tab in the Cycle Count app. Store teams can then begin execution.

documents/retail-operations/inventory/cycle-count/closed.md

@@ -0,0 +1,114 @@
+# Closed and completed cycle counts
+
+## Closed cycle counts page
+
+The `Closed` page in the Cycle Count app lets you review every cycle count that has been completed. On this page you can search for counts, apply filters to narrow results, export filtered data, and drill into the details of each closed count.
+
+## Required permissions
+
+* View closed counts, open details, and export: `COMMON_ADMIN`.
+
+## Navigating to the closed counts page
+
+1. Open the Cycle Count app. Use the navigation drawer on the left side of the screen.  
+     
+2. Select `Closed` from the menu. The Closed Counts view displays all cycle counts that have been completed (previously known as “cycle counts history”).  
+     
+3. The main pane shows a list of closed counts along with filters at the top. Each row corresponds to a completed cycle count and shows the count name, ID, facility, created date and closed date.
+
+## Understanding the closed counts list
+
+The list view is designed to help you quickly find and filter completed counts:
+
+* Search bar: Use the search box to find a cycle count by name or ID. When you enter text and press `Enter`, the list updates to show matching counts. You can clear the search using the `×` button in the field.  
+    
+* Facility filter: The Facility drop‑down shows `All` by default. Clicking the bubble opens a modal with a searchable list of facilities. You can select one or more facilities and confirm with the blue check button; the selected facility appears as a pill next to `Facility` and the list refreshes to show counts from that facility.  
+    
+* Type filter: The Type drop‑down lets you filter counts by type. Options include `All types`, `Hard count` and `Directed count`. Selecting a type updates the list; for example, choosing `Hard count` shows only hard counts.  
+    
+* More filters: Click `More filters` to open a modal with date‑range filters. You can specify `Created before/after` and `Closed before/after` dates using the calendar pickers, then click `Apply` to filter the list.  
+    
+* List columns: Each closed count row displays:  
+    
+* **Count name and ID:** e.g., CycleCountSample‑Nov4 (ID M1000204).  
+    
+* **Facility:** shown as a pill with the facility name.  
+    
+* **Created date:** date the count was created.  
+    
+* **Closed date:** date the count was completed.  
+    
+* **Type label:** for hard counts or directed counts, a small label (e.g., `HARD COUNT`) appears above the name.
+
+## Filtering and searching closed counts
+
+1. Search by name or ID: Click in the search bar, type the count name or part of the ID and press Enter. The list will narrow to items containing the search term.  
+     
+2. Filter by facility: Click the `All` bubble in the Facility filter. Use the search field in the facility modal to find a store, select its checkbox and click the blue check icon to apply the filter. The facility name appears as a pill.  
+     
+3. Filter by type: Click the current type (e.g., `All types`). Choose `Hard count` or `Directed count`. The list refreshes to show only counts of that type.  
+     
+4. Apply date filters: Choose `More filters`. In the modal, specify any combination of creation or closing dates and click `Apply`.  
+     
+5. Clear filters: To remove a facility or type filter, click the small `×` on the pill. Clear date filters by reopening `More filters` and clearing the date fields.
+
+## Exporting filtered cycle counts
+
+You can export the closed counts you are viewing (according to the current filters):
+
+1. Apply any filters you want so that only the desired counts are visible.  
+     
+2. Click the blue export button in the bottom right corner of the page. The button displays an arrow pointing down. A message appears saying “Requesting export…”.  
+     
+3. The application prepares an export file containing the filtered cycle counts. Depending on your configuration, the file downloads automatically or is delivered through your configured export service. You can continue using the app while the export is processed.
+
+## Viewing the details of a closed cycle count
+
+Click any row in the closed counts list to open the Closed count details view. This page lets you examine item‑level variance and compliance.
+
+### Header
+
+At the top of the details page you’ll see several cards summarizing the count:
+
+* Count card: Shows the cycle count name, ID and facility. It also displays the due date if one was set.  
+    
+* Time card: Shows the timestamp when the first item was counted and when the last item was counted.  
+    
+* Progress and completion card: Displays a progress bar with “x out of y items complete.” This indicates how many items have been reviewed and accepted.  
+    
+* Overall variance (filtered): Shows the total variance units based on the items currently displayed.
+
+
+Use the back arrow in the page header to return to the closed counts list.
+
+### Item list and filters
+
+Below the header, you’ll find filters to help locate specific products within the count:
+
+* Search product name: Enter all or part of a product’s name or SKU to filter the list.  
+    
+* Status filter: Choose from `All`, `Accepted` or `Rejected` to show products based on whether their counts were accepted or rejected during review.  
+    
+* Compliance filter: Options include `All`, `Acceptable`, `Rejectable` and `Configure threshold`. `Acceptable` shows items whose variances are within the compliance threshold; `Rejectable` shows items outside the threshold.  
+    
+* **Sort by:** Use this drop-down to sort products `Alphabetically` or by `Variance`.
+
+### Reviewing item‑level details
+
+* The item list shows each product counted during the cycle count along with an image, SKU, counted quantity vs system quantity, and calculated variance.  
+    
+* Clicking a product row expands it to reveal count sessions. Each session row displays the counter’s name (user), counted quantity, the time the counting started and when it was last updated. These details help you trace who counted the item and when.  
+    
+* If there are discrepancies (variance ≠ 0), you can use the Status and Compliance filters to isolate non‑compliant items for review and acceptance or rejection.
+
+## Tips for using Closed Counts
+
+* Combine filters for targeted exports. For example, set the Type to Hard Count and choose a facility before exporting; the exported file will include only hard counts from that store.  
+    
+* Use the More Filters date ranges to retrieve counts completed within a specific window.  
+    
+* Within the details view, sorting by Variance quickly surfaces products with the highest discrepancies, allowing you to prioritize review.  
+    
+* The Overall variance card updates dynamically based on applied item‑level filters, providing an at‑a‑glance summary of variance for the items you’re examining.
+
+By leveraging search, filters and exports, the Closed Counts page makes it straightforward to locate completed counts, review item‑level variances and compliance, and extract data for auditing or reporting.