EIIƎ User Guide
ModulesServices

AI Report Builder

The AI Report Builder designs the PDF report for a survey template. The AI reads your survey (and, optionally, example reports you upload) and generates up to three professionally designed report options. You pick the one you like, refine it with the assistant, and publish it — from then on, every completed survey of that template can be turned into a branded PDF report with one click.

Use Cases

  • Client-facing reports — turn field survey data into a polished, branded PDF the moment a survey is completed
  • Match an existing look — upload an example of a report your customers already expect, and the generated designs lean toward it
  • Design before data — the report is designed against the survey template, so a project can ship the survey and its report together before any survey has been completed

Key Concepts

ConceptDescription
StyleA professionally designed report look (Editorial, Technical / Tabular, Compliance Certificate, Photo-Forward). You choose one; you don't design page layouts yourself
Report designYour report for one survey template: a style, plus your choices (colours, fonts, photos, header/footer, summary placement)
Draft / PublishedEvery generated design is kept as a draft. Publishing makes it the live design that surveyors' reports use — nothing goes live until you publish
Executive summaryThe summary page at the top of each report, written from that survey's actual data. When the template has finding triggers it leads with the concerns found. You review, edit and sign it off before sharing. See The executive summary

The report body always shows the whole survey — every group and field, automatically, in the style you pick — including any photos captured during the survey, shown next to the field or section they were taken against, and any drawings the surveyor pinned observations on. You're choosing how the report looks, not which content appears.

The report styles

Every report is built on one of four professionally designed styles. Styles are fixed, product-designed looks — you pick and personalise one; you don't build page layouts yourself. Each adapts to any survey.

StyleBest for
EditorialThe safe default for most surveys — property and condition inspections, or any report where a polished, magazine-like look matters. Specimen cover, numbered sections, key-findings stat cards.
Technical / TabularChecklists, equipment servicing, and multi-item inspections — a compact job-sheet with dense tables and status stamps, where the data is the point.
Compliance CertificateRegulatory and compliance records — a formal certificate with a compliance banner and a signed declaration block.
Photo-ForwardReports where photos carry the story — environmental and site surveys, before/after documentation — with a full-bleed hero cover and large captioned figure plates.

Administrators can see the full catalog — each style with a "when to use" note and a sample report — at Services → Survey Templates → Report styles.

New styles are added by the product team as designed, validated additions to the library (they can't be created or edited in the app). If you need a look the four styles don't cover — for example to match a specific customer's house style — ask your account contact.

Designing a report

  1. Open the survey template (Services → Survey Templates) and click Design report.
  2. On the setup screen:
    • Browse the style gallery. The AI picks the best styles for your survey — tap one to make sure it's included.
    • Optionally add example reports (PDF) or extra logos (accreditations, certifications). The design options will lean toward that look. Files are virus-scanned first; a file that isn't ready yet is picked up next time you generate.
  3. Click Generate design options. The AI reads your survey and designs up to three options, each shown as a full PDF preview with realistic sample data and your branding.
  4. Compare the options side by side and click Use this design on your favourite — or Regenerate options for a fresh set, or Skip — design one for me to jump straight in with a single design.

Your chosen design opens in the workspace as a saved draft. If you come back later, you land straight in the workspace; Explore new designs takes you back to the gallery for a fresh set (your current design stays untouched until you publish a new one).

Refining the design

The workspace shows a live PDF preview that re-renders as you make changes.

  • Ask the assistant (left panel) in plain English — "use our navy as the accent", "make the photos bigger", "feel more formal", "move the summary to the front". Each proposal appears as a card you Apply or Discard, so nothing changes without your say-so.
  • Advanced (above the preview) opens the direct controls:
    • Document identity — the document type and title lines, and, on a style that offers it, the switch for a cover with both parties. See A cover with both parties.
    • Style — switch to a different style; your survey re-flows into it.
    • Theme — accent colour and body font for this report, and the accreditation marks it prints. See Accreditation marks.
    • Captured photos — whether the photos surveyors take during the survey appear in the report (on by default). When on, they render next to the field or section they were taken against, with a photographs gallery at the end.
    • Every photo in the report is numbered Figure 1, Figure 2 and so on, in the order it appears. If a photo carries a label, the label prints beside its number. See Labelling a photo.
    • Drawings and pins — whether pinned drawings appear as figures (on by default). See Drawings and pins in the report.
    • Photos — how each cover / evidence photo area renders (grid, inline, large, full-page).
    • Executive summary — whether it appears, and before or after the survey content.
    • Header & footer — what appears at the top and bottom of every page: the style's default, the survey title, the completion date, your standing footer line, or custom text.
  • Preview data — preview with sample data, or with a real completed survey if one exists.
  • Demo mode — temporarily overlay a prospect's logo on the preview (never saved) — useful in sales conversations.

When you're happy, click Publish. Reports generated for this template's surveys now use this design. Save draft keeps work-in-progress without going live; Obsolete retires a published design.

Labelling a photo

A label says what a photo shows. It's what a reader has to go on, so a report full of unlabelled photos tells them very little.

Labels are optional. Add one when it helps and skip it when it doesn't — a surveyor working hands-free by voice is never held up by it.

To label a photo:

  1. Open the survey and click any photo to open it full size. This works everywhere photos appear: on a field, on a section, on an observation, and in Survey Photos.
  2. Type into Label (optional) under the photo, then click Save or press Enter.
  3. Clear the box and save to remove a label.

You label a photo after it's uploaded, never before — so a surveyor is never held up mid-capture, and a label can never land on the wrong photo.

On the phone, a surveyor can label a photo in the field, standing in front of the thing it shows:

  1. Tap the photo to open it full size — from a field, a section, a repeated item, or Survey Photos.
  2. Tap the label strip under the photo (it reads Add a label when there isn't one yet).
  3. Type the label and tap Save. Leave it empty and save to remove one.

This works with no signal. A label typed offline is kept on the phone and reaches the server on the next sync — whether the photo had already uploaded or is still waiting to.

If a photo has been marked up, the report prints it with the markup on. See Marking Up a Photo.

Labels appear straight away in the report — no change to the report design, and no need to republish it. The report prints the label after the photo's figure number, like Figure 4 — Cracked lintel above the door.

Note: figure numbers follow the order photos appear in the document, and are worked out each time a report is generated. If you add a photo and regenerate, later numbers can shift. Quote the label rather than the number in an email.

Drawings and pins in the report

If surveyors attach drawings and pin observations on them, each pinned drawing appears as a figure after the section it belongs to:

  • The drawing, with a numbered marker for every observation of that group pinned on it.
  • A legend underneath: marker number, observation, and — where the observation has a survey finding — its classification and severity, taken from the most severe finding.
  • The observation's own pin row reads "Marker 3 · plan.pdf p.1".

A group pinned on two drawings produces two figures. Marker numbers follow the observation's position in its group, so "Defect 3" is marker 3 wherever it appears.

Show sheet figures (Advanced → Drawings and pins) switches them off for this design. The observation still says which marker and drawing it has; only the pictures go.

A drawing that can't be rendered — still being prepared, preparation failed, or blocked by the virus scan — keeps its pins in the data but is left out. Very large reports also drop images that don't fit the page budget; drawings are allocated their share first, and the words always stay.

Nothing here needs configuring in the survey template beyond adding a Location pin field. See Drawings & Pins →

A cover with both parties

Most covers name one party: you. The parties cover puts your client and your own organisation side by side on the front page, each with a logo, an address and a named contact, over an accreditation strip and a foot carrying the revision, the date the report was written and the job number. It's the shape of a formal report of findings.

Only the Editorial style offers it today. On a style that doesn't, the option shows as unavailable with a Switch to Editorial link, and a design keeps its setting if you switch styles and come back.

To turn it on: in Advanced → Cover, directly under Style, pick the Client and contractor card. The preview re-renders straight away.

The body pages don't change. Only the cover does, and it replaces the cover photo with the two columns.

What fills it

Your own side comes from Organisation branding and the survey's assignee, so it's filled in already. The client's side comes from the customer and the job:

On the coverWhere you set it
Client logoLogo on the customer record (SVG or PNG)
Client addressBilling address on the customer record, picked from that business's addresses
Client contact, phone, emailClient contact on the job — the person at the customer named on this report. The list follows the job's Customer field
RevisionRevision on the job, free text such as "Rev A"
Project job no.Job Reference on the job
Date report writtenThe survey's completion date

Anything you leave blank is simply left out — the columns keep their place and nothing shifts. A client with no logo shows as a name, a job with no contact drops the contact rows, and a job with no reference or revision drops the job line and those foot cells. So the cover is worth switching on even before every customer record is filled in.

Accreditation marks

Accreditation marks are the small logos of the bodies that approve, certify or verify your work — an ISO badge, a Gas Safe mark, a trade association. They print under "Approved, certified or verified by" on the parties cover, and beside your logo on the other covers.

You upload them once and every report design uses them, the same way your logo and accent colour work.

To add them: open Advanced → Organisation branding, then Accreditation marks → Add a mark. SVG or PNG, up to six, and they appear in the order you add them. The cross on a mark removes it. Editing these requires the Admin Settings permission; everyone else sees them but can't change them.

A mark has to be a file you upload. A link to an image hosted somewhere else won't print, because reports are built without reaching out to the internet. If the assistant offers to set one from a web address, upload the image instead.

Giving one report different marks

A single report design can carry its own set — a certificate that only applies to one kind of work, say.

In Advanced → Theme, the marks are labelled either · organisation or · this report, which tells you which set that design is using:

  • Use different marks for this report — upload one, and the design switches to its own set. From then on it ignores the organisation's.
  • Use the organisation's marks — throws that set away and goes back to inheriting, so later changes in Organisation branding reach this report again.

Removing a report's last mark has the same effect as the second button: it goes back to the organisation's marks. To print a report with no marks at all, remove them in Organisation branding.

Organisation branding

Click Organisation branding (in Advanced) to set details that apply to every report: accent colour, business contact and address, company registration and VAT numbers (shown in the "Issued by" block), your accreditation marks (see Accreditation marks), and a standing footer line (e.g. a confidentiality notice) that new designs place at the bottom of every page automatically. Editing these requires the Admin Settings permission. Your logo is still set in Account → Setup.

Generating a report from a completed survey

Review a survey and reissue its report

Once a design is published, every completed survey of that template shows a Reports & printing section on its detail page:

  1. Click Generate designed report. If the executive summary hasn't been written, hasn't been reviewed, or the survey changed after it was written, you're asked first: Review summary opens the editor, and marking the summary reviewed there builds the report straight away; Create report anyway carries on without a review. Then the summary is written from the survey's data (first time only), the pages are designed — including any photos captured during the survey — and the PDF opens.
  2. Use Copy link to share it — the link expires (the expiry time is shown); regenerate for a fresh one.
  3. Click Review summary to read, edit and sign off the executive summary (see The executive summary), then Regenerate designed report to see your changes in the PDF. An edited summary is never overwritten.

The last report is remembered: when you come back to the survey, the section shows Open report (which fetches the stored PDF — the link is always fresh) and Regenerate designed report to rebuild it with the latest survey data.

The executive summary

Every designed report opens with an executive summary: a short narrative and a panel of key findings (label, value and a coloured badge). It is written for one completed survey from that survey's own answers, stored with the survey, and placed where the report design says (before or after the survey content).

Two kinds of summary

Which one you get is decided by the survey template, not by a setting:

The template has…The summary is…
Finding triggers (see Survey Findings)Concerns-first. The findings decide what the summary covers; the AI only puts them into words. It opens with the counts ("6 of 24 items failed; 9 observations"), then covers every failed item, most serious first, then the observations. Nothing that passed is described.
No finding triggersOverview. The AI reads the whole survey and writes a general summary of what was recorded.

In a concerns-first summary the key-findings panel is built by the system, not by the AI: an Inspection outcome card with the counts, then one card per concern in severity order. The AI can never leave a concern out of the panel or add one, so the panel is the list to check against; the narrative is there to read well.

A concern is any finding the survey raised — a failed check, or a passed check the surveyor remarked on (see Remarks raise an observation) — plus any finding added by hand on the survey.

Reviewing and signing off

Click Review summary on the survey page to open the editor:

  • Title — defaults to "Executive Summary" in the report; change it if the design calls for something else.
  • Summary — a rich-text box. Paragraphs, bold, italic, lists, headings and quotes carry into the PDF; anything else is dropped at print time, so the editor doesn't offer it. HTML shows the source if you prefer to work on it directly. The report applies its own typography, so the box shows structure, not final appearance.
  • Key findings — one card each: a short label, the value under it, and a severity (Info, Good, Warning, Critical) for the badge colour. Add, edit or remove cards freely.
  • Write summary appears when there's no summary yet, and writes one from the survey data.
  • Regenerate from survey rewrites the whole summary from the survey data. It replaces any edits, so copy anything you want to keep first.
  • Save summary keeps your edits. A saved summary is marked as yours and the report generator never overwrites it.
  • Mark as reviewed records your sign-off. The report then ends the summary with "Reviewed by you on date". Saving an edit or regenerating clears the mark, so a reviewed summary is always the version the reviewer saw. Save first; the button waits for unsaved changes.

After any change, click Regenerate designed report to see it in the PDF.

When the survey changes after the summary is written

A summary is written once and your edits are never overwritten, so it doesn't follow later changes to the survey on its own. If the survey changes in a way the summary covers, the editor shows The survey changed after this summary was written. For a concerns-first summary that means a concern was added, fixed or reworded; for an overview summary, any answer changed. The report button asks you to review it too, even if it was reviewed before.

You have two choices:

  • Regenerate from survey to start again from the survey as it is now.
  • Keep the summary, edit it if needed, and Mark as reviewed. That accepts the survey as it is now, and the notice goes.

Saving an edit on its own doesn't clear the notice.

On the phone

The HAMI Voice app has the same review. Tap Review summary on the survey, or answer the question the report button asks. See Reviewing the Executive Summary.

What the AI is told, and what it isn't

The summary is written by an AI model from the recorded answers, and every report says so in a line under the summary. The model is instructed to use only the recorded data and to carry the surveyor's remarks faithfully. Even so, read the narrative before sharing: an AI can occasionally add a detail that isn't in the data. In a concerns-first summary the counts line and the key-findings panel come from the data directly and are always right; use them as the check.

If the survey changes

Report designs reference survey fields (for example, which field is the cover title). If you later remove such a field from the survey:

  • The survey editor warns you before the change, naming where the field appears in your report design.
  • The Report Builder shows a notice ("This report design uses survey fields that were removed") with a Fix automatically button that points the affected parts at the closest current fields.
  • The report body is never affected — it always adapts to the survey's current structure.

Tips

  • Upload an example first. A strongly branded example report is the fastest way to designs that match customer expectations — it steers colours, tone, and style choice.
  • Set organisation branding once. Registration details and the standing footer line then appear on every new design without per-report work.
  • Publish deliberately. Drafts are safe to experiment with — surveyors only ever see the published design.
  • Preview with a real survey. Sheet figures and photos only show their true weight against a completed survey, not sample data.
  • Regenerate after a branding change. A report you generated earlier is stored as it was. New marks, or a new cover, reach it only when you click Regenerate report.

On this page