The tap-netsuite extractor pulls data from NetSuite 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-netsuite extractor to your
project using
:meltano add -
Configure the tap-netsuite
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-netsuite --variant gthesheepmeltano config tap-netsuite set --interactivemeltano config tap-netsuite 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-netsuite
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-netsuite 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:
Expand To Show SDK Settings
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-netsuite 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.
Account IDentifier (account_identifier)
-
Environment variable:
TAP_NETSUITE_ACCOUNT_IDENTIFIER
Account identifier, taken from your Netsuite URL
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set account_identifier [value]Client ID (client_id)
-
Environment variable:
TAP_NETSUITE_CLIENT_ID
Client ID
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set client_id [value]Client Secret (client_secret)
-
Environment variable:
TAP_NETSUITE_CLIENT_SECRET
App secret key
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set client_secret [value]Refresh Token (refresh_token)
-
Environment variable:
TAP_NETSUITE_REFRESH_TOKEN
Refresh token obtained from the OAuth2 user flow
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set refresh_token [value]Start Date (start_date)
-
Environment variable:
TAP_NETSUITE_START_DATE
The earliest record date to sync
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set start_date [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_NETSUITE_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_NETSUITE_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_NETSUITE_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-netsuite set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_NETSUITE_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-netsuite set stream_maps [value]Compared to the taps using the Netsuite SOAP API, the REST based Netsuite tap is less complete, fewer datasets and transaction types are available due to still being marked as "Beta" endpoints, these can be added to the tap as Netsuite move them out of Beta
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-yellow){kind=icon}
