tap-bamboohr - Meltano Hub

BambooHR

tap-bamboohr (autoidm variant)🥇

HR Platform

The tap-bamboohr extractor pulls data from BambooHR that can then be sent to a destination using a loader.

Alternate Implementations

Airbyte
🥉
AutoIDM (default)🥇

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
```
:

meltano add tap-bamboohr

Configure the tap-bamboohr settings using

meltano config

:

meltano config tap-bamboohr set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-bamboohr 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-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
activate-version
batch
catalog
discover
schema-flattening
state
stream-maps
structured-logging

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:

auth_token
custom_reports
field_mismatch
flattening_max_key_length
photo_size
subdomain

Expand To Show SDK Settings

batch_config.encoding.compression
batch_config.encoding.format
batch_config.storage.prefix
batch_config.storage.root
faker_config.locale
faker_config.seed
flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list 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]

Max Key Length (flattening_max_key_length)

Environment variable: TAP_BAMBOOHR_FLATTENING_MAX_KEY_LENGTH

The maximum length of a flattened key.

Configure this setting directly using the following Meltano command:

meltano config tap-bamboohr set flattening_max_key_length [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 Compression Format (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 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 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 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]

Faker Locale (faker_config.locale)

Environment variable: TAP_BAMBOOHR_FAKER_CONFIG_LOCALE

One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization

Configure this setting directly using the following Meltano command:

meltano config tap-bamboohr set faker_config locale [value]

Faker Seed (faker_config.seed)

Environment variable: TAP_BAMBOOHR_FAKER_CONFIG_SEED

Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator

Configure this setting directly using the following Meltano command:

meltano config tap-bamboohr set faker_config seed [value]

Enable Schema Flattening (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]

Max Flattening 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]

User Stream Map Configuration (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?

If you're having trouble getting the tap-bamboohr extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the

#plugins-general

channel.

Install

meltano add
              tap-bamboohr

Maintenance Status

Repo

https://github.com/AutoIDM/autoidm-tap-bamboohr

Maintainer

Meltano Stats

Keywords