Contract Events: Contract Event Email Placeholders

Event management, coded events, and email notifications

Contract Event Email Placeholders

Download this request form Contract Event Email Request and send it to Catch-e Support if you want to set up a Contract Event Email.

Placeholders

The placeholders listed below are available for use in Contract Event Emails when = pdfcontracteventemailmessage.

The markers ## or {} can be used to create placeholders.
E.g. #contractid# or {contractid} are both valid.

Placeholder Reference List

Driver Details

  • driver_login — Drivers/Contact "Driver Login"

  • driver_id — Drivers/Contact "Driver ID"

  • driveremployeeno — Drivers/Contact "Employee No"

  • drivercontact1name — Drivers/Contact "Given Name"

  • driver_name — Drivers/Contact "Given Name" "Surname"

  • driver_email — Drivers/Contact "Email"

Client Details

  • client_name — Clients/Contact "Name"

  • clientcontact1name — Clients/Contact "Contact 1" Name

  • clientcontact1email — Clients/Contact "Contact 1" Email

  • clientcontact2name — Clients/Contact "Contact 2" Name

  • clientcontact2email — Clients/Contact "Contact 2" Email

  • clientcontact3name — Clients/Contact "A/C Payable" Name

  • clientcontact3email — Clients/Contact "A/C Payable" Email

  • clientcontact4name — Clients/Contact "CC" Name

  • clientcontact4email — Clients/Contact "CC" Email

  • clientcontact5name — Clients/Contact "Payroll" Name

  • clientcontact5email — Clients/Contact "Payroll" Email

  • costcentrecontact — Clients/Cost Centre "Contact" Name

  • costcentreemail — Clients/Cost Centre "Contact" Email

  • costcentrename — Clients/Cost Centre "Contact" Email

Quote Details

  • quoteassignedname — Quotes / Contract "Assigned"

  • quoteassignedemail — Quotes / Contract "Assigned"

  • quotefuelbudget_gross — Quotes / Lease Inclusive "Fuel"

Contract Details

  • contract_id — Contracts Header "Contract ID"

  • contract_description — Contracts/Vehicle "Description"

  • contract_start — Contracts/Contract Start

  • contract_end — Contracts/Billing "Contract ID"

  • contractsuspenddate — Contracts/Contract "Suspend Date"

  • contractsuspenddate_2busdays — calculated date

  • contractsuspenddate_5days — calculated date

  • contractsuspenddate_14days — calculated date

  • annual_kms — Contracts/Contract Km (calculation = / term * 12)

  • finance_ref — Contracts/Finance "Finance Ref"

  • periodic_interval — Contracts/Billing “Periodic Interval”

  • quote_id — Contracts/Order "Quote Number"

  • regexpirydate — Contracts/Vehicle "Expiry"

  • reg_no — Contracts/Contract "Reg Number"

  • start_periodic — Contracts/Billing “Start Periodic”

Contract Events Email

  • eventactionid — Contracts/Events "Action"

  • event_amount — Contracts/Events "Amount"

  • eventcontractid — Contracts Header "Contract ID"

  • eventcompletedflag — Contracts/Events "Completed"

  • event_date

  • event_description — Contracts/Events "Description"

  • eventduedate — Contracts/Events "Due Date"

  • eventmessagetype

  • eventrecordid

  • eventtablename

  • event_value — Contracts/Events "Value"

Contract Registration Label Contact

  • reglabelemail — Points to "Send Reg Label To" selection (Client/Lease Type)

  • reglabelname — Points to "Send Reg Label To" selection (Client/Lease Type)

Contract Suppliers

  • broker_email — Suppliers/Detail "Email"

  • broker_name — Contracts/Finance "Broker"

  • dealer_email — Suppliers/Detail "Email"

  • dealer_name — Contracts/Vehicle "Supplier"

  • etag_email — Suppliers/Detail "Email"

  • etag_name — Contracts/Contract "Tag Supplier"

  • financier_email — Suppliers/Detail "Email"

  • financier_name — Contracts/Finance "Financier"

  • financier _phone — Suppliers/Detail "Phone"

  • insurer_email — Suppliers/Detail "Email"

  • insurer_name — Contracts/Insurance "Insurer"

  • roadside_email — Suppliers/Detail "Email"

  • roadside_name — Contracts/Vehicle "Roadside Supplier"

Other Details

  • date_filter

  • accountmanagername — Clients/Contact "A/C Manager"

  • accountmanageremail — Users/Details "Email" (A/C Manager user)

  • sender_direct — Users/Details "Direct"

  • sender_email — Users/Details "Email"

  • sender_fax — Users/Details "Fax"

  • senderfullname — Users/Details "Name"

  • senderjobtitle — Users/Details "Job Title"

  • sender_mobile — Users/Details "Mobile"

  • sender_phone — Users/Details "Phone"

  • sender_organisation — Users/Details "Organisation"

Due Off Quote Manager Details

  • dueoffquotemanagername — Users/Details "Name"

  • dueoffquotemanagerjob_title — Users/Details "Job Title"

  • dueoffquotemanageremail — Users/Details "Email"

  • dueoffquotemanagermobile — Users/Details "Mobile"

  • dueoffquotemanagerphone — Users/Details "Phone"

  • dueoffquotemanagerorganisation — Users/Details "Organisation"

Events Report

The Events Report uses the same report template as:

Fleet / Administration / Events → Contracts screen

Use filters to select required reports.

Key Differences

This report differs from the Events / Contracts report because it shows:

  • Driver Name

  • Cost Centre

  • Division

From the event record, not the contract.

This means historical values are used instead of current contract values.

If multiple cost centres or divisions exist for the same day, the last created record is used (excluding deleted events).

Report Distribution

  • Can be emailed to clients via scheduler job

  • Refer to System Reports page for configuration details

Left Column Filters

  • As at (Date) — includes contracts starting on or before date; excludes suspended on or before date

  • Manager (List) — filter by A/C Manager

  • Group (List) — filter by Client Group

  • Client (List Box) — multi-select clients using Ctrl / Shift

  • Contract Type (List Box) — multi-select contract types

  • Report Queue (Checkbox) — sends report to queue instead of immediate download

Right Column Filters

  • Cost Centre (List) —

    • Default: All

    • Blank option available

    • Filtered by Group/Client selection

Events Emails Troubleshooting

Email escape character issue

If an event email shows a \ before an apostrophe:

  • This is a display artifact in the Contracts / Events pop-up

  • It is NOT stored in the email

  • It does NOT appear in Mail Queue or recipient email

To verify:

  • Check email in Mail Queue

Event Query

An eventQuery scheduled job can create contract or driver events.

  • One event is created per query row

  • Suitable for high-volume automated processes

  • Managed via gb_queries table

Contact Catch-e support to configure.

How it works

  • Query is saved in gb_queries

  • Selected in scheduler job setup

  • Must include required event fields

Scheduler Parameters

  • Query ID — selects query definition

  • Event Table — determines event type (read-only)

  • Event Type — selects event within table

Event Table Rules

Query Attribute

Event Table

Purpose

eventcontractid

Contract

Contract events

eventclientid

Client

Client events

eventdriverid

Driver

Driver events

Error Conditions

  • Missing key field → CATCHEEVENTKEYNOT_DEFINED

  • Multiple key fields → CATCHEEVENTMULTIPLEKEYS

Contract Events (Query Fields)

Configurable fields

  • eventcontractid — Mandatory contract ID

  • event_value — optional

  • event_description — optional (defaults to posting class description)

  • event_amount — optional

  • eventactionid — optional

  • eventduedate — optional

  • eventcompletedflag — default YES

  • eventtablename — optional

System fields (not configurable)

  • CURDATE → system date

  • NULL → optional attachment placeholder

  • 100000 → system user (admin)

Driver Events

Configurable fields

  • eventdriverid — Mandatory

  • event_value — optional

  • event_description — optional

  • eventduedate — optional

  • eventcompletedflag — default YES

Example query

Creates driver event for quotes:

  • Trigger: quotes in last day with status "sent"

  • Follow-up: +2 days

  • Includes quote ID in event value

Client Events

Configurable fields

  • eventclientid — Mandatory

  • event_value — optional

  • event_description — optional

  • eventactionid — optional

  • eventduedate — optional

  • eventlastedit — optional

  • eventuserid_edit — optional override user

  • eventcompletedflag — default YES

System field

  • attachment_id — NULL unless report attached

Client Events Screen

Overview

Allows reporting and management of client events.

Features

  • Default view: Incomplete Only

  • Filter by event type

  • Mark events as Completed

  • CSV and PDF export

  • Attachment viewing via paperclip icon

  • Navigate via Client Code

Event Types

  • Client Request

  • Insurance Base Premium

  • Insurance Claims History Amount

  • Insurance Number of Cars for claims history

  • Meeting

  • Note

  • Sales Call

  • Telephone

  • Regular Visit

Stored in fmclientevents.

Field Descriptions

  • Client Code

  • Type

  • Date

  • Value

  • Description (100 chars)

  • Action (Closed / Follow Up / None / Urgent)

  • Due Date

  • Completed

  • Attachment

  • Last Edit

  • User

Actions

  • Print

  • Delete

  • Edit

  • Attach

  • New