The tap-dayforce extractor pulls data from Dayforce 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-dayforce extractor to your
project using
:meltano add -
Configure the tap-dayforce
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-dayforcemeltano config tap-dayforce set --interactivemeltano config tap-dayforce 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-dayforce
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-dayforce 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 configlist
subcommand:
meltano config tap-dayforce 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 Version (api_version)
-
Environment variable:
TAP_DAYFORCE_API_VERSION
The api version to send requests to, default V1.
Configure this setting directly using the following Meltano command:
meltano config tap-dayforce set api_version [value]Client Namespace (client_namespace)
-
Environment variable:
TAP_DAYFORCE_CLIENT_NAMESPACE
A valid client name (e.g. Company Name) that will be inserted into the request URL.
Configure this setting directly using the following Meltano command:
meltano config tap-dayforce set client_namespace [value]Dayforce Release (dayforce_release)
-
Environment variable:
TAP_DAYFORCE_DAYFORCE_RELEASE
The Dayforce release, default 61.
Configure this setting directly using the following Meltano command:
meltano config tap-dayforce set dayforce_release [value]Password (password)
-
Environment variable:
TAP_DAYFORCE_PASSWORD
A valid Dayforce web services user account password.
Configure this setting directly using the following Meltano command:
meltano config tap-dayforce set password [value]Start Date (start_date)
-
Environment variable:
TAP_DAYFORCE_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-dayforce set start_date [value]Test (test)
-
Environment variable:
TAP_DAYFORCE_TEST
Whether to use a test environment, default False.
Configure this setting directly using the following Meltano command:
meltano config tap-dayforce set test [value]Username (username)
-
Environment variable:
TAP_DAYFORCE_USERNAME
A valid Dayforce web services user account username.
Configure this setting directly using the following Meltano command:
meltano config tap-dayforce set username [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-brightgreen){kind=icon}
