tap-smartsheet - Meltano Hub

Smartsheet

tap-smartsheet (airbyte variant)🥉

Smartsheet enables project management professionals to streamline workflows

The tap-smartsheet extractor pulls data from Smartsheet that can then be sent to a destination using a loader.

Airbyte Usage Notice

This connector uses tap-airbyte-wrapper to call the underlying Airbyte source Docker container. This means you must have Docker installed and running prior to usage. We also recommend using Meltano version 2.13.0 or later.

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.

Alternate Implementations

Airbyte🥉
Brooklyn Data Co
(default)🥈

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

Installation and configuration

Add the tap-smartsheet extractor to your project using
```
meltano add
```
:

meltano add extractor tap-smartsheet --variant airbyte

Configure the tap-smartsheet settings using

meltano config

meltano config tap-smartsheet set --interactive

Test that extractor settings are valid using

meltano config

meltano config tap-smartsheet test

Next 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-smartsheet 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-smartsheet 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_token
airbyte_config.spreadsheet_id
airbyte_config.start_datetime
airbyte_spec.image
airbyte_spec.tag
docker_mounts

Expand To Show SDK Settings

flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-smartsheet 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_SMARTSHEET_AIRBYTE_CONFIG_ACCESS_TOKEN

The access token to use for accessing your data from Smartsheets. This access token must be generated by a user with at least read access to the data you'd like to replicate. Generate an access token in the Smartsheets main menu by clicking Account > Apps & Integrations > API Access. See the setup guide for information on how to obtain this token.