Getting started

Audience: new administrators and first office users. Install first: requirements then the Web Installer.

How the office CMS, Field PWA, customer portal, public booking, APIs, and the optional native Field app fit together. Laravel is the authority. Clients never invent jobs, money, or licenses of their own.

Beginner glossary

Customer — The company or household you serve.

Site — A customer location (address, timezone).

Service request — Optional inbound demand. Not every job starts as a request. Public booking does not create one.

Work order — The job record. Technicians never create work orders in Field.

Appointment — One visit on a work order.

Technician — Workforce profile linked to a CMS user. Field PWA and native Field require an active technician plus field.workspace.view.

Field PWA — Browser technician client included with the web product. Open it from the command palette (Field). URL: /app/w/{slug}/field. It is not Veldriq Field (the Flutter app).

After install (first administrator)

Install and activate the licence for product veldriq. Create a workspace user and a technician if someone will run Field. Fresh installs are English, EUR, tax 0, core defaults — not a demo industry catalog.

First operational journey (11 steps)

1. Create the customer — Customers → Customers → New customer (Person or Company, Active, name).
2. Add a site — Customers → Sites → New site (timezone and address). Field “today” and dispatch geography follow this timezone.
3. Capture demand (optional) — Operations → Service requests → New service request (Customer, Title, Priority, Source).
4. Convert the request (Convert to work order — typically Open, 1:1) or skip and Operations → Work orders → New work order (starts Draft).
5. Open a Draft work order before Field can see it.
6. Add a visit — Add appointment. Scheduled needs Date and Start. Dispatch does not create the visit.
7. Assign — Operations → Dispatch → Find candidates / Assign technician / Auto-Assign (dispatch.assign). Auto-Assign fills a person on an already dated empty slot; it does not pick a date.
8. Open Field — command palette → Field. The job appears only if the work order is not Draft, the visit is dated, and this technician is assigned.
9. Execute — Start travel / Start work, forms, findings, evidence, parts, signatures, then Closeout → Complete appointment. That completes the visit, not the work order.
10. Office completes the job — on the work order click Complete (then Close). If a visit pack should count, mark Count as contract visit before office Complete.
11. Service report — may auto-generate on appointment complete, or generate from the appointment panel (service_reports.generate). PDFs need a queue worker.

Unassigned appointments never appear in Field. Invoice only if you use finance.

Fresh installs are English, EUR, tax 0, core defaults — not a demo industry catalog.

Do not conflate Field PWA with Veldriq Field

Technicians can run jobs in Chrome or Safari today with the included PWA. The Flutter app is a separate purchase (store binary, OS secure storage, optional FCM).

live_gps is not released. There is no live van tracking in V1. No GPS-based dispatch, no ETA.

If Today is empty after step 8: still Draft, undated visit, or this technician is not assigned. If Closeout left the work order Open: expected — office still Completes the job.

Next: Work orders or Installation.