tap-fishbowl - Meltano Hub

Fishbowl

tap-fishbowl (hotgluexyz variant)🥇

Inventory management and Manufacturing ERP system

The tap-fishbowl extractor pulls data from Fishbowl 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:

Installation and configuration

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

meltano add extractor tap-fishbowl

Configure the tap-fishbowl settings using

meltano config

:

meltano config tap-fishbowl set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-fishbowl 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-fishbowl 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-fishbowl 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:

app_id
app_name
auth_token
instance
password
start_date
username

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-fishbowl 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.

App ID (app_id)

Environment variable: TAP_FISHBOWL_APP_ID

App id

Configure this setting directly using the following Meltano command:

meltano config tap-fishbowl set app_id [value]

App Name (app_name)

Environment variable: TAP_FISHBOWL_APP_NAME

The App name registered and approved in the Fishbowl Client

Configure this setting directly using the following Meltano command:

meltano config tap-fishbowl set app_name [value]

Auth Token (auth_token)

Environment variable: TAP_FISHBOWL_AUTH_TOKEN

The token to authenticate against the API service

Configure this setting directly using the following Meltano command:

meltano config tap-fishbowl set auth_token [value]

Instance (instance)

Environment variable: TAP_FISHBOWL_INSTANCE

The URL instance for API's base_url

Configure this setting directly using the following Meltano command:

meltano config tap-fishbowl set instance [value]

Password (password)

Environment variable: TAP_FISHBOWL_PASSWORD

Username's password

Configure this setting directly using the following Meltano command:

meltano config tap-fishbowl set password [value]

Start Date (start_date)

Environment variable: TAP_FISHBOWL_START_DATE

The earliest record date to sync

Configure this setting directly using the following Meltano command:

meltano config tap-fishbowl set start_date [value]

Username (username)

Environment variable: TAP_FISHBOWL_USERNAME

Registered username on the Fishbowl's server

Configure this setting directly using the following Meltano command:

meltano config tap-fishbowl set username [value]

Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

Environment variable: TAP_FISHBOWL_FLATTENING_ENABLED

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

Configure this setting directly using the following Meltano command:

meltano config tap-fishbowl set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_FISHBOWL_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-fishbowl set flattening_max_depth [value]

Stream Map Config (stream_map_config)

Environment variable: TAP_FISHBOWL_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-fishbowl set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_FISHBOWL_STREAM_MAPS

Config object for stream maps capability.

Configure this setting directly using the following Meltano command:

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

Maintenance Status

Repo

https://gitlab.com/hotglue/tap-fishbowl

Maintainer

Keywords