Code Monkey home page Code Monkey logo

autoidm-tap-bamboohr's Introduction

tap-bamboohr

Tap was created by AutoIDM. Check us out for tap/target creation, maintenace, support, and more!

Capabilities

  • catalog
  • state
  • discover
  • about
  • stream-maps

Settings

Setting Required Default Description
auth_token True None Token gathered from BambooHR, instructions are here
subdomain True None subdomain from BambooHR
field_mismatch True fail Either fail or ignore. Determines behavior when fields returned by API don't match the requested fields.
custom_reports False None CustomReport full body definition, example in meltano.yml, same format as the Body for the POST request here
stream_maps False None Config object for stream maps capability. For more information check out Stream Maps.
stream_map_config False None User-defined config values to be used within map expressions.
flattening_enabled False None 'True' to enable schema flattening and automatically expand nested properties.
flattening_max_depth False None The max depth to flatten schemas.
batch_config False None

A full list of supported settings and capabilities is available by running: tap-bamboohr --about

Getting Started

```bash
pipx install poetry
poetry install
```
```bash
poetry run tap-bamboohr --help
```
```bash
poetry run pytest
```

Singer SDK Dev Guide

See the dev guide for more instructions on how to use the Singer SDK to develop your own taps and targets.

Config Guide

Selecting Additional Fields in a Custom Report

To select additional fields in a custom report, pass in a manually modified catalog using a command like meltano elt tap-bamboohr target-jsonl --catalog=catalog.json. The catalog.json file should be modified such that the field you want to include is marked as available and selected. For example, to add the zipcode field to the set of selected fields, change its breadcrumb to the following:

{
    "breadcrumb": [
        "properties",
        "zipcode"
    ],
    "metadata": {
        "inclusion": "available",
        "selected": true
    }
}

You can also modify meltano.yml by adding metadata, accomplishing the same thing.

    metadata:
      "CUSTOM REPORT NAME":
        "customFIELDNAME":
          "inclusion": "available"
          "selected": true

Alternatively, to modify the tap and permanently add a field to the default set of selected fields, add its name to tap_bamboohr/selected_fields.json. Or, if the field exists but is undocumented or not returned by /meta/fields, add its name and data type to tap_bamboohr/merge_fields.json to have it be merged into the default catalog (but not necessarily selected by default).

Source Authentication and Authorization

  • TODO: If your tap requires special access on the source system, or any special authentication requirements, provide those here. This Singer-compliant tap was created using the Singer SDK.

Testing with Meltano

_Note: This tap will work in any Singer environment and does not require Meltano.

Install Meltano (if you haven't already) and any needed plugins:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-bamboohr
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-bamboohr --version
# OR run a test `elt` pipeline:
meltano elt tap-bamboohr target-jsonl

SDK

Built with the Meltano SDK for Singer Taps and Targets.

autoidm-tap-bamboohr's People

Contributors

aaronsteers avatar ssmiley-autoidm avatar visch avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.