v3.14.0

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:

• 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_" (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.

• ▶️ 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:

• MyGeotab API Adapter DM2 — Solution and Implementation Guide

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 3.13.0 to version 3.14.0, see MyGeotab API Adapter — Upgrade Guide — from v3.13.0 to v3.14.0.
  • If using Data Model 2 (DM2), refer to the Upgrading to v3.14.0 with Data Model 2 (DM2) section.
  • If using the original (deprecated) data model, refer to the Upgrading to v3.14.0 with Original Data Model section.

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 Log - MyGeotab API Adapter - Data Model 2 (DM2)
• Change Log - MyGeotab API Adapter - Original Data Model
• Change Log - Data Optimizer (Only available with API Adapter Original Data Model)

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

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:

• 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_" (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.

• ▶️ 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:

• MyGeotab API Adapter DM2 — Solution and Implementation Guide

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 3.12.0 to version 3.13.0, see MyGeotab API Adapter — Upgrade Guide — from v3.12.0 to v3.13.0.
  • If using Data Model 2 (DM2), refer to the Upgrading to v3.13.0 with Data Model 2 (DM2) section.
  • If using the original (deprecated) data model, refer to the Upgrading to v3.13.0 with Original Data Model section.

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 Log - MyGeotab API Adapter - Data Model 2 (DM2)
• Change Log - MyGeotab API Adapter - Original Data Model
• Change Log - Data Optimizer (Only available with API Adapter Original Data Model)

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.
  • Added upd_DVIRDefectUpdates2 and fail_DVIRDefectUpdateFailures2 tables.
  • Added DVIRLog Manipulator section to this guide to fully explain what it does and how to use it.
• [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

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:

• 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_" (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.

• ▶️ 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:

• MyGeotab API Adapter DM2 — Solution and Implementation Guide

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 3.11.0 to version 3.12.0, see MyGeotab API Adapter — Upgrade Guide — from v3.11.0 to v3.12.0.
  • If using Data Model 2 (DM2), refer to the Upgrading to v3.12.0 with Data Model 2 (DM2) section.
  • If using the original (deprecated) data model, refer to the Upgrading to v3.12.0 with Original Data Model section.

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 Log - MyGeotab API Adapter - Data Model 2 (DM2)
• Change Log - MyGeotab API Adapter - Original Data Model
• Change Log - Data Optimizer (Only available with API Adapter Original Data Model)

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

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:

• 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_" (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.

• ▶️ 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:

• MyGeotab API Adapter DM2 — Solution and Implementation Guide

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 3.10.0 to version 3.11.0, see MyGeotab API Adapter — Upgrade Guide — from v3.10.0 to v3.11.0.
  • If using Data Model 2 (DM2), refer to the Upgrading to v3.11.0 with Data Model 2 (DM2) section.
  • If using the original (deprecated) data model, refer to the Upgrading to v3.11.0 with Original Data Model section.

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 Log - MyGeotab API Adapter - Data Model 2 (DM2)
• Change Log - MyGeotab API Adapter - Original Data Model
• Change Log - Data Optimizer (Only available with API Adapter Original Data Model)

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 the Step 4: Run the MyGeotab API Adapter section in the guide to include instructions on installing the API Adapter as a service.
• [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.

v3.10.0

Data Model 2 (DM2) - The Next Evolution

Important

As of version 3.0, the MyGeotab API Adapter solution has begun its evolution to using a new data model. It is expected to take several months from the initial version 3.0 release to port-over the various Geotab entity types that are currently supported. Once complete, the existing data model and the Data Optimizer will be deprecated after a reasonable period to provide integrators time to modify any integrations that they need to migrate to the new data model.

For more information:

• IMPORTANT: Version 3.x - Data Model 2 (DM2)
• Data Optimizer Deprecated (Capabilities Moved to Core API Adapter in Version 3.x)
• MyGeotab API Adapter DM2 — Solution and Implementation Guide

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.

The following resources are available for further information:

• MyGeotab API Adapter DM2 — Solution and Implementation Guide (guide) 🆕
• (Deprecated) MyGeotab API Adapter - Solution and Implementation Guide (guide)
• MyGeotab API Adapter - Data Optimizer - Solution and Implementation Guide (guide)
• MyGeotab API Adapter (presentation)
• MyGeotab API Adapter and Data Optimizer (presentation)
• MyGeotab API Adapter - Guide for Deploying to Microsoft Azure (guide)
• MyGeotab API Adapter - Developer Overview (presentation)
• MyGeotab API Adapter — How to Add a Data Feed (guide)
• MyGeotab API Adapter - Expanding on the Data Optimizer (presentation)

Upgrade Instructions

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

• To upgrade an existing installation of the MyGeotab API Adapter solution from version 3.9.0 to version 3.10.0, see MyGeotab API Adapter — Upgrade Guide — from v3.9.0 to v3.10.0.
  • If using the original data model, refer to the Upgrading to v3.10.0 with Original Data Model section.
  • If using Data Model 2 (DM2), refer to the Upgrading to v3.10.0 with Data Model 2 (DM2) section.

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 Log - MyGeotab API Adapter - Data Model 2 (DM2)
• Change Log - MyGeotab API Adapter - Original Data Model
• Change Log - Data Optimizer (Only available with API Adapter Original Data Model

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 FuelAndEnergyUsed2 table with associated data feed.
• [DM2] Modified the FaultData2 table:
  • Added EffectOnComponent, FaultDescription, FlashCodeId, FlashCodeName, Recommendation and RiskOfBreakdown columns to include properties recently added to the FaultData entity.
• [DM1, DM2] Modified the appsettings.json file:
  • Added a section with settings for the new FuelAndEnergyUsed feed.
  • Added a “PopulateEffectOnComponentAndRecommendation” setting to the FaultData feed section.
  • Made related changes throughout the application.
• [DM1, DM2] Updated NuGet packages to the latest stable release.
  • Geotab.Checkmate.ObjectModel updated from version 11.68.266 to 11.83.265.
• [DM1, DM2] Updated version to 3.10.0.0.
• [DM2] Added training videos to the Quick Start Guide:
  • How to Download the MyGeotab API Adapter.mp4
  • How to Set Up the MyGeotab API Adapter Database.mp4
  • How to Deploy and Configure the MyGeotab API Adapter Application.mp4
  • How to Start the MyGeotab API Adapter Application.mp4
  • How to Upgrade the MyGeotab API Adapter.mp4

v3.9.0

Data Model 2 (DM2) - The Next Evolution

Important

As of version 3.0, the MyGeotab API Adapter solution has begun its evolution to using a new data model. It is expected to take several months from the initial version 3.0 release to port-over the various Geotab entity types that are currently supported. Once complete, the existing data model and the Data Optimizer will be deprecated after a reasonable period to provide integrators time to modify any integrations that they need to migrate to the new data model.

For more information:

• IMPORTANT: Version 3.x - Data Model 2 (DM2)
• Data Optimizer Deprecated (Capabilities Moved to Core API Adapter in Version 3.x)
• MyGeotab API Adapter DM2 — Solution and Implementation Guide

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.

The following resources are available for further information:

• MyGeotab API Adapter - Solution and Implementation Guide (guide)
• MyGeotab API Adapter DM2 — Solution and Implementation Guide (guide) 🆕
• MyGeotab API Adapter - Data Optimizer - Solution and Implementation Guide (guide)
• MyGeotab API Adapter (presentation)
• MyGeotab API Adapter and Data Optimizer (presentation)
• MyGeotab API Adapter - Guide for Deploying to Microsoft Azure (guide)
• MyGeotab API Adapter - Developer Overview (presentation)
• MyGeotab API Adapter — How to Add a Data Feed (guide)
• MyGeotab API Adapter - Expanding on the Data Optimizer (presentation)

Upgrade Instructions

NOTE: This build includes changes to the schema of the adapter database and the optimizer database as well as to the appsettings.json files.

• To upgrade an existing installation of the MyGeotab API Adapter solution from version 3.8.0 to version 3.9.0, see MyGeotab API Adapter — Upgrade Guide — from v3.8.0 to v3.9.0.
  • If using the original data model, refer to the Upgrading to v3.9.0 with Original Data Model section.
  • If using Data Model 2 (DM2), refer to the Upgrading to v3.9.0 with Data Model 2 (DM2) section.

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 Log - MyGeotab API Adapter - Data Model 2 (DM2)
• Change Log - MyGeotab API Adapter - Original Data Model
• Change Log - Data Optimizer (Only available with API Adapter Original Data Model

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

• [DM1, DM2] Added Feedback section to the DM2 guide with a link to the MyGeotab API Adapter - Usage Survey which provides a mechanism by which to provide feedback about the MyGeotab API Adapter solution.
• [DM1, DM2] FIX: Modified stg_Diagnostics2 and Diagnostics2 tables, the Diagnostics table and the DiagnosticsT table:
  • Increased length of DiagnosticName column from 255 to max to accommodate new Diagnostics with long names on the MyGeotab side.
• [DM2] Added pseudo feed for DutyStatusAvailability along with associated DutyStatusAvailabilities2 table.
• [DM1, DM2] Modified ExceptionEvent feed - setting IncludeInvalidated, IncludeDismissedEvents and IncludeDeleted all to true (previously, only IncludeInvalidated was set to true)
• [DM1, DM2] Modified the appsettings.json files (for both API Adapter and Data Optimizer):
  • Renamed “OverrideSetings” to “OverrideSettings” (to correct typo).
  • Made related changes throughout the applications.
• [DM1, DM2] Added macOS publish profile (to facilitate deployment to macOS systems)
• [DM1, DM2] Updated NuGet packages to the latest stable release.
• [DM1, DM2] Updated version to 3.9.0.0.

v3.8.0

Data Model 2 (DM2) - The Next Evolution

Important

As of version 3.0, the MyGeotab API Adapter solution has begun its evolution to using a new data model. It is expected to take several months from the initial version 3.0 release to port-over the various Geotab entity types that are currently supported. Once complete, the existing data model and the Data Optimizer will be deprecated after a reasonable period to provide integrators time to modify any integrations that they need to migrate to the new data model.

For more information:

• IMPORTANT: Version 3.x - Data Model 2 (DM2)
• Data Optimizer Deprecated (Capabilities Moved to Core API Adapter in Version 3.x)
• MyGeotab API Adapter DM2 — Solution and Implementation Guide

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.

The following resources are available for further information:

• MyGeotab API Adapter - Solution and Implementation Guide (guide)
• MyGeotab API Adapter DM2 — Solution and Implementation Guide (guide) 🆕
• MyGeotab API Adapter - Data Optimizer - Solution and Implementation Guide (guide)
• MyGeotab API Adapter (presentation)
• MyGeotab API Adapter and Data Optimizer (presentation)
• MyGeotab API Adapter - Guide for Deploying to Microsoft Azure (guide)
• MyGeotab API Adapter - Developer Overview (presentation)
• MyGeotab API Adapter — How to Add a Data Feed (guide)
• MyGeotab API Adapter - Expanding on the Data Optimizer (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 3.7.0 to version 3.8.0, see MyGeotab API Adapter — Upgrade Guide — from v3.7.0 to v3.8.0 [PUBLIC].
  • If using the original data model, refer to the Upgrading to v3.8.0 with Original Data Model section.
  • If using Data Model 2 (DM2), refer to the Upgrading to v3.8.0 with Data Model 2 (DM2) section.

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 Log - MyGeotab API Adapter - Data Model 2 (DM2)
• Change Log - MyGeotab API Adapter - Original Data Model
• Change Log - Data Optimizer (Only available with API Adapter Original Data Model

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] Modified Devices2 table:
  • [DM2] Added TmpTrailerGeotabId and TmpTrailerId columns.
• [DM2] Added DefectSeverities2 and RepairStatuses2 reference data tables.
• [DM2] Added data feed for DVIRLogs along with associated DVIRLogs2, DVIRDefects2 and DVIRDefectRemarks2 tables.
• [DM2] Added DVIRLog Queries section to the guide.
• [DM1, DM2] Updated NuGet packages to the latest stable release.
• [DM1, DM2] Updated version to 3.8.0.0.

v3.7.0

Data Model 2 (DM2) - The Next Evolution

Important

As of version 3.0, the MyGeotab API Adapter solution has begun its evolution to using a new data model. It is expected to take several months from the initial version 3.0 release to port-over the various Geotab entity types that are currently supported. Once complete, the existing data model and the Data Optimizer will be deprecated after a reasonable period to provide integrators time to modify any integrations that they need to migrate to the new data model.

For more information:

• IMPORTANT: Version 3.x - Data Model 2 (DM2)
• Data Optimizer Deprecated (Capabilities Moved to Core API Adapter in Version 3.x)
• MyGeotab API Adapter DM2 — Solution and Implementation Guide

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.

The following resources are available for further information:

• MyGeotab API Adapter - Solution and Implementation Guide (guide)
• MyGeotab API Adapter DM2 — Solution and Implementation Guide (guide) 🆕
• MyGeotab API Adapter - Data Optimizer - Solution and Implementation Guide (guide)
• MyGeotab API Adapter (presentation)
• MyGeotab API Adapter and Data Optimizer (presentation)
• MyGeotab API Adapter - Guide for Deploying to Microsoft Azure (guide)
• MyGeotab API Adapter - Developer Overview (presentation)
• MyGeotab API Adapter — How to Add a Data Feed (guide)
• MyGeotab API Adapter - Expanding on the Data Optimizer (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 3.6.0 to version 3.7.0, see MyGeotab API Adapter — Upgrade Guide — from v3.6.0 to v3.7.0 [PUBLIC].
  • If using the original data model, refer to the Upgrading to v3.7.0 with Original Data Model section.
  • If using Data Model 2 (DM2), refer to the Upgrading to v3.7.0 with Data Model 2 (DM2) section.

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 Log - MyGeotab API Adapter - Data Model 2 (DM2)
• Change Log - MyGeotab API Adapter - Original Data Model
• Change Log - Data Optimizer (Only available with API Adapter Original Data Model

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 DeviceStatusInfo2 table with associated data feed.
• [DM2] Added DeviceStatusInfo Queries section to the guide.
• [DM1, DM2] Updated NuGet packages to the latest stable release.
• [DM1, DM2] Updated version to 3.7.0.0.

v3.6.0

Data Model 2 (DM2) - The Next Evolution

Important

As of version 3.0, the MyGeotab API Adapter solution has begun its evolution to using a new data model. It is expected to take several months from the initial version 3.0 release to port-over the various Geotab entity types that are currently supported. Once complete, the existing data model and the Data Optimizer will be deprecated after a reasonable period to provide integrators time to modify any integrations that they need to migrate to the new data model.

For more information:

• IMPORTANT: Version 3.x - Data Model 2 (DM2)
• Data Optimizer Deprecated (Capabilities Moved to Core API Adapter in Version 3.x)
• MyGeotab API Adapter DM2 — Solution and Implementation Guide

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.

The following resources are available for further information:

• MyGeotab API Adapter - Solution and Implementation Guide (guide)
• MyGeotab API Adapter DM2 — Solution and Implementation Guide (guide) 🆕
• MyGeotab API Adapter - Data Optimizer - Solution and Implementation Guide (guide)
• MyGeotab API Adapter (presentation)
• MyGeotab API Adapter and Data Optimizer (presentation)
• MyGeotab API Adapter - Guide for Deploying to Microsoft Azure (guide)
• MyGeotab API Adapter - Developer Overview (presentation)
• MyGeotab API Adapter — How to Add a Data Feed (guide)
• MyGeotab API Adapter - Expanding on the Data Optimizer (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 3.5.0 to version 3.6.0, see MyGeotab API Adapter — Upgrade Guide — from v3.5.0 to v3.6.0 [PUBLIC].
  • If using the original data model, refer to the Upgrading to v3.6.0 with Original Data Model section.
  • If using Data Model 2 (DM2), refer to the Upgrading to v3.6.0 with Data Model 2 (DM2) section.

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 Log - MyGeotab API Adapter - Data Model 2 (DM2)
• Change Log - MyGeotab API Adapter - Original Data Model
• Change Log - Data Optimizer (Only available with API Adapter Original Data Model

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 DriverChanges2 table with associated data feed.
• [DM2] Added handling for database foreign key violations caused by race conditions. Essentially, if Processor B encounters an FK violation exception related to Processor A, Processor B will roll-back and wait until Processor A has completed another iteration (via monitoring the OserviceTracking2 table) before trying the next iteration in which it will re-execute the rolled-back actions.
• [DM2] Bug Fix: Updated BackgroundServiceAwaiter WaitForConnectivityRestorationIfNeededAsync method to return bool indicating whether wait was needed. Updated relevant v2 services to set feedVersionRollbackRequired based on this bool so that feed version rollback works properly.
• [DM1, DM2] Enhanced GenericGeotabObjectFeeder:
  • Added Rollback method to simplify updating of LastFeedVersion and LastProcessedFeedVersion properties along with resetting FeedStartOption to ConfiguredFeedStartOption in cases where rollback occurs on the first GetFeed call for a given entity type.
  • Modified services to use the new GenericGeotabObjectFeeder.Rollback method.
• [DM1, DM2] Updated NuGet packages to the latest stable release.
• [DM1, DM2] Updated version to 3.6.0.0.

v3.5.0

Data Model 2 (DM2) - The Next Evolution

Important

As of version 3.0, the MyGeotab API Adapter solution has begun its evolution to using a new data model. It is expected to take several months from the initial version 3.0 release to port-over the various Geotab entity types that are currently supported. Once complete, the existing data model and the Data Optimizer will be deprecated after a reasonable period to provide integrators time to modify any integrations that they need to migrate to the new data model.

For more information:

• IMPORTANT: Version 3.x - Data Model 2 (DM2)
• Data Optimizer Deprecated (Capabilities Moved to Core API Adapter in Version 3.x)
• MyGeotab API Adapter DM2 — Solution and Implementation Guide

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.

The following resources are available for further information:

• MyGeotab API Adapter - Solution and Implementation Guide (guide)
• MyGeotab API Adapter DM2 — Solution and Implementation Guide (guide) 🆕
• MyGeotab API Adapter - Data Optimizer - Solution and Implementation Guide (guide)
• MyGeotab API Adapter (presentation)
• MyGeotab API Adapter and Data Optimizer (presentation)
• MyGeotab API Adapter - Guide for Deploying to Microsoft Azure (guide)
• MyGeotab API Adapter - Developer Overview (presentation)
• MyGeotab API Adapter — How to Add a Data Feed (guide)
• MyGeotab API Adapter - Expanding on the Data Optimizer (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 3.4.0 to version 3.5.0, see MyGeotab API Adapter — Upgrade Guide — from v3.4.0 to v3.5.0 [PUBLIC].
  • If using the original data model, refer to the Upgrading to v3.5.0 with Original Data Model section.
  • If using Data Model 2 (DM2), refer to the Upgrading to v3.5.0 with Data Model 2 (DM2) section.

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 Log - MyGeotab API Adapter - Data Model 2 (DM2)
• Change Log - MyGeotab API Adapter - Original Data Model
• Change Log - Data Optimizer (Only available with API Adapter Original Data Model

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 ChargeEvents2 table with associated data feed.
• [DM2] Modified Rules2 table: Added Condition column populated with the hierarchical tree of Condition(s) defining the logic of a Rule in JSON form.
• Modified FaultDataLocationService2 and StatusDataLocationService2 to include Polly retry wrappers around transactionless bulk updates of database tables to avoid crash in the event of a transient deadlock.
• [DM1, DM2] Updated NuGet packages to the latest stable release.
• [DM1, DM2] Updated version to 3.5.0.0.