Skip to content

Releases: Geotab/mygeotab-api-adapter

v4.1.2

10 Apr 16:01

Choose a tag to compare

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:

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.

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

Upgrade Instructions

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

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

06 Apr 18:17

Choose a tag to compare

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:

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.

For more detailed information, refer to the official guide and 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.

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

26 Mar 20:07

Choose a tag to compare

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:

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.

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

Upgrade Instructions

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

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

02 Feb 02:45

Choose a tag to compare

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:

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.

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

Upgrade Instructions

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

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

30 Jan 19:17

Choose a tag to compare

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:

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.

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

Upgrade Instructions

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

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.

v4.0.0

02 Jan 21:41

Choose a tag to compare

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:

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.

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

Upgrade Instructions

NOTE: This build includes changes to the appsettings.json file.

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.

  • DEPRECATED THE ORIGINAL DATA MODEL. Related changes include the following:
    • Removed the Data Optimizer. Its capabilities are included (and vastly improved) in the API Adapter’s Data Enhancement Services.
    • Removed v1 database scripts.
    • Removed the VSS Add-On. This was an extraneous feature that was not ported over to DM2.
    • Removed Azure deployment scripts. The scripts were designed for DM1 and would not work with DM2 as a result of database partitioning complexities. Similar Azure deployment scripts supporting DM2 may be added in the future.
    • Modified the appsettings.json file:
      • Removed the UseDataModel2 setting.
      • Removed the DebugData section (DebugData is not supported in DM2).
    • Cleaned-up the solution by modifying code as needed and removing items no longer needed as a result of the above.
    • Updated README.md file.
    • Updated NuGet packages to the latest stable release.
      • Geotab.Checkmate.ObjectModel updated from version 11.83.265 to 11.98.302.
    • Updated version to 4.0.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.

v3.14.0

02 Dec 01:14

Choose a tag to compare

Original Data Model and Data Optimizer Deprecated

Important

As of version 3.0, the MyGeotab API Adapter solution has migrated to a new data model. The original data model and the Data Optimizer have been deprecated and will be removed from the solution after December 31, 2025.

For more information:

Notes

  • Self-contained deployments are packaged in zip files - the names of which are prefixed with "MyGeotabAPIAdapter_SCD_" (for the MyGeotab API Adapter) or "MyGeotabAPIAdapter.DataOptimizer_SCD_" (for the MyGeotab API Adapter Data Optimizer) 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.
  • If using Oracle for the adapter database, the Oracle.zip file contains the scripts associated with this release.
  • For the Data Optimizer database, the SQLServer_DataOptimizer.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.

For more detailed information, refer to the official guide:

Upgrade Instructions

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

Changes in This Release

For information on changes introduced in this and prior releases, refer to the Change Log section(s) in the relevant document(s) below:

Change Summary

Changes in this release are summarized below with "DM1" denoting changes that apply to the original data model and "DM2" denoting changes that apply to Data Model 2 (DM2).

  • [DM2] Bug Fix: Modified database partitioning procedure/function (spManagePartitions):
    • SQL Server version: Fixed issue that could cause monthly partitions to become daily.
    • PostgreSQL version: Changed function to ensure that daily/weekly/monthly partitions cover the entire next month.
  • [DM1, DM2] Updated version to 3.14.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.

v3.13.0

03 Nov 22:32

Choose a tag to compare

Original Data Model and Data Optimizer Deprecated

Important

As of version 3.0, the MyGeotab API Adapter solution has migrated to a new data model. The original data model and the Data Optimizer have been deprecated and will be removed from the solution after December 31, 2025.

For more information:

Notes

  • Self-contained deployments are packaged in zip files - the names of which are prefixed with "MyGeotabAPIAdapter_SCD_" (for the MyGeotab API Adapter) or "MyGeotabAPIAdapter.DataOptimizer_SCD_" (for the MyGeotab API Adapter Data Optimizer) 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.
  • If using Oracle for the adapter database, the Oracle.zip file contains the scripts associated with this release.
  • For the Data Optimizer database, the SQLServer_DataOptimizer.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.

For more detailed information, refer to the official guide:

Upgrade Instructions

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

Changes in This Release

For information on changes introduced in this and prior releases, refer to the Change Log section(s) in the relevant document(s) below:

Change Summary

Changes in this release are summarized below with "DM1" denoting changes that apply to the original data model and "DM2" denoting changes that apply to Data Model 2 (DM2).

  • [DM2] Migrated DVIRLog Manipulator to DM2.
  • [DM2] Bug Fix: Modified the PostgreSQL version of the spMerge_stg_Trips2 function to include the missing Distance column when updating the Trips2 table. See the Re-Extract Trips Data if Necessary section in the upgrade guide for more information.
  • [DM2] Bug Fix: Added logic to ensure that database partitioning happens, if needed, on application startup before any other services write data to the adapter database.
    • This is to prevent partitioning-related errors that could occur in situations such as where the API Adapter is started after having been stopped for an extended period.
  • [DM2] Added a section to PostgreSQL scripts to change ownership of all tables to geotabadapter_client to capture any that were not set previously and avoid any possible related issues.
  • [DM1, DM2] Updated NuGet packages to the latest stable release.
  • [DM1, DM2] Updated version to 3.13.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.

v3.12.0

23 Sep 20:24

Choose a tag to compare

Original Data Model and Data Optimizer Deprecated

Important

As of version 3.0, the MyGeotab API Adapter solution has migrated to a new data model. The original data model and the Data Optimizer have been deprecated and will be removed from the solution after December 31, 2025.

For more information:

Notes

  • Self-contained deployments are packaged in zip files - the names of which are prefixed with "MyGeotabAPIAdapter_SCD_" (for the MyGeotab API Adapter) or "MyGeotabAPIAdapter.DataOptimizer_SCD_" (for the MyGeotab API Adapter Data Optimizer) 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.
  • If using Oracle for the adapter database, the Oracle.zip file contains the scripts associated with this release.
  • For the Data Optimizer database, the SQLServer_DataOptimizer.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.

For more detailed information, refer to the official guide:

Upgrade Instructions

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

Changes in This Release

For information on changes introduced in this and prior releases, refer to the Change Log section(s) in the relevant document(s) below:

Change Summary

Changes in this release are summarized below with "DM1" denoting changes that apply to the original data model and "DM2" denoting changes that apply to Data Model 2 (DM2).

  • [DM2] Added DutyStatusLogs2 table with associated data feed.
  • [DM2] Removed physical foreign key relationships associated with User, Device and Rule Ids to accommodate historic data and certain edge cases.
  • [DM2] Added handling for specific KnownIds including "NoDeviceId", "NoDriverId", “NoRuleId”, “NoUserId”, “NoZoneId” and "UnknownDriverId" via the introduction of sentinel records with placeholder values to represent these IDs in the relevant tables and logic in associated processors to perform the related ID substitutions.
  • [DM2] Made the ExceptionEvents2.RuleId column nullable.
  • [DM1, DM2] Updated NuGet packages to the latest stable release.
  • [DM1, DM2] Updated version to 3.12.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.

v3.11.0

05 Aug 19:51

Choose a tag to compare

Original Data Model and Data Optimizer Deprecated

Important

As of version 3.0, the MyGeotab API Adapter solution has migrated to a new data model. The original data model and the Data Optimizer have been deprecated and will be removed from the solution after December 31, 2025.

For more information:

Notes

  • Self-contained deployments are packaged in zip files - the names of which are prefixed with "MyGeotabAPIAdapter_SCD_" (for the MyGeotab API Adapter) or "MyGeotabAPIAdapter.DataOptimizer_SCD_" (for the MyGeotab API Adapter Data Optimizer) 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.
  • If using Oracle for the adapter database, the Oracle.zip file contains the scripts associated with this release.
  • For the Data Optimizer database, the SQLServer_DataOptimizer.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.

For more detailed information, refer to the official guide:

Upgrade Instructions

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

Changes in This Release

For information on changes introduced in this and prior releases, refer to the Change Log section(s) in the relevant document(s) below:

Change Summary

Changes in this release are summarized below with "DM1" denoting changes that apply to the original data model and "DM2" denoting changes that apply to Data Model 2 (DM2).

  • [DM2] Added ability to install the MyGeotab API Adapter application (DM2) as a service (in Windows or Linux).
  • [DM2] Updated spMerge_stg_DVIRDefects2 and spMerge_stg_DVIRLogs2 stored procedures / functions to avoid FK violations caused when records must be deleted and re-inserted to move between database partitions.
  • [DM1] Modified GeotabTripDbTripObjectMapper to ignore Trips with null Device.
  • [DM1, DM2] Updated README.md file.
  • [DM1, DM2] Updated NuGet packages to the latest stable release.
  • [DM1, DM2] Updated version to 3.11.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.