4f97ee2dab
## What <!-- * Describe what the change is solving. Link all GitHub issues related to this change. --> This pull request updates plan names across most of the Documentation so they're consistent with our current plan names. ## How <!-- * Describe how code changes achieve the solution. --> My original plan was to convert free text to MDX variables so we only had to make future updates to names in one place. While broadly successful, there were numerous edge cases that made rolling this out almost impossible. There were too many ways and places you couldn't use variables due to a variety of limitations in Docusaurus and Airbyte's internal MarkDown processor. Explaining how to properly use them made me realize how prohibitively insufficient this was. In the end, I opted to return to using free text for plan names. Scope is now broadly reduced. This PR: - Converts remaining instances of old plan names to new plan names. In most cases, I replaced old plan names with new plan names directly. In some cases, sentences were rewritten to make a bit more sense or be more maintainable in the future. - Removes previously added preprocessor variables from Docusaurus configuration. - Update Vale styles or various artifacts of content based on linter findings. ## Review guide <!-- 1. `x.py` 2. `y.py` --> Spot check updated pages to ensure plan names appear appropriately. It's probably not necessary to check every single instance in detail. For Platform docs, changes only apply to the Next/Cloud version. After merging, I'll regenerate 2.0 docs based on this. 1.8 and before won't be updated. ## User Impact <!-- * What is the end result perceived by the user? * If there are negative side effects, please list them. --> People can see correct plan names in docs content. ## Can this PR be safely reverted and rolled back? <!-- * If unsure, leave it blank. --> - [x] YES 💚 - [ ] NO ❌ --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
4.4 KiB
4.4 KiB
Source Workday
:::info This premium connector is available to Enterprise customers at an additional cost. Talk to Sales. :::
Airbyte's Workday enterprise source connector currently offers the following features:
- Incremental as well as Full Refresh sync modes. Note that incremental syncs are only supported for specific streams.
- Reliable replication at any size with 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.
Features
| Feature | Supported? |
|---|---|
| Full Refresh Sync | Yes |
| Incremental Sync | No |
| 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
-
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 Pro, 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.
Setup Guide
For REST API streams
- Log into your Airbyte Cloud account.
- Click Sources and then click + New source.
- On the Set up the source page, select Workday.
- Enter a name for the Workday connector.
- Enter the Tenant and Hostname for your Workday environment.
- Select the option for REST API Streams.
- Enter the access token.
- 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.
- Click Set up source.
For RaaS streams
- Log into your Airbyte Cloud account.
- Click Sources and then click + New source.
- On the Set up the source page, select Workday
- Enter a name for the Workday connector.
- Enter the Tenant and Hostname for your Workday environment.
- Select the option for Report Based Streams.
- Enter the username and password of the Workday account that can access your desired reports.
- Enter the Report IDs for the reports you want to sync with this connector.
- Click Set up source.
Supported sync modes
The Workday source connector supports the following sync modes:
- Full Refresh
- Incremental for the following REST API streams:
- Worker Payslips
- Worker Time Off Entries
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)
Changelog
Expand to review
The connector is still incubating, this section only exists to satisfy Airbyte's QA checks.
- 0.2.0
- 0.1.0