From 5316b14f6c35ef28e71ac8864c50e851a2335a53 Mon Sep 17 00:00:00 2001 From: Matteo Palarchio <20643714+matteogp@users.noreply.github.com> Date: Thu, 21 Nov 2024 13:46:20 -0800 Subject: [PATCH] Doc updates based on feedback --- .../enterprise-connectors/source-workday.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/integrations/enterprise-connectors/source-workday.md b/docs/integrations/enterprise-connectors/source-workday.md index fc883398979da..1dc06332558b9 100644 --- a/docs/integrations/enterprise-connectors/source-workday.md +++ b/docs/integrations/enterprise-connectors/source-workday.md @@ -5,9 +5,10 @@ Airbyte Enterprise Connectors are a selection of premium connectors available ex ::: 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 +* 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 @@ -20,19 +21,21 @@ Airbyte's [Workday](https://workday.com) enterprise source connector currently o | 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. 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 Airbyte Teams. If you are using Self-Managed Enterprise, you can replace cloud.airbyte.com with the URL of your Airbyte deployment. + * 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 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. @@ -47,6 +50,7 @@ Airbyte's [Workday](https://workday.com) enterprise source connector currently o ### 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 @@ -94,4 +98,3 @@ The connector is still incubating, this section only exists to satisfy Airbyte's - 0.1.0 -4. \ No newline at end of file