Jump to content

TachoSync Integrations: Difference between revisions

From Teltonika Telematics Wiki
TachoSync Integrations v1
No edit summary
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
TachoSync supports integrations to automatically deliver tachograph files from TachoSync into your internal IT systems.
TachoSync provides integration mechanisms for automated data transfer to external systems. These integrations support both file-based delivery (e.g., SFTP) and event-based delivery (e.g., webhooks), enabling flexible and secure connectivity with fleet management platforms, IT systems, and other third-party services.
 
Integrations help companies streamline operational workflows, reduce manual file handling, and ensure that data flows securely into fleet management or archiving systems.


This page describes the available TachoSync integrations:
This page describes the available TachoSync integrations:
Line 14: Line 12:
'''To add an integration, click “Add integration” in the top right corner of the window, enter the required details, and click “Save”.'''
'''To add an integration, click “Add integration” in the top right corner of the window, enter the required details, and click “Save”.'''


The following data is presented in the table:  
The table presents the following data:  
* '''Name''' – name (label) given to the integration.  
* '''Name''' – name (label) given to the integration.  
* '''Method''' – integration method.  
* '''Method''' – integration method.  
* '''Company''' - company within TachoSync associated with this integration.  
* '''Company''' - company within TachoSync associated with this integration.  
* '''Status''':
* '''Status''':
** Active  
** Active - integration is enabled, latest checks have been successful, data is transferred
** Disabled  
** Disabled - integration is disabled by the user
** Interrupted - integration works but some recent operations have failed or have been delayed
** Failed - repeated errors or integration unreachable
* '''Enable''' – toggles the integration on/off.  
* '''Enable''' – toggles the integration on/off.  
* '''Last event''' – timestamp of last changes in the integration.  
* '''Last event''' – timestamp of last changes in the integration.


==SFTP==
==SFTP==
SFTP (Secure/SSH File Transfer Protocol) is a network protocol that provides secure file access, transfer, and management over a reliable data stream.
'''''NOTE!''' <u>TachoSync supports only '''SFTP (SSH File Transer Protocol)'''!</u> Reusing old WEB TACHO FTP settings (such as FTP credentials and ports, e.g. port 21) will not work. FTP and SFTP are not compatible.''
 
SFTP (Secure/SSH File Transfer Protocol) is a network protocol that provides secure file access, transfer, and management over a reliable data stream. SFTP is a replacement of File Transfer Protocol (FTP) due to superior security.


SFTP integration allows receiving files from TachoSync directly to your SFTP server. This option is ideal for organizations that want to automate the intake of data from TachoSync into an existing backend system.  
SFTP integration allows receiving files from TachoSync directly to your SFTP server. This option is ideal for organizations that want to automate the intake of data from TachoSync into an existing backend system.  


You can create as many SFTP connections as needed.  
Main features:
* You can create as many SFTP connections as needed.
* File transfer to your SFTP server starts as soon as the file is received from device to TachoSync.


'''''NOTE!''' TachoSync does not create or configure the SFTP server. The customer is responsible for ensuring that the server is reachable from the internet and properly secured.''  
'''''NOTE!''' TachoSync does not create or configure the SFTP server. The customer is responsible for ensuring that the server is reachable from the internet and properly secured.''  


Prerequisites (prepare this information before configuring the SFTP integration):  
===Prerequisites===
* SFTP server host (domain or IP address)  
Prepare this before configuring the SFTP integration:
* SFTP port number  
* Set up your SFTP server and know:
* Username and password for SFTP authentication  
** SFTP server host (domain or IP address).
* Optional: a dedicated folder path to place the downloaded files  
** SFTP server port number.
** Username and password for SFTP authentication.
* Make sure that your SFTP server firewall rules allow inbound SFTP connections from TachoSync ('''IP address 3.126.35.133''').
* Optional: a dedicated folder path to place the downloaded files.


===SFTP Server Settings===
===SFTP Server Settings===
[[File:TachoSync Integrations settings.png|thumb|right|alt=TachoSync Integrations settings|TachoSync Integrations settings]]
[[File:TachoSync Integrations settings.png|thumb|right|alt=TachoSync Integrations settings|TachoSync SFTP integration settings]]
This section allows configuring the connection to your SFTP server. Settings marked by an asterisk (*) are mandatory.  
This section allows configuring the connection to your SFTP server. Settings marked by an asterisk (*) are mandatory.  
* '''Host*''': The hostname or IP address of the SFTP server.  
* '''Host*''': The hostname or IP address of the SFTP server.  
* '''Port*''': The port number on the SFTP server (typically 22).  
* '''Port*''': The port number on the SFTP server (typically 22).  
* '''Remote directory path''' (optional): The specific folder on the SFTP server where files will be uploaded. If left blank, files will be placed in the root directory of the configured server user.  
* '''Remote directory path (optional)''': The specific folder on the SFTP server where files will be uploaded. If left blank, files will be placed in the root directory of the configured server user.  
* '''Username*''': The username for authenticating with the SFTP server.  
* '''Username*''': The username for authenticating with the SFTP server.  
* '''Password'''*: The password for the specified username.  
* '''Password'''*: The password for the specified username.


===General Settings===
===General Settings===
Line 57: Line 64:
** .V1B, .C1B  
** .V1B, .C1B  
* '''Vehicles folder naming'''*: The naming convention for the folders that contain vehicle data.  
* '''Vehicles folder naming'''*: The naming convention for the folders that contain vehicle data.  
** IMEI (E.g., 999999999999999)  
** IMEI (E.g., 123456789012345)  
** Vehicle number (E.g., LLL 999)  
** Vehicle number (E.g., ABC123)  
* '''Drivers folder naming'''*: This field is set to "Driver ID", meaning folders for driver data will be named using the driver's unique identification number.  
* '''Drivers folder naming'''*: This field is set to "Driver ID", meaning folders for driver data will be named using the driver's unique identification number.  
* '''Include files from all sub-companies''': When enabled, in addition to the main company data, data from sub-companies will be gathered and uploaded as well.  
* '''Include files from all sub-companies''': When enabled, in addition to the main company data, data from sub-companies will be gathered and uploaded as well.  
* '''Include historical files''': When enabled, TachoSync will attempt to upload files captured before the integration was created.  
* '''Include historical files''': When enabled, TachoSync will attempt to upload files captured before the integration was created.  


===Example SFTP Server Folder Structure===
===File Naming & Server Folder Structure===
File naming and folder structure is configured in [[TachoSync Integrations#General Settings|General Settings]].
 
The file name that appears in your SFTP server is identical to the file name in TachoSync. Only the file extension may change (depends on the selected file format ).
 
Below is an example of how files may be organized on your SFTP server:  
Below is an example of how files may be organized on your SFTP server:  
* /root-folder/  
* /root-folder/  
Line 72: Line 83:
** /drivers/  
** /drivers/  
*** /1234567890/ ''← driver folder (set the naming convention in „General Settings“)''
*** /1234567890/ ''← driver folder (set the naming convention in „General Settings“)''
**** 2025-01-12_.DDD
**** 2025-01-12.DDD
 
===File Upload Behavior===
TachoSync uploads files to your SFTP server as soon as they become available in TachoSync (after being downloaded from device):
* Files are sent to the SFTP server automatically and continuously, there is no fixed schedule.
* If you enable “Include historical files,” TachoSync also adds your previously downloaded files to the queue and syncs them in batches based on current system load.
 
If file upload fails, TachoSync attempts to re-upload. The retry pattern is "exponential backoff" - after 3 seconds, 9 seconds, 27 seconds, 1 min 21 s, ~4 minutes. If all 5 retry attempts fail, the file is marked as "Failed". A manual "Retry failed files" functionality is in development.


<!---
To troubleshoot, see [[TachoSync Integrations#SFTP Integration Troubleshooting|SFTP Integration Troubleshooting]].
===SFTP File Upload Behavior===
Describe upload behavior here.
--->


===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 server is reachable from the Internet.  
* The [[TachoSync Integrations#Prerequisites|prerequisites]] are met.
* Firewall rules allow inbound SFTP connections from TachoSync.  
* Your internet connection is stable (there are no repeating time-outs or interruptions).
* The user has write permissions for the configured directory.  
* The user has write permissions for the configured directory.
* 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]]

Latest revision as of 11:44, 1 December 2025

Main Page > Software & Applications > TachoSync > TachoSync Integrations

TachoSync provides integration mechanisms for automated data transfer to external systems. These integrations support both file-based delivery (e.g., SFTP) and event-based delivery (e.g., webhooks), enabling flexible and secure connectivity with fleet management platforms, IT systems, and other third-party services.

This page describes the available TachoSync integrations:

  • REST API - see this link for TachoSync API documentation portal
  • SFTP

Additional integration methods, such as webhooks, are in development.

Integrations Menu

TachoSync Integrations menu
TachoSync Integrations menu

In the TachoSync UI, the Integrations menu shows the configured integrations.

To add an integration, click “Add integration” in the top right corner of the window, enter the required details, and click “Save”.

The table presents the following data:

  • Name – name (label) given to the integration.
  • Method – integration method.
  • Company - company within TachoSync associated with this integration.
  • Status:
    • Active - integration is enabled, latest checks have been successful, data is transferred
    • Disabled - integration is disabled by the user
    • Interrupted - integration works but some recent operations have failed or have been delayed
    • Failed - repeated errors or integration unreachable
  • Enable – toggles the integration on/off.
  • Last event – timestamp of last changes in the integration.

SFTP

NOTE! TachoSync supports only SFTP (SSH File Transer Protocol)! Reusing old WEB TACHO FTP settings (such as FTP credentials and ports, e.g. port 21) will not work. FTP and SFTP are not compatible.

SFTP (Secure/SSH File Transfer Protocol) is a network protocol that provides secure file access, transfer, and management over a reliable data stream. SFTP is a replacement of File Transfer Protocol (FTP) due to superior security.

SFTP integration allows receiving files from TachoSync directly to your SFTP server. This option is ideal for organizations that want to automate the intake of data from TachoSync into an existing backend system.

Main features:

  • You can create as many SFTP connections as needed.
  • File transfer to your SFTP server starts as soon as the file is received from device to TachoSync.

NOTE! TachoSync does not create or configure the SFTP server. The customer is responsible for ensuring that the server is reachable from the internet and properly secured.

Prerequisites

Prepare this before configuring the SFTP integration:

  • Set up your SFTP server and know:
    • SFTP server host (domain or IP address).
    • SFTP server port number.
    • Username and password for SFTP authentication.
  • Make sure that your SFTP server firewall rules allow inbound SFTP connections from TachoSync (IP address 3.126.35.133).
  • Optional: a dedicated folder path to place the downloaded files.

SFTP Server Settings

TachoSync Integrations settings
TachoSync SFTP integration settings

This section allows configuring the connection to your SFTP server. Settings marked by an asterisk (*) are mandatory.

  • Host*: The hostname or IP address of the SFTP server.
  • Port*: The port number on the SFTP server (typically 22).
  • Remote directory path (optional): The specific folder on the SFTP server where files will be uploaded. If left blank, files will be placed in the root directory of the configured server user.
  • Username*: The username for authenticating with the SFTP server.
  • Password*: The password for the specified username.

General Settings

This section defines how the files and folders are structured and named when sent to the SFTP server. Settings marked by an asterisk (*) are mandatory.

  • Company*: The company within TachoSync, associated with this integration.
  • SFTP name*: A label for this specific SFTP configuration (e.g., "Primary Server" or "Backup Archive").
  • File format*: The desired format for tachograph files.
    • .DDD
    • .TGD
    • .V1B, .C1B
  • Vehicles folder naming*: The naming convention for the folders that contain vehicle data.
    • IMEI (E.g., 123456789012345)
    • Vehicle number (E.g., ABC123)
  • Drivers folder naming*: This field is set to "Driver ID", meaning folders for driver data will be named using the driver's unique identification number.
  • Include files from all sub-companies: When enabled, in addition to the main company data, data from sub-companies will be gathered and uploaded as well.
  • Include historical files: When enabled, TachoSync will attempt to upload files captured before the integration was created.

File Naming & Server Folder Structure

File naming and folder structure is configured in General Settings.

The file name that appears in your SFTP server is identical to the file name in TachoSync. Only the file extension may change (depends on the selected file format ).

Below is an example of how files may be organized on your SFTP server:

  • /root-folder/
    • /vehicles/
      • /ABC123/ ← vehicle folder (set the naming convention in „General Settings“)
        • 2025-01-12.DDD
        • 2025-01-13.DDD
    • /drivers/
      • /1234567890/ ← driver folder (set the naming convention in „General Settings“)
        • 2025-01-12.DDD

File Upload Behavior

TachoSync uploads files to your SFTP server as soon as they become available in TachoSync (after being downloaded from device):

  • Files are sent to the SFTP server automatically and continuously, there is no fixed schedule.
  • If you enable “Include historical files,” TachoSync also adds your previously downloaded files to the queue and syncs them in batches based on current system load.

If file upload fails, TachoSync attempts to re-upload. The retry pattern is "exponential backoff" - after 3 seconds, 9 seconds, 27 seconds, 1 min 21 s, ~4 minutes. If all 5 retry attempts fail, the file is marked as "Failed". A manual "Retry failed files" functionality is in development.

To troubleshoot, see SFTP Integration Troubleshooting.

SFTP Integration Troubleshooting

If the SFTP integration does not work as expected, verify the following:

  • The prerequisites are met.
  • Your internet connection is stable (there are no repeating time-outs or interruptions).
  • The user has write permissions for the configured directory.
  • The provided path exists on the server.

If issues persist, collect the “Last event” details from the Integrations page and contact Support.