The tap-capsulecrm extractor pulls data from Capsulecrm that can then be sent to a destination using a loader.
Alternate Implementations
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-capsulecrm extractor to your
project using
:meltano add -
Configure the tap-capsulecrm
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-capsulecrm --variant matatikameltano config tap-capsulecrm set --interactivemeltano config tap-capsulecrm 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-capsulecrm
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
- batch
- 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-capsulecrm 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:
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-capsulecrm 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.
Access Token (access_token)
-
Environment variable:
TAP_CAPSULECRM_ACCESS_TOKEN
Your Capsule access token.
Configure this setting directly using the following Meltano command:
meltano config tap-capsulecrm set access_token [value]Client ID (client_id)
-
Environment variable:
TAP_CAPSULECRM_CLIENT_ID
Your Capsule client ID.
Configure this setting directly using the following Meltano command:
meltano config tap-capsulecrm set client_id [value]Client Secret (client_secret)
-
Environment variable:
TAP_CAPSULECRM_CLIENT_SECRET
Your Capsule client secret.
Configure this setting directly using the following Meltano command:
meltano config tap-capsulecrm set client_secret [value]Expires In (expires_in)
-
Environment variable:
TAP_CAPSULECRM_EXPIRES_IN
The seconds until the token expires.
Configure this setting directly using the following Meltano command:
meltano config tap-capsulecrm set expires_in [value]Refresh Token (refresh_token)
-
Environment variable:
TAP_CAPSULECRM_REFRESH_TOKEN
Your Capsule refresh token.
Configure this setting directly using the following Meltano command:
meltano config tap-capsulecrm set refresh_token [value]Expand To Show SDK Settings
Batch Config Encoding Compression (batch_config.encoding.compression)
-
Environment variable:
TAP_CAPSULECRM_BATCH_CONFIG_ENCODING_COMPRESSION
Compression format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-capsulecrm set batch_config encoding.compression [value]Batch Config Encoding Format (batch_config.encoding.format)
-
Environment variable:
TAP_CAPSULECRM_BATCH_CONFIG_ENCODING_FORMAT
Format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-capsulecrm set batch_config encoding.format [value]Batch Config Storage Prefix (batch_config.storage.prefix)
-
Environment variable:
TAP_CAPSULECRM_BATCH_CONFIG_STORAGE_PREFIX
Prefix to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-capsulecrm set batch_config storage.prefix [value]Batch Config Storage Root (batch_config.storage.root)
-
Environment variable:
TAP_CAPSULECRM_BATCH_CONFIG_STORAGE_ROOT
Root path to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-capsulecrm set batch_config storage.root [value]Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_CAPSULECRM_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-capsulecrm set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_CAPSULECRM_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-capsulecrm set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_CAPSULECRM_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-capsulecrm set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_CAPSULECRM_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-capsulecrm 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-brightgreen){kind=icon}
-2,269-c0c0c4){kind=icon}
-64-c0c0c4){kind=icon}
