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