The tap-purecloud extractor pulls data from Genesys Cloud that can then be sent to a destination using a loader.
Alternate Implementations
- dbt Labs 🥈
- Drew Banin
- Elton de Andrade Rodrigues
- Marcin Fałek
- isabella232
- Piotr Mynarski
- Pathlight (default)🥈
- Jean Rumeau 🥈
- Stitch Data 🥈
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-purecloud extractor to your
project using
:meltano add
-
Configure the tap-purecloud
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-purecloud
meltano config tap-purecloud set --interactive
meltano config tap-purecloud 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-purecloud
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:
- catalog
- discover
- state
You can
override these capabilities or specify additional ones
in your meltano.yml
by adding the capabilities
key.
Settings
The
tap-purecloud
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-purecloud 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.
Client ID (client_id)
-
Environment variable:
TAP_PURECLOUD_CLIENT_ID
Your API client ID for authentication.
Configure this setting directly using the following Meltano command:
meltano config tap-purecloud set client_id [value]
Client Secret (client_secret)
-
Environment variable:
TAP_PURECLOUD_CLIENT_SECRET
Your API Client secret for authentication.
Configure this setting directly using the following Meltano command:
meltano config tap-purecloud set client_secret [value]
Domain (domain)
-
Environment variable:
TAP_PURECLOUD_DOMAIN
Your API domain. The string to add following "https://api." in API requests.
Configure this setting directly using the following Meltano command:
meltano config tap-purecloud set domain [value]
Schedule Lookahead Weeks (schedule_lookahead_weeks)
-
Environment variable:
TAP_PURECLOUD_SCHEDULE_LOOKAHEAD_WEEKS
-
Default Value:
5
The amount of weeks to extend beyond the current date in order to generate the end_date parameter for syncing data.
Configure this setting directly using the following Meltano command:
meltano config tap-purecloud set schedule_lookahead_weeks [value]
Start Date (start_date)
-
Environment variable:
TAP_PURECLOUD_START_DATE
Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.
Configure this setting directly using the following Meltano command:
meltano config tap-purecloud 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.