TachoSync Integrations: Difference between revisions
Updated both general info and SFTP descriptions in particular. [GTPGTM-10958] |
No edit summary |
||
| (12 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
TachoSync provides integration mechanisms for automated data transfer to external systems. These integrations support both file-based delivery (e.g., SFTP) and | TachoSync provides integration mechanisms for automated data transfer to external systems. These integrations support both file-based delivery (e.g., SFTP) and request-response (e.g., API), enabling flexible and secure connectivity with fleet management platforms, IT systems, and other third-party services. | ||
This page gives information about the available TachoSync integrations: | |||
* '''[[TachoSync_API|API]]''' | |||
* '''[[TachoSync Integrations#SFTP|SFTP]]''' | |||
Additional integration methods are in development. | |||
==Integrations Menu== | ==Integrations Menu== | ||
[[File:TachoSync Integrations menu.png|frame|center|alt=TachoSync Integrations menu|TachoSync Integrations menu]] | [[File:TachoSync Integrations menu.png|frame|center|alt=TachoSync Integrations menu|TachoSync Integrations menu]] | ||
| Line 17: | Line 18: | ||
* '''Status''' - displays the status of the integration. See below for explanations. | * '''Status''' - displays the status of the integration. See below for explanations. | ||
* '''Enable''' – toggles the integration on/off. | * '''Enable''' – toggles the integration on/off. | ||
* '''Last event''' – | * '''Last event''' – last time a file was successfully synced. | ||
* '''Edit button''' - allows editing the integration. | * '''Edit button''' - allows editing the integration. | ||
* '''Retry button''' - allows to manually retry the connection. Button is available for Failed and Interrupted statuses. Upon pressing, a connection test is executed: | * '''Retry button''' - allows to manually retry the connection. Button is available for Failed and Interrupted statuses. Upon pressing, a connection test is executed: | ||
| Line 47: | Line 48: | ||
** No failed file transfers. | ** No failed file transfers. | ||
** New (and historical, if enabled) files are queued and uploaded. | ** New (and historical, if enabled) files are queued and uploaded. | ||
* '''Disabled''' - integration is disabled by the user: | |||
** No files are queued or uploaded. | ** No files are queued or uploaded. | ||
** No retries can occur. | ** No retries can occur. | ||
* '''Interrupted''' – integration works only partially: | |||
** At least one file transferred successfully AND at least one file failed. | ** At least one file transferred successfully AND at least one file failed. | ||
** New files are processed. | ** New files are processed. | ||
** Failed files remain as "Failed" until a successful retry. | ** Failed files remain as "Failed" until a successful retry. | ||
** | ** ''The user can try to [[#SFTP Integration Troubleshooting|fix the connection]] and manually retry the connection''. | ||
* '''Failed''' – integration has failed: | |||
** One or more file transfers have failed AND no file transfer has been successful: | ** One or more file transfers have failed AND no file transfer has been successful: | ||
*** New files are processed. | *** New files are processed nevertheless. | ||
** Alternatively, the integration has failed the connection test. | ** Alternatively, the integration has failed the connection test. | ||
*** Integration is skipped when files are queued, no uploads are attempted. | *** Integration is skipped when files are queued, no uploads are attempted. | ||
** | ** ''The user can try to [[#SFTP Integration Troubleshooting|fix the connection]] and manually retry the connection.'' | ||
===SFTP Server Settings=== | ===SFTP Server Settings=== | ||
[[File:TachoSync Integrations settings.png|thumb|right|alt=TachoSync Integrations settings|TachoSync SFTP integration settings]] | [[File:TachoSync Integrations settings.png|thumb|right|alt=TachoSync Integrations settings|TachoSync SFTP integration settings]] | ||
| Line 88: | Line 89: | ||
File naming and folder structure is configured in [[TachoSync Integrations#General Settings|General Settings]]. | File naming and folder structure is configured in [[TachoSync Integrations#General Settings|General Settings]]. | ||
To ensure valid paths on the SFTP server, TachoSync automatically cleans up folder and file names: | |||
* Removes leading and trailing spaces. | |||
* Replaces empty spaces with "_". | |||
* Removes characters: <code>\ / : * ? " < > | { }</code>. | |||
====Folder Naming Options==== | |||
* The vehicle folders can be named based on vehicle IMEI or vehicle registration number. | |||
* The driver folders are named based on the driver card number. | |||
====File Naming Schema==== | |||
<table class="nd-othertables_2" style="width:100%; border-collapse: collapse;"> | |||
<tr> | |||
<th style="width:40%; vertical-align: middle; text-align: left;">VEHICLE FILES</th> | |||
<th style="width:40%; vertical-align: middle; text-align: left;">DRIVER FILES</th> | |||
</tr> | |||
<tr> | |||
<td style="vertical-align: middle; text-align: left;"><code>M_YYYYMMDD_HHmm_VEHICLEREGNUMBER_VIN.DDD</code></td> | |||
<td style="vertical-align: middle; text-align: left;"><code>C_YYYYMMDD_HHmm_N_SURNAME_CARDNUMBER.DDD</code></td> | |||
</tr> | |||
<tr> | |||
<td style="vertical-align: top; text-align: left;"> | |||
M – vehicle (mass memory) data<br>YYYYMMDD – download date (UTC)<br>HHmm – download time (UTC)<br>VEHICLEREGNUMBER – vehicle registration number<br>VIN – vehicle identification number | |||
</td> | |||
<td style="vertical-align: top; text-align: left;"> | |||
C – driver card data<br>YYYYMMDD – download date (UTC)<br> HHmm – download time (UTC)<br>N – first letter of driver’s first name<br>SURNAME – driver’s surname<br>CARDNUMBER – driver card number | |||
</td> | |||
</tr> | |||
</table> | |||
====Folder Logic==== | |||
''Each SFTP integration has a base folder'', configured in the field "Remote directory path". | |||
Inside this base folder, the system always creates folders that reflect your company hierarchy, e.g. <code>base_folder/MainCompany/SubCompany/Department/…</code>. | |||
Beyond company structure, '''the “Driver file destination“ setting determines how folders are structured:''' | |||
* If you choose to store driver files in a separate driver folder '''(option “Driver folder”) - two separate folders named “Drivers” and “Vehicles” are created.''' | |||
** In these folders, subfolders are created according to driver card and vehicle IMEI/number, respectively. | |||
** Files are placed accordingly. | |||
* If you choose to store driver files in the vehicle folder '''(option “Vehicle folder”) - separate folders are NOT created. Under the company hierarchy, only specific vehicle folders are created''' (named according to vehicle IMEI/number). | |||
** Both driver and vehicle files are placed under these specific vehicle folders. | |||
** To correctly place driver files under a vehicle folder, the system determines which vehicle the driver is operating. | |||
====Folder Structure Examples==== | |||
Assuming “Vehicles folder naming” = “Vehicle number” and .DDD file format. | |||
<table class="nd-othertables_2" style="width:100%; border-collapse: collapse;"> | |||
<tr> | |||
<th style="width:50%; vertical-align: middle; text-align: left;">Driver file destination = Driver folder</th> | |||
<th style="width:50%; vertical-align: middle; text-align: left;">Driver file destination = Vehicle folder</th> | |||
</tr> | |||
<tr> | |||
<td style="vertical-align: top; text-align: left;"> | |||
* /base_folder/MainCompany/SubCompany/Department | |||
** /Vehicles | |||
*** /ABC123 ''← vehicle folder'' | |||
**** M_YYYYMMDD_HHmm_ABC123_VIN.DDD ← vehicle file | |||
**** … | |||
** /Drivers | |||
*** /1234567890''← driver folder'' | |||
**** C_YYYYMMDD_HHmm_N_SURNAME_1234567890.DDD← driver file | |||
**** … | |||
</td> | |||
<td style="vertical-align: top; text-align: left;"> | |||
* /base_folder/MainCompany/SubCompany/Department | |||
** /Vehicles | |||
*** /ABC123 ''← vehicle folder | |||
**** M_YYYYMMDD_HHmm_ABC123_VIN.DDD ← vehicle file | |||
**** C_YYYYMMDD_HHmm_N_SURNAME_1234567890.DDD← driver file | |||
**** … | |||
</td> | |||
</tr> | |||
</table> | |||
===File Upload Behavior=== | ===File Upload Behavior=== | ||
TachoSync uploads files to your SFTP server as soon as they become available in TachoSync (after being downloaded from device): | TachoSync uploads files to your SFTP server as soon as they become available in TachoSync (after being downloaded from device): | ||
| Line 110: | Line 168: | ||
To troubleshoot, see [[TachoSync Integrations#SFTP Integration Troubleshooting|SFTP Integration Troubleshooting]]. | To troubleshoot, see [[TachoSync Integrations#SFTP Integration Troubleshooting|SFTP Integration Troubleshooting]]. | ||
===SFTP Integration Troubleshooting=== | ===SFTP Integration Troubleshooting=== | ||
If the SFTP integration does not work as expected, verify the following: | If the SFTP integration does not work as expected, verify the following: | ||
* The [[TachoSync Integrations#Prerequisites|prerequisites]] are met. | * The [[TachoSync Integrations#Prerequisites|prerequisites]] are met. | ||
* | * SFTP server internet connection is stable (there are no repeating time-outs or interruptions). | ||
* | * TachoSync has the neccessary permissions to create folders and upload files in your SFTP server. | ||
* The provided path exists on the server. | * The provided path exists on the server. | ||
If issues persist, collect the “Last event” details from the Integrations page and contact Support. | If issues persist, collect the “Last event” details from the Integrations page and contact Support. | ||
[[Category:TachoSync]] | [[Category:TachoSync]] | ||