v5.2.0

MyGeotab API Adapter

This repository contains two adapters for integrating with the Geotab platform. Each adapter has its own comprehensive README with architecture overview, configuration reference, operator guide, database schema reference, troubleshooting, and developer guide.

MyGeotab API Adapter

The MyGeotab API Adapter is a free, open source .NET 10.0 (C#) application that downloads data from a MyGeotab database and writes it to a local SQL Server or PostgreSQL database. It uses the MyGeotab SDK data feeds to pull the most common data sets incrementally, streaming them into tables that can serve as the foundation for downstream integrations with external systems.

For developers, the solution serves as both an example of proper MyGeotab API integration via data feeds and a ready-to-use starting point for building new integrations with the Geotab platform.

• See the MyGeotab API Adapter README for full documentation.
• Change log: Version 5.2.0.0
• Upgrade instructions: Upgrade Guide: from v5.1.0.0 to v5.2.0.0

What's changed: This release includes a database change: a stored procedure or function change and maintenance-view changes on both engines. There are no table, column or index changes and no appsettings.json changes, but a database upgrade script must still be run. The release fixes partition management on databases shared with the Geotab DIG Adapter, and a set of defects in database maintenance and retry handling.

Before you upgrade:

• A database upgrade script is required on both SQL Server and PostgreSQL. The required adapter database version moves from 5.1.0.0 to 5.2.0.0.
• On SQL Server, back up the database first. Run every script with sqlcmd -b (SQL Server) or psql -v ON_ERROR_STOP=1 (PostgreSQL). Without those flags, a refused upgrade still exits 0. On SQL Server, a script that fails part-way leaves whatever ran before the failure in place.
• If the Geotab DIG Adapter shares this database, upgrade the MyGeotab API Adapter's schema first.
• The first Level 2 database maintenance run after upgrading may take considerably longer than usual, on both engines. Fixes in this release mean Level 2 now maintains indexes it was previously skipping. No setting changes and no action is required.

Highlights:

• Partition management on a shared database. On PostgreSQL, spManagePartitions failed before creating any of the adapter's own partitions whenever another schema in the same database had partitioned tables, as the Geotab DIG Adapter's gda schema does from this release. On SQL Server, it silently skipped the adapter's own monthly boundaries. New rows then piled into a single partition, and the partition retirement utility could no longer retire a month. Both now look only at the adapter's own objects.
• Level 2 database maintenance now does its work. In the shipped configuration it stopped before maintaining anything for most of the day, while recording each run as a success. Several related defects are also fixed: on SQL Server, two thresholds were applied at one hundredth of their intended values, and the maintenance views reached beyond the adapter's schema. A run also could not start in the part of an enabled window that falls after midnight UTC.
• A failed maintenance or partition-management run no longer stops the adapter while it is running.
• Retries: a PostgreSQL deadlock is now retried, as it already was on SQL Server. A failure to open a SQL Server connection is now retried on every path, as it already was on PostgreSQL.
• Settings that name one of a fixed set of values are now matched case-insensitively.

Geotab DIG Adapter

The Geotab DIG Adapter is an application that pushes telemetry data into MyGeotab via the Data Intake Gateway (DIG). While the MyGeotab API Adapter pulls data out of MyGeotab, the Geotab DIG Adapter enables integrators to stream data from custom (non-Geotab) telematics devices into the MyGeotab platform.

The two adapters can be used independently or together. They share the same geotabadapterdb database but use separate schemas.

• See the Geotab DIG Adapter README for full documentation.
• Change log: Version 5.2.0.0
• Upgrade instructions: Upgrade Guide: from v5.1.0.0 to v5.2.0.0

What's changed: This is the first Geotab DIG Adapter release to change its database schema (gda 5.0.0.0 → 5.2.0.0). It adds a second way to authorize devices: device subscriptions, for operators whose devices are activated and terminated outside the adapter rather than provisioned through MyAdmin. It also adds a database maintenance service that partitions the fail tables and reclaims old records from them. Two more fixes: multiple adapter instances no longer receive duplicate records, and claiming is faster when queues are deep.

Before you upgrade:

• THIS VERSION DELETES OLD DATA BY DEFAULT. The new DatabaseMaintenanceService is enabled out of the box. With the shipped settings it permanently deletes failure records and invalid records older than 90 days, starting with its first run, which happens within seconds of starting the upgraded adapter. There is no archive, and the deletion cannot be rolled back. If any of that history matters, decide before you start the upgraded adapter: either set DIGSettings:Services:DatabaseMaintenanceService:EnableAutomaticRetention to false, or raise FailTableRetentionDays. Take a backup either way.
• One configuration change is required, and the adapter will not start without it. Add DIGSettings:OperatingMode. An existing installation sets it to DeviceProvisioning; the default for a new installation is OemSubscription. Every other new setting has a default.
• A database upgrade script is required, and part of it rewrites existing tables. The upgrade partitions the twelve existing fail tables and widens their primary key, so allow time and disk space, and take a backup first. Stop the application before upgrading the database. Version 5.1.0.0 will not start against a 5.2.0.0 database, version 5.2.0.0 will not start against a 5.0.0.0 one, and the two halves of the upgrade cannot be reversed independently.
• If the MyGeotab API Adapter shares this database, upgrade it to 5.2.0.0 first, on either engine. Its earlier spManagePartitions fails (PostgreSQL) or silently stops partitioning its own tables (SQL Server) once the gda fail tables are partitioned.
• Run the scripts with sqlcmd -b or psql -v ON_ERROR_STOP=1. Without those flags, a refused upgrade still exits 0. On SQL Server, restore your backup if the script fails part-way. The SQL Server script contains a USE [geotabadapterdb] statement; edit it if your database has a different name.
• Running the adapter's services on more than one host? Enable DatabaseMaintenanceService on only one of them: the host that runs the services writing the queues. Set EnableDatabaseMaintenanceService to false on every other host.
• Level 2 maintenance pauses telemetry while it rebuilds indexes offline. Its first run is part of the first maintenance iteration, seconds after start-up. On tables that have never been maintained, that first pause may be the longest.
• PartitionInterval cannot be changed after the first maintenance run. monthly suits almost every installation.
• Enabling device subscriptions on an existing installation means changing OperatingMode at the same time: to Both to keep provisioning, or to OemSubscription for subscriptions only. Also size MaxTerminationsPerWindow deliberately. A batch that exceeds it is refused in its entirety, and the service stops until an operator clears the guard.

Highlights:

• Device subscriptions (new). DIGSettings:OperatingMode takes OemSubscription, DeviceProvisioning or Both. A new DeviceSubscriptionService applies subscribe and terminate instructions from the new Q_DeviceSubscriptions queue, and telemetry is resolved against every enabled workflow. A deployment no longer needs a MyAdmin account unless it uses the provisioning services. See README Section 3.1.
• Fail-table partitioning, retention and database maintenance (new). The fail tables are partitioned by date. The new DatabaseMaintenanceService creates and retires partitions, deletes expired invalid records, runs Level 1 and Level 2 maintenance on the queue tables, and logs queue depths. See README Section 3.7.
• No more duplicate delivery across instances. Previously, two adapter instances claiming from the same queue could each be handed the same records and forward both copies to Geotab. The claim procedures now return exactly the rows each claim took. Claiming a batch also no longer reads the whole queue, which made it much faster at depth.
• **W...

v5.1.0

MyGeotab API Adapter

This repository contains two adapters for integrating with the Geotab platform. Each adapter has its own comprehensive README with architecture overview, configuration reference, operator guide, database schema reference, troubleshooting, and developer guide.

MyGeotab API Adapter

The MyGeotab API Adapter is a free, open source .NET 10.0 (C#) application that downloads data from a MyGeotab database and writes it to a local SQL Server or PostgreSQL database. It uses the MyGeotab SDK data feeds to pull the most common data sets incrementally, streaming them into tables that can serve as the foundation for downstream integrations with external systems.

For developers, the solution serves as both an example of proper MyGeotab API integration via data feeds and a ready-to-use starting point for building new integrations with the Geotab platform.

• See the MyGeotab API Adapter README for full documentation.
• Change log: Version 5.1.0.0
• Upgrade instructions: Upgrade Guide: from v5.0.0.3 to v5.1.0.0

What's changed: This release adds the ShipmentLog data feed and includes a fix for an issue that could stop the adapter and require a manual restart. It includes database schema changes and a new appsettings.json section — see the upgrade guide for details.

• New ShipmentLog data feed. The adapter can now pull ShipmentLog records from MyGeotab. This adds the ShipmentLogs2 partitioned table and a ShipmentLog section in appsettings.json. The feed is disabled by default (EnableShipmentLogFeed: false), so existing installations are unaffected until you turn it on.
• Bug fix — the adapter no longer stops when a MyGeotab API call returns no result. Five API call sites previously treated a null result as fatal, stopping the adapter and requiring a manual restart. Null results have been observed during MyGeotab-side maintenance and failover windows. These sites now raise a connectivity exception, so the adapter's existing connectivity-restoration logic pauses the feeds and resumes automatically once MyGeotab is reachable again.
• New partition-retirement utility scripts, which automate the longer-term data-retention procedure previously documented as a manual process in README Section 3.6. They are standalone and on-demand — not part of database creation or upgrade, and never required for normal adapter operation. They are print-only by default, save every dropped object definition before touching it, and keep all destructive action behind explicit confirmation parameters. See the operator guide for quick-starts, an FAQ, and a troubleshooting reference. The scripts ship inside the PostgreSQL.zip and SQLServer.zip assets below.
• Bug fix — the clear-database scripts now include AuditLogs2 and ShipmentLogs2. Records in those two tables previously survived a clear operation.
• Documentation accuracy. Corrected the documented primary-key column order for the partitioned tables in SCHEMA_REFERENCE.md (including where PostgreSQL and SQL Server differ), plus several other corrections, and added documentation of odometer-type diagnostics and how to determine whether a reading came from the engine bus or was derived from GPS.

Geotab DIG Adapter

The Geotab DIG Adapter is an application that pushes telemetry data into MyGeotab via the Data Intake Gateway (DIG). While the MyGeotab API Adapter pulls data out of MyGeotab, the Geotab DIG Adapter enables integrators to stream data from custom (non-Geotab) telematics devices into the MyGeotab platform.

The two adapters can be used independently or together. They share the same geotabadapterdb database but use separate schemas.

• See the Geotab DIG Adapter README for full documentation.
• Change log: Version 5.1.0.0
• Upgrade instructions: Upgrade Guide: from v5.0.0.3 to v5.1.0.0

What's changed: This release fixes an issue whereby a rejected refresh token silently halted record delivery until the adapter was manually restarted. There are no database schema or configuration file changes — upgrading is a binary replacement.

• Bug fix — a rejected refresh token now triggers automatic re-authentication. Version 5.0.0.3 corrected the bearer token used on record-posting calls, but the token refresh call still reported a 401 Unauthorized or 403 Forbidden rejection without the numeric HTTP status code. The rejection was therefore absorbed by the general retry policy and retried against the same dead refresh token, never reaching the logic that escalates to a full re-login — so record delivery stopped until someone restarted the adapter. The refresh call now reports the numeric status code, matching the record-posting calls, so a rejected refresh token escalates to a full re-authentication automatically and delivery resumes without intervention.

Feedback

Help us prioritize future efforts and better understand how the adapters are used. If you would like to provide any feedback, please feel free to complete the applicable 100% voluntary survey(s):

• MyGeotab API Adapter - Usage Survey
• Geotab DIG Adapter - Usage Survey

v5.0.0.3

MyGeotab API Adapter

This repository contains two adapters for integrating with the Geotab platform. Each adapter has its own comprehensive README with architecture overview, configuration reference, operator guide, database schema reference, troubleshooting, and developer guide.

MyGeotab API Adapter

The MyGeotab API Adapter is a free, open source .NET 10.0 (C#) application that downloads data from a MyGeotab database and writes it to a local SQL Server or PostgreSQL database. It uses the MyGeotab SDK data feeds to pull the most common data sets incrementally, streaming them into tables that can serve as the foundation for downstream integrations with external systems.

For developers, the solution serves as both an example of proper MyGeotab API integration via data feeds and a ready-to-use starting point for building new integrations with the Geotab platform.

• See the MyGeotab API Adapter README for full documentation.
• Change log: Version 5.0.0.3
• Upgrade instructions: Upgrade Guide: from v5.0.0.1 to v5.0.0.3

What's changed: There are no changes to the MyGeotab API Adapter in v5.0.0.3 — the binaries are functionally identical to v5.0.0.1. The version is updated for alignment with the broader solution, in which a bug fix was made to the Geotab DIG Adapter (see below). Existing v5.0.0.1 installations of the MyGeotab API Adapter do not need to be upgraded.

Geotab DIG Adapter

The Geotab DIG Adapter is an application that pushes telemetry data into MyGeotab via the Data Intake Gateway (DIG). While the MyGeotab API Adapter pulls data out of MyGeotab, the Geotab DIG Adapter enables integrators to stream data from custom (non-Geotab) telematics devices into the MyGeotab platform.

The two adapters can be used independently or together. They share the same geotabadapterdb database but use separate schemas.

• See the Geotab DIG Adapter README for full documentation.
• Change log: Version 5.0.0.3
• Upgrade instructions: Upgrade Guide: from v5.0.0.1 to v5.0.0.3

What's changed: This release fixes a bug that could silently halt delivery of records to MyGeotab after a DIG API token rejection, and adds proactive token refresh as defense-in-depth. There are no database schema or configuration file changes from v5.0.0.1 — upgrading is a simple binary replacement.

• Bug fix — automatic re-authentication on token rejection. Previously, if the DIG API returned a 401 Unauthorized or 403 Forbidden token-rejection response, the adapter retried the same rejected token indefinitely (about every 10 minutes) instead of re-authenticating, silently stopping all delivery of records to MyGeotab until the adapter was manually restarted. The adapter now routes these responses to its re-authentication policy and recovers automatically (refreshing the token, or performing a full re-login as a fallback).
• Proactive token refresh-ahead (defense-in-depth). The adapter now re-authenticates automatically once its DIG bearer token is within roughly an hour of expiry (capped at half the token's lifetime, so short-lived tokens are not refreshed prematurely), rather than waiting for a rejection. This is built-in and requires no configuration; the reactive re-authentication described above remains in place as a backstop.

Feedback

Help us prioritize future efforts and better understand how the adapters are used. If you would like to provide any feedback, please feel free to complete the applicable 100% voluntary survey(s):

• MyGeotab API Adapter - Usage Survey
• Geotab DIG Adapter - Usage Survey

v5.0.0.1

MyGeotab API Adapter

This repository contains two adapters for integrating with the Geotab platform. Each adapter has its own comprehensive README with architecture overview, configuration reference, operator guide, database schema reference, troubleshooting, and developer guide.

MyGeotab API Adapter

The MyGeotab API Adapter is a free, open source .NET 10.0 (C#) application that downloads data from a MyGeotab database and writes it to a local SQL Server or PostgreSQL database. It uses the MyGeotab SDK data feeds to pull the most common data sets incrementally, streaming them into tables that can serve as the foundation for downstream integrations with external systems.

For developers, the solution serves as both an example of proper MyGeotab API integration via data feeds and a ready-to-use starting point for building new integrations with the Geotab platform.

• See the MyGeotab API Adapter README for full documentation.
• Change log: Version 5.0.0.1
• Upgrade instructions: Upgrade Guide: from v5.0.0 to v5.0.0.1

What's changed: This is a patch release containing a single bug fix. There are no database schema changes and no configuration file changes — upgrading is a simple binary replacement.

• Bug Fix: Resolved an issue with DatabaseMaintenanceService2 whereby Level 2 database maintenance (index rebuild) on SQL Server fails for non-partitioned indexes (such as those on staging tables) with the error Cannot specify partition number in the alter index statement as the index '...' is not partitioned.

Geotab DIG Adapter

The Geotab DIG Adapter is an application that pushes telemetry data into MyGeotab via the Data Intake Gateway (DIG). While the MyGeotab API Adapter pulls data out of MyGeotab, the Geotab DIG Adapter enables integrators to stream data from custom (non-Geotab) telematics devices into the MyGeotab platform.

The two adapters can be used independently or together. They share the same geotabadapterdb database but use separate schemas.

• See the Geotab DIG Adapter README for full documentation.
• Change log: Version 5.0.0.1
• Upgrade instructions: Upgrade Guide: from v5.0.0 to v5.0.0.1

Note: There are no changes to the Geotab DIG Adapter in v5.0.0.1. The version is updated for alignment with the broader solution. Existing v5.0.0 installations do not need to be upgraded.

Feedback

Help us prioritize future efforts and better understand how the adapters are used. If you would like to provide any feedback, please feel free to complete the applicable 100% voluntary survey(s):

• MyGeotab API Adapter - Usage Survey
• Geotab DIG Adapter - Usage Survey

v5.0.0

MyGeotab API Adapter

This repository contains two adapters for integrating with the Geotab platform. Each adapter has its own comprehensive README with architecture overview, configuration reference, operator guide, database schema reference, troubleshooting, and developer guide.

MyGeotab API Adapter

The MyGeotab API Adapter is a free, open source .NET 10.0 (C#) application that downloads data from a MyGeotab database and writes it to a local SQL Server or PostgreSQL database. It uses the MyGeotab SDK data feeds to pull the most common data sets incrementally, streaming them into tables that can serve as the foundation for downstream integrations with external systems.

For developers, the solution serves as both an example of proper MyGeotab API integration via data feeds and a ready-to-use starting point for building new integrations with the Geotab platform.

• See the MyGeotab API Adapter README for full documentation.
• Change log: Version 5.0.0
• Upgrade instructions: Upgrade Guide: from v4.1.2 to v5.0.0

Geotab DIG Adapter

The Geotab DIG Adapter is an application that pushes telemetry data into MyGeotab via the Data Intake Gateway (DIG). While the MyGeotab API Adapter pulls data out of MyGeotab, the Geotab DIG Adapter enables integrators to stream data from custom (non-Geotab) telematics devices into the MyGeotab platform.

The two adapters can be used independently or together. They share the same geotabadapterdb database but use separate schemas.

• See the Geotab DIG Adapter README for full documentation.
• Change log: Version 5.0.0
• Upgrade instructions: Initial release - see the Geotab DIG Adapter README above

Feedback

Help us prioritize future efforts and better understand how the adapters are used. If you would like to provide any feedback, please feel free to complete the applicable 100% voluntary survey(s):

• MyGeotab API Adapter - Usage Survey
• Geotab DIG Adapter - Usage Survey

v4.1.2

Important

As of version 4.0, the MyGeotab API Adapter solution has been fully migrated to Data Model 2 (DM2). The original data model and the Data Optimizer have been deprecated and removed from the solution effective January 2, 2026.
Anyone still using the original data model and looking to upgrade may refer to the following sections in the now deprecated original guide:

• IMPORTANT: Version 3.x - Data Model 2 (DM2)
• Data Optimizer Deprecated (Capabilities Moved to Core API Adapter in Version 3.x)

Notes

• Self-contained deployments are packaged in zip files - the names of which are prefixed with "MyGeotabAPIAdapter_SCD_" followed by the target Runtime Identifier (e.g. "win-x64").
• If using SQL Server or Azure SQL for the adapter database, the SQLServer.zip file contains the scripts associated with this release.
• If using PostgreSQL for the adapter database, the PostgreSQL.zip file contains the scripts associated with this release.

Here are some videos to help get started quickly and augment the documentation below. While SQL Server is the database of choice in these videos, the processes are similar for PostgreSQL, so the videos are still relevant regardless of the database provider chosen.

• ▶️ How to Download the MyGeotab API Adapter (3:25)
• ▶️ How to Set Up the MyGeotab API Adapter Database (4:20)
• ▶️ How to Deploy and Configure the MyGeotab API Adapter Application (8:15)
• ▶️ How to Start the MyGeotab API Adapter Application (2:15)
• ▶️ How to Upgrade the MyGeotab API Adapter (7:11)

For more detailed information, refer to the official guide and presentation:

• MyGeotab API Adapter DM2 — Solution and Implementation Guide
• MyGeotab API Adapter (presentation)

Upgrade Instructions

NOTE: This build includes changes to the schema of the adapter database.

• To upgrade an existing installation of the MyGeotab API Adapter solution from version 4.1.1 to version 4.1.2, see MyGeotab API Adapter — Upgrade Guide — from v4.1.1 to v4.1.2

Changes in This Release

For information on changes introduced in this and prior releases, refer to: Change Log - MyGeotab API Adapter - Data Model 2 (DM2)

Change Summary

Changes in this release are summarized below.

• Bug Fix: Resolved an issue with DatabaseMaintenanceService2 whereby Level 2 database maintenance may fail in some PostgreSQL environments where the geotabadapter_user lacks execute permissions on pgstattuple. Resolves Issue #25.
• Updated version to 4.1.2.0.

Feedback

Help us prioritize future efforts and better understand how the API Adapter is used! If you would like to provide any feedback about the MyGeotab API Adapter solution, please feel free to complete the 100% voluntary MyGeotab API Adapter - Usage Survey.

v4.1.1

Important

As of version 4.0, the MyGeotab API Adapter solution has been fully migrated to Data Model 2 (DM2). The original data model and the Data Optimizer have been deprecated and removed from the solution effective January 2, 2026.
Anyone still using the original data model and looking to upgrade may refer to the following sections in the now deprecated original guide:

• IMPORTANT: Version 3.x - Data Model 2 (DM2)
• Data Optimizer Deprecated (Capabilities Moved to Core API Adapter in Version 3.x)

Notes

• Self-contained deployments are packaged in zip files - the names of which are prefixed with "MyGeotabAPIAdapter_SCD_" followed by the target Runtime Identifier (e.g. "win-x64").
• If using SQL Server or Azure SQL for the adapter database, the SQLServer.zip file contains the scripts associated with this release.
• If using PostgreSQL for the adapter database, the PostgreSQL.zip file contains the scripts associated with this release.

Here are some videos to help get started quickly and augment the documentation below. While SQL Server is the database of choice in these videos, the processes are similar for PostgreSQL, so the videos are still relevant regardless of the database provider chosen.

• ▶️ How to Download the MyGeotab API Adapter (3:25)
• ▶️ How to Set Up the MyGeotab API Adapter Database (4:20)
• ▶️ How to Deploy and Configure the MyGeotab API Adapter Application (8:15)
• ▶️ How to Start the MyGeotab API Adapter Application (2:15)
• ▶️ How to Upgrade the MyGeotab API Adapter (7:11)

For more detailed information, refer to the official guide and presentation:

• MyGeotab API Adapter DM2 — Solution and Implementation Guide
• MyGeotab API Adapter (presentation)

Upgrade Instructions

NOTE: There are no database schema or configuration file changes from version 4.1.0 to version 4.1.1. It is safe to upgrade from version 4.1.0 to version 4.1.1 by simply downloading the new version and overwriting the respective appsettings.json and nlog.config files with those that were configured for version 4.1.0.

• To upgrade an existing installation of the MyGeotab API Adapter solution from version 4.1.0 to version 4.1.1, see MyGeotab API Adapter — Upgrade Guide — from v4.1.0 to v4.1.1.

Changes in This Release

For information on changes introduced in this and prior releases, refer to: Change Log - MyGeotab API Adapter - Data Model 2 (DM2)

Change Summary

Changes in this release are summarized below.

• Bug Fix: Resolved an issue with DatabaseMaintenanceService2 whereby Level 1 and 2 database maintenance activities were not being triggered. Resolves Issue #24.
• Updated version to 4.1.1.0.

Feedback

Help us prioritize future efforts and better understand how the API Adapter is used! If you would like to provide any feedback about the MyGeotab API Adapter solution, please feel free to complete the 100% voluntary MyGeotab API Adapter - Usage Survey.

v4.1.0

Important

As of version 4.0, the MyGeotab API Adapter solution has been fully migrated to Data Model 2 (DM2). The original data model and the Data Optimizer have been deprecated and removed from the solution effective January 2, 2026.
Anyone still using the original data model and looking to upgrade may refer to the following sections in the now deprecated original guide:

• IMPORTANT: Version 3.x - Data Model 2 (DM2)
• Data Optimizer Deprecated (Capabilities Moved to Core API Adapter in Version 3.x)

Notes

• Self-contained deployments are packaged in zip files - the names of which are prefixed with "MyGeotabAPIAdapter_SCD_" followed by the target Runtime Identifier (e.g. "win-x64").
• If using SQL Server or Azure SQL for the adapter database, the SQLServer.zip file contains the scripts associated with this release.
• If using PostgreSQL for the adapter database, the PostgreSQL.zip file contains the scripts associated with this release.

Here are some videos to help get started quickly and augment the documentation below. While SQL Server is the database of choice in these videos, the processes are similar for PostgreSQL, so the videos are still relevant regardless of the database provider chosen.

• ▶️ How to Download the MyGeotab API Adapter (3:25)
• ▶️ How to Set Up the MyGeotab API Adapter Database (4:20)
• ▶️ How to Deploy and Configure the MyGeotab API Adapter Application (8:15)
• ▶️ How to Start the MyGeotab API Adapter Application (2:15)
• ▶️ How to Upgrade the MyGeotab API Adapter (7:11)

For more detailed information, refer to the official guide and presentation:

• MyGeotab API Adapter DM2 — Solution and Implementation Guide
• MyGeotab API Adapter (presentation)

Upgrade Instructions

NOTE: This build includes changes to the schema of the adapter database and to the appsettings.json file.

• To upgrade an existing installation of the MyGeotab API Adapter solution from version 4.0.1.1 to version 4.1.0, see MyGeotab API Adapter — Upgrade Guide — from v4.0.1.1 to v4.1.0.

Changes in This Release

For information on changes introduced in this and prior releases, refer to: Change Log - MyGeotab API Adapter - Data Model 2 (DM2)

Change Summary

Changes in this release are summarized below.

• Added AuditLogs2 table with associated data feed.
• Modified Trips2 table:
  • Added Odometer and EngineHours columns.
• Modified Devices2 table:
  • Added CustomProperties column.
• Modified Users2 table:
  • Added Designation column.
• Bug Fix: Resolved an issue whereby records in the DiagnosticIds2 table were not restored if erroneously deleted by an external user/process, causing StatusData and FaultData records to be dropped instead of written to the adapter database.
  • Modified spMerge_stg_Diagnostics2 stored procedure/function (SQL Server + PostgreSQL):
    • Added DiagnosticIds2 self-healing logic that independently restores missing DiagnosticIds2 rows for active Diagnostics2 rows, regardless of whether the MERGE operation detects changes. This fixes an issue where DiagnosticIds2 rows could be permanently lost if Diagnostics2 rows remained unchanged.
  • Added two-phase diagnostic cache miss recovery to StatusDataProcessor2 and FaultDataProcessor2:
    • Phase 1: When a batch contains StatusData or FaultData records referencing unknown diagnostics, the processors now defer those records, force a refresh of the in-memory DiagnosticIds2 cache from the adapter database, and retry the lookup before skipping.
    • Phase 2: Unknown diagnostic Ids are tracked and signaled to DiagnosticProcessor2, which triggers an out-of-cycle sync from the MyGeotab API to ensure newly-appearing diagnostics are captured promptly.
  • Improved log messages for diagnostic lookup failures to include the diagnostic Id value for easier troubleshooting.
• Updated required adapter database version to 4.1.0.0.
• Updated NuGet packages to the latest stable release.
  • Geotab.Checkmate.ObjectModel updated from version 11.109.349 to 11.118.421.
• Updated version to 4.1.0.0.

Feedback

Help us prioritize future efforts and better understand how the API Adapter is used! If you would like to provide any feedback about the MyGeotab API Adapter solution, please feel free to complete the 100% voluntary MyGeotab API Adapter - Usage Survey.

v4.0.1.1

Important

As of version 4.0, the MyGeotab API Adapter solution has been fully migrated to Data Model 2 (DM2). The original data model and the Data Optimizer have been deprecated and removed from the solution effective January 2, 2026.
Anyone still using the original data model and looking to upgrade may refer to the following sections in the now deprecated original guide:

• IMPORTANT: Version 3.x - Data Model 2 (DM2)
• Data Optimizer Deprecated (Capabilities Moved to Core API Adapter in Version 3.x)

Notes

• Self-contained deployments are packaged in zip files - the names of which are prefixed with "MyGeotabAPIAdapter_SCD_" followed by the target Runtime Identifier (e.g. "win-x64").
• If using SQL Server or Azure SQL for the adapter database, the SQLServer.zip file contains the scripts associated with this release.
• If using PostgreSQL for the adapter database, the PostgreSQL.zip file contains the scripts associated with this release.

Here are some videos to help get started quickly and augment the documentation below. While SQL Server is the database of choice in these videos, the processes are similar for PostgreSQL, so the videos are still relevant regardless of the database provider chosen.

• ▶️ How to Download the MyGeotab API Adapter (3:25)
• ▶️ How to Set Up the MyGeotab API Adapter Database (4:20)
• ▶️ How to Deploy and Configure the MyGeotab API Adapter Application (8:15)
• ▶️ How to Start the MyGeotab API Adapter Application (2:15)
• ▶️ How to Upgrade the MyGeotab API Adapter (7:11)

For more detailed information, refer to the official guide and presentation:

• MyGeotab API Adapter DM2 — Solution and Implementation Guide
• MyGeotab API Adapter (presentation)

Upgrade Instructions

NOTE: This build includes changes to the schema of the adapter database.

• To upgrade an existing installation of the MyGeotab API Adapter solution from version 4.0.0 to version 4.0.1.1, see MyGeotab API Adapter — Upgrade Guide — from v4.0.0 to v4.0.1.1.

Changes in This Release

For information on changes introduced in this and prior releases, refer to: Change Log - MyGeotab API Adapter - Data Model 2 (DM2)

Change Summary

Changes in this release are summarized below.

• Bug Fix: Modified GenericGeotabGUIDCacheableDbObjectCache2 class:
  • Added logic to prevent a “A DbDiagnostic2 with GeotabId ""..."" already exists in the geotabGuidFromGeotabIdCache. Duplicates are not allowed.” exception that will cause the application to crash.
• Bug Fix: Modified database partitioning procedure/function (spManagePartitions):
  • SQL Server version: Added check to throw error if filePath is invalid to prevent creation of a partition with no associated FileGroup, which can happen during initial setup and cause partitioning issues if not handled.
  • PostgreSQL version: No changes other than DB version upgrade to by consistent with MSSQL..
• Updated required adapter database version to 4.0.1.0.
• Updated NuGet packages to the latest stable release.
  • Geotab.Checkmate.ObjectModel updated from version 11.98.302 to 11.109.349.
• Updated version to 4.0.1.1.

Feedback

Help us prioritize future efforts and better understand how the API Adapter is used! If you would like to provide any feedback about the MyGeotab API Adapter solution, please feel free to complete the 100% voluntary MyGeotab API Adapter - Usage Survey.

v4.0.1

Important

As of version 4.0, the MyGeotab API Adapter solution has been fully migrated to Data Model 2 (DM2). The original data model and the Data Optimizer have been deprecated and removed from the solution effective January 2, 2026.
Anyone still using the original data model and looking to upgrade may refer to the following sections in the now deprecated original guide:

• IMPORTANT: Version 3.x - Data Model 2 (DM2)
• Data Optimizer Deprecated (Capabilities Moved to Core API Adapter in Version 3.x)

Notes

• Self-contained deployments are packaged in zip files - the names of which are prefixed with "MyGeotabAPIAdapter_SCD_" followed by the target Runtime Identifier (e.g. "win-x64").
• If using SQL Server or Azure SQL for the adapter database, the SQLServer.zip file contains the scripts associated with this release.
• If using PostgreSQL for the adapter database, the PostgreSQL.zip file contains the scripts associated with this release.

Here are some videos to help get started quickly and augment the documentation below. While SQL Server is the database of choice in these videos, the processes are similar for PostgreSQL, so the videos are still relevant regardless of the database provider chosen.

• ▶️ How to Download the MyGeotab API Adapter (3:25)
• ▶️ How to Set Up the MyGeotab API Adapter Database (4:20)
• ▶️ How to Deploy and Configure the MyGeotab API Adapter Application (8:15)
• ▶️ How to Start the MyGeotab API Adapter Application (2:15)
• ▶️ How to Upgrade the MyGeotab API Adapter (7:11)

For more detailed information, refer to the official guide and presentation:

• MyGeotab API Adapter DM2 — Solution and Implementation Guide
• MyGeotab API Adapter (presentation)

Upgrade Instructions

NOTE: This build includes changes to the schema of the adapter database.

• To upgrade an existing installation of the MyGeotab API Adapter solution from version 4.0.0 to version 4.0.1, see MyGeotab API Adapter — Upgrade Guide — from v4.0.0 to v4.0.1.

Changes in This Release

For information on changes introduced in this and prior releases, refer to: Change Log - MyGeotab API Adapter - Data Model 2 (DM2)

Change Summary

Changes in this release are summarized below.

• Bug Fix: Modified GenericGeotabGUIDCacheableDbObjectCache2 class:
  • Added logic to prevent a “A DbDiagnostic2 with GeotabId ""..."" already exists in the geotabGuidFromGeotabIdCache. Duplicates are not allowed.” exception that will cause the application to crash.
• Bug Fix: Modified database partitioning procedure/function (spManagePartitions):
  • SQL Server version: Added check to throw error if filePath is invalid to prevent creation of a partition with no associated FileGroup, which can happen during initial setup and cause partitioning issues if not handled.
  • PostgreSQL version: No changes other than DB version upgrade to by consistent with MSSQL..
• Updated NuGet packages to the latest stable release.
• Geotab.Checkmate.ObjectModel updated from version 11.98.302 to 11.109.349.
• Updated version to 4.0.1.0.

Feedback

Help us prioritize future efforts and better understand how the API Adapter is used! If you would like to provide any feedback about the MyGeotab API Adapter solution, please feel free to complete the 100% voluntary MyGeotab API Adapter - Usage Survey.