Formstack

tap-formstack (hotgluexyz variant)🥇

Workplace productivity platform

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

Getting Started

Prerequisites

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

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-formstack extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-formstack
  3. Configure the tap-formstack settings using
    meltano config
    :
  4. meltano config tap-formstack set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-formstack test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-formstack 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-formstack 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

meltano config
with the list subcommand:

meltano config tap-formstack 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.

API URL (api_url)

  • Environment variable: TAP_FORMSTACK_API_URL
  • Default Value: https://www.formstack.com/api/v2

The url for the API service


Configure this setting directly using the following Meltano command:

meltano config tap-formstack set api_url [value]

Client ID (client_id)

  • Environment variable: TAP_FORMSTACK_CLIENT_ID

Client ID for the API service


Configure this setting directly using the following Meltano command:

meltano config tap-formstack set client_id [value]

Client Secret (client_secret)

  • Environment variable: TAP_FORMSTACK_CLIENT_SECRET

Client Secret for the API service


Configure this setting directly using the following Meltano command:

meltano config tap-formstack set client_secret [value]

Expires In (expires_in)

  • Environment variable: TAP_FORMSTACK_EXPIRES_IN

Expiration time in seconds for the API service


Configure this setting directly using the following Meltano command:

meltano config tap-formstack set expires_in [value]

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_FORMSTACK_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.


Configure this setting directly using the following Meltano command:

meltano config tap-formstack set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_FORMSTACK_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-formstack set flattening_max_depth [value]

Refresh Token (refresh_token)

  • Environment variable: TAP_FORMSTACK_REFRESH_TOKEN

Refresh token for the API service


Configure this setting directly using the following Meltano command:

meltano config tap-formstack set refresh_token [value]

Stream Map Config (stream_map_config)

  • Environment variable: TAP_FORMSTACK_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-formstack set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_FORMSTACK_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-formstack 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?

If you're having trouble getting the tap-formstack extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add extractor tap-formstack

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://gitlab.com/hotglue/tap-formstack
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Hotglue

Meltano Stats

  • Projects (Last 3 Months)

Keywords

  • meltano_sdk