Template Letter MergeFields

Service Infractions uses specific field names to populate MergeField entries.

Merge Field Names that apply to Infractions are used in Infractions tables and Merge Field Names that apply to Letters are used in Letters tables.

Table 1. Description of Template Letter MergeFields
Applies To Merge Field Name Description Stages
Case CaseId Identification number of the case for which the letter is composed. All
Client ClientId Identification number of the client attached to the case. All
Client ClientCode Code associated with the client attached to the case. All
Client Title Honorific (for example, Mr. or Mrs.) of the client attached to the case. All
Client FirstName Client’s first name. All
Client MiddleName Client’s middle name. All
Client LastName Client’s last name. All
Case SuspFromDate Start date of the suspension: today’s date + grace period. Violation Alert, Appeal
Case SuspToDate End date of the suspension: today’s date + grace period. Violation Alert, Appeal
Case TotalFareShortage In ShortFare policies, the total amount of money owed by the client. All
Client StreetNo Street number of the mailing address.

If no mailing address is defined, client home (CH) address information is used. If no CH address is defined, information from the first saved client address is used.

 All
Client OnStreet Street name of the mailing address.

If no mailing address is defined, client home (CH) address information is used. If no CH address is defined, information from the first saved client address is used.

 All
Client Unit Unit number of the mailing address.

If no mailing address is defined, client home (CH) address information is used. If no CH address is defined, information from the first saved client address is used.

 All
Client City City of the mailing address.

If no mailing address is defined, client home (CH) address information is used. If no CH address is defined, information from the first saved client address is used.

 All
Client State State of the mailing address. For example, WA.

If no mailing address is defined, client home (CH) address information is used. If no CH address is defined, information from the first saved client address is used.

 All
Client ZipCode Zip code (or postal code) of the mailing address.

If no mailing address is defined, client home (CH) address information is used. If no CH address is defined, information from the first saved client address is used.

 All
Client Phone Phone number tied to the client address used by Service Infractions.

For example, if the mailing address is used but no phone number is associated with the address, then no phone number is used when the letter is generated.

 All
Client ViolationCount Arabic numeral of the prior suspension count for this client case. All
Client OrdinalViolationCount Ordinal of the suspension count.

For example, 1st, 2nd, 3rd, 4th.

 All
Client ViolationCountWord Written version of the suspension count.

For example, four.

 All
Case SuspendedFor Arabic numeral of the number of days that the client is suspended.

For example, 21.

 Violation Alert, Appeal: Compose Suspension
Case SuspendedForWords Written version of the SuspendedFor number, including the word days.

For example, twenty-one days.

 Violation Alert, Appeal: Compose Suspension
Case SuspendedForDaysWord Written version of the number of days that the client is suspended.

For example, twenty-one.

 Violation Alert, Appeal: Compose Suspension
Case AppealReviewDate Date the appeal was originally created. Appeal
Case LastWarningDate Last date of a delivered warning letter for the client case. Violation Alert, Appeal
Case InfractionCountWord Number of infractions in the client case. All
Case FlaggedPeriodCount For the flag periods case type, this is the number of periods during the policy’s defined lookback horizon that the client surpasses the policy’s infraction or percentage threshold.

The FlaggedPeriodCount is used to determine the violation level.

 All (only flagged period policy)
Case OrdinalFlaggedPeriodCount Ordinal of the flagged period count.

For example, 1st, 2nd, 3rd, 4th.

 All (only flagged period policy)
Case RecentFlaggedPeriod Month of the most recent flagged period, not including the current one. All (only flagged period policy)
Case CurrentFlaggedPeriod Month of the current flagged period (that is, the month of the first infraction in the case). All (only flagged period policy)
Infractions Id Identification number of the infraction in the system. All
Infractions BookingId Booking ID associated with the infraction.

This is typically referred to as Trip ID in Service Infractions.

 All
Infractions SchedStatus Schedule Status of the trip associated with the infraction.

For example, No Show or Late Cancel.

 All
Infractions Occurred Date the infraction occurred. All
Infractions PickUp.StreetNo Street number of the pick-up address associated with the infraction. All
Infractions PickUp.OnStreet Street name of the pick-up address associated with the infraction. All
Infractions PickUp.Unit Unit number of the pick-up address associated with the infraction. All
Infractions PickUp.City City of the pick-up address associated with the infraction. All
Infractions PickUp.State State of the pick-up address associated with the infraction. For example, AK. All
Infractions PickUp.ZipCode Zip code (or postal code) of the pick-up address associated with the infraction. All
Infractions PickUp.Phone Phone number of the pick-up address associated with the infraction. All
Infractions DropOff.StreetNo Street number of the drop-off address associated with the infraction. All
Infractions DropOff.OnStreet Street name of the drop-off address associated with the infraction. All
Infractions DropOff.Unit Unit number of the drop-off address associated with the infraction. All
Infractions DropOff.City City of the drop-off address associated with the infraction. All
Infractions DropOff.State State of the drop-off address associated with the infraction. For example, MN. All
Infractions DropOff.ZipCode Zip code (or postal code) of the drop-off address associated with the infraction. All
Infractions DropOff.Phone Phone number of the drop-off address associated with the infraction. All
Infractions FareShortage In ShortFare policies, the amount of money the client was short when they paid their fare to the driver. All
Infractions FareToCollect In ShortFare policies, the amount of money the driver needed to collect from the client. All
Infractions FareCollected In ShortFare policies, the amount of money the driver actually collected from the client. All
Letters LetterDate For flagged period cases: dates (month/year) of the letters that have been delivered during the time horizon. All (only flag periods policy)
Letters Stage Stage to which the delivered flagged period letters belonged.

For example, Warning, Violation, Appeal.

 All (only flag periods policy)
Letters CaseId Identification number of the case(s) associated with the delivered letters. All (only flag periods policy)
Case AccountBalance (per infraction) EZ-Wallet purse balance after the trip was performed. All (only ShortFare policy with the context property PASS > PassInfoServer > Faring > EnablePrepaid​Faring​Deductions enabled)
Case FareDeducted (per infraction) Amount deducted from the EZ-Wallet purse for the trip. All (only ShortFare policy with the context property PASS > PassInfoServer > Faring > EnablePrepaid​Faring​Deductions enabled)
Case FareShortage (per infraction) Difference between the funds applied to the FareAmount (for example, the client's purse balance, FareCollected amount, and overdraft limit [client overdraft limit or amount defined in the DefaultOverDraftLimit context property]) and the FareAmount. All (only ShortFare policy)
Client OverdraftLimit Client overdraft limit (as shown in the Trapeze4 Workstation, under Task > Clients, on the Detail tab, in the Fare frame, in the Overdraft Limit field).

If the client overdraft is $0.00, the amount defined in the DefaultOverdraftLimit context property is used for calculations in Service Infractions. This amount is not shown in the Overdraft Limit field in the Infractions widget.

 All (only ShortFare policy with the context property PASS > PassInfoServer > Faring > EnablePrepaid​Faring​Deductions enabled)
Client TotalFareShortage Total fare shortage for all confirmed infractions. In Service Infractions, on the Cases tab, in the Infractions widget, this is seen as Confirmed Fare Shortage. All (only ShortFare policy)
Client CurrentAccountBalance Current EZ-Wallet purse balance. All (only ShortFare policy with the context property PASS > PassInfoServer > Faring > EnablePrepaid​Faring​Deductions enabled)