Skip to content

Repair Works Order Form

Live dependencies & version history: see the auto-generated catalog page — its Dependencies & Related section lists the sub-forms, sub-tasks, and workflows that use this form, refreshed on every dev pull.

The main field operative form for responding to repair jobs raised in Aareon QL. Operatives use it to record arrival, work performed, customer satisfaction, and completion. It is also the launch point for sub-forms (Component Replacement Request, Gas Servicing, Damp & Mould Inspection, etc.).


Version History

Version Notes
v63 Baseline version present in workspace.
v64 CRR sub-task (ComponentReplacementRequest) added — operatives can now launch CRR directly from RWO via the "Starting Work" button. Insights data is passed across using "Defined Format and Mappings".
v73 Current version as of 13/05/2026 Management Studio full pull-down.

Current file: extracted/forms/Forms/Repair+Works+Order_73.form


Name Fields (task display name)

Field Meaning
GenBP_HMS_Ord_Priority Repair priority code from QL
GenBP_HMS_Add_AddressLine1 Property address line 1
GenBP_HMS_Add_Postcode Property postcode

Key Sub-Tasks

Field Type Sub-form
ComponentReplacementRequest SubTask CRR form — for component replacement work identified during the repair
Gas Servicing SubTask Gas servicing certificate form
Commercial Gas Servicing SubTask Commercial gas variant
Commercial Gas Test Purge SubTask Gas test/purge sub-form
Gas Monthly Check SubTask Monthly gas safety check
Damp and Mould Inspection SubTask Damp and mould survey
FirstPersonVisit SubTask First person visit (void properties)
NIBE SubTask NIBE heat pump sub-form

Key Form Items

Order & Property Keys

Field Type Notes
GenBP_Key_OrderNumber String QL order number
GenBP_Key_PropertyId String Property reference
GenBP_Key_PersonId String Tenancy person reference
GenBP_Key_PersonIdInt Integer Integer version of PersonId
QL_Property ID String QL property ID
QLOrd_OrderNumber Integer QL order number (integer)

Events (appointment lifecycle)

Field Notes
Form_EventEnroute Fired when operative marks "en route"
Form_EventArrived Fired when operative arrives on site
Form_EventStarted Fired when work begins
Form_EventFinished Fired when work is complete

Completion & Follow-on

Field Options Notes
Form_CompletionReason Job complete; Additional Work; Customer refused; Contractor required; H&S concern; Major works; Capital works; Heating install… Why the job is being completed
Form_FollowOnRequired Yes; No Whether follow-on work is needed
Form_FollowOnReason More time required; Materials required; Different trade required; Survey required; Bad weather; Work at height; Asbestos rep… Follow-on reason
Form_FollowOnComment String Free-text explanation
Form_CanOperativeGetAccess Yes; No Access available
Form_NoAccessReason Health and Safety Risk; No Appropriate Adult; Customer Not In; Customer Refused Access; Compliance No Access No-access reason

Customer Satisfaction

Field Options
CustSats_WillingToDoSurvey Yes; No
CustSats_SatisfiedOverall Yes; No
CustSats_HappyWithOperative Yes; No
CustSats_OperativeShowedID Yes; No
CustSats_WorkAreaLeftClean Yes; No
CustSats_WouldRecommendToOthers Yes; No
CustSats_TypeOfSurvey Complete on mobile device; Telephone call

Document Generation

Field Default value Notes
Form_DocumentTemplateName Repair Works Order Word Connector template name
DocEx_HandlerTrigger Repair Works Order.Complete Triggers document export on completion
Form_DataWarehouseTable WorksOrder DW target table

Scheduling & Appointments

Field Notes
Diary_AppointmentId iAppoint appointment reference
Form_IsDiaryUsed Whether iAppoint diary is in use
Form_IsDirectScheduler Whether direct scheduler is in use
Form_IsSchedulerUsed Whether Versaa scheduler is active

Components (for CRR linkage)

Field Type Notes
GenBP_Components Group Holds property components data (populated by workflow)
GenBPInsight Group Insights/alerts data for the property
GenBP_Alerts Group Property warning flags

The RWO handles gas servicing sub-forms. Key selector:

Field Options
Gas Form Choice LGSR (CP12); GSIF (CP4); None
Gas Form Type LGSR; GSIF; None; UvHWSV
Form_IsGasEngineer Yes; No
Form_IsGasService Yes; No
Form_IsGasRepair Yes; No
Form_IsGasLPGService Yes; No
Form_IsLPGService Yes; No
Form_IsOilService Yes; No
Form_IsSolidFuelService Yes; No
Form_IsUnventedCylinder Yes; No
Form_IsSmokeCODetectorCheck Yes; No
Form_IsEICR Yes; No
Form_IsElectrician Yes; No

Meter Reading Fields (Void properties)

When Form_IsVoid = Yes, operatives capture meter readings:

  • Electric: serial number, meter type (credit/prepay/Economy 7), readings (A/F/G), supplier
  • Gas: serial number, type (credit/prepay), readings, supplier
  • Water: reading, stopcock location (internal/external)

CRR Integration (v64+)

From v64, the CRR form is launched as a sub-task from within RWO via the "Starting Work" button.

Insights data passing

When the "Starting Work" button launches the CRR sub-task, all Insights data needs to be available in the CRR form. The approach:

  • "Defined Format and Mappings" is configured on the button to map the GenBPInsight group across.
  • Because Insights field names are identical in both forms (Mark Wright copied them with the same names), the entire group can be mapped at once rather than field-by-field.
  • This ensures CRR receives property alerts/insights context from the RWO.

Get Component Request Data

The CRR form has a "Get Component Request Data" button that sends the message event getComponentRequestData. The wildcard workflow any *.getComponentRequestData fires and populates property component data into the CRR form. See forms/component-replacement-request.md for full detail.


Completion Workflow

The Repair Works Order Completion workflow (Repair+Works+Order+Comp_7.workflow) processes the form on completion. As of session 10 (13/05/2026), a step was added to "process component replacement requests" — this step runs and completes but does nothing useful yet. Investigation ongoing: likely the CRR instantiated sub-task needs its own dedicated completion workflow. Status: not resolved, in Dev only.

Key workflow files: - extracted/workflows/Workflows/Repair+Works+Order+Comp_7.workflow