Skip to content

Commit 232a648

Browse files
committed
docs: Improve clarity and consistency in pending review documentation
1 parent 4358910 commit 232a648

File tree

1 file changed

+96
-113
lines changed

1 file changed

+96
-113
lines changed
Lines changed: 96 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -1,227 +1,210 @@
1-
# Pending Review
1+
# Pending review
22

33
## Pending review page
44

5-
This manual provides a step-by-step guide to understanding and using the Pending Review sections in the Cycle Count App, helping admins review all submitted counts before they are finalized and guiding them on how to navigate the page, interpret the information displayed, and perform review actions smoothly.
5+
Use the `Pending review` section in the Cycle Count app to review submitted counts before they are finalized. This page lists inventory counts completed by store associates that are waiting for admin review so you can check variances, validate accuracy, and take action.
66

7-
This manual provides a step-by-step guide to understanding and using the Pending Review sections in the Cycle Count App, helping admins review all submitted counts before they are finalized. It lists all inventory counts completed by store associates that are waiting for admin review. From here, admins can check variances, validate accuracy, and take necessary review actions.
7+
## Required permissions
88

9-
## Required Permissions
9+
* `COMMON_ADMIN`: Grants access to view pending cycle counts, review submitted counts, accept or reject items, and close counts.
1010

11-
To access and use the Pending Review page, users must have the following permission:
11+
### Search and filter counts
1212

13-
* `COMMON_ADMIN` - This permission grants access to view pending cycle counts, review submitted counts, accept or reject items, and close counts.
13+
#### Search
1414

15-
Without this permission, users will not be able to access the Pending Review section or perform any review actions.
15+
Use the search bar to find a specific count by name or ID.
1616

17-
### Search and Filter Counts
17+
#### Filter by type
1818

19-
1. Search
20-
21-
Admins can use the search bar to quickly find a specific count by entering the count name or ID.
19+
Filter pending counts by inventory count type:
2220

23-
2. Filter by Type
24-
25-
Admins can filter pending counts based on the type of inventory count. Types include:
26-
* Hard Count
27-
* Directed Count
28-
29-
3. Filter by Facility
30-
31-
This filter allows the admin to view counts submitted by a specific store or warehouse. For instance, selecting Brooklyn will display only the counts completed at that location.
32-
21+
* `Hard count`
22+
* `Directed count`
3323

34-
Both Filter by Type and Filter by Facility filters can be combined to refine the results further.
24+
#### Filter by facility
3525

36-
### Viewing Count Details
26+
Filter by store or warehouse to see counts submitted at a specific location (for example, Brooklyn). Combine facility and type filters to refine results further.
27+
28+
### Viewing count details
3729

3830
Each item in the list represents one cycle count and displays the following details:
3931

40-
* Count Type: Indicates the type of inventory count submitted by the store team.
41-
* Count Name: A user-assigned name that identifies the count.
42-
* Facility Name: Specifies the facility where the inventory count was performed.
43-
* Created Date: Shows when the count was initially created.
44-
* Due Date: Indicates the deadline for completing the count.
32+
* Count type: Indicates the type of inventory count submitted by the store team.
33+
* Count name: A user-assigned name that identifies the count.
34+
* Facility name: Specifies the facility where the inventory count was performed.
35+
* Created date: Shows when the count was initially created.
36+
* Due date: Indicates the deadline for completing the count.
4537

4638
For example:
4739

48-
A Hard Count named 03 December Count created on 3rd Dec 2025 at Brooklyn will appear as a row on this page.
40+
A `Hard count` named 03 December Count created on 3 Dec 2025 at Brooklyn appears as a row on this page.
4941

50-
Admins can click on any count card to open the detailed review screen.
42+
Admins can click any count card to open the detailed review screen.
5143

52-
## Review Count Page Overview
44+
## Review count page overview
5345

5446
This page is used by admins to review the inventory counts submitted by store associates. It highlights mismatches between the counted quantity and system inventory, giving the admin full control to approve or reject each item.
5547

56-
### Page Header Information
48+
### Page header information
5749

5850
At the top of the page, you will find key details about the count:
5951

60-
**Count Information**
52+
**Count information**
6153

62-
* Count Name – The name of the count (e.g., 26 December Count).
63-
* Facility Name: The facility where the inventory count was performed.
64-
* Start Date – When the store was supposed to start the count.
65-
* Due Date – The scheduled completion date.
66-
* First Item Counted – Timestamp of when counting began.
67-
* Last Item Counted – Timestamp of when the last item was counted.
54+
* Count name – The name of the count (for example, 26 December Count).
55+
* Facility name – The facility where the inventory count was performed.
56+
* Start date – When the store was supposed to start the count.
57+
* Due date – The scheduled completion date.
58+
* First item counted – Timestamp of when counting began.
59+
* Last item counted – Timestamp of when the last item was counted.
6860

69-
**Review Progress**
61+
**Review progress**
7062

7163
* Shows the percentage of items reviewed.
7264
* Displays how many items have been reviewed out of the total.
7365

74-
**Overall Variance (Filtered)**
66+
**Overall variance (filtered)**
7567

7668
This metric shows the total variance across all filtered items in the current count. Variance means the difference between what was physically counted and what the system expected.
7769

78-
**Example shown:**
70+
**Example:**
7971

8072
* 90 units of variance
8173
* Based on 10 results
8274

8375

8476
This means that out of the items currently displayed (based on filters applied), the combined difference between counted and system quantities is 90 units across 10 items.
8577

86-
### Search and Filters
78+
### Search and filters
8779

8880
The section provides search and filtering options to refine the list of items.
8981

90-
**Search Bar**
82+
**Search bar**
9183

9284
* Allows searching for products by name or SKU.
9385

86+
**Status filter**
87+
Filter items by review status:
9488

95-
Status Filter
96-
You can filter items based on review status:
97-
98-
* All
99-
* Open – Items that need review.
100-
* Accepted – Items approved.
101-
* Rejected – Items rejected.
89+
* `All`
90+
* `Open` – Items that need review.
91+
* `Accepted` – Items approved.
92+
* `Rejected` – Items rejected.
10293

103-
### Compliance Filter
94+
### Compliance filter
10495

105-
The Compliance Filter helps reviewers identify items that fall within or outside the acceptable variance thresholds during a cycle count.
96+
The compliance filter helps reviewers identify items that fall within or outside the acceptable variance thresholds during a cycle count.
10697

107-
**Filter Options**
98+
**Filter options**
10899

109-
* Acceptable – Shows items whose variance is within the defined threshold.
110-
* Rejectable – Shows items whose variance exceeds the threshold.
111-
* Configure Threshold – Allows admins to define the acceptable variance limit.
100+
* `Acceptable` – Shows items whose variance is within the defined threshold.
101+
* `Rejectable` – Shows items whose variance exceeds the threshold.
102+
* `Configure threshold` – Allows admins to define the acceptable variance limit.
112103

113104

114-
**Configure Threshold**
105+
**Configure threshold**
115106
Admins can configure how much variance is allowed before an item is flagged as out of compliance.
116107

117-
**Admin Options**
108+
**Admin options**
118109

119-
* Select Unit of Measurement – Choose the basis for calculating variance:
120-
121-
* Units: Compares the difference between counted and system quantities in absolute units
122-
* Percent: Calculates variance as a percentage difference between counted and system quantities
110+
* Select unit of measurement – Choose the basis for calculating variance:
111+
* Units: Compares the difference between counted and system quantities in absolute units.
112+
* Percent: Calculates variance as a percentage difference between counted and system quantities.
123113
* Cost: Flags variance based on the cost impact of the quantity difference.
124-
125-
* Enter Threshold Value – Example: 10 units, 5%, or a cost value depending on the selected unit.
126-
127-
* Save Threshold – Click the blue check button to apply the threshold settings.
114+
* Enter threshold value – Example: 10 units, 5%, or a cost value depending on the selected unit.
115+
* Save threshold – Click the blue check button to apply the threshold settings.
128116

129117

130-
**How it works (Example)**
118+
**How it works (example)**
131119

132120
If the threshold is set to **10 units**:
133121

134-
* A product with a variance of 8 is Acceptable
135-
* A product with a variance of 25 is Rejectable
122+
* A product with a variance of 8 is acceptable.
123+
* A product with a variance of 25 is rejectable.
136124

137125

138-
This allows admins to quickly focus on items with **major mismatches** instead of reviewing every minor deviation.
126+
This allows admins to quickly focus on items with major mismatches instead of reviewing every minor deviation.
139127

140-
**Sort By**
128+
**Sort by**
141129

142130
* Sort items alphabetically or by variance.
143131

144132

145-
**Item List Section**
133+
**Item list section**
146134

147-
The **Item List** displays all items included in a count event, along with their relevant details and actions for review.
135+
The item list displays all items included in a count event, along with their relevant details and actions for review.
148136

149-
**Item Row Details**
137+
**Item row details**
150138
Each item row contains the following information:
151139

152-
1. **Product Details**
140+
1. **Product details**
153141

154-
* Product Image – Visual representation of the product.
155-
* SKU and Name – SKU and the product name.
142+
* Product image – Visual representation of the product.
143+
* SKU and name – SKU and the product name.
156144

157-
2. **Count Information**
145+
2. **Count information**
158146

159-
* Counted Quantity / System Quantity – Shows the quantity counted versus the system-recorded quantity.
160-
161-
* Variance Value – The difference between the counted and system quantity.
147+
* `Counted quantity` / `System quantity` – Shows the quantity counted versus the system-recorded quantity.
148+
* `Variance` – The difference between the counted and system quantity.
162149

163150
3. **Actions**
164151

165-
* ACCEPT – Approve the counted quantity.
166-
* REJECT – Reject the count and send the item for recount.
152+
* `Accept` – Approve the counted quantity.
153+
* `Reject` – Reject the count and send the item for recount.
167154

168155
Note: Bulk actions can be applied when multiple items are selected using the checkboxes.
169156

170-
### Bulk Review Actions
157+
### Bulk review actions
171158

172159
At the top of the item list, you can perform bulk actions for all selected items:
173160

174-
* ACCEPT – Accepts the counted quantities of selected items.
175-
* REJECT – Rejects selected items and sends them for recount.
161+
* `Accept` – Accepts the counted quantities of selected items.
162+
* `Reject` – Rejects selected items and sends them for recount.
176163

177164
Clicking these buttons will apply the chosen action to all selected rows simultaneously.
178165

179-
### Additional Information (Expanded View)
166+
### Additional information (expanded view)
180167

181168
When you click on an item row, it expands to display additional details:
182169

183170
1. **Count details**
184171

185-
* Count Name – The name of the count.
186-
* Count Performed By – The user who performed the count.
187-
* Total Quantity Counted – The total counted quantity for the item.
172+
* Count name – The name of the count.
173+
* Count performed by – The user who performed the count.
174+
* Total quantity counted – The total counted quantity for the item.
188175
* Timestamps – Time when counting started and when it was last updated.
189176

190177
2. **More options**
191178

192-
* Last Counted – Displays the last counted quantity for the item.
193-
* Edit Count – Allows editing the counted quantity if adjustments are needed.
194-
* Remove Count – Removes the current count for the item.
179+
* Last counted – Displays the last counted quantity for the item.
180+
* Edit count – Allows editing the counted quantity if adjustments are needed.
181+
* Remove count – Removes the current count for the item.
195182

196183

197-
Items that have already been reviewed and accepted display an “APPLIED” status, indicating that the final counted quantity has been successfully submitted to the system.
184+
Items that have already been reviewed and accepted display an `Applied` status, indicating that the final counted quantity has been submitted to the system.
198185

199-
### Closing the Review
186+
### Closing the review
200187

201-
Once the admin has finished reviewing all items in the count, they can use the Close Count button to finalize the cycle count. Closing a count means that the admin has reviewed all variances and is ready to complete the process.
188+
Once the admin has finished reviewing all items in the count, they can use the `Close count` button to finalize the cycle count. Closing a count means the admin has reviewed all variances and is ready to complete the process.
202189

203-
When the admin clicks the Close button, the system opens a confirmation modal with two options:
190+
When the admin clicks `Close count`, the system opens a confirmation modal with two options:
204191

205-
Options Available While Closing a Count
192+
**Options when closing a count**
206193

207194
1. Accept all outstanding variances and close
208-
209-
* This option automatically accepts all remaining items that were not manually accepted or rejected.
210-
* Useful when the admin is confident that the remaining variances are correct.
211-
* Example: If 3 items are still open and the admin wants to approve them all at once, selecting this option completes the review quickly.
212-
195+
* Automatically accepts all remaining items that were not manually accepted or rejected.
196+
* Useful when the admin is confident the remaining variances are correct.
197+
* Example: If three items are still open and the admin wants to approve them at once, selecting this option completes the review quickly.
213198

214199
2. Reject all outstanding variances and close
215-
216-
* This option automatically rejects all remaining open variances.
217-
* Useful when the admin wants those items to be recounted or corrected later.
218-
* Example: If several items show unusual variances, the admin can reject all of them in one action.
219-
200+
* Automatically rejects all remaining open variances.
201+
* Useful when the admin wants those items to be recounted or corrected later.
202+
* Example: If several items show unusual variances, the admin can reject all of them in one action.
220203

221204
Closing the cycle count ensures that the cycle count lifecycle is completed and that the inventory updates are accurately reflected in the system.
222205

223-
**After Closing the Count**
206+
**After closing the count**
224207

225-
* The count moves from the Pending Review section to the Closed section.
226-
* This means the review is fully completed and no further changes can be made.
227-
* The system will now post adjustments based on the accepted items.
208+
* The count moves from the `Pending review` section to the `Closed` section.
209+
* The review is fully completed and no further changes can be made.
210+
* The system posts adjustments based on the accepted items.

0 commit comments

Comments
 (0)