Workday 人資管理平台

透過 Workday 連接器,您可以連線至 Workday 執行個體,並以傳統資料庫的形式存取 Workday 資料。

事前準備

使用 Workday 連接器前,請先完成下列工作:

  • 在 Google Cloud 專案中:
    • 確認已設定網路連線。如要瞭解網路模式,請參閱「網路連線」。
    • roles/connectors.admin IAM 角色授予設定連線器的使用者。
    • 將下列 IAM 角色授予要用於連接器的服務帳戶:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      服務帳戶是特殊的 Google 帳戶類型,主要用於代表需要驗證且必須取得授權才能存取 Google API 資料的非人類使用者。如果您沒有服務帳戶,請建立服務帳戶。詳情請參閱「建立服務帳戶」。

    • 啟用下列服務:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      如要瞭解如何啟用服務,請參閱「啟用服務」。

    如果專案先前未啟用這些服務或權限,系統會在設定連結器時提示您啟用。

Workday 設定

設定 Workday 帳戶

登入 Workday Login 建立 Workday 帳戶。如要瞭解 Workday 社群,請參閱 Workday 社群。如要瞭解 REST API,請參閱「REST API」。

設定 OAuth 2.0 驗證的用戶端 ID 和用戶端密鑰

如要在 Workday 中建立及註冊 API 用戶端,請按照下列步驟操作:

  1. 在 Workday 中按一下「Register API Client」
  2. 輸入客戶名稱。
  3. 選取用戶端授權類型做為授權碼授權。
  4. 選取承載不記名權杖類型,視需要新增其他範圍,然後按一下「確定」
  5. 輸入註冊 API 用戶端所需的所有詳細資料和範圍。
  6. 如要設定 SOAP 驗證類型,請新增使用者名稱和密碼。

設定連接器

連線專屬於資料來源。也就是說,如果您有多個資料來源,則必須為每個資料來源建立個別的連線。如要建立連線,請按照下列步驟操作:

  1. Cloud 控制台中,前往「Integration Connectors」>「Connections」頁面,然後選取或建立 Google Cloud 專案。

    前往「連線」頁面

  2. 按一下「+ 建立新項目」開啟「建立連線」頁面。
  3. 在「位置」部分中,選擇連線位置。
    1. 區域:從下拉式清單中選取位置。

      如需所有支援的地區清單,請參閱「位置」一文。

    2. 點選「下一步」
  4. 在「連線詳細資料」部分,完成下列步驟:
    1. 連接器:從可用連接器的下拉式清單中選取「Workday」
    2. 連接器版本:從可用版本的下拉式清單中選取連接器版本。
    3. 在「連線名稱」欄位中,輸入連線執行個體的名稱。

      連線名稱必須符合下列條件:

      • 連線名稱可使用英文字母、數字或連字號。
      • 字母必須為小寫。
      • 連線名稱開頭須為英文字母,結尾則須為英文字母或數字。
      • 連結名稱不得超過 49 個字元。
    4. 視需要輸入連線執行個體的「Description」(說明)
    5. 或者,可啟用 Cloud Logging,然後選取記錄層級。記錄層級預設為 Error
    6. 服務帳戶:選取具備必要角色的服務帳戶。
    7. 視需要設定「連線節點設定」

      • 節點數量下限:輸入連線節點數量下限。
      • 節點數量上限:輸入連線節點數量上限。

      節點是用來處理交易的連線單位 (或備用資源)。連線處理的交易量越多,就需要越多節點;反之,處理的交易量越少,需要的節點就越少。如要瞭解節點對連接器定價的影響,請參閱「 連線節點定價」。如未輸入任何值,系統預設會將節點下限設為 2 (提高可用性),節點上限則設為 50。

    8. 租戶:帳戶的租戶。例如,abc_cms1。您可以在 Workday 執行個體設定詳細資料中取得租戶名稱。
    9. 服務:要從中擷取資料的特定服務。請逐一列出,並以逗號分隔。例如:absenceManagement,common,compensation,recruiting,payroll,person
    10. WSDL 版本:要使用的 WSDL 版本。
    11. (選用) 在「進階設定」部分,選取「使用 Proxy」核取方塊,為連線設定 Proxy 伺服器,並設定下列值:
      • Proxy 驗證機制:選取與 Proxy 伺服器進行驗證的驗證類型。系統支援下列驗證類型:
        • 基本:基本 HTTP 驗證。
        • 摘要:摘要 HTTP 驗證。
      • Proxy 使用者:用於向 Proxy 伺服器驗證的使用者名稱。
      • Proxy Password:使用者的密碼 Secret Manager 密鑰。
      • Proxy SSL Type:連線至 Proxy 伺服器時要使用的 SSL 類型。系統支援下列驗證類型:
        • 自動:預設設定。如果網址是 HTTPS 網址,則會使用「通道」選項。如果網址是 HTTP 網址,系統會使用「永不」選項。
        • 一律:連線一律啟用 SSL。
        • 從未:連線未啟用 SSL。
        • 通道:連線是透過通道 Proxy 建立。Proxy 伺服器會開啟與遠端主機的連線,流量則會透過 Proxy 來回傳輸。
      • 在「Proxy 伺服器」部分中,輸入 Proxy 伺服器的詳細資料。
        1. 按一下「+ 新增目的地」
        2. 選取「目的地類型」
          • 主機位址:指定目的地的主機名稱或 IP 位址。

            如要與後端系統建立私人連線,請按照下列步驟操作:

    12. (選用) 按一下「+ 新增標籤」,以鍵/值組合的形式為連線新增標籤。
    13. 點選「下一步」
  5. 在「目的地」部分,輸入要連線的遠端主機 (後端系統) 詳細資料。
    1. 您可以設定下列任一目的地類型:
      • 基本網址:按一下「+ 新增目的地」,然後輸入 Workday 執行個體的基本網址。例如:https://wd5-impl-service23.workday.com
      • API 網址:按一下「+ 新增目的地」,然後輸入 Workday 執行個體的 API 網址。例如:https://wd5-impl-service23.workday.com/srx/api/v1/TENANT
      • WSDL 網址:按一下「+ 新增目的地」,然後輸入 Workday 執行個體的 WSDL 網址。

      您可以使用 REST 或 SOAP 通訊協定與 Workday 執行個體通訊。如要瞭解如何為各項通訊協定設定連線,請參閱「為 REST 或 SOAP 設定連線」。

    2. 點選「下一步」
  6. 在「Authentication」(驗證) 部分中,輸入驗證詳細資料。
    1. 選取「驗證類型」並輸入相關詳細資料。

      Workday 連線支援下列驗證類型:

      • 使用者名稱和密碼
      • OAuth 2.0 - 授權碼
    2. 如要瞭解如何設定這些驗證類型,請參閱「設定驗證」。

    3. 點選「下一步」
  7. 檢查:檢查連線和驗證詳細資料。
  8. 點選「建立」

設定 REST 或 SOAP 的連線

REST 的設定

如要讓連線使用 REST 通訊協定,您必須使用 OAuth 2.0 - 授權碼驗證類型,並設定下列欄位:

在「連線詳細資料」部分:

  • 用戶群
  • 服務
  • WSDL 版本

在「目的地」部分中:

  • 基準網址
  • API 網址

在「Authentication」(驗證) 專區中:

  • 用戶端 ID
  • 用戶端密鑰

SOAP 設定

如要讓連線使用 SOAP 通訊協定,您必須使用「使用者名稱和密碼」驗證類型,並設定下列欄位:

在「連線詳細資料」部分:

  • 用戶群
  • 服務
  • WSDL 版本

在「目的地」部分中:

  • 基準網址

在「Authentication」(驗證) 專區中:

  • 使用者名稱
  • 密碼

設定驗證機制

根據要使用的驗證方式輸入詳細資料。

  • 使用者名稱和密碼
    • 使用者名稱:連接器的使用者名稱
    • 密碼:Secret Manager 密鑰,內含與連接器相關聯的密碼。
  • OAuth 2.0 - 授權碼
    • 用戶端 ID: 外部應用程式提供的用戶端 ID。
    • 範圍: 權限範圍。
    • 用戶端密鑰: 選取 Secret Manager 密鑰。 設定這項授權前,您應該已建立 Secret Manager 密鑰。
    • 密鑰版本: 用戶端密鑰的 Secret Manager 密鑰版本。
    • 授權網址:輸入您建立 Workday 執行個體時產生的授權網址。
    • 連線類型:選取連線類型。

    如果是 OAuth 2.0 - Authorization code 驗證類型,建立連線後,您應執行幾個額外步驟來設定驗證。詳情請參閱建立連結後需執行的額外步驟

建立連結後需執行的其他步驟

如果您選取 OAuth 2.0 - Authorization code 進行驗證,建立連線後必須執行下列額外步驟:

  1. 在「連線」頁面中,找出新建立的連線。

    請注意,新連接器的「狀態」會顯示「需要授權」

  2. 按一下「需要授權」

    系統隨即會顯示「編輯授權」窗格。

  3. 將「重新導向 URI」值複製到外部應用程式。
  4. 驗證授權詳細資料。
  5. 按一下「Authorize」

    授權成功後,「連線」頁面的連線狀態會設為「有效」

重新授權授權碼

如果您使用 Authorization code 驗證類型,且已在 Workday 應用程式中進行任何設定變更,則必須重新授權 Workday 連線。如要重新授權連結,請按照下列步驟操作:

  1. 在「連線」頁面中,按一下所需連線。

    系統隨即會開啟連線詳細資料頁面。

  2. 按一下「編輯」即可編輯連結詳細資料。
  3. 在「驗證」部分中,確認「OAuth 2.0 - 授權碼」詳細資料。

    視需要進行必要變更。

  4. 按一下 [儲存]。系統會將您帶往連線詳細資料頁面。
  5. 在「驗證」部分中,按一下「編輯授權」。系統會顯示「Authorize」(授權) 窗格。
  6. 按一下「Authorize」

    如果授權成功,「連線」頁面的連線狀態會設為「有效」

連線設定範例

本節列出建立 Workday 連線時設定各個欄位的範例值。

使用者名稱密碼連線類型

欄位名稱 詳細資料
位置 us-central1
連接器 Workday 人資管理平台
連接器版本 1
連線名稱 google-cloud-workday-soap-conn
啟用 Cloud Logging
服務帳戶 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
用戶群 TENANT_NAME
服務 SERVICE_NAME
WSDL 版本 v41.0
詳細程度 5
節點數量下限 2
節點數量上限 50
基準網址 BASE_URL
驗證 USER_PASSWORD
使用者名稱 使用者名稱
密碼 密碼
Secret 版本 1

OAuth 2.0 - 授權碼連線類型

欄位名稱 詳細資料
位置 us-central1
連接器 Workday 人資管理平台
連接器版本 1
連線名稱 google-cloud-workday-rest-conn
啟用 Cloud Logging
服務帳戶 XSERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
用戶群 TENANT_NAME
詳細程度 5
節點數量下限 2
節點數量上限 50
基準網址 BASE_URL
APIURL API_URL
驗證 OAuth 2.0 - 驗證碼
用戶端 ID CLIENT_ID
範圍 system
用戶端密鑰 CLIENT_SECRET
Secret 版本 1
授權網址 AUTHORIZATION_URL
連線類型 REST

如要瞭解如何為 REST API 用戶端設定 OAuth 2.0,請參閱 Workday 說明文件。

整合系統使用者連線類型

欄位名稱 詳細資料
位置 europe-west1
連接器 Workday 人資管理平台
連接器版本 1
連線名稱 CONNECTION_NAME
啟用 Cloud Logging
服務帳戶 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
用戶群 TENANT_NAME
服務 SERVICE_NAME
節點數量下限 2
節點數量上限 50
基準網址 BASE_URL
驗證 整合系統使用者
用戶端 ID CLIENT_ID
用戶端密鑰 CLIENT_SECRET
Secret 版本 8
更新權杖 REFRESH_TOKEN
Secret 版本 7

實體、作業和動作

所有整合連接器都會為所連應用程式的物件提供抽象層。您只能透過這個抽象化程序存取應用程式的物件。抽象化會以實體、作業和動作的形式呈現。

  • 實體: 實體可以視為已連結應用程式或服務中的物件,或是屬性集合。實體的定義因連接器而異。舉例來說,在資料庫連接器中,資料表是實體;在檔案伺服器連接器中,資料夾是實體;在訊息系統連接器中,佇列是實體。

    不過,連接器可能不支援或沒有任何實體,在這種情況下,Entities 清單會是空白。

  • 作業: 作業是指您可以在實體上執行的活動。您可以對實體執行下列任一操作:

    從可用清單中選取實體,系統會產生該實體可用的作業清單。如需作業的詳細說明,請參閱 Connectors 工作的實體作業。 不過,如果連接器不支援任何實體作業,系統就不會在 Operations 清單中列出這些不支援的作業。

  • 動作: 動作是透過連接器介面提供給整合的第一類函式。動作可讓您變更一或多個實體,且因連接器而異。一般來說,動作會有一些輸入參數和輸出參數。不過,連接器可能不支援任何動作,此時 Actions 清單會是空白。

系統限制

Workday 連接器每秒可處理 3 筆交易,每個節點每秒可處理 3 筆交易,並節流任何超出此限制的交易。根據預設,Integration Connectors 會為連線分配 2 個節點 (以提高可用性)。

如要瞭解 Integration Connectors 適用的限制,請參閱「限制」一文。

在整合中運用 Workday 連線

建立連線後,Apigee Integration 和 Application Integration 都會提供該連線。您可以在整合中透過「連線器」工作使用連線。

  • 如要瞭解如何在 Apigee Integration 中建立及使用「連線器」工作,請參閱「連線器工作」。
  • 如要瞭解如何在 Application Integration 中建立及使用「連線器」工作,請參閱「連線器工作」。

實體作業範例

本節說明如何使用這個連接器執行部分實體作業。

使用 Workday 連線時,實體名稱會以「SCHEMA_NAME.ENTITY_NAME」格式顯示。舉例來說,在「Staffing.Workers_training」中,「Staffing」是結構定義名稱,「Workers_training」則是資料表名稱。

根據 Entity API 的定義,檢視區塊僅支援列出和取得作業,而表格則支援所有 CRUD 作業。

範例 - 列出所有記錄

這個範例會列出 Scorecards 實體中的所有記錄。

  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取 Scorecards
  3. 選取「List」作業,然後按一下「完成」
  4. (選用) 在「連結器」工作的「工作輸入」部分,您可以指定篩選子句,篩選結果集。請一律在單引號 (') 內指定篩選子句值。例如 Id='13b1724a91ce448bad2f1986321fc70f'。您也可以使用邏輯運算子指定多個篩選條件。例如:Id='13b1724a91ce448bad2f1986321fc70f' and Inactive=false

範例 - 取得記錄

這個範例會從 Scorecards 實體取得具有指定 ID 的記錄。

  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取 Scorecards
  3. 選取「Get」作業,然後按一下「完成」
  4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入) 區段中,按一下「EntityId」,然後在「Default Value」(預設值) 欄位中輸入 1|CN=admin,CN=Users,DC=test-ldap,DC=com

    其中 1|CN=admin,CN=Users,DC=test-ldap,DC=comScorecards 實體中的主鍵值。

範例 - 建立記錄

這個範例會在 PayrollInputs 實體中建立記錄。

  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取 PayrollInputs
  3. 選取「Create」作業,然後按一下「完成」
  4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
    {
    "Worker_Id": "21327",
    "Worker_Descriptor": "Worker 2"
    }

    如果整合成功,連接器工作的 connectorOutputPayload 欄位會包含類似下列內容的值:

    {
    "Id": "c3c68bc9a13f901d43ca8e5ddcaa0000"
    }

範例 - 更新記錄

這個範例會更新 Scorecards 實體中具有指定 ID 的記錄。

  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取 Scorecards
  3. 選取「Update」作業,然後按一下「完成」
  4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
    {
    "ScorecardDescription": "New updated description",
    "ScorecardName": "Scorecard_1"
    }
  5. 按一下「entityId」,然後在「Default Value」欄位中輸入 f368471438b14705a1178c6744d75853

範例 - 刪除記錄

這個範例會刪除 Scorecards 實體中具有指定 ID 的記錄。

  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取 Scorecards
  3. 選取「Delete」作業,然後按一下「完成」
  4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下「entityId」,然後在「Default Value」(預設值) 欄位中輸入 e002de05784910123c443f7eb0970722

使用 Terraform 建立連線

您可以使用 Terraform 資源建立新連線。

如要瞭解如何套用或移除 Terraform 設定,請參閱「基本 Terraform 指令」。

如要查看用於建立連線的 Terraform 範本範例,請參閱範本範例

使用 Terraform 建立這項連線時,您必須在 Terraform 設定檔中設定下列變數:

參數名稱 資料類型 必填 說明
用戶群 STRING 帳戶的租戶。
服務 STRING 要從中擷取資料的特定服務。請逐一列出,並以逗號分隔。
wsdlversion STRING 要使用的 WSDL 版本。
proxy_enabled BOOLEAN 選取這個核取方塊,即可為連線設定 Proxy 伺服器。
proxy_auth_scheme ENUM 用於向 ProxyServer Proxy 驗證的驗證類型。支援的值包括:BASIC、DIGEST、NONE
proxy_user STRING 用於向 ProxyServer Proxy 驗證的使用者名稱。
proxy_password SECRET 用於向 ProxyServer 代理程式驗證的密碼。
proxy_ssltype ENUM 連線至 ProxyServer Proxy 時要使用的 SSL 類型,支援的值包括:AUTO、ALWAYS、NEVER、TUNNEL

向 Google Cloud 社群尋求協助

如要發布問題及討論這個連接器,請前往 Cloud 論壇的 Google Cloud 社群。

後續步驟