Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Updates BambooHR Source Connector Docs (Removes inapp page, adds <HideInUI>, adds Limitations & Troubleshooting) #32360

Merged
merged 4 commits into from
Nov 29, 2023
+51 −64
Merged

Docs: Updates BambooHR Source Connector Docs (Removes inapp page, adds <HideInUI>, adds Limitations & Troubleshooting) #32360

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2d1c323
Consolidated BambooHR source connector docs. Added new Limitations & …
pnilan Nov 6, 2023
1efda0c
Minor formatting fix
pnilan Nov 7, 2023
4abdf02
Typo fix
pnilan Nov 21, 2023
5110795
Merge branch 'master' into pnilan/bamboo-hr-docs-fix
pnilan Nov 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions docs/integrations/sources/bamboo-hr.inapp.md
View file
Open in desktop

This file was deleted.

101 changes: 51 additions & 50 deletions docs/integrations/sources/bamboo-hr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,71 +1,54 @@
# Bamboo HR
# BambooHR

## Overview
<HideInUI>

The BambooHr source supports Full Refresh sync. You can choose if this connector will overwrite the old records or duplicate old ones.
This page contains the setup guide and reference information for the [BambooHR](https://www.bamboohr.com/) source connector.

### Output schema
</HideInUI>

This connector outputs the following stream:

* [Custom Reports](https://documentation.bamboohr.com/reference/request-custom-report-1)

### Features

| Feature | Supported? |
| :--- | :--- |
| Full Refresh Sync | Yes |
| Incremental - Append Sync | No |
| SSL connection | Yes |
| Namespaces | No |

### Performance considerations

BambooHR has the [rate limits](https://documentation.bamboohr.com/docs/api-details), but the connector should not run into API limitations under normal usage. Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.
## Prerequisites

## Getting started
* BambooHR Account
* BambooHR [Api key](https://documentation.bamboohr.com/docs)

pnilan marked this conversation as resolved.
Show resolved Hide resolved
### Requirements
## Setup Guide

* BambooHr Account
* BambooHr [Api key](https://documentation.bamboohr.com/docs)
## Step 1: Set up the BambooHR connector in Airbyte

# Bamboo HR
<!-- env:cloud -->

This page contains the setup guide and reference information for the Bamboo HR source connector.
**For Airbyte Cloud:**

## Prerequisites
1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account.
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ New source**.
3. On the Set up the source page, enter the name for the BambooHR connector and select **BambooHR** from the Source type dropdown.
3. Enter your `subdomain`. If you access BambooHR at https://mycompany.bamboohr.com, then the subdomain is "mycompany".
4. Enter your `api_key`. To generate an API key, log in and click your name in the upper right-hand corner of any page to get to the user context menu. If you have sufficient administrator permissions, there will be an "API Keys" option in that menu to go to the page.
5. (Optional) Enter any `Custom Report Fields` as a comma-separated list of fields to include in your custom reports. Example: `firstName,lastName`. If none are listed, then the [default fields](https://documentation.bamboohr.com/docs/list-of-field-names) will be returned.
6. Toggle `Custom Reports Include Default Fields`. If true, then the [default fields](https://documentation.bamboohr.com/docs/list-of-field-names) will be returned. If false, then the values defined in `Custom Report Fields` will be returned.
7. Click **Set up source**

* BambooHr Account
* BambooHr [Api key](https://documentation.bamboohr.com/docs)
<!-- /env:cloud -->

## Setup guide
## Step 1: Set up the Bamboo HR connector in Airbyte
<!-- env:oss -->

### For Airbyte Cloud:
**For Airbyte OSS:**

1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account.
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**.
3. On the Set up the source page, enter the name for the Bamboo HR connector and select **Bamboo HR** from the Source type dropdown.
3. Enter your `subdomain`
4. Enter your `api_key`
5. Enter your `custom_reports_fields` if need
6. Choose `custom_reports_include_default_fields` flag value
1. Navigate to the Airbyte Open Source dashboard.
2. Set the name for your source.
3. Enter your `subdomain`. If you access BambooHR at https://mycompany.bamboohr.com, then the subdomain is "mycompany".
4. Enter your `api_key`. To generate an API key, log in and click your name in the upper right-hand corner of any page to get to the user context menu. If you have sufficient administrator permissions, there will be an "API Keys" option in that menu to go to the page.
5. (Optional) Enter any `Custom Report Fields` as a comma-separated list of fields to include in your custom reports. Example: `firstName,lastName`. If none are listed, then the [default fields](https://documentation.bamboohr.com/docs/list-of-field-names) will be returned.
6. Toggle `Custom Reports Include Default Fields`. If true, then the [default fields](https://documentation.bamboohr.com/docs/list-of-field-names) will be returned. If false, then the values defined in `Custom Report Fields` will be returned.
7. Click **Set up source**

### For Airbyte OSS:
<!-- /env:oss -->

1. Navigate to the Airbyte Open Source dashboard
2. Set the name for your source
3. Enter your `subdomain`
4. Enter your `api_key`
5. Enter your `custom_reports_fields` if need
6. Choose `custom_reports_include_default_fields` flag value
7. Click **Set up source**
<HideInUI>

## Supported sync modes

The Bamboo HR source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
The BambooHR source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):

| Feature | Supported? |
| :--- | :--- |
Expand All @@ -79,11 +62,27 @@ The Bamboo HR source connector supports the following [sync modes](https://docs.

* [Custom Reports](https://documentation.bamboohr.com/reference/request-custom-report-1)

## Performance considerations
## Limitations & Troubleshooting

<details>
<summary>
Expand to see details about BambooHR connector limitations and troubleshooting.
</summary>

### Connector limitations

#### Rate limiting

BambooHR has the [rate limits](https://documentation.bamboohr.com/docs/api-details), but the connector should not run into API limitations under normal usage.

BambooHR has the [rate limits](https://documentation.bamboohr.com/docs/api-details), but the connector should not run into API limitations under normal usage.
Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.

### Troubleshooting

* Check out common troubleshooting issues for the BambooHR source connector on our [Airbyte Forum](https://github.com/airbytehq/airbyte/discussions).

</details>

## Changelog

| Version | Date | Pull Request | Subject |
Expand All @@ -92,3 +91,5 @@ Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see
| 0.2.1 | 2022-09-16 | [16826](https://github.com/airbytehq/airbyte/pull/16826) | Add custom fields validation during check |
| 0.2.0 | 2022-03-24 | [11326](https://github.com/airbytehq/airbyte/pull/11326) | Add support for Custom Reports endpoint |
| 0.1.0 | 2021-08-27 | [5054](https://github.com/airbytehq/airbyte/pull/5054) | Initial release with Employees API |

</HideInUI>
Loading