DriverMate Settings

The DriverMate settings use an ID instead of a local (Language) specific name. The setting ID is unique and cannot be changed. (These settings are not compatible with those of DriverMate classic.)

The settings chart includes a Friendly Name, however this name has no effect on the settings.

The settings are configured in the DriverMateXam.json file.

ID Friendly Name Description Default
1000 No Show Wait Time Sets the time in seconds that the driver must wait after arriving a pick-up event before the No Show option is available. 120 seconds
1010 No Show Enable If set to false, then the No Show functionality is enabled, otherwise, No Show button or No Show Timer button is hidden. true
1011 No Show Remove Trip If enabled, both the pick-up and drop-off events are automatically removed if the dispatch system hasn't removed the trip in the amount of time set in No Show Remove Trip Time. false
1012 No Show Remove TripTime Sets the time in seconds that the application waits for the dispatch system to remove an event before automatically removing both the pick-up and drop-off events. 30 seconds
1020

Fare Collect Enable

(Dependent on Fare Modify Enable)

If false, then the user is not prompted to collect any fares.

If Fare Modify Enable is set to false (disabled), then Fare Collect Enable is ignored, that is, the user is not prompted to collect fare.

false
1030 Fare Modify Enable If enabled, allows the user to modify the fare amount in the Fare Collection pop-up window. It requires Fare Collect Enable (1020) to be enabled. true
1040 Event Time For Break Used for Time Display Customization.

Events in PASS can contain up to 10 different time stamps. This feature allows you to customize how and which times are displayed on the tablet's event manifest screen and on the event details screen.

Events
  • Break
  • Lunch
  • User Breaks
Est: %0
1050 Default Event Time For Break Used for Time Display Customization.

Events in PASS can contain up to 10 different time stamps. This feature allows you to customize how and which times are displayed on the tablet's event manifest screen and on the event details screen.

Events
  • Break
  • Lunch
  • User Breaks
Note:
There are situations where PASS does not fill in the time values. DriverMate then scans the time string to see if any of the desired event times actually contain a time value. If it determines that none of the event times have values, it uses the time string settings identified as Default, for example, Default Event Time For Break. Typically, it is the estimated time but you can specify any value you want.
%0
1060 Event Time For Dropoff Used for Time Display Customization.

Events in PASS can contain up to 10 different time stamps. This feature allows you to customize how and which times are displayed on the tablet's event manifest screen and on the event details screen.

Events
  • Drop-off
  • Escort Drop-off
  • Transfer Drop-off
Appt: %6
1070 Default Event Time For Dropoff Used for Time Display Customization.

Events in PASS can contain up to 10 different time stamps. This feature allows you to customize how and which times are displayed on the tablet's event manifest screen and on the event details screen.

Events
  • Drop-off
  • Escort Drop-off
  • Transfer Drop-off
Appt: %0
1080 Event Time For Pickup Used for Time Display Customization.

Events in PASS can contain up to 10 different time stamps. This feature allows you to customize how and which times are displayed on the tablet's event manifest screen and on the event details screen.

Events
  • Pickup
  • Escort Pickup
  • Transfer Pick-up
%2 to %3
1090 Default Event Time For Pickup Pickup

Escort Pickup

Transfer Pick-up

%0
1100 Event Time For Pullout Pull-out Est: %0
1110 Default Event Time For Pullout Pull-out %0
1120 Event Time For Pullin Pull-in Sch: %1
1130 Default Event Time For Pullin Pull-in %0
1140 Event Time For Node Flex Node

Flex Stop

Used for Time Display Customization.

Events in PASS can contain up to 10 different time stamps. This feature allows you to customize how and which times are displayed on the tablet's event manifest screen and on the event details screen.

Sch: %1
1141 Default Event Time for Node Used for Time Display Customization.

Events in PASS can contain up to 10 different time stamps. This feature allows you to customize how and which times are displayed on the tablet's event manifest screen and on the event details screen.

%1
1150 Event Time For Stop

Flex Stop

Est: %0
1160 Event Time For Other

Assist

Event Based Booking

Ferry Arrive

Ferry Depart

Flagstop Dropoff

Layover

Mobility Aid Dropoff

Mobility Aid Pickup

Out Of Service

Refuel

Relief

Return

Est: %0
1170 Default Event Time For Other %0
1200 Group Sort Rule

Sets the order of the trips shown in the Group Trips screen:

0 = Event Order

1 = Client Last Name

2 = Client First Name

1
1210 Odometer Entry Required Setting is a bit mask so that it can be combined to select any combination. Following are the combinations that are supported:

0 = Not Required

1 = Login (default)

3 = Login + Arrive

5 = Login + Logoff

7 = Login + Arrive + Logoff

Login
1220 Odometer in Tenths Sets the display format for Odometer entry. If enabled, the odometer value is shown as an integer or with one decimal in kilometers or miles. false
1230 Unit system Sets how some values are displayed on the screen. For example, if set to Imperial then Odometer values are in Miles.
  • 0 = Metric
  • 1 = Imperial
1
1240 Odometer Entry Start Value

The setting is used in the Login screen only.

1 = Last Known (This refers to the value from the Odometer field in the DeviceXam.json file.)

2 = Zero

3 = Blank

3
1250 Login Odometer Hide If enabled, the ODOMETER entry is hidden.

This setting is ignored when the Odometer Entry Required is not set to 0.

false
1260 Login Run Hide If enabled, the RUN entry is hidden.

The Max Length of Run values is 8 characters.

true
1270 Login PIN Hide If enabled, the PIN entry is hidden.

The Max Length of Pin values is 8 characters.

false
1280 Close Button Show/Hide the "Close" button on the Login screen

true = Show

false = Hide

true
1290 Passenger Add Enabled If enabled, the Add Passenger button is displayed. false
1300 Passenger Remove Enabled If enabled, the Remove button is displayed.
Attention:
This field requires 1020 (Fare Collect Enable) enabled.
false
1310 Passenger Fare Type Modify Enable If enabled, the Fare Type of a passenger or companion can be modified when the passenger or companion is selected.
Attention:
This field requires 1020 (Fare Collect Enable) enabled.
false
1320 Passenger Count Modify Enable If enabled, the Passenger Count of a passenger or companion can be modified once the passenger or companion is selected. false
1330 Passenger Type Modify Enable If enabled, the Passenger Type of a passenger or companion can be modified once the passenger or companion is selected. false
1340 Passenger Space Type Modify Enable If enabled, the Space Type of a passenger or companion can be modified once the passenger or companion is selected. false
1350 Arrive Distance Check If enabled, the target distance constraint is set. The Arrive button is not enabled unless the GPS target is met.

If enabled and DriverMate does not have a valid GPS for more than 30 seconds, then the location constraint is suppressed until a GPS location is acquired. This is to allow the driver to continue to arrive trips when GPS is not available.

false
1351 Arrive Report Records the time and odometer when the vehicle first enters the arrive target radius (set using Arrive Distance Threshold). false
1360 Arrive Distance in Meters When Arrive Distance Check is on, this sets the distance (in meters) that the vehicle must be within on arrival. 1000
1370 Arrive Time Check If enabled, the time constraint is set. The Arrive button is not enabled unless the time target is met. false
1380 Arrive Start Time Offset Sets the number of minutes by which the start time is adjusted. For example, if the start time is set as the Scheduled Early Time, then the time constraint will be the Scheduled Early Time - Arrive Start Time Offset. 15
1390 Cancel At Door Enabled If enabled, then the Cancel at Door functionality is enabled, otherwise, the Cancel At Door button is hidden. true
1400 Cancel At Door Remove Trip If enabled, both the pick-up and drop-off events are removed immediately from the Manifest screen when the driver clicks the Cancel At Door button. Otherwise, it will wait for the confirmation from the server. true
1410 Client Fare Type Modify Enable If enabled, the Fare type of client can be modified once the pick-up trip is arrived. false
1420 Client Space Type Modify Enable If enabled, the Space type of client can be modified once the pick-up trip is arrived. false
1425 Client Eligibility Condition Type Enable Displays the client's eligibility codes in the details screen. false
1450 Client Pictures Enable If enabled, when DriverMate receives a client picture ID from MDT Server, it requests the photo and displays it on the details screen. false
1460 Drive Screen Debounce The number of seconds that the drive screen will remain displayed after the motion sensor transitions to not moving.

The valid range is 0 - 60 seconds.

15 seconds
1470 Drive Screens Logged In A comma separated string indicating which drive screens should be displayed while the driver is logged into DriverMate while the vehicle is in motion.
Possible values are:
  1. Clock - Shows current time.
  2. Event - Shows the next trip in the manifest.

If no value is selected and the Motion Sensor is enabled, the Clock screen is displayed. If both values are selected, when the vehicle is moving, the Clock screen is displayed first. When the driver taps the screen, the Event screen is displayed.

Clock
1490 End Of Day Enable The End Of Day Summary functionality is used to provide a summary to the driver regarding their performance at the end of that day.

If enabled. the driver can request an End of Day report from Trapeze PASS after performing a pull-in event.

false
1500 End Of Day Max Wait Time The amount of time, in seconds to wait for a reply from the server when requesting an End of Day Summary. 30 seconds
1510 Payment Multiple Enable Enables multiple payment screens that are used with EZ-Wallet DriverMate X. false
1520 Fare Use Client Number Controls whether to multiply the amounts by the passenger counts with EZ-Wallet DriverMate X. false
1530 Payment On Dropoff Enable Controls whether to allow payment on drop off instead of on pickup with EZ-Wallet DriverMate X. false
1540 Event Notifications Enable If enabled, pop-up event notifications are used. true
1550 GPS Report Distance (m) Sets the distance in meters when an AVL report is generated. The minimum is 10m. If the distance is less than 10m, then DriverMate applies 10m. 500m
1560 GPS Report Interval (s) Sets the time in seconds when an AVL report is generated. The minimum is 5 seconds. If the time set is less than 5 seconds, then DriverMate applies 5 seconds. The maximum is 300 seconds. If the time is set to more than 300 seconds, then DriverMate applies 300 seconds. 30 seconds
1563 GPS Odometer Verbose Logging Enables verbose logging for GPS odometer related data.
CAUTION:
This is an advanced setting and requires a deep understanding of how DriverMate works and may have a large impact if not set properly. Do not modify this setting without first ensuring that the impact is fully understood.
false
1570 Group Trips Enable If enabled, trips are grouped together automatically based on time and location constraints. true
1580 Group Perform Confirmation If enabled (true), when using Perform All, the driver must confirm the group perform. false
1590 Group Perform Time Window The time window in minutes for how to treat the continuous trips as a group event based on their estimated times. 10
1600 Lock MDT ID on Login Screen If enabled, the MDT ID entry is disabled. This setting is ignored when the MDT ID is not set, for example, set to 0.

Login screen settings are in the DriverMateXam.json and DeviceXam.json files.

false
1610 Motion Sensor Enable If enabled, the speed sensor detects if the vehicle is in motion and creates events for DriverMate when the vehicle transitions between moving states. true
1620 Motion Sensor Threshold Sets the speed (in kilometers per hour) when the vehicle is considered moving.

The valid range is between 4 kph to 18 kph.

15 kph
1630 Motion Sensor Debounce Enter Sets the number of seconds that the speed must be over the Speed Sensor Threshold before the vehicle is considered in motion.

The valid range is between 0 to 60 seconds.

3 seconds
1640 Motion Sensor Debounce Exit Sets the number of seconds that the speed must be under the Speed Sensor Threshold before the vehicle is considered not in motion.

The valid range is between 0 to 60 seconds.

3 seconds
1650 Driver Messages The messages to be displayed to the driver if the functionality is enabled. This can only be modified through the DriverMateXam.json file.
1660 New Message Alert Sets the notification sound that is played when a driver alert is displayed:

0 = None (default)

1 = Enable audio chime

2 = Enable 2 second vibration

3 = Enable both audio and vibration

0
1670 New Message Alert Duration Sets time in seconds of how long audio or vibration is played.
Note:
The device hardware must support vibration.
300 seconds
1680 New Message Alert Interval Sets how often audio or vibration is repeated within the alert duration. 60 seconds
1690 NFS If the NFS is not empty, it enables the NFS (No Fare Slip) check that asks the client to pay full fare or has an NFS payment type with EZ-Wallet. blank
1700 TraceLevel Logging trace level for DriverMate. 3
1710 Transfer Fare Zero If enabled, the collected fare is always zero. false
1720 Trip Confirmation Timeout Sets time in seconds until trip insertion and modification notifications are allowed. The timer is reset for the following conditions:
  • Log in
  • Renew Manifest
60
1730 Connection Timeout (seconds)

Sets the time, in seconds, that a login attempt waits for authentication.

30
1740 XGate Connection URL URL or IP address of the XGate server
1750 Message Time To Live Sets the time that XGate continues to try and deliver a message to the XGate server for timed message.

Not all messages are affected by this setting.

The minimum is 10 seconds. If set less than 10 seconds, then DriverMate applies 10 seconds.

30 seconds
1760 XGate Remote Port IP port of the XGate server.
1780 XGate Ping Interval Sets the rate in seconds that ping messages are sent to the XGate5 server when there is no active channel.

The minimum value is 10 seconds. If set to less than 10, DriverMate uses 10 seconds.

The maximum value is 300 seconds (5 minutes). If set to more than 300, DriverMate uses 300 seconds.

30 seconds
1790 XGate Max Idle Interval Sets the rate in seconds that ping messages are sent to the XGate5 server when there is an active channel.

The minimum value is 10 seconds. If set to less than 10, DriverMate uses 10 seconds.

The maximum value is 300 seconds (5 minutes). If set to more than 300, DriverMate uses 300 seconds.

Note:
If the Max Idle Interval is set lower than the ping interval, then the pings are sent at the Max Idle interval.
30 seconds
1800 XGate Certificate Thumbprint A comma separated string that contains the thumbprint of each certificate created by the agency.
1801 Enable XGate Thumbprint Enables or disables checking of the thumbprint when establishing a connection to XGate. false
1810 Driver Message Enable If enabled, messages regarding driver safety and privacy rules (for example, HIPAA) are displayed every time the Login button is pressed. The user must press the Accept button to be able to log in and use DriverMate. true
1820 Driver Message Timeout Sets the time, in seconds, when the safety message is displayed before returning to the Logon screen.

The acceptable range is 30 to 120 seconds. If a value outside of this range is entered, DriverMate reverts to the default value.

60
1840 Renew Manifest If enabled, the Renew Manifest option is shown in the menu when the manifest screen is open.
1900 VoIP Function Enable VoIP settings.
Attention:
VoIP requires additional licenses to be enabled. Speak to your Trapeze Representative for additional licenses and setup of VoIP with DriverMate.
false
1910 SIP Domain VoIP settings.
Important:
VoIP requires additional licenses to be enabled. Speak to your Trapeze Representative for additional licenses and setup of VoIP with DriverMate.
false
1920 Dispatch Phone Number VoIP settings.
Important:
VoIP requires additional licenses to be enabled. Speak to your Trapeze Representative for additional licenses and setup of VoIP with DriverMate.
false
2000 Walk-On Passenger Enable Supports the Walk-On Passenger feature. Enabling this feature allows drivers to process walk-on passengers as they board their vehicle, in order to then drop them off at specific, pre-defined stops without overly impacting any existing trips on their manifest. false
2100 MJM Payment Enable MJM Settings false
2110 MJM Merchant ID MJM Settings blank
2120 MJM Gateway URI MJM Settings blank
2200 Address Layout Determines how the address format is displayed:
  • 0 = <Street No.> <Street Name>
  • 1 = <Street Name>, <Street No.>
  • 2 = <Street No.> <Street Name>, <Unit>
  • 3 = <Street Name>, <Street No.>, <Unit>
0
2210 Address Unit Prefix Sets the prefix for the unit number within the address.

Example: 1034 Brighton Tower,<Unit Prefix> 13

blank
2500 Client Callout Offset Number of minutes before the estimated (Est) time to send a call out.

If the current time is earlier than the time window, then the event is not a candidate for a call out.

Example: If the Est time is 13:00 and the time window is 10 minutes, then at 12:50 or any later time before 13:00,the event is a candidate for a call out.
5 minutes

Range: 1 to 120

2501 Client Callout Radius Radius of the call out target area centered on the event's GPS target.

The distance in meters from the location that the vehicle has to be within in order to send a call out.

If the vehicle is within the radius, then the event is a candidate for a call out.

1000 meters

Range: 100 to 100000

2502 Client Callout Enable

Enables the Client Callout feature.

If set to True, and trigger conditions met, DriverMate will generate a reminder message to the server. When the server receives the reminder message, it will generate the appropriate interactive voice response (IVR) call to the client.

If set to False(disabled), then all the client call out IVR messages will be disabled, even if the SendReminder flag is set.

false
2510 Location Search Method The method by which to search for locations when navigating Google Maps.

0 = GPS Co-ordinates

1 = Name + Address

2 = Address

0
2600 Flex Stop Functionality This enables and disables the Flex Stop functionality.
To use the functionality, this setting must be the string Summary (case insensitive) since the default value is empty.
Attention:
Both the WalkonPassengerEnable (2000) and Flex Stop Functionality (2600) cannot be enabled at same time. If WalkonPassengerEnable is enabled, DriverMate will disable the Flex Stop Functionality.
Empty
2610 Flex Stop Default Passenger Type If a default Passenger Type is provided, make sure it exists in the database, for example, CLI. Empty
2611 Flex Stop Default Space Type If a default Space Type is provided, make sure it exists in the database, for example, AM Empty
2612 Flex Stop Default Fare Type If a default Fare Type is provided, make sure it exists in the database, for example, STA.

If the FareCollectEnable setting is enabled, then DriverMate will prompt all Fare Types for the driver to select from, and then the selected Fare Type (with its rate) will be applied to the boarding passenger.

Empty
2613 Flex Stop Default Fare Type Only Enable If the Flex Stop Default Fare Type Only Enable (2613) is enabled, ensure that Flex Stop Default Fare Type (2612) has a valid Fare Type defined.

If the FareCollectEnable is enabled, then a Flat Rate of the Default Fare Type will be applied to all boarding passengers.

False
2620 Flex Stop Auto Arrive Perform Enable Enable/Disables Flex Stop Auto Arrive Perform.

By default, when the vehicle enters the radius (Flex Stop Auto Arrive Perform Distance Threshold) of the destination, the Stop/Node event will be arrived automatically. When the vehicle exits the radius of the arrived location, the Stop/Node event will be performed automatically. If the setting is False, then nothing will happen.

True
2621 Flex Stop Auto Arrive Perform Distance Threshold The distance threshold in meters for Flex Stop Arrive Perform 1000
3000 Local Notification Enable If set to True,

Local Notifications feature is enabled.

Local notifications allows DriverMate to ask the hosting OS (Android, iOS, etc.) to present a notification to the user and perform specific actions when tapped. When enabled, it can provide critical information to the driver when DriverMate is in the background.
false
3300 Emergency Enable Show/Hide the Emergency button
If set to true, then the Emergency Icon shows in the following screens:
  • Main
  • Details
  • End of Day
  • Group
  • Map
  • Node Details
  • Non Client Details

Otherwise, the Emergency icon is removed from those pages.

true
5000 Clock Format Controls the format for all displayed times.
  • 12 - Displayed as 12 hour time with AM/PM.
  • 24 - Displayed as 24 hour time.

    Times do not have leading zeros.

12