1

Download the latest release of the MyGeotab API Adapter from GitHub (i.e. following Steps 1-3 in the Using Published Release from GitHub section). The files to download are:

1. MyGeotabAPIAdapter_SCD_win-x64.zip
2. SQLServer.zip

Once downloaded, extract the contents of the zip files.

2

Setup the database (following Steps 1-3 in the SQL Server database setup section):

3

Configure and deploy the MyGeotab API Adapter application (following Steps 1-4 in the Deploy section):

Start Time

Topic

1:23

Intro to the MyGeotab API Adapter

5:41

How to Download and Deploy a Published Release of the Adapter (with SQL Server)

22:38

Database Maintenance & Suggested Strategy

25:40

Understanding the Database Through Examples

26:35

Logging - Example Showing How to Use Logging to Debug a Configuration Issue

31:15

Download Source Code and Code Walk-Through (for developers)

31:49

Download/Clone the Git Repository

33:54

Open the Solution in Visual Studio

35:07

Solution Architecture

37:12

Application Logic

39.06

Code Walk-Through for Developers

1:14:58

Publishing the MyGeotab API Adapter

1:18:18

DVIRLog Manipulator (Bi-Directional Workflow)

Table Name

Category

Description

BinaryData

Feed data

Contains data corresponding to MyGeotab BinaryData objects.

ChargeEvents

Feed data

Contains data corresponding to MyGeotab ChargeEvent objects.

Conditions

Reference data

Contains data corresponding to MyGeotab Condition objects.

DebugData

Feed data

Contains data corresponding to MyGeotab DebugData objects.

Devices

Reference data

Contains data corresponding to MyGeotab Device objects.

DeviceStatusInfo

Reference data

Contains data corresponding to MyGeotab DeviceStatusInfo objects.

Diagnostics

Reference data

Contains data corresponding to MyGeotab Diagnostic objects.

DriverChanges

Feed data

Contains data corresponding to MyGeotab DriverChange objects.

DutyStatusAvailabilities

Reference data

Contains data corresponding to MyGeotab DutyStatusAvailability objects.

DutyStatusLogs

Feed data

Contains data corresponding to MyGeotab DutyStatusLog objects.

DVIRDefectRemarks

Reference data

Contains data corresponding to MyGeotab DefectRemark objects.

DVIRDefects

Reference data

Contains data corresponding to defects associated with DVIRLogs. It includes data derived from MyGeotab DVIRLog, DVIRDefect, Defect and Group objects.

DVIRDefectUpdates

Commands

May be used to send DVIRDefect updates to the MyGeotab database with which the adapter is configured to communicate. See the DVIRLog Manipulator section for more information.

DVIRLogs

Feed data

Contains data corresponding to MyGeotab DVIRLog objects.

ExceptionEvents

Feed data

Contains data corresponding to MyGeotab ExceptionEvent objects.

FailedDVIRDefectUpdates

Command exceptions

Contains copies of any records that were inserted into the DVIRDefectUpdates table and did not result in successful updates of DVIRDefects in the MyGeotab database. The FailureMessage column provides details about the reason why a given command failed. See the DVIRLog Manipulator section for more information.

FaultData

Feed data

Contains data corresponding to MyGeotab FaultData objects.

LogRecords

Feed data

Contains data corresponding to MyGeotab LogRecord objects.

MyGeotabVersionInfo

System info

Contains software version information (obtained from MyGeotab API VersionInformation) about the MyGeotab server and database that the subject adapter database is associated with via the MyGeotab API Adapter.

OServiceTracking

System info

System table used by the MyGeotab API Adapter.

Rules

Reference data

Contains data corresponding to MyGeotab Rule objects.

StatusData

Feed data

Contains data corresponding to MyGeotab StatusData objects.

Trips

Feed data

Contains data corresponding to MyGeotab Trip objects.

Users

Reference data

Contains data corresponding to MyGeotab User objects.

ZoneTypes

Reference data

Contains data corresponding to MyGeotab ZoneType objects.

Zones

Reference data

Contains data corresponding to MyGeotab Zone objects.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

BinaryType

nvarchar(50)

Yes

The BinaryDataType.

ControllerId

nvarchar(50)

No

The Id of the Controller associated with the subject BinaryData.

Data

nvarchar(1024)

No

The binary data for the subject BinaryData object.

DateTime

datetime2(7)

Yes

The date and time of the logging of the data.

DeviceId

nvarchar(50)

Yes

The Id of the Device (in the Devices table) associated with the subject BinaryData.

Version

nvarchar(50)

Yes

The version of the entity.

RecordCreationTimeUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating when the subject record was added to the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

ChargeIsEstimated

bit

No

Indicates whether the charge values were estimated.

ChargeType

nvarchar(50)

No

The ChargeType provided by the external power source.

StartTime

datetime2(7)

No

The date and time at which the ChargeEvent started.

DeviceId

nvarchar(50)

No

The Id of the Device (in the Devices table) associated with the subject ChargeEvent.

DurationTicks

bigint

No

The length of time the vehicle was charging as measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

EndStateOfCharge

float

Yes

The ending state of charge for this ChargeEvent.

EnergyConsumedKwh

float

Yes

The energy consumed during the ChargeEvent.

EnergyUsedSinceLastChargeKwh

float

Yes

The amount of energy drawn from the battery since the last ChargeEvent.

Latitude

float

Yes

The latitude of the location where the ChargeEvent occurred.

Longitude

float

Yes

The longitude of the location where the ChargeEvent occurred.

MaxACVoltage

float

Yes

The maximum AC Voltage over the ChargeEvent.

MeasuredBatteryEnergyInKwh

float

Yes

The amount of energy in measured during charging.

MeasuredBatteryEnergyOutKwh

float

Yes

The amount of energy out measured during charging.

MeasuredOnBoardChargerEnergyInKwh

float

Yes

The total amount of energy in measured on board during charging.

MeasuredOnBoardChargerEnergyOutKwh

float

Yes

The total amount of energy out measured on board during charging.

PeakPowerKw

float

Yes

The peak power used during the ChargeEvent.

StartStateOfCharge

float

Yes

The starting state of charge for this ChargeEvent.

TripStop

datetime2(7)

Yes

The time of the Trip.Stop from the Trip this ChargeEvent occurred in.

Version

bigint

No

The version of the entity.

RecordCreationTimeUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating when the subject record was added to the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

ParentId

nvarchar(50)

Yes

The Id of the parent Condition, if the subject Condition has a parent.

RuleId

nvarchar(50)

Yes

The Id of the Rule (in the Rules table), with which the subject Condition is associated.

ConditionType

nvarchar(50)

No

The ConditionType of the subject Condition.

DeviceId

nvarchar(50)

Yes

The Id of the Device (in the Devices table) associated with the subject Condition.

DiagnosticId

nvarchar(100)

Yes

The Id of the Diagnostic associated with the subject Condition.

DriverId

nvarchar(50)

Yes

The Id of the Driver (corresponding to the Id in the Users table) associated with the subject Condition.

Value

float

Yes

The specified value that the subject Condition evaluates against.

WorkTimeId

nvarchar(50)

Yes

The Id of the WorkTime that the event must occur inside/outside of for the violation to occur.

ZoneId

nvarchar(50)

Yes

The Id of the Zone associated with the subject Condition.

EntityStatus

int

No

Indicates whether the subject corresponding object is active or deleted in the MyGeotab database. 1 = Active. 0 = Deleted.

RecordLastChangedUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating the last time that the subject record was updated in the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

Data

nvarchar(max)

No

The binary data for the subject DebugData object.

DateTime

datetime2(7)

Yes

The date and time of the logging of the data.

DebugReasonId

bigint

Yes

The numeric value of the enumerator representing the reason for the DebugData record. Used for troubleshooting/debugging purposes only.

DebugReasonName

nvarchar(255)

Yes

The alphanumeric value of the enumerator representing the reason for the DebugData record. Used for troubleshooting/debugging purposes only.

DeviceId

nvarchar(50)

Yes

The Id of the Device (in the Devices table) associated with the subject DebugData.

DriverId

nvarchar(50)

Yes

The Id of the Driver (corresponding to the Id in the Users table) associated with the subject DebugData.

RecordCreationTimeUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating when the subject record was added to the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

ActiveFrom

datetime2(7)

Yes

The date the device is active from.

ActiveTo

datetime2(7)

Yes

The date the device is active to.

Comment

nvarchar(1024)

Yes

Free text field where any user information can be stored and referenced for this entity.

DeviceType

nvarchar(50)

No

Specifies the GO or Custom DeviceType.

LicensePlate

nvarchar(50)

Yes

The vehicle license plate details of the vehicle associated with the device.

LicenseState

nvarchar(50)

Yes

The state or province of the vehicle associated with the device.

Name

nvarchar(100)

No

The display name assigned to the device.

ProductId

int

Yes

The product Id. Each device is assigned a unique hardware product Id.

SerialNumber

nvarchar(12)

Yes

The serial number of the device.

VIN

nvarchar(50)

Yes

The Vehicle Identification Number (VIN) of the vehicle associated with the device.

EntityStatus

int

No

Indicates whether the subject corresponding object is active or deleted in the MyGeotab database. 1 = Active. 0 = Deleted.

RecordLastChangedUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating the last time that the subject record was updated in the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

Bearing

float

No

The bearing (heading) in int degrees.

Valued between 0 and 359 inclusive. 0 represents North, 90 represents East, and so on. -1 represents unknown bearing.

CurrentStateDuration

nvarchar(50)

No

The duration between the last Trip state change (i.e. driving or stop), and the most recent date of location information.

DateTime

datetime2(7)

No

The most recent DateTime of the latest piece of status, GPS or fault data.

DeviceId

nvarchar(50)

No

The Id of the Device (in the Devices table) associated with the subject DeviceStatusInfo.

DriverId

nvarchar(50)

No

The Id of the Driver (corresponding to the Id in the Users table) associated with the subject DeviceStatusInfo.

IsDeviceCommunicating

bit

No

A value indicating whether the Device is communicating.

IsDriving

bit

No

A value indicating whether the current Device state. If set true, is driving. Otherwise, it is stopped.

IsHistoricLastDriver

bit

No

Indicates whether the Device has been assigned to "UnknownDriver" and the last Trip Driver is represented in the DriverId column.

Latitude

float

No

The last known latitude of the Device.

Longitude

float

No

The last known longitude of the Device.

Speed

real

No

The current vehicle speed (in km/h).

NaN represents an invalid speed.

RecordLastChangedUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating the last time that the subject record was updated in the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(100)

No

The unique identifier for the specific Entity object in the Geotab system.

GeotabGUID

nvarchar(100)

No

The underlying Globally Unique Identifier (GUID) of the Diagnostic. In the event that the GeotabId changes as a result of the assignment of a KnownId, this GeotabGUID will remain unchanged and can be used for reconciliation of Diagnostic Ids in any downstream integrations.

HasShimId

boolean

No

Indicates whether the Diagnostic is one that has a KnownId on the MyGeotab server side, but is unknown in the MyGeotab .NET API client (Geotab.Checkmate.ObjectModel NuGet package) used at the time of download.

FormerShimGeotabGUID

nvarchar(100)

Yes

If there is an earlier version of the Diagnostic where HasShimId is true, this value lists the GeotabGUID of that earlier Diagnostic so that the two, along with any associated data, can be logically related.

ControllerId

nvarchar(100)

No

The Id of the Controller related to the diagnostic; if applicable.

DiagnosticCode

int

Yes

The diagnostic parameter code number.

DiagnosticName

nvarchar(255)

No

The name of this entity that uniquely identifies it and is used when displaying this entity.

DiagnosticSourceId

nvarchar(50)

No

The Id of the Source of the Diagnostic.

DiagnosticSourceName

nvarchar(255)

No

The Name of the Source of the Diagnostic.

DiagnosticUnitOfMeasureId

nvarchar(50)

No

The Id of the UnitOfMeasure used by the Diagnostic.

DiagnosticUnitOfMeasureName

nvarchar(255)

No

The Name of the UnitOfMeasure used by the Diagnostic.

OBD2DTC

nvarchar(50)

Yes

The OBD-II Diagnostic Trouble Code (DTC), if the Diagnostic is from an OBD Source.

EntityStatus

int

No

Indicates whether the subject corresponding object is active or deleted in the MyGeotab database. 1 = Active. 0 = Deleted.

RecordLastChangedUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating the last time that the subject record was updated in the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

DateTime

datetime2(7)

No

The date and time of the driver change.

DeviceId

nvarchar(50)

No

The Id of the Device (in the Devices table) associated with the subject DriverChange.

DriverId

nvarchar(50)

No

The Id of the Driver (corresponding to the Id in the Users table) associated with the subject DriverChange.

Type

nvarchar(50)

No

The DriverChangeType.

Version

bigint

No

The version of the entity.

RecordCreationTimeUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating when the subject record was added to the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

DriverId

nvarchar(50)

No

The Id of the Driver (corresponding to the Id in the Users table) associated with the subject DutyStatusAvailability record.

CycleAvailabilities

nvarchar(max)

Yes

Cycle available to the driver in the future. Presented in the form of a JSON array (e.g. [{"DateTime":"2021-01-14T05:00:00Z","Available":"00:00:00"},{"DateTime":"2021-01-15T05:00:00Z","Available":"00:00:00"},{"DateTime":"2021-01-16T05:00:00Z","Available":"00:00:00"},{"DateTime":"2021-01-17T05:00:00Z","Available":"00:00:00"},{"DateTime":"2021-01-18T05:00:00Z","Available":"20:18:55.6430000"},{"DateTime":"2021-01-19T05:00:00Z","Available":"1.20:18:55.6430000"},{"DateTime":"2021-01-20T05:00:00Z","Available":"2.12:00:00"}]).

CycleTicks

bigint

Yes

The duration of cycle hours left as measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

CycleRestTicks

bigint

Yes

The duration left before cycle rest must be taken. Measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

DrivingTicks

bigint

Yes

The duration left for driving. Measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

DutyTicks

bigint

Yes

The duration of total on-duty time left in the day. Measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

DutySinceCycleRestTicks

bigint

Yes

The duty hours left since Cycle Rest. Measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

Is16HourExemptionAvailable

bit

Yes

Indicates whether 16 hour exemption is available.

IsAdverseDrivingExemptionAvailable

bit

Yes

Indicates whether adverse driving exemption is available.

IsOffDutyDeferralExemptionAvailable

bit

Yes

Indicates whether off-duty deferral exemption is available.

Recap

nvarchar(max)

Yes

Chronological array representing each day's On-duty time since the beginning of cycle. Presented in the form of a JSON array (e.g. [{"DateTime":"2021-01-07T05:00:00Z","Duration":"1.00:00:00"},{"DateTime":"2021-01-08T05:00:00Z","Duration":"1.00:00:00"},{"DateTime":"2021-01-09T05:00:00Z","Duration":"1.00:00:00"},{"DateTime":"2021-01-10T05:00:00Z","Duration":"1.00:00:00"},{"DateTime":"2021-01-11T05:00:00Z","Duration":"1.00:00:00"},{"DateTime":"2021-01-12T05:00:00Z","Duration":"1.00:00:00"},{"DateTime":"2021-01-13T05:00:00Z","Duration":"15:41:04.3570000"}]).

RestTicks

bigint

Yes

The duration left before rest break must be taken. Measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

WorkdayTicks

bigint

Yes

The duration of workday left in a day. Workday is a consecutive window that begins with first on-duty. Measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

RecordLastChangedUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating the last time that the subject record was updated in the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

Annotations

nvarchar(max)

Yes

The list of AnnotationLog(s) which are associated with this log.

CoDrivers

nvarchar(max)

Yes

The list of the co-driver User(s) (in the Devices table) for this log.

DateTime

datetime2(7)

No

The date and time the log was created.

DeferralMinutes

int

Yes

The deferral minutes.

DeferralStatus

nvarchar(50)

Yes

The DutyStatusDeferralType.

DeviceId

nvarchar(50)

Yes

The Id of the Device (in the Devices table) associated with the subject DutyStatusLog.

DistanceSinceValidCoordinates

real

Yes

The distance since last valid coordinate measurement.

DriverId

nvarchar(50)

Yes

The Id of the User (corresponding to the Id in the Users table) who created this log.

EditDateTime

datetime2(7)

Yes

The date and time the log was edited. If the log has not been edited, this will not be set.

EditRequestedByUserId

nvarchar(50)

Yes

The Id of the User (corresponding to the Id in the Users table) that requested an edit to this log.

EngineHours

float

Yes

The engine hours for the DeviceId at the DateTime of this log. The unit is seconds (not hours).

EventCheckSum

bigint

Yes

The event checksum of this log.

EventCode

int

Yes

The event code of this log (Table 6; 7.20 of the ELD Final Rule).

EventRecordStatus

int

Yes

The record status number of this log 1 = active 2 = inactive - changed 3 = inactive - change requested 4 = inactive - change rejected.

EventType

int

Yes

The event type number of this log 1 = A change in driver's duty-status 2 = An intermediate log 3 = A change in driver's indication of authorized personal use of CMV or yard moves 4 = A driver's certification/recertification of records 5 = A driver's login/logout activity 6 = CMV's engine power up / shut down activity 7 = A malfunction or data diagnostic detection occurrence (Table 6; 7.25 of the ELD Final Rule).

IsHidden

bit

Yes

Indicates whether the log is hidden.

IsIgnored

bit

Yes

If the log is ignored. True means it will not affect the Driver's HOS availability.

IsTransitioning

bit

Yes

A value indicating whether the log is in transitioning state.

Location

nvarchar(max)

Yes

An object with the location information for the log data.

LocationX

float

Yes

The longitude of the Location.

LocationY

float

Yes

The latitude of the Location.

Malfunction

nvarchar(50)

Yes

The DutyStatusMalfunctionTypes of this DutyStatusLog record. As a flag it can be both a diagnostic and malfunction state which is used to mark status based records (e.g. "D", "SB") as having a diagnostic or malfunction present at time of recording.

Odometer

float

Yes

The odometer in metres for the DeviceId at the DateTime of this log.

Origin

nvarchar(50)

Yes

The DutyStatusOrigin from where this log originated

ParentId

nvarchar(50)

Yes

The Id of the parent DutyStatusLog. Used when a DutyStatusLog is edited. When returning history, this field will be populated.

Sequence

bigint

Yes

The sequence number, which is used to generate the sequence ID.

State

nvarchar(50)

Yes

The DutyStatusState of the DutyStatusLog record.

Status

nvarchar(50)

Yes

The DutyStatusLogType representing the driver's duty status.

UserHosRuleSet

nvarchar(max)

Yes

The linked UserHosRuleSet. Only used to link rulesets to log events that affect the driver's operating zone and/or cycle. (Canadian ELD)

VerifyDateTime

datetime2(7)

Yes

The date and time the log was verified. If the log is unverified, this will not be set.

Version

bigint

No

The version of the entity.

RecordCreationTimeUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating when the subject record was added to the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

DVIRDefectId

nvarchar(50)

No

The Id of the DVIRDefect (in the DVIRDefects table) that the remark applies to.

DateTime

datetime2(7)

Yes

The date and time the remark was created.

Remark

nvarchar(max)

No

The remark text.

RemarkUserId

nvarchar(50)

Yes

The Id of the User (in the Users table) who created the remark.

EntityStatus

int

No

Indicates whether the subject corresponding object is active or deleted in the MyGeotab database. 1 = Active. 0 = Deleted.

RecordLastChangedUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating the last time that the subject record was updated in the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the DVIRDefect object in the Geotab system.

DVIRLogId

nvarchar(50)

No

The Id of the DVIRLog (in the DVIRLogs table) with which the subject DVIRDefect is associated.

DefectListAssetType

nvarchar(50)

Yes

The asset type of the defect list.

DefectListId

nvarchar(50)

Yes

The Id of the defect list (Group) that the defect belongs to.

DefectListName

nvarchar(255)

Yes

The Name of the defect list (Group) that the defect belongs to.

PartId

nvarchar(50)

Yes

The Id of the part (Group) that has the defect.

PartName

nvarchar(255)

Yes

The Name of the part (Group) that has the defect.

DefectId

nvarchar(50)

Yes

The Id of the Defect.

DefectName

nvarchar(255)

Yes

The Name of the Defect.

DefectSeverity

nvarchar(50)

Yes

The DefectSeverity of the Defect.

RepairDateTime

datetime2(7)

Yes

The date and time the DVIRDefect was repaired.

RepairStatus

nvarchar(50)

Yes

The RepairStatusType of this DVIRDefect.

RepairUserId

nvarchar(50)

Yes

The Id of the User (in the Users table) who repaired this DVIRDefect.

EntityStatus

int

No

Indicates whether the subject corresponding object is active or deleted in the MyGeotab database. 1 = Active. 0 = Deleted.

RecordLastChangedUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating the last time that the subject record was updated in the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

DVIRLogId

nvarchar(50)

No

The Id of the DVIRLog with which the subject DVIRDefect is associated.

DVIRDefectId

nvarchar(50)

No

The Id of the DVIRDefect that is to be updated in the Geotab system.

RepairDateTime

datetime2(7)

Yes

The date and time the DVIRDefect was repaired.

RepairStatus

nvarchar(50)

Yes

The RepairStatusType of this DVIRDefect.

RepairUserId

nvarchar(50)

Yes

The Id of the User who repaired this DVIRDefect.

Remark

nvarchar(max)

Yes

The remark text.

RemarkDateTime

datetime2(7)

Yes

The date and time the remark was created.

RemarkUserId

nvarchar(50)

Yes

The Id of the User who created the remark.

RecordCreationTimeUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating when the subject record was added to the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

CertifiedByUserId

nvarchar(50)

Yes

The Id of the User (in the Users table) who certified the repairs (or comments, if no repairs were made) to the Device or Trailer.

CertifiedDate

datetime2(7)

Yes

The date and time that the Device or Trailer was certified.

CertifyRemark

nvarchar(max)

Yes

The remark recorded by the User who certified the repairs (or no repairs made) to the Device or Trailer.

DateTime

datetime2(7)

No

The date and time the log was created.

DeviceId

nvarchar(50)

Yes

The Id of the Device (in the Devices table) associated with the subject DVIRLog.

DriverId

nvarchar(50)

Yes

The Id of the User (in the Users table) who created the log.

DriverRemark

nvarchar(max)

Yes

The remark recorded by the driver for this log.

IsSafeToOperate

bit

Yes

Indicates whether the Device or Trailer was certified as safe to operate.

LocationLatitude

float

Yes

The latitude of the location of the log.

LocationLongitude

float

Yes

The longitude of the location of the log.

LogType

nvarchar(50)

Yes

The DVIRLogType of the log.

RepairDate

datetime2(7)

Yes

The date and time the Device or Trailer was repaired.

RepairedByUserId

nvarchar(50)

Yes

The Id of the User (in the Users table) who repaired the Device or Trailer.

TrailerId

nvarchar(50)

Yes

The Id of the Trailer associated with the log.

TrailerName

nvarchar(255)

Yes

The Name of the Trailer associated with the log.

Version

bigint

No

The version of the entity.

RecordCreationTimeUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating when the subject record was added to the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

ActiveFrom

datetime2(7)

Yes

The start date and time of the ExceptionEvent; at or after this date and time.

ActiveTo

datetime2(7)

Yes

The end date and time of the ExceptionEvent; at or before this date and time.

DeviceId

nvarchar(50)

Yes

The Id of the Device (in the Devices table) associated with the subject ExceptionEvent.

Distance

real

Yes

The distance (in KMs) travelled since the start of the ExceptionEvent.

DriverId

nvarchar(50)

Yes

The Id of the Driver (corresponding to the Id in the Users table) associated with the subject ExceptionEvent.

DurationTicks

bigint

Yes

The duration of the ExceptionEvent as measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

LastModifiedDateTime

datetime2(7)

No

The last time this ExceptionEvent was updated (in the MyGeotab database).

RuleId

nvarchar(50)

Yes

The Id of the Rule (corresponding to the Id in the Rules table) that was broken to trigger the subject ExceptionEvent.

State

int

No

The ExceptionEventState of the subject ExceptionEvent. 0 = Valid. 1 = Invalid. 2 = Dismissed.

Version

bigint

Yes

The version of the entity.

RecordLastChangedUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating when the subject record was added to the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

DVIRDefectUpdateId

bigint

No

The value of the id field for the original row in the DVIRDefectUpdates table that resulted in the failure.

DVIRLogId

nvarchar(50)

No

The Id of the DVIRLog with which the subject DVIRDefect is associated.

DVIRDefectId

nvarchar(50)

No

The Id of the DVIRDefect that was to be updated in the Geotab system.

RepairDateTime

datetime2(7)

Yes

The date and time the DVIRDefect was repaired.

RepairStatus

nvarchar(50)

Yes

The RepairStatusType of this DVIRDefect.

RepairUserId

nvarchar(50)

Yes

The Id of the User who repaired this DVIRDefect.

Remark

nvarchar(max)

Yes

The remark text.

RemarkDateTime

datetime2(7)

Yes

The date and time the remark was created.

RemarkUserId

nvarchar(50)

Yes

The Id of the User who created the remark.

FailureMessage

nvarchar(max)

Yes

The reason why this record failed to result in an update of the subject DVIRDefect in the MyGeotab database.

RecordCreationTimeUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating when the subject record was added to the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

AmberWarningLamp

bit

Yes

Indicates whether the amber warning lamp is on.

ClassCode

nvarchar(50)

Yes

The DtcClass code of the fault.

ControllerId

nvarchar(100)

No

The Id of the Controller related to the fault code; if applicable.

ControllerName

nvarchar(255)

Yes

The Name of the Controller related to the fault code; if applicable.

Count

int

No

The number of times the fault occurred.

DateTime

datetime2(7)

Yes

The date and time at which the event occurred.

DeviceId

nvarchar(50)

No

The Id of the Device (in the Devices table) associated with the subject FaultData.

DiagnosticId

nvarchar(100)

No

The Id of the Diagnostic (in the Diagnostics table) associated with the subject FaultData.

DismissDateTime

datetime2(7)

Yes

The date and time that the fault was dismissed.

DismissUserId

nvarchar(50)

Yes

The Id of the User (in the Users table) associated with the subject FaultData entity.

FailureModeCode

int

Yes

The Failure Mode Identifier (FMI) associated with the FailureMode.

FailureModeId

nvarchar(50)

No

The Id of the FailureMode associated with the subject FaultData entity.

FailureModeName

nvarchar(255)

Yes

The Name of the FailureMode associated with the subject FaultData entity.

FaultLampState

nvarchar(50)

Yes

The FaultLampState of a J1939 vehicle.

FaultState

nvarchar(50)

Yes

The FaultState code from the engine system of the specific device.

MalfunctionLamp

bit

Yes

Indicates whether the malfunction lamp is on.

ProtectWarningLamp

bit

Yes

Indicates whether the protect warning lamp is on.

RedStopLamp

bit

Yes

Indicates whether the red stop lamp is on.

Severity

nvarchar(50)

Yes

The DtcSeverity of the fault.

SourceAddress

int

Yes

The source address for enhanced faults.

RecordCreationTimeUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating when the subject record was added to the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

DateTime

datetime2(7)

No

The date and time the log was recorded.

DeviceId

nvarchar(50)

No

The Id of the Device (in the Devices table) associated with the subject LogRecord.

Latitude

float

No

The latitude of the log record.

Longitude

float

No

The longitude of the log record.

Speed

real

No

The logged speed or an invalid speed (in km/h).

RecordCreationTimeUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating when the subject record was added to the adapter database.

Field Name

Data Type

Nullable

Description

DatabaseName

nvarchar(58)

No

The name of the MyGeotab database.

Server

nvarchar(50)

No

The server on which the MyGeotab database resides.

DatabaseVersion

nvarchar(50)

No

The current version of the MyGeotab databases on the server.

ApplicationBuild

nvarchar(50)

No

The MyGeotab application build.

ApplicationBranch

nvarchar(50)

No

The MyGeotab application branch.

ApplicationCommit

nvarchar(50)

No

The MyGeotab application commit.

GoTalkVersion

nvarchar(50)

No

The Text to Speech firmware version provided by the server.

RecordCreationTimeUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating when the subject record was added to the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

ServiceId

nvarchar(50)

No

An identifier for the subject service.

AdapterVersion

nvarchar(50)

Yes

The version of the MyGeotab API Adapter that the subject service is a part of.

AdapterMachineName

nvarchar(100)

Yes

The name of the machine/server that is hosting the MyGeotab API Adapter instance that the subject service is a part of.

EntitiesLastProcessedUtc

datetime2(7)

Yes

A timestamp, in Coordinated Universal Time (UTC), indicating the last time that the subject service processed any entities (data).

LastProcessedFeedVersion

bigint

Yes

If applicable and the subject service uses the GetFeed method, the ToVersion of the last batch of records retrieved by the subject service.

RecordLastChangedUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating the last time that the subject record was updated in the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

ActiveFrom

datetime2(7)

Yes

Start date and time of the Rule's notification activity period.

ActiveTo

datetime2(7)

Yes

End date and time of the Rule's notification activity period.

BaseType

nvarchar(50)

Yes

The ExceptionRuleBaseType of the Rule.

Comment

nvarchar(max)

Yes

Free text field where any user information can be stored and referenced for this entity.

Name

nvarchar(255)

Yes

The name of the rule entity that uniquely identifies it and is used when displaying this entity.

Version

bigint

No

The version of the entity.

EntityStatus

int

No

Indicates whether the subject corresponding object is active or deleted in the MyGeotab database. 1 = Active. 0 = Deleted.

RecordLastChangedUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating the last time that the subject record was updated in the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

Data

float

Yes

The recorded value of the diagnostic parameter.

DateTime

datetime2(7)

Yes

The date and time of the logged event.

DeviceId

nvarchar(50)

No

The Id of the Device (in the Devices table) associated with the subject StatusData.

DiagnosticId

nvarchar(100)

No

The Id of the Diagnostic (in the Diagnostics table) associated with the subject StatusData.

RecordCreationTimeUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating when the subject record was added to the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

AfterHoursDistance

real

Yes

The distance the vehicle was driven after work hours (in km).

AfterHoursDrivingDurationTicks

bigint

Yes

The duration the vehicle was driven after work hours as measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

AfterHoursEnd

bit

Yes

Whether the trip ends after hours.

AfterHoursStart

bit

Yes

Whether the trip starts after hours.

AfterHoursStopDurationTicks

bigint

Yes

The duration the vehicle was stopped after work hours as measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

AverageSpeed

real

Yes

Average speed in km/h. This only includes the average speed while driving.

DeviceId

nvarchar(50)

No

The Id of the Device (in the Devices table) associated with the subject Trip.

Distance

real

No

The distance the vehicle was driven during the trip (in km).

DriverId

nvarchar(50)

No

The Id of the Driver (corresponding to the Id in the Users table) associated with the subject Trip.

DrivingDurationTicks

bigint

No

The duration between the start and stop of the trip as measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

IdlingDurationTicks

bigint

Yes

Total end-of-trip idling (idling is defined as speed being 0 with ignition on). It is calculated from the beginning of the current trip to the beginning of the next trip. Measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

MaximumSpeed

real

Yes

The maximum speed of the vehicle during this trip (in km/h).

NextTripStart

datetime2(7)

No

The start date and time of the next trip.

SpeedRange1

int

Yes

The number of incidents where the vehicle reached the first range of speeding triggers.

SpeedRange1DurationTicks

bigint

Yes

The duration where the vehicle drove in the first range of speeding triggers as measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

SpeedRange2

int

Yes

The number of incidents where the vehicle reached the second range of speeding triggers.

SpeedRange2DurationTicks

bigint

Yes

The duration where the vehicle drove in the second range of speeding triggers as measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

SpeedRange3

int

Yes

The number of incidents where the vehicle reached the third range of speeding triggers.

SpeedRange3DurationTicks

bigint

Yes

The duration where the vehicle drove in the third range of speeding triggers as measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

Start

datetime2(7)

No

The date and time that the trip started.

Stop

datetime2(7)

No

The date and time the trip stopped.

StopDurationTicks

bigint

No

The duration the vehicle was stopped at the end of the trip. This also includes any idling done at the end of a trip. Measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

StopPointX

float

Yes

The longitude of the Coordinate at which the Trip stopped.

StopPointY

float

Yes

The latitude of the Coordinate at which the Trip stopped.

WorkDistance

real

Yes

The distance the vehicle was driven during work hours (in km).

WorkDrivingDurationTicks

bigint

Yes

The duration the vehicle was driven during work hours as measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

WorkStopDurationTicks

bigint

Yes

The duration the vehicle was stopped during work hours as measured in ticks. A tick is equal to 100 nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond and 10 million ticks in a second.

RecordCreationTimeUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating when the subject record was added to the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

ActiveFrom

datetime2(7)

No

The date the user is active from.

ActiveTo

datetime2(7)

No

The date the user is active to.

EmployeeNo

nvarchar(50)

Yes

The employee number or external identifier.

FirstName

nvarchar(255)

Yes

The first name of the user.

HosRuleSet

nvarchar(255)

Yes

The HosRuleSet the user follows. Default: None.

IsDriver

bit

No

Indicates whether the user is classified as a driver.

LastAccessDate

datetime2(7)

Yes

A timestamp, in Coordinated Universal Time (UTC), indicating the last time that the subject user accessed the MyGeotab system.

LastName

nvarchar(255)

Yes

The last name of the user.

Name

nvarchar(255)

No

The user's email address / login name.

EntityStatus

int

No

Indicates whether the subject corresponding object is active or deleted in the MyGeotab database. 1 = Active. 0 = Deleted.

RecordLastChangedUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating the last time that the subject record was updated in the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(100)

No

The unique identifier for the specific Entity object in the Geotab system.

Comment

nvarchar(255)

Yes

A free text field where any user information can be stored and referenced for this entity.

Name

nvarchar(255)

No

The name of this entity that uniquely identifies it and is used when displaying this entity.

EntityStatus

int

No

Indicates whether the subject corresponding object is active or deleted in the MyGeotab database. 1 = Active. 0 = Deleted.

RecordLastChangedUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating the last time that the subject record was updated in the adapter database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the adapter database table. Entirely unrelated to the Geotab system.

GeotabId

nvarchar(50)

No

The unique identifier for the specific Entity object in the Geotab system.

ActiveFrom

datetime2(7)

Yes

The date the zone is active from.

ActiveTo

datetime2(7)

Yes

The date the zone is active to.

CentroidLatitude

float

Yes

The latitude of the geographic centre of the zone.

CentroidLongitude

float

Yes

The longitude of the geographic centre of the zone.

Comment

nvarchar(500)

Yes

A free text field where any user information can be stored and referenced for this entity.

Displayed

bit

Yes

A value indicating whether this zone must be displayed when viewing a map or it should be hidden.

ExternalReference

nvarchar(255)

Yes

Any type of external reference to be attached to the zone. May be used to link zones with corresponding entities in other systems.

MustIdentifyStops

bit

Yes

Indicates whether this zone name must be shown when devices stop in this zone. If true, a "zone stop rule" (Rule with BaseType: ZoneStop) will automatically be created for this zone. This is to facilitate reporting on zone stops. The rule is not visible via the MyGeotab UI.

Name

nvarchar(255)

No

The name of this entity that uniquely identifies it and is used when displaying this entity.

Points

nvarchar(max)

Yes

The list of points (see Coordinate) that make up the zone. A zone should be closed (i.e. the first point should consist of the same set of coordinates as the last point). Presented in the form of a JSON array (e.g. [{"X":-79.68085479736328,"Y":43.517887115478516},{"X":-79.6830825805664,"Y":43.51841354370117},{"X":-79.6854019165039,"Y":43.5172004699707},{"X":-79.68214416503906,"Y":43.51369857788086},{"X":-79.6794204711914,"Y":43.51435470581055},{"X":-79.68085479736328,"Y":43.517887115478516}]).

ZoneTypeIds

nvarchar(max)

No

The Id(s) of the ZoneType(s) that this zone belongs to. Presented in the form of a JSON array (e.g. [{"Id":"ZoneTypeOfficeId"},{"Id":"ZoneTypeCustomerId"}]). Ids correspond to GeotabId values in the ZoneTypes table.

Version

bigint

Yes

The version of the entity.

EntityStatus

int

No

Indicates whether the subject corresponding object is active or deleted in the MyGeotab database. 1 = Active. 0 = Deleted.

RecordLastChangedUtc

datetime2(7)

No

A timestamp, in Coordinated Universal Time (UTC), indicating the last time that the subject record was updated in the adapter database.

2022-10-30 22:16:28.9799|INFO|"******** PAUSING SERVICE: MyGeotabAPIAdapter.StatusDataProcessor (v2.0.0.0) because of the following:

> The prerequisite DeviceProcessor and DiagnosticProcessor have never been run.

> The prerequisite DeviceProcessor and DiagnosticProcessor are not currently running.

Please ensure that all prerequisite processors are running. The MyGeotabAPIAdapter.StatusDataProcessor (v2.0.0.0) will check again at 2022-10-31 2:16:38 AM (UTC) and will resume operation if all prerequisite processors are running at that time.

Service

Direct Service Dependencies

BinaryDataProcessor

DeviceProcessor

ControllerProcessor

DeviceProcessor

DeviceStatusInfoProcessor

DeviceProcessor, UserProcessor

DiagnosticProcessor

DriverChangeProcessor

DeviceProcessor, UserProcessor

DutyStatusAvailabilityProcessor

UserProcessor

DVIRLogManipulator

DVIRLogProcessor

DVIRLogProcessor

DeviceProcessor, UserProcessor

ExceptionEventProcessor

DeviceProcessor, RuleProcessor, UserProcessor

FailureModeProcessor

FaultDataProcessor

ControllerProcessor, DeviceProcessor, DiagnosticProcessor, FailureModeProcessor

GroupProcessor

LogRecordProcessor

DeviceProcessor

RuleProcessor

StatusDataProcessor

DeviceProcessor, DiagnosticProcessor

TripProcessor

DeviceProcessor, UserProcessor

UnitOfMeasureProcessor

UserProcessor

ZoneProcessor

ZoneTypeProcessor

Setting

Description

DisableMachineNameValidation

Indicates whether machine name validation should be disabled. In most cases, the value should be false. It can be set to true only in cases where the application is deployed to a hosted environment in which machine names are not guaranteed to be static.

WARNING! Extreme caution must be used when setting this value to true! Improper deployment could lead to application instability and data integrity issues!

Setting

Description

DatabaseProviderType

The database provider. Must be one of SQLServer, PostgreSQL or Oracle.

DatabaseConnectionString

The database connection string (e.g. Server=<Server>;Database=geotabadapterdb;User Id=geotabadapter_client;Password=<password>;MultipleActiveResultSets=True;TrustServerCertificate=True).

Setting

Description

MyGeotabServer

The MyGeotab server (e.g. my.geotab.com).

MyGeotabDatabase

The name of the MyGeotab database to authenticate against.

WARNING! It is not possible to mix data from multiple MyGeotab databases within a single MyGeotab API Adapter database. Once data has been added to the adapter database, it is not possible to change the MyGeotabDatabase setting.

MyGeotabUser

The username to be used for authentication.

MyGeotabPassword

The password associated with the MyGeotab user.

Setting

Description

TimeoutSecondsForDatabaseTasks

The maximum number of seconds allowed for an individual adapter database operation (select, insert, update, delete) to complete. If a database operation does not complete within this amount of time, it will be assumed that there is a loss of connectivity, the existing operation will be rolled-back and the MyGeotab API Adapter will resume normal operation after establishing that there is connectivity to the adapter database (e.g. 30). Minimum: 10. Maximum: 3600.

TimeoutSecondsForMyGeotabTasks

The maximum number of seconds allowed for a MyGeotab API call to wait for a response. If a response is not received within this amount of time, it will be assumed that there is a loss of connectivity, the existing operation will be rolled-back and the MyGeotab API Adapter will resume normal operation after establishing that there is connectivity to the MyGeotab database via API (e.g. 30). Minimum: 10. Maximum: 3600.

Setting

Description

EnableControllerCache

Indicates whether the data feed for the subject entity type should be enabled. Must be set to either true or false.

ControllerCacheIntervalDailyReferenceStartTimeUTC

The UTC time of day to serve as the basis upon which cache update and refresh times are calculated using the associated interval settings (e.g. 2020-06-23T06:00:00Z).

ControllerCacheUpdateIntervalMinutes

The frequency, in minutes, by which the subject cache should be "updated" - capturing new and changed objects (e.g. 360). Minimum: 1. Maximum: 10080 (1 week).

ControllerCacheRefreshIntervalMinutes

The frequency, in minutes, by which the subject cache should be "refreshed" - dumped and repopulated to make identification of deleted entities possible, since deletes do not propagate from MyGeotab through the MyGeotab API data feeds (e.g. 1440). Minimum: 60 (1 hour). Maximum: 10080 (1 week).

Setting

Description

EnableDeviceCache

Indicates whether the data feed for the subject entity type should be enabled. Must be set to either true or false.

DeviceCacheIntervalDailyReferenceStartTimeUTC

The UTC time of day to serve as the basis upon which cache update and refresh times are calculated using the associated interval settings (e.g. 2020-06-23T06:00:00Z).

DeviceCacheUpdateIntervalMinutes

The frequency, in minutes, by which the subject cache should be "updated" - capturing new and changed objects (e.g. 360). Minimum: 1. Maximum: 10080 (1 week).

DeviceCacheRefreshIntervalMinutes

The frequency, in minutes, by which the subject cache should be "refreshed" - dumped and repopulated to make identification of deleted entities possible, since deletes do not propagate from MyGeotab through the MyGeotab API data feeds (e.g. 1440). Minimum: 60 (1 hour). Maximum: 10080 (1 week).

Setting

Description

EnableDiagnosticCache

Indicates whether the data feed for the subject entity type should be enabled. Must be set to either true or false.

DiagnosticCacheIntervalDailyReferenceStartTimeUTC

The UTC time of day to serve as the basis upon which cache update and refresh times are calculated using the associated interval settings (e.g. 2020-06-23T06:00:00Z).

DiagnosticCacheUpdateIntervalMinutes

The frequency, in minutes, by which the subject cache should be "updated" - capturing new and changed objects (e.g. 360). Minimum: 1. Maximum: 10080 (1 week).

DiagnosticCacheRefreshIntervalMinutes

The frequency, in minutes, by which the subject cache should be "refreshed" - dumped and repopulated to make identification of deleted entities possible, since deletes do not propagate from MyGeotab through the MyGeotab API data feeds (e.g. 1440). Minimum: 60 (1 hour). Maximum: 10080 (1 week).

Setting

Description

DVIRDefectListCacheRefreshIntervalMinutes

The frequency, in minutes, by which the subject cache should be "refreshed" - dumped and repopulated to make identification of deleted entities possible, since deletes do not propagate from MyGeotab through the MyGeotab API data feeds (e.g. 1440). Minimum: 60 (1 hour). Maximum: 10080 (1 week).

Setting

Description

EnableFailureModeCache

Indicates whether the data feed for the subject entity type should be enabled. Must be set to either true or false.

FailureModeCacheIntervalDailyReferenceStartTimeUTC

The UTC time of day to serve as the basis upon which cache update and refresh times are calculated using the associated interval settings (e.g. 2020-06-23T06:00:00Z).

FailureModeCacheUpdateIntervalMinutes

The frequency, in minutes, by which the subject cache should be "updated" - capturing new and changed objects (e.g. 360). Minimum: 1. Maximum: 10080 (1 week).

FailureModeCacheRefreshIntervalMinutes

The frequency, in minutes, by which the subject cache should be "refreshed" - dumped and repopulated to make identification of deleted entities possible, since deletes do not propagate from MyGeotab through the MyGeotab API data feeds (e.g. 1440). Minimum: 60 (1 hour). Maximum: 10080 (1 week).

Setting

Description

EnableGroupCache

Indicates whether the data feed for the subject entity type should be enabled. Must be set to either true or false.

GroupCacheIntervalDailyReferenceStartTimeUTC

The UTC time of day to serve as the basis upon which cache update and refresh times are calculated using the associated interval settings (e.g. 2020-06-23T06:00:00Z).

GroupCacheUpdateIntervalMinutes

The frequency, in minutes, by which the subject cache should be "updated" - capturing new and changed objects (e.g. 360). Minimum: 1. Maximum: 10080 (1 week).

GroupCacheRefreshIntervalMinutes

The frequency, in minutes, by which the subject cache should be "refreshed" - dumped and repopulated to make identification of deleted entities possible, since deletes do not propagate from MyGeotab through the MyGeotab API data feeds (e.g. 1440). Minimum: 60 (1 hour). Maximum: 10080 (1 week).

Setting

Description

EnableRuleCache

Indicates whether the data feed for the subject entity type should be enabled. Must be set to either true or false.

RuleCacheIntervalDailyReferenceStartTimeUTC

The UTC time of day to serve as the basis upon which cache update and refresh times are calculated using the associated interval settings (e.g. 2020-06-23T06:00:00Z).

RuleCacheUpdateIntervalMinutes

The frequency, in minutes, by which the subject cache should be "updated" - capturing new and changed objects (e.g. 360). Minimum: 1. Maximum: 10080 (1 week).

RuleCacheRefreshIntervalMinutes

The frequency, in minutes, by which the subject cache should be "refreshed" - dumped and repopulated to make identification of deleted entities possible, since deletes do not propagate from MyGeotab through the MyGeotab API data feeds (e.g. 1440). Minimum: 60 (1 hour). Maximum: 10080 (1 week).

Setting

Description

EnableUnitOfMeasureCache

Indicates whether the data feed for the subject entity type should be enabled. Must be set to either true or false.

UnitOfMeasureCacheIntervalDailyReferenceStartTimeUTC

The UTC time of day to serve as the basis upon which cache update and refresh times are calculated using the associated interval settings (e.g. 2020-06-23T06:00:00Z).

UnitOfMeasureCacheUpdateIntervalMinutes

The frequency, in minutes, by which the subject cache should be "updated" - capturing new and changed objects (e.g. 360). Minimum: 1. Maximum: 10080 (1 week).

UnitOfMeasureCacheRefreshIntervalMinutes

The frequency, in minutes, by which the subject cache should be "refreshed" - dumped and repopulated to make identification of deleted entities possible, since deletes do not propagate from MyGeotab through the MyGeotab API data feeds (e.g. 1440). Minimum: 60 (1 hour). Maximum: 10080 (1 week).

Setting

Description

EnableUserCache

Indicates whether the data feed for the subject entity type should be enabled. Must be set to either true or false.

UserCacheIntervalDailyReferenceStartTimeUTC

The UTC time of day to serve as the basis upon which cache update and refresh times are calculated using the associated interval settings (e.g. 2020-06-23T06:00:00Z).

UserCacheUpdateIntervalMinutes

The frequency, in minutes, by which the subject cache should be "updated" - capturing new and changed objects (e.g. 360). Minimum: 1. Maximum: 10080 (1 week).

UserCacheRefreshIntervalMinutes

The frequency, in minutes, by which the subject cache should be "refreshed" - dumped and repopulated to make identification of deleted entities possible, since deletes do not propagate from MyGeotab through the MyGeotab API data feeds (e.g. 1440). Minimum: 60 (1 hour). Maximum: 10080 (1 week).

Setting

Description

EnableZoneCache

Indicates whether the data feed for the subject entity type should be enabled. Must be set to either true or false.

ZoneCacheIntervalDailyReferenceStartTimeUTC

The UTC time of day to serve as the basis upon which cache update and refresh times are calculated using the associated interval settings (e.g. 2020-06-23T06:00:00Z).

ZoneCacheUpdateIntervalMinutes

The frequency, in minutes, by which the subject cache should be "updated" - capturing new and changed objects (e.g. 360). Minimum: 1. Maximum: 10080 (1 week).

ZoneCacheRefreshIntervalMinutes

The frequency, in minutes, by which the subject cache should be "refreshed" - dumped and repopulated to make identification of deleted entities possible, since deletes do not propagate from MyGeotab through the MyGeotab API data feeds (e.g. 1440). Minimum: 60 (1 hour). Maximum: 10080 (1 week).

Setting

Description

EnableZoneTypeCache

Indicates whether the data feed for the subject entity type should be enabled. Must be set to either true or false.

ZoneTypeCacheIntervalDailyReferenceStartTimeUTC

The UTC time of day to serve as the basis upon which cache update and refresh times are calculated using the associated interval settings (e.g. 2020-06-23T06:00:00Z).

ZoneTypeCacheUpdateIntervalMinutes

The frequency, in minutes, by which the subject cache should be "updated" - capturing new and changed objects (e.g. 360). Minimum: 1. Maximum: 10080 (1 week).

ZoneTypeCacheRefreshIntervalMinutes

The frequency, in minutes, by which the subject cache should be "refreshed" - dumped and repopulated to make identification of deleted entities possible, since deletes do not propagate from MyGeotab through the MyGeotab API data feeds (e.g. 1440). Minimum: 60 (1 hour). Maximum: 10080 (1 week).

Setting

Description

FeedStartOption

Alternate ways that polling via data feeds may be initiated. Must be set to one of the following values:

1. CurrentTime: Data feeds will be started from the current point in time.
2. SpecificTime: Data feeds will be started at the specific point in time (in the past) specified by the FeedStartSpecificTimeUTC parameter.
3. FeedVersion: Each data feed will be started at the specific version captured in the OServiceTracking table in the adapter database. If the data feed for a specific object type has not yet been run, it will start at version zero, effectively allowing the feed to pull all of the respective data from the database.

CAUTION! If any data has already been captured for a given feed, as determined by the existence of a corresponding entry in the OServiceTracking table in the adapter database, the FeedStartOption will automatically switch to FeedVersion - overriding any other value that may have been set. This mechanism is in place to avoid issues related to data duplication or gaps.

FeedStartSpecificTimeUTC

Only used if the FeedStartOption parameter is set to SpecificTime. The UTC time (formatted as yyyy-MM-ddTHH:mm:ssZ) at which to start all data feeds (e.g. 2020-06-23T06:00:00Z).

DevicesToTrack

A comma-separated list of device IDs that correspond to devices to be tracked. The default value of * indicates that data will be captured for all devices. Alternatively, if a comma-separated list of device IDs is provided (e.g. b1,b2), any feed data with relations to devices will be filtered such that only the data associated with the specified devices will be persisted to the adapter database.

WARNING! In order to capture data related to all devices, the value of this setting must be *.

DiagnosticsToTrack

A comma-separated list of diagnostic IDs that correspond to diagnostics (StatusData or FaultData) to be tracked. The default value of * indicates that data will be captured for all diagnostics. Alternatively, if a comma-separated list of diagnostic IDs is provided (e.g. DiagnosticOdometerAdjustmentId,DiagnosticFuelLevelId,DiagnosticFuelUnitsId,DiagnosticCrankingVoltageId,DiagnosticInvalidGpsMessagesReceivedId), any feed data with relations to diagnostics will be filtered such that only the data associated with the specified diagnostics will be persisted to the adapter database.

WARNING! In order to capture data related to all diagnostics, the value of this setting must be *.

ExcludeDiagnosticsToTrack

Indicates whether the DiagnosticsToTrack should be excluded, effectively inverting functionality. If false, only the data associated with the specified diagnostics will be persisted to the adapter database. If true, all data EXCEPT for the data associated with the specified diagnostics will be persisted to the adapter database. Must be set to either true or false.

EnableMinimunIntervalSamplingForLogRecords

Indicates whether minimum interval sampling should be applied to the LogRecord feed. Only works if EnableLogRecordFeed is true. If set to true, a minimum interval defined by MinimumIntervalSamplingIntervalSeconds will be applied between LogRecords that are written to the LogRecords table. Must be set to either true or false. See the Minimum Interval Sampling section for more information.

EnableMinimunIntervalSamplingForStatusData

Indicates whether minimum interval sampling should be applied to the StatusData feed. Only works if EnableStatusDataFeed is true. If set to true, a minimum interval defined by MinimumIntervalSamplingIntervalSeconds will be applied between StatusData entities with a Diagnostic Id included in the MinimumIntervalSamplingDiagnostics list that are written to the StatusData table. All StatusData entities with a Diagnostic Id included in the DiagnosticsToTrack list but not in the MinimumIntervalSamplingDiagnostics list will be persisted to the StatusData table. Must be set to either true or false. See the Minimum Interval Sampling section for more information.

MinimumIntervalSamplingDiagnostics

A comma-separated list of diagnostic IDs for which minimum interval sampling will be applied to the StatusData feed. Only works if EnableStatusDataFeed is true. If set to true, a minimum interval defined by MinimumIntervalSamplingIntervalSeconds will be applied between StatusData entities with a Diagnostic Id included in this list that are written to the StatusData table. This list must be equal to the list provided in the DiagnosticsToTrack setting or a subset thereof. ExcludeDiagnosticsToTrack must be set to false. The placeholder wildcard value (*) cannot be used for the DiagnosticsToTrack setting nor this setting. See the Minimum Interval Sampling section for more information.

MinimumIntervalSamplingIntervalSeconds

The minimum duration, in seconds, that should be applied between the DateTime values of entities that are written to their respective table(s) in the adapter database for any entity type that has minimum interval sampling enabled. Minimum: 1. Maximum: 3600 (1 hour). See the Minimum Interval Sampling section for more information.

Setting

Description

EnableBinaryDataFeed

Indicates whether the data feed for the subject entity type should be enabled. Must be set to either true or false.

BinaryDataFeedIntervalSeconds

The minimum number of seconds to wait between GetFeed() calls for the subject entity type (e.g. 30). Minimum: 2. Maximum: 604800 (1 week).

Setting

Description

EnableChargeEventFeed

Indicates whether the data feed for the subject entity type should be enabled. Must be set to either true or false.

ChargeEventFeedIntervalSeconds

The minimum number of seconds to wait between GetFeed() calls for the subject entity type (e.g. 30). Minimum: 2. Maximum: 604800 (1 week).

Setting

Description

EnableDebugDataFeed

Indicates whether the data feed for the subject entity type should be enabled. Must be set to either true or false.

DebugDataFeedIntervalSeconds

The minimum number of seconds to wait between GetFeed() calls for the subject entity type (e.g. 30). Minimum: 2. Maximum: 604800 (1 week).

Setting

Description

EnableDeviceStatusInfoFeed

Indicates whether the data feed for the subject entity type should be enabled. Must be set to either true or false.

DeviceStatusInfoFeedIntervalSeconds

The minimum number of seconds to wait between GetFeed() calls for the subject entity type (e.g. 30). Minimum: 2. Maximum: 604800 (1 week).

Setting

Description

EnableDriverChangeFeed

Indicates whether the data feed for the subject entity type should be enabled. Must be set to either true or false.

DriverChangeFeedIntervalSeconds

The minimum number of seconds to wait between GetFeed() calls for the subject entity type (e.g. 30). Minimum: 2. Maximum: 604800 (1 week).

Setting

Description

EnableDutyStatusAvailabilityFeed

Indicates whether the pseudo data feed for the subject entity type should be enabled. Must be set to either true or false.

DutyStatusAvailabilityFeedIntervalSeconds

The minimum number of seconds to wait after retrieving DutyStatusAvailability information for all Drivers before starting the retrieval process again (e.g. 300). Minimum: 2. Maximum: 604800 (1 week).

DutyStatusAvailabilityFeedLastAccessDateCutoffDays

Used to reduce the number of unnecessary Get calls when retrieving DutyStatusAvailability information for all Drivers. Data is not queried for Drivers who have not accessed the Geotab system for more than this many days in the past. This value should be set to approximately twice the longest possible cycle for a HOS ruleset (e.g. 30). Minimum: 14. Maximum: 60.