The tap-zuora extractor pulls data from Zuora that can then be sent to a destination using a loader.
Alternate Implementations
- Airbyte 🥉
- isabella232
- OTA-Insight
- Stitch Data🥈
- Wise (default)🥈
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-zuora extractor to your
project using
:meltano add
-
Configure the tap-zuora
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-zuora --variant singer-io
meltano config tap-zuora set --interactive
meltano config tap-zuora 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-zuora
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:
- discover
- catalog
- state
You can
override these capabilities or specify additional ones
in your meltano.yml
by adding the capabilities
key.
Settings
The
tap-zuora
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
with the meltano config
list
subcommand:
meltano config tap-zuora 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 type (api_type)
-
Environment variable:
TAP_ZUORA_API_TYPE
-
Default Value:
REST
The Zuora API to use, e.g. REST or AQuA
Configure this setting directly using the following Meltano command:
meltano config tap-zuora set api_type [value]
Username (username)
-
Environment variable:
TAP_ZUORA_USERNAME
The Zuora username
Configure this setting directly using the following Meltano command:
meltano config tap-zuora set username [value]
Password (password)
-
Environment variable:
TAP_ZUORA_PASSWORD
The Zuora password
Configure this setting directly using the following Meltano command:
meltano config tap-zuora set password [value]
Use sandbox endpoint (sandbox)
-
Environment variable:
TAP_ZUORA_SANDBOX
Whether to use the sandbox or production Zuora environment
Configure this setting directly using the following Meltano command:
meltano config tap-zuora set sandbox [value]
Connect to a European endpoint (european)
-
Environment variable:
TAP_ZUORA_EUROPEAN
Whether to use the European Zuora endpoint
Configure this setting directly using the following Meltano command:
meltano config tap-zuora set european [value]
Partner ID (partner_id)
-
Environment variable:
TAP_ZUORA_PARTNER_ID
The Zuora partner ID, required for the AQuA API
Configure this setting directly using the following Meltano command:
meltano config tap-zuora set partner_id [value]
Replication start date (start_date)
-
Environment variable:
TAP_ZUORA_START_DATE
The replication start date
Configure this setting directly using the following Meltano command:
meltano config tap-zuora set start_date [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
channel.