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.

Available Variants

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

catalog
state
discover
about
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:

auth_token
subdomain
custom_reports

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]

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]

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]

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 extractor tap-bamboohr

Maintenance Status

Repo

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

Maintainer

Meltano Stats

Keywords