Skip to content

Appointments — QL Parameters & Definitions

This page covers all the QL-side configuration that controls how appointments work, including the Versaa / 1st Touch diary integration. For the Versaa polling mechanism itself, see it/appointment-polling.md.

Overview

Appointments are part of the QL Housing Repairs module. The key config items are:

  1. HPM Main Parameters (and Workgroup Parameters)
  2. Screen Layouts
  3. Definitions (Trade Codes, DLO Operatives, Filters, Contractor records, Calendar Locations)
  4. HSG Parameters
  5. HGM Sequence Maintenance

HPM Main Parameters

Parameter Screen Notes
Outlook Appointment 7 QLH-x Appointments Add-On only — enables the add-on
Outlook Appointment Warn 7 Issues a warning if an order is issued without an appointment
Xmbrace DRS 8 DRS integration — set import/export file paths
Operative Appointments 9 Generic appointment slots based on priority filters (set up in HPM Filter Maintenance)
Prohibit Late Appointment 9 Prevents appointments being booked later than the order's target completion date
Appointment Public Folder 9 Path to the public folder used for appointments (if using named calendar paths)

Also required: In Screen Layouts (and Workgroup Screen Layouts), check Appointments Used — without this, appointments processing for maintenance orders is not available.

HSG Parameters for Appointments

These are the most important parameters for Versaa / 1st Touch diary integration:

Parameter Purpose
1ST_TOUCH_APP Set this to use the 1st Touch / Versaa diary. This is the key switch for Versaa appointment integration
ACTUAL_OPERAT_APPTS Use DLO operative appointments with trade-based timeslots
ALLOW_MULTI_OPTI_APP Allow more than one open DRS appointment per order; sends only amended detail lines to DRS
APP_CHANGE_FIRE_MAIL Send contractor email when appointment dates change or appointments are deleted
APPT_CHECK_OPR_EXP Check that operatives with an expiry date cannot have appointments booked after their expiry
AC_POP_FROM_OP_POPUP Populate Access field from the operative popup
BULK_APPT_DAYS_ADV Default appointment date = today + N days
BULK_APPT_WEEKDAY Select a specific weekday from the week set by BULK_APPT_DAYS_ADV
BULK_APPT_START_TIME Default start time for bulk appointments
BULK_APPT_END_TIME Default end time for bulk appointments
CARD_ESC_LET_STG Carding Escalation: use letter stage field to control carding stage processing
CREATE_ALLOC_AND_APP Create order allocations (DLO) and an appointment simultaneously
DEF_APP_CANC_REAS Default cancellation reason for cancelled orders on mobile working (future use)
DEL_CANCELLED_APPS Delete cancelled/carded appointments from Outlook calendars (vs. marking them Cancelled/Carded)
DONT_COPY_ACCESS Prevent irrelevant appointment data being copied to new orders
ESC_LET_STG_1ST_APP Carding Escalation letters: use first appointment date as timescale, letter stage field as counter
FORCE_OPTI_CANCEL On order cancellation, always create a DRS cancellation file even if no DRS appointments exist
IGNORE_CAL_CHECK_CMP Ignore calendar path check on appointment completion
IGNORE_NWD_CL_OP_POP Ignore non-working day calendar in the operative appointments popup (allows weekend/bank holiday bookings)
MORE_APPT_INF_IN_ACC Auto-populate the Access text box on the order with appointment date/day/time
NEW_ACCESS_APP_TEXT When appointments change, rewrite the Access field (clear on cancel/card, update on amend, set on new)
STATIC_APPOINT_SLOTS Appointment slots for generic operatives follow Fabric requirements
UNRESTRICT_TYPE_OF_APP Enable filters on appointment initial screen when loading from HPM Single/Full Order Entry
UPD_ORD_CHG_CNTR_APP Update order Access field when a contractor appointment changes
XMBRACE_IMP_CLOSE On DRS appointment import, stamp open DRS appointment as D (Changed); reason picked from DRS file

Definitions to Set Up

Definition Purpose
HPM Trade Code Maintenance Sets trade appointment timeslots for each day of the week
DLO Operative Maintenance Skill Set must be created in Category & General Codes, skill set code must match trade code
HPM Filter Maintenance Sets appointment filter colours by trade or priority, used in HPM Single Order Screen Entry
HPM Contractor Maintenance Alternates grid — set appointment calendar paths by area and trade
HPM Appointment Calendar Location Calendar Path field specifies where appointments are stored/sent

HGM Sequence Maintenance

  • Appointment Sequence Number (APPT_NO) — required for Outlook appointments only; sets the next appointment sequence number
  • Screen: QL Housing → Parameters → HGM General Module → HGM Uniface → HGM Sequence Maintenance