1
0
mirror of synced 2025-12-20 10:32:35 -05:00
Files
airbyte/docs/integrations/sources/senseforce.md

10 KiB

Senseforce

This page guides you through the process of setting up the Senseforce source connector.

Sync overview

Prerequisites

Creating a Senseforce Dataset to Export

The Senseforce Airbyte connector allows to export custom datasets built bei Senseforce users. Follow these steps to configure a dataset which can be exported with the Airbyte connector:

  1. Create a new, empty dataset as documented here
  2. Add at least the following columns (these columns are Senseforce system columns and available for all of your custom data models/event schemas):
    1. Metadata -> Timestamp
    2. Metadata -> Thing
    3. Metadata -> Id
  3. Add any other column of your event schemas you want to export
  4. Enter a descriptive Name and a Description and save the dataset
  5. Note the ID of the dataset (the GUID at the end of the URL path of your dataset in your browser URL bar)

Tip: For most exports it is recommended to have the Timestamp column in first place. The Airbyte connector automatically orders in ascending direction. If the Timestamp column is not in the first position, incremental syncs might not work properly.

IMPORTANT: The Timestamp, Thing and Id column are mandatory for the Connector to work as intended. While it still works without eg. the "Id", functionality might be impaired if one of these 3 columns is missing. Make sure to not rename these columns - keep them at their default names.

Set up the Senseforce source connector

  1. Log into your Airbyte Cloud or Airbyte Open Source account.

  2. Click Sources and then click + New source.

  3. On the Set up the source page, select Senseforce from the Source type dropdown.

  4. Enter a name for your source.

  5. For API Access Token, enter your Senseforce API Access Token.

  6. For Senseforce backend URL, enter your Senseforce Backend URL.

  7. For Dataset ID, enter your Senseforce Dataset ID.

    We recommend creating an api access token specifically for Airbyte to control which resources Airbyte can access. For good operations, we recommend to create a separate Airbyte User as well as a separate Senseforce Airbyte Group. Share the dataset with this group and grant Dataset Read, Event Schema Read and Machine Master Data Read permissions.

  8. For The first day (in UTC) when to read data from, enter the day in YYYY-MM-DD format. The data added on and after this day will be replicated.

  9. Click Set up source.

Supported sync modes

The Senseforce source connector supports the following sync modes:

  • Full Refresh
  • Incremental

NOTE: The Senseforce Airbyte connector uses the Timestamp column to determine, which data were already read. Data inserted AFTER a finished sync, with timestamps less than already synced ones, are not considered for the next sync anymore. If this behavior does not fit your use case, follow the next section

Using Inserted Timestamp instead of Data Timestamp for incremental modes

  1. Rename your "Timestamp" column to "Timestamp_data"
  2. Add the Metadata -> Inserted column to your dataset.
  3. Move the newly added "Inserted" column to position 1.
  4. Rename the "Inserted" column to "Timestamp".

Now the inserted timestamp will be used for creating the Airbyte cursor. Note that this method results in slower syncs, as the Senseforce queries to generate the Datasets are slower than if you use the data timestamp.

Supported Streams

The Senseforce source connector supports the following streams:

Features

Feature Supported?(Yes/No) Notes
Full Refresh Sync Yes
Incremental Sync Yes

Performance considerations

Senseforce utilizes an undocumented rate limit which - under normal use - should not be triggered, even with huge datasets. Create an issue if you see any rate limit issues that are not automatically retried successfully.

Changelog

Expand to review
Version Date Pull Request Subject
0.2.27 2025-05-24 60492 Update dependencies
0.2.26 2025-05-10 60180 Update dependencies
0.2.25 2025-05-04 59594 Update dependencies
0.2.24 2025-04-27 59027 Update dependencies
0.2.23 2025-04-19 58378 Update dependencies
0.2.22 2025-04-12 58005 Update dependencies
0.2.21 2025-04-05 57476 Update dependencies
0.2.20 2025-03-29 56906 Update dependencies
0.2.19 2025-03-22 56323 Update dependencies
0.2.18 2025-03-08 55611 Update dependencies
0.2.17 2025-03-01 55006 Update dependencies
0.2.16 2025-02-23 54562 Update dependencies
0.2.15 2025-02-15 54005 Update dependencies
0.2.14 2025-02-08 53498 Update dependencies
0.2.13 2025-02-01 52957 Update dependencies
0.2.12 2025-01-25 52483 Update dependencies
0.2.11 2025-01-18 51912 Update dependencies
0.2.10 2025-01-11 51356 Update dependencies
0.2.9 2024-12-28 50738 Update dependencies
0.2.8 2024-12-21 50235 Update dependencies
0.2.7 2024-12-14 49662 Update dependencies
0.2.6 2024-12-12 49341 Update dependencies
0.2.5 2024-12-11 49100 Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
0.2.4 2024-11-04 48166 Update dependencies
0.2.3 2024-10-29 47765 Update dependencies
0.2.2 2024-10-28 47567 Update dependencies
0.2.1 2024-08-16 44196 Bump source-declarative-manifest version
0.2.0 2024-08-14 44073 Refactor connector to manifest-only format
0.1.15 2024-08-12 43865 Update dependencies
0.1.14 2024-08-10 43704 Update dependencies
0.1.13 2024-08-03 43274 Update dependencies
0.1.12 2024-07-27 42763 Update dependencies
0.1.11 2024-07-20 42247 Update dependencies
0.1.10 2024-07-13 41792 Update dependencies
0.1.9 2024-07-10 41402 Update dependencies
0.1.8 2024-07-09 41242 Update dependencies
0.1.7 2024-07-06 40914 Update dependencies
0.1.6 2024-06-25 40380 Update dependencies
0.1.5 2024-06-22 40190 Update dependencies
0.1.4 2024-06-15 39462 Make compatible with builder
0.1.3 2024-06-04 39073 [autopull] Upgrade base image to v1.2.1
0.1.2 2024-05-20 38431 [autopull] base image + poetry + up_to_date
0.1.1 2023-02-13 22892 Specified date formatting in specification
0.1.0 2022-10-26 #18775 🎉 New Source: Mailjet SMS API [low-code CDK]