The tap-netsuite
extractor
pulls data from
NetSuite that can
then be sent to a destination using a
loader.
Airbyte Usage Notice
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
🥉
- Gary James
- Hotglue (default)🥈
- Josué Sehnem
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 airbytemeltano 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:
airbyte_config.consumer_keyairbyte_config.consumer_secretairbyte_config.object_typesairbyte_config.realmairbyte_config.start_datetimeairbyte_config.token_keyairbyte_config.token_secretairbyte_config.window_in_daysairbyte_spec.imageairbyte_spec.tagdocker_mounts
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.
Airbyte Config Consumer Key (airbyte_config.consumer_key)
-
Environment variable:
TAP_NETSUITE_AIRBYTE_CONFIG_CONSUMER_KEY
Consumer key associated with your integration
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set airbyte_config consumer_key [value]Airbyte Config Consumer Secret (airbyte_config.consumer_secret)
-
Environment variable:
TAP_NETSUITE_AIRBYTE_CONFIG_CONSUMER_SECRET
Consumer secret associated with your integration
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set airbyte_config consumer_secret [value]Airbyte Config Object Types (airbyte_config.object_types)
-
Environment variable:
TAP_NETSUITE_AIRBYTE_CONFIG_OBJECT_TYPES
The API names of the Netsuite objects you want to sync. Setting this speeds up the connection setup process by limiting the number of schemas that need to be retrieved from Netsuite.
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set airbyte_config object_types [value]Airbyte Config Realm (airbyte_config.realm)
-
Environment variable:
TAP_NETSUITE_AIRBYTE_CONFIG_REALM
Netsuite realm e.g. 2344535, as for production or 2344535_SB1, as for the sandbox
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set airbyte_config realm [value]Airbyte Config Start Datetime (airbyte_config.start_datetime)
-
Environment variable:
TAP_NETSUITE_AIRBYTE_CONFIG_START_DATETIME
Starting point for your data replication, in format of "YYYY-MM-DDTHH:mm:ssZ"
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set airbyte_config start_datetime [value]Airbyte Config Token Key (airbyte_config.token_key)
-
Environment variable:
TAP_NETSUITE_AIRBYTE_CONFIG_TOKEN_KEY
Access token key
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set airbyte_config token_key [value]Airbyte Config Token Secret (airbyte_config.token_secret)
-
Environment variable:
TAP_NETSUITE_AIRBYTE_CONFIG_TOKEN_SECRET
Access token secret
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set airbyte_config token_secret [value]Airbyte Config Window In Days (airbyte_config.window_in_days)
-
Environment variable:
TAP_NETSUITE_AIRBYTE_CONFIG_WINDOW_IN_DAYS
The amount of days used to query the data with date chunks. Set smaller value, if you have lots of data.
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set airbyte_config window_in_days [value]Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_NETSUITE_AIRBYTE_SPEC_IMAGE -
Default Value:
airbyte/source-netsuite
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set airbyte_spec image [value]Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_NETSUITE_AIRBYTE_SPEC_TAG -
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set airbyte_spec tag [value]Docker Mounts (docker_mounts)
-
Environment variable:
TAP_NETSUITE_DOCKER_MOUNTS
Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation
Configure this setting directly using the following Meltano command:
meltano config tap-netsuite set docker_mounts [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]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}
-76-c0c0c4){kind=icon}
-4-c0c0c4){kind=icon}
