The tap-bamboohr extractor pulls data from BambooHR 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-bamboohr extractor to your
project using
:meltano add -
Configure the tap-bamboohr
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-bamboohrmeltano config tap-bamboohr set --interactivemeltano config tap-bamboohr 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-bamboohr
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
- batch
- 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-bamboohr 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-bamboohr 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.
Auth Token (auth_token)
-
Environment variable:
TAP_BAMBOOHR_AUTH_TOKEN
Token gathered from BambooHR, instructions are here
Configure this setting directly using the following Meltano command:
meltano config tap-bamboohr set auth_token [value]Custom Reports (custom_reports)
-
Environment variable:
TAP_BAMBOOHR_CUSTOM_REPORTS
CustomReport full body definition, example in meltano. Yml, same format as the Body for the POST request here
Configure this setting directly using the following Meltano command:
meltano config tap-bamboohr set custom_reports [value]Field Mismatch (field_mismatch)
-
Environment variable:
TAP_BAMBOOHR_FIELD_MISMATCH -
Default Value:
fail
Either fail or ignore. Determines behavior when fields returned by API don't match fields specified in tap config.
Configure this setting directly using the following Meltano command:
meltano config tap-bamboohr set field_mismatch [value]Photo Size (photo_size)
-
Environment variable:
TAP_BAMBOOHR_PHOTO_SIZE -
Default Value:
original
Size of photos to return from the photos stream. Pixel size information can be found in the docs
Configure this setting directly using the following Meltano command:
meltano config tap-bamboohr set photo_size [value]Subdomain (subdomain)
-
Environment variable:
TAP_BAMBOOHR_SUBDOMAIN
Subdomain from BambooHR
Configure this setting directly using the following Meltano command:
meltano config tap-bamboohr set subdomain [value]Expand To Show SDK Settings
Batch Config Encoding Compression (batch_config.encoding.compression)
-
Environment variable:
TAP_BAMBOOHR_BATCH_CONFIG_ENCODING_COMPRESSION
Compression format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-bamboohr set batch_config encoding.compression [value]Batch Config Encoding Format (batch_config.encoding.format)
-
Environment variable:
TAP_BAMBOOHR_BATCH_CONFIG_ENCODING_FORMAT
Format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-bamboohr set batch_config encoding.format [value]Batch Config Storage Prefix (batch_config.storage.prefix)
-
Environment variable:
TAP_BAMBOOHR_BATCH_CONFIG_STORAGE_PREFIX
Prefix to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-bamboohr set batch_config storage.prefix [value]Batch Config Storage Root (batch_config.storage.root)
-
Environment variable:
TAP_BAMBOOHR_BATCH_CONFIG_STORAGE_ROOT
Root path to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-bamboohr set batch_config storage.root [value]Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_BAMBOOHR_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-bamboohr set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_BAMBOOHR_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-bamboohr set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_BAMBOOHR_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-bamboohr set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_BAMBOOHR_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-bamboohr 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-brightgreen){kind=icon}
-94-c0c0c4){kind=icon}
-1-c0c0c4){kind=icon}
