Files
threadcount-community/docs/manual/account/export-and-backup.md
T
ThreadCount a6f1059ddf ThreadCount Community edition
Uniform stock management for healthcare linen rooms: the coordinator app, the phone counter and the staff app, for your own server. Built from a113353 on 2026-09-15. Licensed under the Functional Source License (FSL-1.1-ALv2).
2026-09-15 22:54:09 +10:00

72 lines
4.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
title: Export and backup
section: account
order: 5
summary: The one-file backup, CSV exports, the last-backup date, what a restore replaces and refuses, and whose backups are whose.
screen: Settings Data & audit log
role: Admin
keywords: backup, export, download, restore, import backup, JSON, CSV, last backup, data, recovery, take my data, leave
---
## The backup file
`Export backup` on `Settings Data` downloads the whole facility as one JSON file, named for the date where your facility is, such as `threadcount-backup-2026-09-13.json`. `Download backup` on `Settings Plan` gets the same file. Only admins can take it.
The file holds the facility's settings and every record. That covers the catalogue, barcodes, stock and its movements, and locations. It also covers departments, suppliers, the staff register, manager approvals, issues, orders and their deliveries, pickups, stocktakes, hand-ins and cost changes. The staff app's side is in it too: requests and their messages, the waitlist, kit checks, damage reports, record queries and the ward notice. Photos and signatures are written into the file.
Left out on purpose:
- users and staff sign-ins, because those rows hold passwords;
- ThreadCount's own notes about your plan.
The newest photos travel, up to 2000 photos or 40 MB. Older ones are counted and left out, so the file stays small enough to restore, and the screen says how many. The records they belong to are all in the file, and the images stay on the server.
The backup still downloads when the facility is read-only.
## CSV exports
Reports, People, Stock (On hand, Count and Locations), Orders, Requests and the audit log in Settings download CSV files. So do the department and supplier lists in Settings. The files are for reading and for finance; see [The nine reports](/docs/reports/the-nine-reports).
Only the backup file restores a facility. A CSV export does not change the last-backup date.
## The last-backup date
`Settings Data` shows `Last backup:` with the date and how many days ago, or `No backup taken yet.` Past 7 days, or with no backup at all, the line is marked in red.
Each download of the backup file, from either screen, sets the date.
## Restore a backup
1. **Open `Settings Data` and choose `Import backup`.**
2. **Pick a ThreadCount backup file.**
3. **Confirm.** The warning says the restore replaces all data in this facility.
Everything in the facility is deleted and rebuilt from the file, facility settings included. The facility name, slips, groups, sets and time zone all come from the file. It keeps the users, single sign-on settings and plan. Staff sign-ins survive, re-attached to register entries by staff number.
| Record | Change | Undo |
|---|---|---|
| Facility | All records replaced by the file's | Restore an earlier file |
| Facility | Settings replaced by the file's | Restore an earlier file |
| Staff sign-ins | Re-attached by staff number | None needed |
A restore is refused when:
- the file is not a ThreadCount backup;
- the facility is read-only;
- the file holds more staff records than the plan allows, 60 on Hosted Small;
- the file exceeds a count limit, such as 20,000 staff or 300,000 issues;
- you have made 20 restores or imports in 10 minutes;
- the upload is over 60 MB.
Photos beyond 2000 in a file are dropped rather than refused, and the screen says how many. Keep that file, because those images exist only in it.
> **Careful** A restore replaces what is there now. Take a fresh backup first if today's records matter.
## Your backups and the service's
The Plan screen's `Backups` row shows the hosted service's own nightly backups: 14 days on Hosted Small, 35 days on the other plans. What they commit to is in the [Service Level Agreement](/sla) and on [Security](/security).
No screen restores one facility from those backups. The only restore in the app is `Import backup` with a file you hold.
The [Terms](/terms) make exporting and keeping regular backups the facility's own responsibility. Store the file under your records policy; it holds the staff register. Self-hosted servers need a backup of their own, as described in [Backups](/docs/selfhost/backups).