Customer monthly reports
A customer monthly report is an email, in your brand, that tells one customer how their backups went last month, with the same report attached as a PDF. It goes out on the 1st, only to recipients you have confirmed, and every figure in it says where it came from. Where Caryvane has no figure, the report says so rather than showing zero. The email and PDF are in English for now.
Set it up #
- Console → Customers → the customer's ⋮ menu → Monthly report…
- Add the people who should receive it under To, and anyone to copy under Copied to. Copy me adds your own address; Copy the IT provider copies your support address from Branding (or your billing address if no brand is set).
- Turn on Send automatically on the 1st of each month.
- Press Confirm recipients. Nothing is sent automatically until you do, and any later change to the recipients needs confirming again.
MSP and distributor admins set up reports for their customers. A customer with no IT provider above it can set up its own. A customer under an MSP can read its own sent reports but leaves the recipients to the MSP.
Preview and send now #
- Pick a month on the right to see the report exactly as it would be sent, for any of the last twelve months or the month so far. The preview is not stored or sent.
- Send now builds the report for the month shown and sends it straight away, after a confirmation that lists everyone it goes to. If you have changed the recipients on screen without saving, the send goes only to the people under To, with no copies; save first to include the copies.
- Every send by hand is recorded in the audit trail with who sent it and to whom.
- Download PDF saves the month shown as a PDF, the same file the email attaches. Like the preview, it is built when you press it and nothing is stored or sent.
The PDF copy #
Every report email carries the report as a PDF attachment as well as in the body, for customers who file it, print it or pass it to an auditor or insurer. The PDF is A4, in your brand: your logo, colours, name and support contact, and Powered by Caryvane in the footer unless you have turned that off in Branding. It opens with a one-line position and a short plain-English summary of the month, then the same sections as the email, each with its source, and numbered pages with the date it was produced.
The PDF is made from the same figures as the email, so the two always agree. Nothing extra is stored: a sent report's PDF is made again from its frozen figures whenever you download it, so the figures are always as sent, while the logo, colours and contact details are the ones in your Branding at that moment.
What the report contains #
- What was backed up: machines with a completed backup in the month, Hyper-V virtual machines, Microsoft 365 and Google Workspace resources synced in the month, and Xero organisations, Shopify stores and WordPress sites connected at the month end, and Proxmox guests with a finished backup. A kind the customer does not use is left out.
- Backup runs as n of N runs completed. Only first attempts count: a retry is the same work counted once. Runs cut short when a machine or worker stopped, cancelled runs and continuous (real-time) jobs are not counted. Runs that completed with warnings are counted separately. Below five runs the report gives the counts only.
- Backup jobs: each job with the machine or service it covers (a machine's own name, or Microsoft 365, Xero and so on), its runs in the month counted the same way, and how its last run went.
- Runs that did not complete, and when the same job next completed. The report describes what happened, not why: error messages stay in the console.
- Storage used at each of the customer's own destinations, from the nightly measurements, with the trend over the last 90 days once there are at least 14 complete measurements. A projection always says at this rate and how many measurements it rests on. A destination never measured is listed as Not measured, and the total then reads At least.
- Last verified restore: the most recent automatic restore test of each opted-in Proxmox guest. Other machines show Not yet recorded.
- Needs attention: the same list the customer health check gives (jobs whose last run failed or warned, jobs that never ran, machines that have not checked in for a day, destinations that lost their sign-in), as at the moment the report was built.
- Worth knowing: legal holds in place at the month end (name and scope, never the reason), whether backups at each destination are locked, and a one-line summary from the stale data report where Microsoft 365 or Google is backed up.
Shared storage #
If your customers share a destination you own, its size covers other customers' data too. The report counts it as a shared destination provided by you, but never shows its name or size, so no customer sees another's figures.
When it goes #
- Reports go out at 06:00 UTC on the 1st, covering the month just ended. Each customer's report is sent once: if two servers try at the same moment, only one sends.
- On the 2nd, a second pass retries any report that failed to send and sends last month's report to customers whose recipients were confirmed after the 1st.
- Suspended customers are not sent a report.
- Each sent report is kept under Sent reports, exactly as sent, with its figures frozen. Open one to see it, and use the PDF button there to download it as a PDF.
Not yet #
- Another day of the month: reports go out on the 1st for now.
From an assistant or the API #
The read tool get_customer_report returns one customer's report for a month as figures, never the email itself: the report as it was sent when there is one, otherwise built just now and stored nowhere. A figure Caryvane does not have comes back empty and must not be read as zero. Ask with includePdf set and it also returns the branded PDF, made from the same figures; anyone who can read the report can have its PDF. See AI assistants & API.