Skip to content
Open
Show file tree
Hide file tree
Changes from 9 commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Workday Migration Guide
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐢
[Google.Headings] 'Workday Migration Guide' should use sentence-style capitalization.


## Upgrading to 1.0.0

This release splits Source Workday into two separate connectors - Source Workday and Source Workday REST.
Connector you're currently using deprecates REST streams and continues to support only RAAS streams, REST streams will be available in the new Source Workday REST.

Action required only if you were using this source to sync REST streams (REST authentication on Set Up page), you'll need to disable this connection and create a new connection using new Source Workday REST. Otherwise, simply upgrade this source to v1.0.0 and continue syncing RAAS streams as usual.

Migration Steps:

1. Go to yor connection that is uses Source Workday and syncs REST streams.
2. Disable the connectio using toggle on the top right.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐢
[Vale.Spelling] Did you really mean 'connectio'?

3. Go to sources page and select `+ New source`, find and select Source Workday REST.
4. Set up the new Source Workday REST.
5. Define destination.
6. Select streams to sync.
7. Configure connection.
70 changes: 70 additions & 0 deletions docs/integrations/enterprise-connectors/source-workday-rest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
dockerRepository: airbyte/source-workday-rest
enterprise-connector: true
---
# Source Workday REST
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐢
[Google.Headings] 'Source Workday REST' should use sentence-style capitalization.


Airbyte's [Workday](https://workday.com) enterprise source connector currently offers the following features:

- Incremental as well as Full Refresh [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes). Note that incremental syncs are only supported for specific streams.
- Reliable replication at any size with [checkpointing](https://docs.airbyte.com/understanding-airbyte/airbyte-protocol/#state--checkpointing).
- Support for REST API Workday streams.

## Features

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

## Prerequisites

- Workday tenant - The Organization ID for your Workday environment. This can be found by logging into your Workday account and going to My Account > Organization ID
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐢
[Google.FirstPerson] Avoid first-person pronouns such as 'My'.

- Workday hostname - The endpoint for connecting into your Workday environment. This can be found by logging into your Workday instance and searching β€œPublic Web Service” in the search bar and selecting the appropriate report. Use the ellipse (...) button to select **Web Service > View WSDL**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐢
[Vale.Spelling] Did you really mean 'hostname'?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐢
[Google.Ellipses] In general, don't use an ellipsis.

- Access token - An OAuth 2.0 access token for API client integrations. More information and instructions can be found in the Workday community documentation for your environment about creating and registering a Workday API Client. If you are using Airbyte Teams, when registering the API Client for Airbyte you can use https://cloud.airbyte.com/auth_flow for the Redirection URI field . If you are using Self-Managed Enterprise, you can use the URL of your Airbyte deployment instead.

## Setup Guide
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐢
[Google.Headings] 'Setup Guide' should use sentence-style capitalization.


1. Log into your Airbyte Cloud account.
2. Click Sources and then click **+ New source**.
3. On the Set up the source page, select Workday REST.
4. Enter a name for the Workday connector.
5. Enter the Tenant and Hostname for your Workday environment.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐢
[Vale.Spelling] Did you really mean 'Hostname'?

6. Enter the access token.
7. **Start Date (Optional)** is the earliest date for data that will be synced. If a date is not specified, all data from the last 2 years will be synced.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐢
[Google.Will] Avoid using 'will'.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐢
[Google.Will] Avoid using 'will'.

8. Click Set up source.

## Supported sync modes

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

- Full Refresh
- Incremental for the following streams:
- Worker Payslips
- Worker Time Off Entries

## Supported Streams
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐢
[Google.Headings] 'Supported Streams' should use sentence-style capitalization.


The Workday connector supports the following streams:

- Jobs
- Job Families
- Job Profiles
- People
- Workers
- Workers Direct Reports
- Worker History
- Worker Payslips (Incremental)
- Worker Time Off Entries (Incremental)

## Changelog

<details>
<summary>Expand to review</summary>

- 0.1.0

</details>
73 changes: 17 additions & 56 deletions docs/integrations/enterprise-connectors/source-workday.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,94 +6,55 @@ enterprise-connector: true

Airbyte's [Workday](https://workday.com) enterprise source connector currently offers the following features:

* Incremental as well as Full Refresh [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes). Note that incremental syncs are only supported for specific streams.
* Reliable replication at any size with [checkpointing](https://docs.airbyte.com/understanding-airbyte/airbyte-protocol/#state--checkpointing).
* Support for both REST API and Workday Report-as-a-Service (RaaS) streams. Each provided Report ID can be used as a separate stream with an auto-detected schema. Note that a separate Source must be created to use RaaS streams in addition to REST API streams.
- Full Refresh [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes). Note that incremental syncs are only supported for specific streams.
- Reliable replication at any size with [checkpointing](https://docs.airbyte.com/understanding-airbyte/airbyte-protocol/#state--checkpointing).
- Support for Workday Report-as-a-Service (RaaS) streams. Each provided Report ID can be used as a separate stream with an auto-detected schema.

## Features

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

## Prerequisites

* Workday tenant - The Organization ID for your Workday environment. This can be found by logging into your Workday account and going to My Account > Organization ID
* Workday hostname - The endpoint for connecting into your Workday environment. This can be found by logging into your Workday instance and searching β€œPublic Web Service” in the search bar and selecting the appropriate report. Use the ellipse (...) button to select **Web Service > View WSDL**

* For REST API streams:
* Access token - An OAuth 2.0 access token for API client integrations. More information and instructions can be found in the Workday community documentation for your environment about creating and registering a Workday API Client. If you are using Airbyte Teams, when registering the API Client for Airbyte you can use https://cloud.airbyte.com/auth_flow for the Redirection URI field . If you are using Self-Managed Enterprise, you can use the URL of your Airbyte deployment instead.

* For Report-as-a-Service (RaaS) streams:
* Workday username and password - A user account that has the necessary permissions to access the reports you want to sync.
* Report IDs - Each report in Workday has a unique Report ID.
- Workday tenant - The Organization ID for your Workday environment. This can be found by logging into your Workday account and going to My Account > Organization ID
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐢
[Google.FirstPerson] Avoid first-person pronouns such as 'My'.

- Workday hostname - The endpoint for connecting into your Workday environment. This can be found by logging into your Workday instance and searching β€œPublic Web Service” in the search bar and selecting the appropriate report. Use the ellipse (...) button to select **Web Service > View WSDL**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐢
[Vale.Spelling] Did you really mean 'hostname'?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐢
[Google.Ellipses] In general, don't use an ellipsis.

- Workday username and password - A user account that has the necessary permissions to access the reports you want to sync.
- Report IDs - Each report in Workday has a unique Report ID.

## Setup Guide

### For REST API streams

1. Log into your Airbyte Cloud account.
2. Click Sources and then click **+ New source**.
3. On the Set up the source page, select Workday.
4. Enter a name for the Workday connector.
5. Enter the Tenant and Hostname for your Workday environment.
6. Select the option for **REST API Streams**.
7. Enter the access token.
8. **Start Date (Optional)** is the earliest date for data that will be synced. If a date is not specified, all data from the last 2 years will be synced.
9. Click Set up source.

![REST Setup](/assets/docs/enterprise-connectors/workday-rest.png)


### For RaaS streams

1. Log into your Airbyte Cloud account.
2. Click Sources and then click **+ New source**.
3. On the Set up the source page, select Workday
4. Enter a name for the Workday connector.
5. Enter the Tenant and Hostname for your Workday environment.
6. Select the option for **Report Based Streams**.
7. Enter the username and password of the Workday account that can access your desired reports.
8. Enter the Report IDs for the reports you want to sync with this connector.
9. Click **Set up source**.

![RaaS Setup](/assets/docs/enterprise-connectors/workday-raas.png)
6. Enter the username and password of the Workday account that can access your desired reports.
7. Enter the Report IDs for the reports you want to sync with this connector.
8. Click **Set up source**.

## Supported sync modes

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

* Full Refresh
* Incremental for the following REST API streams:
* Worker Payslips
* Worker Time Off Entries
- Full Refresh

## Supported Streams

The Workday connector supports the following REST API streams:

* Jobs
* Job Families
* Job Profiles
* People
* Workers
* Workers Direct Reports
* Worker History
* Worker Payslips (Incremental)
* Worker Time Off Entries (Incremental)

The Workday connector supports dynamic streams based on report ids provided in the source set up.

## Changelog

<details>
<summary>Expand to review</summary>

The connector is still incubating, this section only exists to satisfy Airbyte's QA checks.

- 1.0.0
- 0.2.1
- 0.2.0
- 0.1.0

Expand Down
Loading