1

Ensure that the main MyGeotab API Adapter application and database is first downloaded and deployed. Refer to the Quick Start: Download and Deploy the MyGeotab API Adapter section of the main guide for details.

2

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 Data Optimizer files to download are:

1. MyGeotabAPIAdapter.DataOptimizer_SCD_win-x64.zip
2. SQLServer_DataOptimizer.zip

Once downloaded, extract the contents of the zip files.

3

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

4

Configure and deploy the Data Optimizer application (following Steps 1-4 in the Application Deployment and Configuration section):

Table Name

Category

Description

BinaryDataT

Feed data

Contains data corresponding to MyGeotab BinaryData objects.

BinaryTypesT

Reference data

Contains data corresponding to MyGeotab BinaryDataType objects.

ControllersT

Reference data

Contains data corresponding to MyGeotab Controller objects.

DevicesT

Reference data

Contains data corresponding to MyGeotab Device objects.

DiagnosticIdsT

Reference data

Contains data corresponding to MyGeotab Diagnostic objects.

DiagnosticsT

Reference data

Contains data corresponding to MyGeotab Diagnostic objects.

DriverChangesT

Feed data

Contains data corresponding to MyGeotab DriverChange objects.

DriverChangeTypesT

Feed data

Contains data corresponding to MyGeotab DriverChangeType objects.

FaultDataT

Feed data

Contains data corresponding to MyGeotab FaultData objects.

LogRecordsT

Feed data

Contains data corresponding to MyGeotab LogRecord objects.

OProcessorTracking

System Info

Used by the Data Optimizer for tracking and management of its various services. Data in this table should not be modified other than by the Data Optimizer itself.

StatusDataT

Feed data

Contains data corresponding to MyGeotab StatusData objects.

UsersT

Reference Data

Contains data corresponding to MyGeotab User objects.

Field Name

Data Type

Nullable

Description

id

bigint

No

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

GeotabId

nvarchar(50)

No

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

BinaryTypeId

bigint

No

The Id of the BinaryDataType (in the BinaryTypesT table) associated with the subject BinaryDataT.

ControllerId

bigint

No

The Id of the Controller (in the ControllersT table) associated with the subject BinaryDataT.

Data

nvarchar(1024)

No

The binary data for the subject BinaryDataT.

DateTime

datetime2(7)

Yes

The date and time of the logging of the data.

DeviceId

bigint

No

The Id of the Device (in the DevicesT table) associated with the subject BinaryDataT.

Version

nvarchar(50)

Yes

The version of the entity.

RecordLastChangedUtc

datetime2(7)

No

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

Field Name

Data Type

Nullable

Description

id

bigint

No

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

GeotabId

nvarchar(50)

No

The value of the BinaryDataType object in the Geotab system.

RecordLastChangedUtc

datetime2(7)

No

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

Field Name

Data Type

Nullable

Description

id

bigint

No

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

GeotabId

nvarchar(50)

No

The Id property of the Controller object in the Geotab system.

RecordLastChangedUtc

datetime2(7)

No

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

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the optimizer 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

character varying(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)

No

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 modified in the optimizer database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the optimizer database table. Entirely unrelated to 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.

GeotabId

nvarchar(100)

No

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

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.

RecordLastChangedUtc

datetime2(7)

No

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

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the optimizer database table. Entirely unrelated to 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)

Yes

The applicable Controller for the diagnostic.

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 modified in the optimizer database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the optimizer 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)

Yes

The date and time of the driver change.

DeviceId

bigint

No

The Id of the Device (in the DevicesT table) associated with the subject DriverChangeT.

DriverId

bigint

No

The Id of the Driver (corresponding to the Id in the UsersT table) associated with the subject DriverChangeT.

DriverChangeTypeId

bigint

No

The Id of the DriverChangeType (in the DriverChangeTypesT table) associated with the subject DriverChangeT.

Version

bigint

No

The version of the entity.

RecordLastChangedUtc

datetime2(7)

No

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

Field Name

Data Type

Nullable

Description

id

bigint

No

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

GeotabId

nvarchar(100)

No

The Type property of the DriverChange object in the Geotab system.

RecordLastChangedUtc

datetime2(7)

No

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

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the optimizer 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

bigint

No

The Id of the Device (in the DevicesT table) associated with the subject FaultDataT.

DiagnosticId

bigint

No

The Id of the Diagnostic (in the DiagnosticsT table) associated with the subject FaultDataT.

DismissDateTime

datetime2(7)

Yes

The date and time that the fault was dismissed.

DismissUserId

bigint

Yes

The Id of the User (in the UsersT table) associated with the subject FaultDataT 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.

DriverId

bigint

Yes

* The Id of the Driver (corresponding to the Id in the UsersT table) associated with the subject FaultDataT.

Latitude

float

Yes

* The latitude of the FaultDataT record.

Longitude

float

Yes

* The longitude of the FaultDataT record.

Speed

real

Yes

* The speed (in km/h) of the FaultDataT record.

Bearing

real

Yes

* The bearing (heading) in degrees of the FaultDataT record.

Direction

nvarchar(3)

Yes

* The compass direction (e.g. “N”, “SE”, “WSW”, etc.) of the FaultDataT record.

LongLatProcessed

bit

No

* Indicates whether the Longitude and Latitude (and by extension, Speed, Bearing and Direction) columns have been processed.

LongLatReason

tinyint

Yes

* If not null and LongLatProcessed = true, indicates the reason why it was not possible to determine Longitude and Latitude values for the subject record.

DriverIdProcessed

bit

No

* Indicates whether the DriverId column has been processed.

DriverIdReason

tinyint

Yes

* If not null and DriverIdProcessed = true, indicates the reason why it was not possible to determine the DriverId value for the subject record.

RecordLastChangedUtc

datetime2(7)

No

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

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the optimizer 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

bigint

No

The Id of the Device (in the DevicesT table) associated with the subject LogRecordsT.

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).

RecordLastChangedUtc

datetime2(7)

No

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

Field Name

Data Type

Nullable

Description

id

bigint

No

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

ProcessorId

nvarchar(50)

No

The unique identifier for the processor/optimizer service.

OptimizerVersion

nvarchar(50)

Yes

The version of the Data Optimizer application that the subject processor is part of.

OptimizerMachineName

nvarchar(100)

Yes

The name of the machine running the Data Optimizer application that the subject processor is part of.

EntitiesLastProcessedUtc

datetime2(7)

Yes

A timestamp, in Coordinated Universal Time (UTC), indicating the last time that the subject processor completed the processing of entities.

AdapterDbLastId

bigint

Yes

The unique identifier for the last record processed by the subject processor in the associated adapter database table. Entirely unrelated to the Geotab system.

AdapterDbLastGeotabId

nvarchar(50)

Yes

The unique identifier for the specific Entity object in the Geotab system associated with the last record processed by the subject processor in the associated adapter database table.

AdapterDbLastRecordCreationTimeUtcTicks

bigint

Yes

A timestamp, in Coordinated Universal Time (UTC), indicating when the last record processed by the subject processor was added to the associated table in the adapter database. 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 modified in the optimizer database.

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the optimizer 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

double precision

Yes

The recorded value of the diagnostic parameter.

DateTime

datetime2(7)

Yes

The date and time of the logged event.

DeviceId

bigint

No

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

DiagnosticId

bigint

No

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

DriverId

bigint

Yes

* The Id of the Driver (corresponding to the Id in the UsersT table) associated with the subject StatusDataT.

Latitude

float

Yes

* The latitude of the StatusDataT record.

Longitude

float

Yes

* The longitude of the StatusDataT record.

Speed

real

Yes

* The speed (in km/h) of the StatusDataT record.

Bearing

real

Yes

* The bearing (heading) in degrees of the StatusDataT record.

Direction

nvarchar(3)

Yes

* The compass direction (e.g. “N”, “SE”, “WSW”, etc.) of the StatusDataT record.

LongLatProcessed

bit

No

* Indicates whether the Longitude and Latitude (and by extension, Speed, Bearing and Direction) columns have been processed.

LongLatReason

tinyint

Yes

* If not null and LongLatProcessed = true, indicates the reason why it was not possible to determine Longitude and Latitude values for the subject record.

DriverIdProcessed

bit

No

* Indicates whether the DriverId column has been processed.

DriverIdReason

tinyint

Yes

* If not null and DriverIdProcessed = true, indicates the reason why it was not possible to determine the DriverId value for the subject record.

RecordLastChangedUtc

datetime2(7)

No

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

Field Name

Data Type

Nullable

Description

id

bigint

No

The unique identifier for the record in the optimizer 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)

No

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)

No

The last name of the user.

Name

nvarchar(255)

No

The user's email address / login name.

RecordLastChangedUtc

datetime2(7)

No

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

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

AdapterDatabaseProviderType

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

AdapterDatabaseConnectionString

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

Setting

Description

OptimizerDatabaseProviderType

The database provider of the optimizer database.

✱ NOTE: At this time, SQL Server is the only supported database type for the optimizer database. Therefore, the value of this setting must be SQLServer.

OptimizerDatabaseConnectionString

The adapter database connection string (e.g. Server=;Database=geotabadapteroptimizerdb;User Id=geotabadapteroptimizer_client;Password=;MultipleActiveResultSets=True;TrustServerCertificate=True).

Setting

Description

TimeoutSecondsForDatabaseTasks

The maximum number of seconds allowed for an individual adapter or optimizer 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 Data Optimizer will resume normal operation after establishing that there is connectivity to the subject database (e.g. 30). Minimum: 10. Maximum: 3600.

Setting

Description

EnableBinaryDataProcessor

Indicates whether the BinaryDataProcessor service should be enabled. Must be set to either true or false.

BinaryDataProcessorOperationMode

If set to Continuous, the BinaryDataProcessor service will keep running indefinitely. If set to Scheduled, the BinaryDataProcessor service will run indefinitely, but pause operation outside of a daily time window defined by the BinaryDataProcessorDailyStartTimeUTC and BinaryDataProcessorDailyRunTimeSeconds settings. Must be set to either Continuous or Scheduled.

BinaryDataProcessorDailyStartTimeUTC

Only used if BinaryDataProcessorOperationMode is set to Scheduled. An ISO 8601 date and time string used to specify a time of day to serve as the start time for the daily operation window of the BinaryDataProcessor service. Only the time portion of the string is used; the date entered is irrelevant. To avoid time-zone related issues, Coordinated Universal Time (UTC) should be used (e.g. 2020-06-23T06:00:00Z).

BinaryDataProcessorDailyRunTimeSeconds

Only used if BinaryDataProcessorOperationMode is set to Scheduled and BinaryDataProcessorDailyStartTimeUTC is set to an appropriate value. The duration, in seconds, that the BinaryDataProcessor service will run for each day, starting from the time defined in the BinaryDataProcessorDailyStartTimeUTC setting (e.g. 21600 for 6 hours). Minimum: 300 (5 minutes). Maximum: 82800 (23 hours).

BinaryDataProcessorBatchSize

The number of records that the BinaryDataProcessor service should process during each batch/iteration. Minimum: 100. Maximum: 100000.

BinaryDataProcessorExecutionIntervalSeconds

While the BinaryDataProcessor service is running, either continuously or within a daily operation window, if less than 1000 records are returned in a given batch/iteration, the service will pause for this duration (in seconds) before proceeding with the next batch/iteration (e.g. 60). Minimum: 10. Maximum: 86400 (1 day). This throttling mechanism is designed to prevent excessive CPU usage and database I/O when little or no data is returned as the service would otherwise needlessly iterate multiple times per second.

Setting

Description

EnableDeviceProcessor

Indicates whether the DeviceProcessor service should be enabled. Must be set to either true or false.

DeviceProcessorOperationMode

If set to Continuous, the DeviceProcessor service will keep running indefinitely. If set to Scheduled, the DeviceProcessor service will run indefinitely, but pause operation outside of a daily time window defined by the DeviceProcessorDailyStartTimeUTC and DeviceProcessorDailyRunTimeSeconds settings. Must be set to either Continuous or Scheduled.

DeviceProcessorDailyStartTimeUTC

Only used if DeviceProcessorOperationMode is set to Scheduled. An ISO 8601 date and time string used to specify a time of day to serve as the start time for the daily operation window of the DeviceProcessor service. Only the time portion of the string is used; the date entered is irrelevant. To avoid time-zone related issues, Coordinated Universal Time (UTC) should be used (e.g. 2020-06-23T06:00:00Z).

DeviceProcessorDailyRunTimeSeconds

Only used if DeviceProcessorOperationMode is set to Scheduled and DeviceProcessorDailyStartTimeUTC is set to an appropriate value. The duration, in seconds, that the DeviceProcessor service will run for each day, starting from the time defined in the DeviceProcessorDailyStartTimeUTC setting (e.g. 21600 for 6 hours). Minimum: 300 (5 minutes). Maximum: 82800 (23 hours).

DeviceProcessorExecutionIntervalSeconds

While the DeviceProcessor service is running, either continuously or within a daily operation window, if no records are returned in a given batch/iteration, the service will pause for this duration (in seconds) before proceeding with the next batch/iteration (e.g. 60). Minimum: 10. Maximum: 86400 (1 day). This throttling mechanism is designed to prevent excessive CPU usage and database I/O when little or no data is returned as the service would otherwise needlessly iterate multiple times per second.

Setting

Description

EnableDiagnosticProcessor

Indicates whether the DiagnosticProcessor service should be enabled. Must be set to either true or false.

DiagnosticProcessorOperationMode

If set to Continuous, the DiagnosticProcessor service will keep running indefinitely. If set to Scheduled, the DiagnosticProcessor service will run indefinitely, but pause operation outside of a daily time window defined by the DiagnosticProcessorDailyStartTimeUTC and DiagnosticProcessorDailyRunTimeSeconds settings. Must be set to either Continuous or Scheduled.

DiagnosticProcessorDailyStartTimeUTC

Only used if DiagnosticProcessorOperationMode is set to Scheduled. An ISO 8601 date and time string used to specify a time of day to serve as the start time for the daily operation window of the DiagnosticProcessor service. Only the time portion of the string is used; the date entered is irrelevant. To avoid time-zone related issues, Coordinated Universal Time (UTC) should be used (e.g. 2020-06-23T06:00:00Z).

DiagnosticProcessorDailyRunTimeSeconds

Only used if DiagnosticProcessorOperationMode is set to Scheduled and DiagnosticProcessorDailyStartTimeUTC is set to an appropriate value. The duration, in seconds, that the DiagnosticProcessor service will run for each day, starting from the time defined in the DiagnosticProcessorDailyStartTimeUTC setting (e.g. 21600 for 6 hours). Minimum: 300 (5 minutes). Maximum: 82800 (23 hours).

DiagnosticProcessorExecutionIntervalSeconds

While the DiagnosticProcessor service is running, either continuously or within a daily operation window, if no records are returned in a given batch/iteration, the service will pause for this duration (in seconds) before proceeding with the next batch/iteration (e.g. 60). Minimum: 10. Maximum: 86400 (1 day). This throttling mechanism is designed to prevent excessive CPU usage and database I/O when little or no data is returned as the service would otherwise needlessly iterate multiple times per second.

Setting

Description

EnableDriverChangeProcessor

Indicates whether the DriverChangeProcessor service should be enabled. Must be set to either true or false.

DriverChangeProcessorOperationMode

If set to Continuous, the DriverChangeProcessor service will keep running indefinitely. If set to Scheduled, the DriverChangeProcessor service will run indefinitely, but pause operation outside of a daily time window defined by the DriverChangeProcessorDailyStartTimeUTC and DriverChangeProcessorDailyRunTimeSeconds settings. Must be set to either Continuous or Scheduled.

DriverChangeProcessorDailyStartTimeUTC

Only used if DriverChangeProcessorOperationMode is set to Scheduled. An ISO 8601 date and time string used to specify a time of day to serve as the start time for the daily operation window of the DriverChangeProcessor service. Only the time portion of the string is used; the date entered is irrelevant. To avoid time-zone related issues, Coordinated Universal Time (UTC) should be used (e.g. 2020-06-23T06:00:00Z).

DriverChangeProcessorDailyRunTimeSeconds

Only used if DriverChangeProcessorOperationMode is set to Scheduled and DriverChangeProcessorDailyStartTimeUTC is set to an appropriate value. The duration, in seconds, that the DriverChangeProcessor service will run for each day, starting from the time defined in the DriverChangeProcessorDailyStartTimeUTC setting (e.g. 21600 for 6 hours). Minimum: 300 (5 minutes). Maximum: 82800 (23 hours).

DriverChangeProcessorBatchSize

The number of records that the DriverChangeProcessor service should process during each batch/iteration. Minimum: 100. Maximum: 100000.

DriverChangeProcessorExecutionIntervalSeconds

While the DriverChangeProcessor service is running, either continuously or within a daily operation window, if less than 1000 records are returned in a given batch/iteration, the service will pause for this duration (in seconds) before proceeding with the next batch/iteration (e.g. 60). Minimum: 10. Maximum: 86400 (1 day). This throttling mechanism is designed to prevent excessive CPU usage and database I/O when little or no data is returned as the service would otherwise needlessly iterate multiple times per second.

Setting

Description

EnableFaultDataProcessor

Indicates whether the FaultDataProcessor service should be enabled. Must be set to either true or false.

FaultDataProcessorOperationMode

If set to Continuous, the FaultDataProcessor service will keep running indefinitely. If set to Scheduled, the FaultDataProcessor service will run indefinitely, but pause operation outside of a daily time window defined by the FaultDataProcessorDailyStartTimeUTC and FaultDataProcessorDailyRunTimeSeconds settings. Must be set to either Continuous or Scheduled.

FaultDataProcessorDailyStartTimeUTC

Only used if FaultDataProcessorOperationMode is set to Scheduled. An ISO 8601 date and time string used to specify a time of day to serve as the start time for the daily operation window of the FaultDataProcessor service. Only the time portion of the string is used; the date entered is irrelevant. To avoid time-zone related issues, Coordinated Universal Time (UTC) should be used (e.g. 2020-06-23T06:00:00Z).

FaultDataProcessorDailyRunTimeSeconds

Only used if FaultDataProcessorOperationMode is set to Scheduled and FaultDataProcessorDailyStartTimeUTC is set to an appropriate value. The duration, in seconds, that the FaultDataProcessor service will run for each day, starting from the time defined in the FaultDataProcessorDailyStartTimeUTC setting (e.g. 21600 for 6 hours). Minimum: 300 (5 minutes). Maximum: 82800 (23 hours).

FaultDataProcessorBatchSize

The number of records that the FaultDataProcessor service should process during each batch/iteration. Minimum: 100. Maximum: 100000.

FaultDataProcessorExecutionIntervalSeconds

While the FaultDataProcessor service is running, either continuously or within a daily operation window, if less than 1000 records are returned in a given batch/iteration, the service will pause for this duration (in seconds) before proceeding with the next batch/iteration (e.g. 60). Minimum: 10. Maximum: 86400 (1 day). This throttling mechanism is designed to prevent excessive CPU usage and database I/O when little or no data is returned as the service would otherwise needlessly iterate multiple times per second.

Setting

Description

EnableLogRecordProcessor

Indicates whether the LogRecordProcessor service should be enabled. Must be set to either true or false.

LogRecordProcessorOperationMode

If set to Continuous, the LogRecordProcessor service will keep running indefinitely. If set to Scheduled, the LogRecordProcessor service will run indefinitely, but pause operation outside of a daily time window defined by the LogRecordProcessorDailyStartTimeUTC and LogRecordProcessorDailyRunTimeSeconds settings. Must be set to either Continuous or Scheduled.

LogRecordProcessorDailyStartTimeUTC

Only used if LogRecordProcessorOperationMode is set to Scheduled. An ISO 8601 date and time string used to specify a time of day to serve as the start time for the daily operation window of the LogRecordProcessor service. Only the time portion of the string is used; the date entered is irrelevant. To avoid time-zone related issues, Coordinated Universal Time (UTC) should be used (e.g. 2020-06-23T06:00:00Z).

LogRecordProcessorDailyRunTimeSeconds

Only used if LogRecordProcessorOperationMode is set to Scheduled and LogRecordProcessorDailyStartTimeUTC is set to an appropriate value. The duration, in seconds, that the LogRecordProcessor service will run for each day, starting from the time defined in the LogRecordProcessorDailyStartTimeUTC setting (e.g. 21600 for 6 hours). Minimum: 300 (5 minutes). Maximum: 82800 (23 hours).

LogRecordProcessorBatchSize

The number of records that the LogRecordProcessor service should process during each batch/iteration. Minimum: 100. Maximum: 100000.

LogRecordProcessorExecutionIntervalSeconds

While the LogRecordProcessor service is running, either continuously or within a daily operation window, if less than 1000 records are returned in a given batch/iteration, the service will pause for this duration (in seconds) before proceeding with the next batch/iteration (e.g. 60). Minimum: 10. Maximum: 86400 (1 day). This throttling mechanism is designed to prevent excessive CPU usage and database I/O when little or no data is returned as the service would otherwise needlessly iterate multiple times per second.

Setting

Description

EnableStatusDataProcessor

Indicates whether the StatusDataProcessor service should be enabled. Must be set to either true or false.

StatusDataProcessorOperationMode

If set to Continuous, the StatusDataProcessor service will keep running indefinitely. If set to Scheduled, the StatusDataProcessor service will run indefinitely, but pause operation outside of a daily time window defined by the StatusDataProcessorDailyStartTimeUTC and StatusDataProcessorDailyRunTimeSeconds settings. Must be set to either Continuous or Scheduled.

StatusDataProcessorDailyStartTimeUTC

Only used if StatusDataProcessorOperationMode is set to Scheduled. An ISO 8601 date and time string used to specify a time of day to serve as the start time for the daily operation window of the StatusDataProcessor service. Only the time portion of the string is used; the date entered is irrelevant. To avoid time-zone related issues, Coordinated Universal Time (UTC) should be used (e.g. 2020-06-23T06:00:00Z).

StatusDataProcessorDailyRunTimeSeconds

Only used if StatusDataProcessorOperationMode is set to Scheduled and StatusDataProcessorDailyStartTimeUTC is set to an appropriate value. The duration, in seconds, that the StatusDataProcessor service will run for each day, starting from the time defined in the StatusDataProcessorDailyStartTimeUTC setting (e.g. 21600 for 6 hours). Minimum: 300 (5 minutes). Maximum: 82800 (23 hours).

StatusDataProcessorBatchSize

The number of records that the StatusDataProcessor service should process during each batch/iteration. Minimum: 100. Maximum: 100000.

StatusDataProcessorExecutionIntervalSeconds

While the StatusDataProcessor service is running, either continuously or within a daily operation window, if less than 1000 records are returned in a given batch/iteration, the service will pause for this duration (in seconds) before proceeding with the next batch/iteration (e.g. 60). Minimum: 10. Maximum: 86400 (1 day). This throttling mechanism is designed to prevent excessive CPU usage and database I/O when little or no data is returned as the service would otherwise needlessly iterate multiple times per second.

Setting

Description

EnableUserProcessor

Indicates whether the UserProcessor service should be enabled. Must be set to either true or false.

UserProcessorOperationMode

If set to Continuous, the UserProcessor service will keep running indefinitely. If set to Scheduled, the UserProcessor service will run indefinitely, but pause operation outside of a daily time window defined by the UserProcessorDailyStartTimeUTC and UserProcessorDailyRunTimeSeconds settings. Must be set to either Continuous or Scheduled.

UserProcessorDailyStartTimeUTC

Only used if UserProcessorOperationMode is set to Scheduled. An ISO 8601 date and time string used to specify a time of day to serve as the start time for the daily operation window of the UserProcessor service. Only the time portion of the string is used; the date entered is irrelevant. To avoid time-zone related issues, Coordinated Universal Time (UTC) should be used (e.g. 2020-06-23T06:00:00Z).

UserProcessorDailyRunTimeSeconds

Only used if UserProcessorOperationMode is set to Scheduled and UserProcessorDailyStartTimeUTC is set to an appropriate value. The duration, in seconds, that the UserProcessor service will run for each day, starting from the time defined in the UserProcessorDailyStartTimeUTC setting (e.g. 21600 for 6 hours). Minimum: 300 (5 minutes). Maximum: 82800 (23 hours).

UserProcessorExecutionIntervalSeconds

While the UserProcessor service is running, either continuously or within a daily operation window, if no records are returned in a given batch/iteration, the service will pause for this duration (in seconds) before proceeding with the next batch/iteration (e.g. 60). Minimum: 10. Maximum: 86400 (1 day). This throttling mechanism is designed to prevent excessive CPU usage and database I/O when little or no data is returned as the service would otherwise needlessly iterate multiple times per second.

Setting

Description

EnableFaultDataOptimizer

Indicates whether the FaultDataOptimizer service should be enabled. Must be set to either true or false.

FaultDataOptimizerOperationMode

If set to Continuous, the FaultDataOptimizer service will keep running indefinitely. If set to Scheduled, the FaultDataOptimizer service will run indefinitely, but pause operation outside of a daily time window defined by the FaultDataOptimizerDailyStartTimeUTC and FaultDataOptimizerDailyRunTimeSeconds settings. Must be set to either Continuous or Scheduled.

FaultDataOptimizerDailyStartTimeUTC

Only used if FaultDataOptimizerOperationMode is set to Scheduled. An ISO 8601 date and time string used to specify a time of day to serve as the start time for the daily operation window of the FaultDataOptimizer service. Only the time portion of the string is used; the date entered is irrelevant. To avoid time-zone related issues, Coordinated Universal Time (UTC) should be used (e.g. 2020-06-23T06:00:00Z).

FaultDataOptimizerDailyRunTimeSeconds

Only used if FaultDataOptimizerOperationMode is set to Scheduled and FaultDataOptimizerDailyStartTimeUTC is set to an appropriate value. The duration, in seconds, that the FaultDataOptimizer service will run for each day, starting from the time defined in the FaultDataOptimizerDailyStartTimeUTC setting (e.g. 21600 for 6 hours). Minimum: 300 (5 minutes). Maximum: 82800 (23 hours).

FaultDataOptimizerExecutionIntervalSeconds

While the FaultDataOptimizer service is running, either continuously or within a daily operation window, if fewer than 100 records are processed in a given batch/iteration, the service will pause for this duration (in seconds) before proceeding with the next batch/iteration. If 100 or more records are processed in a given batch/iteration, the FaultDataOptimizer will immediately retrieve the next batch of records for processing (e.g. 60). Minimum: 10. Maximum: 86400 (1 day).

This throttling mechanism is designed to maximize throughput while preventing excessive CPU usage and database I/O when little or no data is returned as the service would otherwise needlessly iterate multiple times per second.

FaultDataOptimizerPopulateLongitudeLatitude

Indicates whether the FaultDataOptimizer service should populate the Longitude and Latitude columns in the FaultDataT table. Must be set to either true or false.

FaultDataOptimizerPopulateSpeed

Only used if FaultDataOptimizerPopulateLongitudeLatitude is set to true. Indicates whether the FaultDataOptimizer service should populate the Speed column in the FaultDataT table. Must be set to either true or false.

FaultDataOptimizerPopulateBearing

Only used if FaultDataOptimizerPopulateLongitudeLatitude is set to true. Indicates whether the FaultDataOptimizer service should populate the Bearing column in the FaultDataT table. Must be set to either true or false.

FaultDataOptimizerPopulateDirection

Only used if FaultDataOptimizerPopulateLongitudeLatitude is set to true. Indicates whether the FaultDataOptimizer service should populate the Direction column in the FaultDataT table. Must be set to either true or false.

FaultDataOptimizerNumberOfCompassDirections

Only used if FaultDataOptimizerPopulateLongitudeLatitude and FaultDataOptimizerPopulateDirection are both set to true. Indicates the number of cardinal directions (on the compass rose) to use when determining direction based on the Bearing value. Must be one of 4, 8, or 16.

FaultDataOptimizerPopulateDriverId

Indicates whether the FaultDataOptimizer service should populate the DriverId column in the FaultDataT table. Must be set to either true or false.

Setting

Description

EnableStatusDataOptimizer

Indicates whether the StatusDataOptimizer service should be enabled. Must be set to either true or false.

StatusDataOptimizerOperationMode

If set to Continuous, the StatusDataOptimizer service will keep running indefinitely. If set to Scheduled, the StatusDataOptimizer service will run indefinitely, but pause operation outside of a daily time window defined by the StatusDataOptimizerDailyStartTimeUTC and StatusDataOptimizerDailyRunTimeSeconds settings. Must be set to either Continuous or Scheduled.

StatusDataOptimizerDailyStartTimeUTC

Only used if StatusDataOptimizerOperationMode is set to Scheduled. An ISO 8601 date and time string used to specify a time of day to serve as the start time for the daily operation window of the StatusDataOptimizer service. Only the time portion of the string is used; the date entered is irrelevant. To avoid time-zone related issues, Coordinated Universal Time (UTC) should be used (e.g. 2020-06-23T06:00:00Z).

StatusDataOptimizerDailyRunTimeSeconds

Only used if StatusDataOptimizerOperationMode is set to Scheduled and StatusDataOptimizerDailyStartTimeUTC is set to an appropriate value. The duration, in seconds, that the StatusDataOptimizer service will run for each day, starting from the time defined in the StatusDataOptimizerDailyStartTimeUTC setting (e.g. 21600 for 6 hours). Minimum: 300 (5 minutes). Maximum: 82800 (23 hours).

StatusDataOptimizerExecutionIntervalSeconds

While the StatusDataOptimizer service is running, either continuously or within a daily operation window, if fewer than 500 records are processed in a given batch/iteration, the service will pause for this duration (in seconds) before proceeding with the next batch/iteration (e.g. 60). Minimum: 10. Maximum: 86400 (1 day). This throttling mechanism is designed to maximize throughput while preventing excessive CPU usage and database I/O when little or no data is returned as the service would otherwise needlessly iterate multiple times per second.

StatusDataOptimizerPopulateLongitudeLatitude

Indicates whether the StatusDataOptimizer service should populate the Longitude and Latitude columns in the StatusDataT table. Must be set to either true or false.

StatusDataOptimizerPopulateSpeed

Only used if StatusDataOptimizerPopulateLongitudeLatitude is set to true. Indicates whether the StatusDataOptimizer service should populate the Speed column in the StatusDataT table. Must be set to either true or false.

StatusDataOptimizerPopulateBearing

Only used if StatusDataOptimizerPopulateLongitudeLatitude is set to true. Indicates whether the StatusDataOptimizer service should populate the Bearing column in the StatusDataT table. Must be set to either true or false.

StatusDataOptimizerPopulateDirection

Only used if StatusDataOptimizerPopulateLongitudeLatitude is set to true. Indicates whether the StatusDataOptimizer service should populate the Direction column in the StatusDataT table. Must be set to either true or false.

StatusDataOptimizerNumberOfCompassDirections

Only used if StatusDataOptimizerPopulateLongitudeLatitude and StatusDataOptimizerPopulateDirection are both set to true. Indicates the number of cardinal directions (on the compass rose) to use when determining direction based on the Bearing value. Must be one of 4, 8, or 16.

StatusDataOptimizerPopulateDriverId

Indicates whether the StatusDataOptimizer service should populate the DriverId column in the StatusDataT table. Must be set to either true or false.

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

autoReload="true"

internalLogFile="LOG-MyGeotab_API_Adapter-internal.log"

internalLogLevel="Error" >

maxArchiveFiles="100" archiveAboveSize="5120000" archiveEvery="Day">

layout="${date}|${level:uppercase=true}|${message} ${exception}|${logger}|${all-event-properties}" />

minlevel="Info" writeTo="target1,target2" />

Setting

Description

autoReload

Indicates whether the nlog.config file should be watched for changes and reloaded automatically when changed. Must be set to either true or false.

maxArchiveFiles

Maximum number of archive files that should be kept. If maxArchiveFiles is less or equal to 0, old files aren't deleted. Default: 100.

archiveAboveSize

Size in bytes above which log files will be automatically archived. Default: 5120000 (5 MB).

archiveEvery

Indicates whether to automatically archive log files every time the specified time passes. Default: DAY.

Possible values:

1. Day: Archive daily.
2. Hour: Archive every hour.
3. Minute: Archive every minute.
4. Month: Archive every month.
5. None: Don't archive based on time.
6. Year: Archive every year.
7. Sunday: Archive every Sunday.
8. Monday: Archive every Monday.
9. Tuesday: Archive every Tuesday.
10. Wednesday: Archive every Wednesday.
11. Thursday: Archive every Thursday.
12. Friday: Archive every Friday.
13. Saturday: Archive every Saturday.

minlevel

Indicates the log level, which is the amount of detail to be written to log files. Default: Debug.

Possible values:

Service

Prerequisite Services

BinaryDataProcessor

DeviceProcessor

DeviceProcessor

None

DiagnosticProcessor

None

DriverChangeProcessor

DeviceProcessor, UserProcessor

FaultDataOptimizer

None

FaultDataProcessor

DeviceProcessor, DiagnosticProcessor, UserProcessor

LogRecordProcessor

DeviceProcessor

StatusDataOptimizer

None

StatusDataProcessor

DeviceProcessor, DiagnosticProcessor

UserProcessor

None

LongLatReason Value

Description

NULL

1

Lag and lead LogRecordT records could not be found for the DateTime of the subject record.

2

This is a data validation check and should not be encountered. The DateTime of the lead LogRecordT record is less than that of the lag LogRecordT record - both of which the subject record was associated with.

3

This is a data validation check and should not be encountered. The DateTime of the subject record is greater than that of the associated lead LogRecordT record.

4

This is a data validation check and should not be encountered. The DateTime of the subject record is less than that of the associated lag LogRecordT record.

5

The DateTime of the subject record is older than the DateTime of any LogRecordT records. It is highly unlikely that new LogRecords with older dates will come-in, since the MyGeotab API Adapter only moves forward in time once started.

6

The DateTime of the subject record is older than the DateTime of any LogRecordT records for the associated Device. It is highly unlikely that new LogRecords with older dates will come-in, since the MyGeotab API Adapter only moves forward in time once started.

LongLatReason Value

Description

NULL

1

The DateTime of the subject record is older than the DateTime of any DriverChangesT records. It is highly unlikely that new DriverChangesT records with older dates will come-in, since the MyGeotab API Adapter only moves forward in time once started.

2

The DateTime of the subject record is older than the DateTime of any DriverChangesT records for the associated Device. It is highly unlikely that new DriverChangesT records with older dates will come-in, since the MyGeotab API Adapter only moves forward in time once started.

3

A lag DriverChangesT record could not be found for the DateTime of the subject record.