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