Baton

tap-hellobaton (dluftspring variant)🥈

Customer onboarding software for managing software implementations

The tap-hellobaton extractor pulls data from Baton 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:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

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

Next steps

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

Capabilities

The current capabilities for tap-hellobaton 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-hellobaton 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-hellobaton 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 Key (api_key)

  • Environment variable: TAP_HELLOBATON_API_KEY

The token to authenticate against the API service


Configure this setting directly using the following Meltano command:

meltano config tap-hellobaton set api_key [value]

Company (company)

  • Environment variable: TAP_HELLOBATON_COMPANY

Company instance to add to the base url


Configure this setting directly using the following Meltano command:

meltano config tap-hellobaton set company [value]

User Agent (user_agent)

  • Environment variable: TAP_HELLOBATON_USER_AGENT

User agent string


Configure this setting directly using the following Meltano command:

meltano config tap-hellobaton set user_agent [value]
Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_HELLOBATON_FLATTENING_ENABLED

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


Configure this setting directly using the following Meltano command:

meltano config tap-hellobaton set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_HELLOBATON_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-hellobaton set flattening_max_depth [value]

Stream Map Config (stream_map_config)

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

Stream Maps (stream_maps)

  • Environment variable: TAP_HELLOBATON_STREAM_MAPS

Config object for stream maps capability.


Configure this setting directly using the following Meltano command:

meltano config tap-hellobaton 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-hellobaton 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-hellobaton

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/dluftspring/tap-hellobaton
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Daniel Luftspring

Keywords

  • apimeltano_sdk