The tap-senseforce
extractor
pulls data from
Senseforce that can
then be sent to a destination using a
loader.
Airbyte Usage Notice
Container-based connectors
can introduce deployment challenges including the potential need to run
Docker-in-Docker (not currently supported by services like AWS ECS, Meltano
Cloud, etc. see
FAQ
and
Airbyte's ECS deployment docs
for more details). Before using this variant we recommend considering if/how
you will be able to deploy container-based connectors to production.
For more context on how this Airbyte integration works please checkout out the
FAQ in the Meltano Docs.
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-senseforce extractor to your
project using
:meltano add -
Configure the tap-senseforce
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-senseforcemeltano config tap-senseforce set --interactivemeltano config tap-senseforce testNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-senseforce
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- about
- catalog
- discover
- schema-flattening
- state
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-senseforce settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
airbyte_config.access_tokenairbyte_config.backend_urlairbyte_config.dataset_idairbyte_config.slice_rangeairbyte_config.start_dateairbyte_spec.imageairbyte_spec.tagdocker_mounts
Expand To Show SDK Settings
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-senseforce list
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Airbyte Config Access Token (airbyte_config.access_token)
-
Environment variable:
TAP_SENSEFORCE_AIRBYTE_CONFIG_ACCESS_TOKEN
Your API access token. See here. The toke is case sensitive.
Configure this setting directly using the following Meltano command:
meltano config tap-senseforce set airbyte_config access_token [value]Airbyte Config Backend Url (airbyte_config.backend_url)
-
Environment variable:
TAP_SENSEFORCE_AIRBYTE_CONFIG_BACKEND_URL
Your Senseforce API backend URL. This is the URL shown during the Login screen. See here for more details. (Note: Most Senseforce backend APIs have the term 'galaxy' in their ULR)
Configure this setting directly using the following Meltano command:
meltano config tap-senseforce set airbyte_config backend_url [value]Airbyte Config Dataset Id (airbyte_config.dataset_id)
-
Environment variable:
TAP_SENSEFORCE_AIRBYTE_CONFIG_DATASET_ID
The ID of the dataset you want to synchronize. The ID can be found in the URL when opening the dataset. See here for more details. (Note: As the Senseforce API only allows to synchronize a specific dataset, each dataset you want to synchronize needs to be implemented as a separate airbyte source).
Configure this setting directly using the following Meltano command:
meltano config tap-senseforce set airbyte_config dataset_id [value]Airbyte Config Slice Range (airbyte_config.slice_range)
-
Environment variable:
TAP_SENSEFORCE_AIRBYTE_CONFIG_SLICE_RANGE
The time increment used by the connector when requesting data from the Senseforce API. The bigger the value is, the less requests will be made and faster the sync will be. On the other hand, the more seldom the state is persisted and the more likely one could run into rate limites. Furthermore, consider that large chunks of time might take a long time for the Senseforce query to return data - meaning it could take in effect longer than with more smaller time slices. If there are a lot of data per day, set this setting to 1. If there is only very little data per day, you might change the setting to 10 or more.
Configure this setting directly using the following Meltano command:
meltano config tap-senseforce set airbyte_config slice_range [value]Airbyte Config Start Date (airbyte_config.start_date)
-
Environment variable:
TAP_SENSEFORCE_AIRBYTE_CONFIG_START_DATE
UTC date and time in the format 2017-01-25. Only data with "Timestamp" after this date will be replicated. Important note: This start date must be set to the first day of where your dataset provides data. If your dataset has data from 2020-10-10 10:21:10, set the start_date to 2020-10-10 or later
Configure this setting directly using the following Meltano command:
meltano config tap-senseforce set airbyte_config start_date [value]Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_SENSEFORCE_AIRBYTE_SPEC_IMAGE -
Default Value:
airbyte/source-senseforce
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-senseforce set airbyte_spec image [value]Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_SENSEFORCE_AIRBYTE_SPEC_TAG -
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-senseforce set airbyte_spec tag [value]Docker Mounts (docker_mounts)
-
Environment variable:
TAP_SENSEFORCE_DOCKER_MOUNTS
Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation
Configure this setting directly using the following Meltano command:
meltano config tap-senseforce set docker_mounts [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_SENSEFORCE_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-senseforce set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_SENSEFORCE_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-senseforce set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_SENSEFORCE_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-senseforce set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_SENSEFORCE_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-senseforce set stream_maps [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-yellow){kind=icon}
