kyle/threadcount-community
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ThreadCount Community edition

Browse Source 
Uniform stock management for healthcare linen rooms: the coordinator app, the phone counter and the staff app, for your own server. Built from 2d04e45 on 2026-09-15. Licensed under the Functional Source License (FSL-1.1-ALv2).
This commit is contained in:
ThreadCount
2026-09-16 04:04:31 +10:00
commit 8c86c988c1
424 changed files with 53598 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/manual/reference/csv-templates.md
+119
View File
@@ -0,0 +1,119 @@
---
title: CSV templates
section: reference
order: 1
summary: The six import files, the columns each one reads, how a row is matched to a record, and what every importer message means.
screen: Settings › Data & audit log
role: Admin
keywords: csv, import, template, import the register, data and audit log, spreadsheet, columns, headers, upload, catalogue, staff register, departments, barcodes, reorder levels, opening balances, bulk load
---
## Load order and the basics
Under `Settings › Data & audit log`, in `Import from CSV`, an Admin picks a file kind, presses `Download template` for `threadcount-<kind>-template.csv` (header row plus one example row), fills it in, saves it as CSV and presses `Import CSV`. `Import the register` on `People` opens the same place with the staff register already chosen.
Load in this order, because later files look up what earlier ones created:
1. **Departments & cost centres** (`depts`)
2. **Catalogue** (`catalog`)
3. **Staff register** (`staff`)
4. **Supplier barcodes** (`barcodes`)
5. **Opening balances** (`opening`)
6. **Reorder levels** (`reorder`)
For every file:
- Headers are matched ignoring case, spaces and punctuation, so `Staff no.` reads as `staffno`. Unknown columns are ignored.
- Cells are trimmed and cut at 400 characters. Blank lines are skipped.
- The apostrophe ThreadCount's exports put before `=`, `+`, `-`, `@` or a space is removed, so an exported file imports back unchanged.
- On a re-import a blank cell keeps what the record holds. An import cannot clear a field.
## Departments and catalogue
**Departments & cost centres.** Matched by exact name. The row order becomes the list's order.
| Column | Required | Rule | Example |
|---|---|---|---|
| `dept` | Yes | Also `department`, `name`, `ward`. | `Harbour Ward` |
| `cc` | No | Also `costcentre`, `costcenter`, `code`. Blank keeps the existing one. | `RGH-4010` |
**Catalogue.** Updates the garment with the same `item` and gender, and the same `sku` when given; otherwise creates one.
| Column | Required | Rule | Example |
|---|---|---|---|
| `item` | Yes | Also `name`, `itemname`, `garment`. | `Scrub Top` |
| `gender` | No | Starts `m`: men's. Starts `f` or `w`: women's. Anything else or blank: Unisex. | `Women's` |
| `sku` | No | Also `code`, `productcode`. | `NW-ST-220` |
| `supplier` | No | Also `vendor`. A new name is added to the supplier directory; a known one, in any case, takes the directory's spelling. | `Northline Workwear` |
| `cost` | No | Also `unitcost`, `price`. Non-digits dropped. Blank or 0 keeps the existing cost. | `31.50` |
| `group` | No | Also `staffgroup`. Several separated by a pipe; `All` is every group. Blank: All when new, unchanged on update. | `Midwife` |
| `sizes` | New garments | Also `size`. Separated by a pipe, `,`, `;` or `/`. An update adds new sizes and removes none. | `S/M/L/XL` |
| `notes` | No | Also `note`. | `Navy` |
| `type` | No | Not in the template. Also `producttype`, `garmenttype`. Decides top, trousers or neither. | `Scrub top` |
## Staff register
Updates the person with the same staff number, or creates one. Managers are linked after every row is written, so a manager can sit anywhere in the file. A row without a staff number or first name is skipped.
| Column | Required | Rule | Example |
|---|---|---|---|
| `num` | Yes | Also `staffnumber`, `staffno`, `number`, `payroll`, `payrollnumber`, `id`. | `00400127` |
| `first` | Yes | Also `firstname`, `given`. A `name` or `fullname` column is split at the first space if first and last are blank. | `Amira` |
| `last` | No | Also `lastname`, `surname`, `family`. | `Hassan` |
| `phone` | No | Also `mobile`, `contact`. | `0400 000 000` |
| `group` | No | Also `staffgroup`, `classification`. Not checked against `Settings › Issuing rules`. | `Registered Nurse` |
| `dept` | No | Also `department`, `ward`, `wardunit`. | `Harbour Ward` |
| `cc` | No | Also `costcentre`, `costcenter`, `departmentcostcentre`. With `dept`, creates a missing department. Never changes an existing one. | `RGH-4010` |
| `manager` | No | Also `managernum`, `managernumber`, `approver`, `reportsto`. A staff number, not a name. | `00400019` |
| `fte` | No | Also `combinedfte`, `totalcombinedfte`, `totalfte`, `employmentfraction`, `fraction`. Above 0, or `Casual`. | `0.8` |
| `style` | No | Also `uniformstyle`, `uniform`, `cut`, `gender`. `m`, `male`, `men's`: Men's. `f`, `w`, `female`, `women's`, `ladies`: Women's. `either`, `both`, `any`, `all`, `unisex`: Either. | `Women's` |
| `top` | No | Also `topsize`, `shirt`, `shirtsize`. | `M` |
| `pants` | No | Also `pantsize`, `pant`, `trouser`. | `12` |
| `ccoverride` | No | Also `costcentreoverride`. | `RGH-4090` |
| `ent` | No | Also `entitlement`, `annualentitlement`. Whole number for the yearly report; limits nothing. | `10` |
| `start` | No | Also `startdate`, `commenced`. `YYYY-MM-DD`, or day first as `11/03/2024`. | `2026-02-02` |
| `notes` | No | Also `note`. | `Night shift` |
`Export CSV` on `People` writes headers that read back onto these columns. See [the staff register](/docs/people/staff-register) and [managers](/docs/people/managers).
## Barcodes, opening balances, reorder levels
Each row must match exactly one garment on whichever of `sku` (also `code`, `productcode`), `item` (also `name`, `itemname`, `garment`) and `gender` it fills in, then a `size` spelt as on the garment. Blank `gender` matches any. A header named `code` is read as the SKU.
| File | Column | Rule | Example |
|---|---|---|---|
| Supplier barcodes | `barcode` | Also `ean`, `code128`, `scan`. Blank skips the row. | `9300000000017` |
| Opening balances | `opening` | Also `qty`, `quantity`, `onhand`, `count`. Overwrites; blank leaves the size alone. | `14` |
| Opening balances | `reorder` | Optional. Also `reorderat`, `reorderlevel`. Not a number: sets 0. | `4` |
| Reorder levels | `reorder` | Also `reorderat`, `reorderlevel`, `level`. Overwrites; not a whole number skips the row. | `4` |
Negative figures are stored as 0. Every row these files write counts as created. See [barcodes](/docs/stock/barcodes) and [reorder levels](/docs/stock/reorder-levels).
## Messages and what to do
The result reads like `Catalogue: 12 created, 3 updated, 1 skipped.`, then up to 40 row messages. `Row 1` is the first row under the header, blank lines not counted; the two whole-file refusals give the file's line number.
| Message | Meaning | Fix |
|---|---|---|
| `Line N: a quote is opened and never closed…` | Nothing imported. | Fix the quote. |
| `Lines N: the wrong number of columns…` | Nothing imported; usually a stray `"`. | Fix those lines. |
| `No rows found — check the header row.` | Nothing under the header. | Save the right sheet. |
| `Row N: X has no sizes` | New garment skipped. | Add `sizes`. |
| `Row N: start date “X” isn't a date…` | Stored blank. | Write `YYYY-MM-DD`. |
| `Row N: FTE “X” isn't a fraction…` | Stored blank. | Write `0.75` or `Casual`. |
| `Row N: uniform style “X” isn't…` | Stored blank. | Use Men's, Women's or Either. |
| `Row N: no staff member with number X to be the manager` | Not linked. | Add or fix the manager's row. |
| `The register is full for this plan — 60 staff records…` | Said once; further new people skipped, updates applied. | See [plan and billing](/docs/account/plan-and-billing). |
| `Row N: no catalogue items match…` or `several…` | Skipped. | Fill in `item` or `gender`. |
| `Row N: size X not on Y` | Skipped. | Match the size's spelling. |
| `Row N: opening “X” isn't a number…` | Size left alone. | Write a whole number. |
| `X is already on Y · size Z…` | Code bound to another size, as a one-code-per-style list does. | One code per size. |
| `X is the generated code for Y…` | Refused. | Use the printed label's code. |
## Limits
- 20,000 rows a file: `Import at most 20,000 rows at a time`.
- 20 imports and backup restores together per person in 10 minutes: `Too many imports — wait a few minutes.`
- Over 60 MB: `Request too large`.
- An Issuer gets `Admin only`. A read-only facility gets the read-only message pointing to `Settings › Plan`.
- Hosted Small holds 60 staff records (`PRICES.freeStaff`). Other plans and the Community edition have no ceiling.
docs/manual/reference/glossary.md
+116
View File
@@ -0,0 +1,116 @@
---
title: Glossary
section: reference
order: 2
summary: The words ThreadCount's screens use, in alphabetical order, each with a line of meaning and the page that explains it.
role: Anyone
keywords: glossary, terms, definitions, words, meaning, vocabulary, what does it mean, audit log, to order, override
---
## A–C
**Admin** — The [coordinator role](/docs/start/the-two-roles) that manages settings, the register, the catalogue, prices and suppliers.
**Audit log** — Every change in the facility, newest first, with who made it, under `Settings › Data & audit log`. Only an Admin can read it. See [export and backup](/docs/account/export-and-backup).
**Back Order** — An order status for stock the supplier has not yet sent. See [receiving](/docs/stock/receiving-and-back-orders).
**Barcode** — The code bound to one size of one garment, so a scan finds that size. See [barcodes](/docs/stock/barcodes).
**Casual** — The FTE for someone with no fixed fraction. See [groups and routes](/docs/people/groups-and-routes).
**Catalogue** — The garments stocked, each with [sizes, SKU, supplier, cost, type and groups](/docs/stock/catalogue-sizes-and-cuts).
**Ceiling** — The most sets anyone may hold at once, 6 unless changed at `Most anyone holds` under `Settings › Issuing rules`, the same for every group. See [the entitlement rule](/docs/people/entitlement-rule).
**Collection code** — The 4-digit code on a request's bag waiting at the counter. See [requests from staff](/docs/counter/requests-from-staff).
**Cost centre** — The finance code a department's issues are [charged to](/docs/reports/cost-centres).
**Cost centre override** — A [cost centre](/docs/reports/cost-centres) on one person's record, used instead of their department's.
## D–G
**Damage report** — A garment reported damaged, listed under `Requests › Damage` until it is [handed in](/docs/counter/exchanges-and-returns).
**Delivery round** — Bags taken to wards and signed for on screen, from `Deliver on the round` on `Today`. See [delivery rounds](/docs/counter/delivery-rounds).
**Department** — A ward or unit, with its [cost centre](/docs/reports/cost-centres), under `Settings › Places & cost centres`.
**Draft** — An order not yet placed with the supplier, shown under its supplier in `To order` on `Orders`. See [the To order list](/docs/stock/order-list).
**Either** — The uniform style offered [both cuts](/docs/stock/catalogue-sizes-and-cuts).
**FTE** — A person's combined employment fraction, such as 0.8, or Casual. See [groups and routes](/docs/people/groups-and-routes).
**FTE table** — The [route](/docs/people/groups-and-routes) where FTE proposes the starting kit, from 5 sets at 1.0 down to 1 at 0.1.
**Grace** — The 14 days after a trial or paid period ends, when changes are still accepted. See [plan and billing](/docs/account/plan-and-billing).
**Grandfathered** — A facility created before plans existed, [hosted free](/docs/account/plan-and-billing) with everything.
**Group** — A staff group, such as Registered Nurse. Each is on one [route](/docs/people/groups-and-routes), and garments are tagged for the groups that wear them.
## H–M
**Hand-in** — Garments given back, in `Hand in` mode on `Counter`: good ones join the pre-loved pool, rags are counted for disposal. See [exchanges and returns](/docs/counter/exchanges-and-returns).
**Issuer** — The [coordinator role](/docs/start/the-two-roles) that issues stock, files stock counts and receives deliveries, and cannot edit a price or delete a past issue.
**Items (FY)** — What someone has drawn since 1 July, a column under `Reports › People`. It feeds the [reports](/docs/reports/the-nine-reports) and never limits the counter.
**Kit check** — A round, started by an Admin under `Requests › Kit check & waitlist`, asking staff in the staff app to confirm what they hold. See [the staff app](/docs/apps/staff-app).
**Manager** — The person, recorded by staff number, who [approves someone's requests](/docs/people/managers) and signs their order form.
**Manager approval** — The route with no starting kit, where the manager [approves each set](/docs/counter/manager-approvals).
## N–R
**Needs an approver** — A request nobody has been asked to decide, listed under that heading on `Requests`. See [requests from staff](/docs/counter/requests-from-staff).
**Opening balance** — The count a size starts from, set in `Adjust quantity` or by CSV. See [stocktakes](/docs/stock/stocktakes).
**Override** — An issue past the ceiling, outside the person's group or not their uniform style, recorded by ticking `Record as an override` on `Counter`. See [issue a garment](/docs/counter/issue-a-garment).
**Pre-loved** — Good handed-in garments, reissued at $0, which count toward the ceiling like new ones. See [exchanges and returns](/docs/counter/exchanges-and-returns).
**Rag** — A handed-in garment counted for [disposal](/docs/counter/exchanges-and-returns).
**Read-only** — After grace: reports, exports, printing and the backup still work and nothing is deleted, but most changes are refused. See [plan and billing](/docs/account/plan-and-billing).
**Reorder level** — The count at or below which a size joins `To order` on `Orders`. See [reorder levels](/docs/stock/reorder-levels).
**Request** — Garments asked for in the staff app, worked through on `Today`, on the person's record and on `Requests`. See [requests from staff](/docs/counter/requests-from-staff).
**Route** — How a group's garments are decided: FTE table, Starting kit or Manager approval. See [groups and routes](/docs/people/groups-and-routes).
## S
**Self-approved** — A request approved by someone who is [their own manager](/docs/people/managers).
**Set** — One top and one pair of trousers; the garment's type decides which half it is. See [the entitlement rule](/docs/people/entitlement-rule).
**Slip** — A printed collection or delivery slip, or a staff app code slip. See [slips and signatures](/docs/counter/slips-and-signatures).
**Starting kit** — The [route](/docs/people/groups-and-routes) giving sets on the first day, 3 by default, then more as needed.
**Stock on hand** — The live count of each size on the shelf, under `Stock › On hand`. See [stocktakes](/docs/stock/stocktakes).
**Stock take** — A count of the shelf or the pre-loved pool against the system figure, done on `Stock › Count` with a `Mode` of `Normal` or `Blind`. See [stocktakes](/docs/stock/stocktakes).
## T–Z
**To order** — On `Orders`, for Admins: every size at or below its reorder level, suggested at twice the level less what is on hand and on order, grouped by supplier. See [the To order list](/docs/stock/order-list).
**Trial** — 30 days for a new hosted facility, no card taken. See [plan and billing](/docs/account/plan-and-billing).
**Uniform style** — The cut a person is offered, Men's, Women's or Either, plus everything unisex; blank offers every style. See [the staff register](/docs/people/staff-register).
**Variance** — The difference between a count and the system figure on `Stock › Count`. See [stocktakes](/docs/stock/stocktakes).
**Waitlist** — People waiting for a size not on the shelf, under `Requests › Kit check & waitlist`; an offer holds it for 48 hours. See [the staff app](/docs/apps/staff-app).
**Ward desk** — `On the ward desk` on a staff record, letting that person sign for bags a round leaves at their ward. See [delivery rounds](/docs/counter/delivery-rounds).
**Ward Requests** — The old name of `Requests`, reached from `People`. See [requests from staff](/docs/counter/requests-from-staff).
docs/manual/reference/keyboard-and-scanner.md
+93
View File
@@ -0,0 +1,93 @@
---
title: Keyboard and scanner
section: reference
order: 3
summary: Setting up a USB barcode scanner, where a scan goes on each screen, the formats ThreadCount reads and prints, the keys the screens answer to, and how printing works.
screen: Search or scan, Counter, Stock › Count
role: Admin or Issuer
keywords: usb scanner, keyboard wedge, enter, suffix, barcode, badge, ean-13, code 128, keyboard, shortcut, slash, ctrl k, search, escape, tab, print, labels, slip, pop-up
---
## Setting up a USB scanner
ThreadCount has no scanner driver. A USB scanner in keyboard mode (keyboard wedge) types the code and ends it with Enter.
1. **Set the scanner to keyboard mode.** Most are out of the box; the scanner's own manual has the setup barcode.
2. **Set the suffix to Enter (carriage return).** With a Tab suffix nothing is recorded.
3. **Scan a staff badge from `Today`.** `Counter` opens with that person chosen.
With no field selected, the portal treats at least 4 characters, each within 35 milliseconds of the last and ending in Enter, as a scan. While a field is selected, a dialog is open or the search panel is open, the portal does not watch for scans: the keys go wherever the cursor already is.
## Where a scan goes
With no field selected:
| What was scanned | Where you are | What happens |
|---|---|---|
| A staff number | Any screen | `Counter` opens with that person |
| A garment barcode | `Counter`, with a person chosen | That size is added to the pickup, in `Issue` mode |
| A garment barcode | `Stock › Count` | 1 is added to that size's count |
| A garment barcode | Anywhere else | The garment's page opens at that size |
| A code nobody has | Any screen | Search opens with `No person or garment has <code>.` |
Admins also get `Bind it to a garment` in that search panel. Scan fields that act on Enter:
- `Counter`, `Find a person`: an exact staff number, or else the first match.
- `Counter`, `Scan a garment, or type a name`: adds the size to the pickup.
- `Stock › Count`, `Scan to count +1`: selected when the tab opens.
- `Scan to add` on `Stock` (Admin): finds the garment, or offers to add it.
- `Scan sizes` on a garment's page (Admin): binds the code to the size it asks for.
An unknown code in the `Counter` box opens `Unknown barcode` for an Admin; an Issuer sees `No garment has <code>.` On `Stock › Count` the dialog opens for everyone, but only an Admin can bind. See [barcodes](/docs/stock/barcodes).
## Formats
| Where | Formats |
|---|---|
| USB scanner | Whatever the scanner types. A binding keeps up to 64 characters. |
| Camera, in the browser and the counter app | EAN-13, EAN-8, UPC-A, UPC-E, Code 128, Code 39, Code 93 |
| Printed labels | EAN-13 for a valid 13-digit code, Code 128 for anything else |
`Generate barcodes` on a garment's page gives each size with no code an EAN-13 starting `29`, the GS1 range for use inside one organisation.
At a window 780 pixels wide or narrower, a `SCAN` button sits at the bottom right. On `Counter` and `Stock › Count` it opens that screen's camera; anywhere else it opens search with the camera running. Which browsers can use the camera is on [scanning and browsers](/docs/apps/scanning-and-browsers).
## Keys the screens answer to
| Key | Where | Does |
|---|---|---|
| / or Ctrl+K (Cmd+K on a Mac) | Any portal screen, outside a field or dialog | Opens search |
| Up and Down arrows, Enter | Search panel | Move through results; open the highlighted one |
| Shift+Enter | Search panel, on a person | Opens their record instead of `Counter` |
| Escape | Search panel, any dialog | Closes it |
| Tab, Shift+Tab | Search panel, any dialog | Moves round its controls without leaving it |
| Escape | `Counter`, with a person chosen | Changes person, unless the pickup has lines or a match list is open |
| Ctrl+Enter (Cmd+Enter) | `Counter`, `Issue` mode | Records the issue |
| Down arrow | `Counter` scan box, `Manager` search | Moves to the first match |
| Alt+Left, Alt+Right | `Settings › Issuing rules`, a group's menu button | Moves the group one route back; one route on |
| Enter, Escape | Renaming a group | Saves; cancels |
| Enter | `New group name`, `New supplier`, `Add a size`, a size's barcode field | Adds or saves |
## Keys in this manual
The manual has its own keys, on the website at `/docs` and in the app at `/app/help`.
| Key | Where | Does |
|---|---|---|
| / | A manual page, when you are not typing in a field | Puts the cursor in the manual's search box |
| Up and Down arrows | The search results | Move between results |
| Enter | The search results | Opens the highlighted page |
| Escape | The search box | Closes the results |
Manual pages also carry `Print` and `Copy link` buttons.
## Printing
Printing uses the browser's own print dialog. Two routes lead there.
- **A print page** opens the dialog after half a second and keeps a `Print` button for another try. The order form (`Order form` on `Counter`, `Print order form` on a request, `Print the form` on a person's `History` tab), the supplier order sheet (`Print` after ordering, `Order sheet` on an order) and labels (`Print labels (N)` in a garment page's menu) open in a new tab. Collection and delivery slips open in a pop-up window: `Collection slip` on `Counter`, `Slip` under `Call to collect` on `Today`, and `Collection slip` or `Delivery slip` on a request.
- **A print window** carries the document itself: `Print` on each `Reports` panel, `Month-end pack`, `Sheet` on a supplier's `To order` panel, `Print order` on an order, `Print count sheet` on `Stock › Count`, `Credit slip`, and the hand-in `Receipt`. If the browser blocks it, ThreadCount says `Pop-up blocked — allow pop-ups for ThreadCount to print.`
The label sheet holds 6 labels to an A4 page. From a garment's page it prints one label per garment on hand for each size with a code, after you confirm the number. From the counter app, a single code prints 1 to 24 copies, 6 unless changed.
> **Careful** The counter app cannot print. A print page opened there says `This app can't print. Open this page in a browser — on the computer at the counter — to print it.`