diff --git a/Integration-Configuration-with-database.properties.md b/Integration-Configuration-with-database.properties.md new file mode 100644 index 0000000..ae192eb --- /dev/null +++ b/Integration-Configuration-with-database.properties.md @@ -0,0 +1,59 @@ +# TrackEngine Integration Configuration + +This section of the `database.properties` file controls the **TrackEngine module integration**, including the executable path and whether the system should automatically provision the required runtime and data files. + +--- + +## `trizdistribution.dossier.chemain.trackEngine` + +| Property | Value | Description | +|----------|-------|-------------| +| `trizdistribution.dossier.chemain.trackEngine` | `C:\TrackEngine\bin\TrackEngine.exe` | Absolute file-system path to the **TrackEngine executable**. | + +**What it points to:** +- `TrackEngine.exe` is the compiled native binary of the trajectory processing pipeline. +- This is the entry-point program that orchestrates the T-DBSCAN → Douglas-Peucker → OSRM pipeline described in the main configuration. + +**Usage:** +- The application launcher or service wrapper reads this property to know **where to invoke** TrackEngine. +- Ensure the path uses escaped backslashes (`\\`) as required by Java `.properties` file format. + +--- + +## `trizdistribution.trackEngine.enabled` + +| Property | Value | Description | +|----------|-------|-------------| +| `trizdistribution.trackEngine.enabled` | `true` | **Feature toggle** that enables or disables the TrackEngine module. | + +**Behavior when `true`:** +- The system **downloads** the TrackEngine runtime (if not already present at the configured path). +- The system **downloads** the required OSRM road-network data (e.g., `algeria-260108.osrm`) into the TrackEngine `data/` directory. +- The trajectory processing pipeline becomes **active** and can be invoked by the application. + +**Behavior when `false`:** +- TrackEngine is **not initialized**. +- No automatic downloads occur. +- GPS trajectory processing features are not going to work. + +--- + +## Provisioning Flow + +When `enabled = true` and the application starts: + +``` +Check TrackEngine.exe at configured path + ↓ + [Missing?] + ↓ + Download TrackEngine binaries + ↓ + Download OSRM dataset (algeria-260108.osrm) + ↓ + Place files under C:\TrackEngine\ + ↓ + Ready to process trajectories +``` + +The provisioning step ensures the deployment is **self-contained**: even on a fresh machine, enabling the flag guarantees that both the executable engine and its underlying road-network graph are available before any GPS data is submitted.