-
Notifications
You must be signed in to change notification settings - Fork 4.8k
feat(source-workday) update docs #67214
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.
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
base: master
Are you sure you want to change the base?
Changes from 9 commits
2ca4c02
e231003
ad122ad
8048a75
fa39381
d0d98af
c473ef0
34bfaee
f2c2707
8375b48
a57b8ce
44f9086
4c7da4e
513324c
418bb0f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Workday Migration Guide | ||
|
||
## Upgrading to 1.0.0 | ||
|
||
This release splits Source Workday into two separate connectors - Source Workday and Source Workday REST. | ||
darynaishchenko marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
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. | ||
darynaishchenko marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
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. | ||
darynaishchenko marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
Migration Steps: | ||
|
||
1. Go to yor connection that is uses Source Workday and syncs REST streams. | ||
darynaishchenko marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
2. Disable the connectio using toggle on the top right. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. π« [vale] reported by reviewdog πΆ |
||
3. Go to sources page and select `+ New source`, find and select Source Workday REST. | ||
darynaishchenko marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
4. Set up the new Source Workday REST. | ||
5. Define destination. | ||
6. Select streams to sync. | ||
7. Configure connection. |
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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
- 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** | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. π« [vale] reported by reviewdog πΆ There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
- 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. | ||
darynaishchenko marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## Setup Guide | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. π« [vale] reported by reviewdog πΆ |
||
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
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): | ||
darynaishchenko marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
- Full Refresh | ||
- Incremental for the following streams: | ||
- Worker Payslips | ||
- Worker Time Off Entries | ||
|
||
## Supported Streams | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
The Workday connector supports the following streams: | ||
darynaishchenko marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
- 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> |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
- 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** | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. π« [vale] reported by reviewdog πΆ There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
- 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. | ||
|
||
 | ||
|
||
|
||
### 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**. | ||
|
||
 | ||
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 | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Google.Headings] 'Workday Migration Guide' should use sentence-style capitalization.