SAP SuccessFactors

您可以使用 SAP SuccessFactors 連接器,對 SAP SuccessFactors 資料執行插入、刪除、更新和讀取作業。

事前準備

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

  • 在 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)

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

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

  • 如要使用 SAP ID 建立付費的 SuccessFactors 帳戶,請參閱「SAP SuccessFactors 快速入門」。

設定連接器

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

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

    前往「連線」頁面

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

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

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

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

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

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

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

    8. 公司 ID:貴公司的專屬 ID。這是驗證身分時的必要步驟。
    9. 資料格式:擷取資料時使用的資料格式。選取 ATOM 或 JSON。
    10. 包含導覽屬性:布林值,指出是否應在欄清單中加入導覽屬性。
    11. 清除類型:PurgeType 是選用參數,可決定要對實體執行增量或完整更新。
    12. 使用用戶端分頁:CData ADO.NET Provider for SAP SuccessFactors 是否應使用用戶端分頁。
    13. 使用顯示名稱:布林值,用於判斷是否使用 SAP 標籤。
    14. 使用 Proxy:指出是否使用系統 Proxy 設定。這項設定的優先順序高於其他 Proxy 設定,因此您必須將 ProxyAutoDetect 設為 FALSE,才能使用自訂 Proxy 設定。
    15. Proxy 驗證配置:用於向 ProxyServer Proxy 驗證身分的驗證類型。
    16. Proxy 使用者:用於向 ProxyServer Proxy 驗證身分的使用者名稱。
    17. Proxy 密碼:用於向 ProxyServer Proxy 驗證的密碼。
    18. Proxy SSL Type:連線至 ProxyServer Proxy 時要使用的 SSL 類型。
    19. (選用) 在「進階設定」部分,選取「使用 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 位址。

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

    20. 選用:按一下「+ 新增標籤」,以鍵/值組合的形式為連線新增標籤。
    21. 點選「下一步」
  5. 在「目的地」部分,輸入要連線的遠端主機 (後端系統) 詳細資料。
    1. 目的地類型:選取目的地類型
      • 如要指定目的地主機名稱或 IP 位址,請選取「主機地址」,然後在「主機 1」欄位中輸入地址。
      • 如要建立私人連線,請選取「Endpoint attachment」(端點連結),然後從「Endpoint Attachment」(端點連結) 清單中選擇所需連結。

      如要建立與後端系統的公開連線,並加強安全性,建議為連線設定靜態輸出 IP 位址,然後設定防火牆規則,只允許特定靜態 IP 位址。

      如要輸入其他目的地,請按一下「+新增目的地」

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

      SAP SuccessFactors 連線支援下列驗證類型:

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

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

設定驗證機制

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

  • 使用者名稱和密碼
    • 使用者名稱:連接器的使用者名稱
    • 密碼:Secret Manager 密鑰,內含與連接器相關聯的密碼。
    • 驗證機制:用於驗證的機制

基本驗證連線類型範例

下表列出基本驗證連線類型的範例設定值。請參閱管理中心的連線建立介面,瞭解必填和選填欄位。

欄位名稱 範例值
區域 us-central1
連接器 SAP SuccessFactors
連接器版本 1
連線名稱 sapsf-basicauth-conn
說明 SuccessFactors 連線
服務帳戶 SERVICE_ACCOUNT_NAME@developer.gserviceaccount.com
公司 ID SFPART068178
主機地址 https://HOST_NAME.successfactors.eu/
使用者名稱 sfadmin
密碼 密碼
驗證機制 基本

實體、作業和動作

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

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

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

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

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

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

系統限制

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

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

動作

這個部分會列出 SuccessFactors 連線支援的所有動作。

UpsertEntity 動作

這個動作可讓您插入或更新實體的記錄。

UpsertEntity 動作的輸入參數

參數名稱 資料類型 必填 說明
entityType 字串 要 upsert 的實體類型。
酬載 物件 以 JSON 格式插入/更新酬載。

UpsertEntity 動作的輸出參數

這項操作會傳回狀態 200 (OK),以及指出所有 Upsert 結果的回應主體。

如要瞭解如何設定 UpsertEntity 動作,請參閱範例

動作範例

本節說明如何在這個連接器中執行部分動作。

範例 - 更新 PerPersonal 實體中的記錄

以下範例會更新 PerPersonal 實體中的記錄。

  1. 在「Configure connector task」對話方塊中,按一下 Actions
  2. 選取 UpsertEntity 動作,然後按一下「完成」
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
    {
    "entityType": "PerPersonal",
    "payload": {
      "personIdExternal": "109031",
      "startDate": "1800-01-01 00:00:00.0",
      "firstName": "John",
      "lastName": "Job",
      "nationality": "IND"
      }
    }
  4. 如果動作成功,連接器工作的 connectorOutputPayload 欄位會包含類似以下內容的值:

    [{
      "personIdExternal": "109031",
      "startDate": "1989-12-31 23:00:00.0"
    }]

範例 - 更新 PaymentInformationDetailV3 實體中的記錄

以下範例會更新 PaymentInformationDetailV3 實體中的記錄。

  1. 在「Configure connector task」對話方塊中,按一下 Actions
  2. 選取 UpsertEntity 動作,然後按一下「完成」
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
    {
      "entityType": "PaymentInformationDetailV3",
      "payload": {
        "PaymentInformationV3_effectiveStartDate": "2015-01-21 00:00:00.0",
        "PaymentInformationV3_worker": "82096",
        "externalCode": 563.0,
        "currency": "EUR"
      }
    }
  4. 如果動作成功,連接器工作的 connectorOutputPayload 欄位會包含類似下列內容的值:

    [{
      "externalCode": 563.0,
      "PaymentInformationV3_effectiveStartDate": "2015-01-20 23:00:00.0",
      "PaymentInformationV3_worker": "82096"
    }]

範例 - 在實體中建立記錄

下列範例會在 TodoEntryV2 實體中建立記錄。

  1. 在「Configure connector task」對話方塊中,按一下 Actions
  2. 選取 UpsertEntity 動作,然後按一下「完成」
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
    {
      "entityType": "TodoEntryV2",
      "payload": {
        "todoEntryName": "Finish Your Tasks",
        "status": 1.0,
        "categoryId": "41",
        "LinkeduserNav": {
          "__metadata": {
            "uri": "https://apisalesdemo2.successfactors.eu/odata/v2/User('613577712')",
            "type": "SFOData.User"
          }
        }
      }
    }
  4. 如果動作執行成功,連接器工作的 connectorOutputPayload 欄位會包含類似以下內容的值:

    [{
      "todoEntryId": 221443.0
    }] 

實體範例

範例 - 列出實體的記錄

這個範例會列出 FOCompany 實體的記錄。

  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取 FOCompany
  3. 選取「LIST」作業,然後按一下「完成」
  4. 在「連線器」工作的「工作輸入」部分,您可以根據需求設定 filterClause

    舉例來說,將篩選子句設為 externalCode='5100' and startDate='1900-01-01 00:00:00',只會列出 externalCode 為 5100 且 startDate 為 1900-01-01 00:00:00 的記錄。

範例 - 從實體取得記錄

這個範例會從 User 實體擷取記錄。

  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取 User
  3. 選取「GET」作業,然後按一下「完成」
  4. 在「連線器」工作的「工作輸入」部分,按一下「EntityId」,然後在「預設值」欄位中輸入 103032

    其中 103032Users 實體的主鍵。

範例 - 從實體刪除記錄

這個範例會從 FOCompany 實體刪除記錄。

  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取 FOCompany
  3. 選取「DELETE」作業,然後按一下「完成」
  4. 在「連線器」工作的「工作輸入」部分,按一下「entityId」,然後在「預設值」欄位中輸入 113132

    或者,如果實體具有複合式主鍵,而非指定 entityId,則可以設定 filterClause。例如:externalCode='5100' and startDate='1900-01-01 00:00:00'

範例 - 在實體中建立記錄

  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取 FOCompany
  3. 選取「Create」作業,然後按一下「完成」
  4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
    {
    "externalCode": "1000",
    "startDate": "1900-01-01 00:00:00.0",
    "standardHours": 40.0,
    "status": "I",
    "currency": "EUR",
    "country": "DEU"
    }

    如果整合成功,連接器工作的 connectorOutputPayload 欄位會顯示類似下列的值:

    {
    "externalCode": "1000",
    "startDate": "1900-01-01 00:00:00.0"
    }

範例 - 在 TimeZone 實體中建立記錄

  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取 TimeZone
  3. 選取「Create」作業,然後按一下「完成」
  4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
    {
    "effectiveStartDate": "2023-08-16 00:00:00.0",
    "externalCode": "10013",
    "effectiveStatus": "A",
    "utcDstOffset": "UTC+01:00",
    "utcOffset": "+0100"
    }

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

    {
    "effectiveStartDate": "2023-08-16 00:00:00.0",
    "externalCode": "10013"
    }

範例 - 更新實體中的記錄

這個範例會更新 FOCompany 實體中的記錄。

  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取 FOCompany
  3. 選取「Update」作業,然後按一下「完成」
  4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
    {
    "description": "BestRun India"
    }
  5. 在「連線器」工作的「工作輸入」部分,按一下「entityId」,然後在「預設值」欄位中輸入 103032

    或者,如果實體具有複合式主鍵,而非指定 entityId,則可以設定 filterClause。例如:externalCode='5100' and startDate='1900-01-01 00:00:00'

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

    {
    "externalCode": "5100",
    "startDate": "1900-01-01 00:00:00.0"
    }

使用 Terraform 建立連線

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

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

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

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

參數名稱 資料類型 必填 說明
company_id STRING 貴公司的專屬 ID。這是驗證身分時的必要步驟。
purge_type STRING PurgeType 是選用參數,可決定要對實體執行增量更新或完整更新。
use_client_side_paging BOOLEAN CData ADO.NET Provider for SAP SuccessFactors 是否應使用用戶端分頁。
use_display_names BOOLEAN 布林值,用於判斷是否要使用 SAP 標籤。
詳細程度 STRING 連線的詳細程度,範圍為 1 到 5。詳細程度越高,記錄的通訊詳細資料就越多 (要求、回應和 SSL 憑證)。
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

在整合中運用 SAP SuccessFactors 連線

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

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

向 Google Cloud 社群尋求協助

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

後續步驟