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 のクイックスタートをご覧ください。

コネクタを構成する

コネクタを構成するには、データソース（バックエンドシステム）への接続を作成する必要があります。接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。

Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
[接続] ページに移動
[+ 新規作成] をクリックして [接続の作成] ページを開きます。
[ロケーション] セクションで、接続のロケーションを選択します。
1. リージョン: プルダウンリストからロケーションを選択します
  サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。
2. [次へ] をクリックします。
[接続の詳細] セクションで、次の操作を行います。
1. コネクタ: 使用可能なコネクタのプルダウンリストから [SAP SuccessFactors] を選択します。
2. コネクタのバージョン: 使用可能なバージョンのプルダウンリストからコネクタのバージョンを選択します。
3. [接続名] フィールドに、接続インスタンスの名前を入力します。
  接続名は次の条件を満たす必要があります。
  - 接続名には英字、数字、ハイフンを使用できます。
  - 文字は小文字のみを使用できます。
  - 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
  - 接続名は 49 文字以内で指定してください。
4. 必要に応じて、接続インスタンスの [説明] を入力します。
5. 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは Error に設定されています。
6. サービスアカウント: 必要なロールを持つサービスアカウントを選択します。
7. 必要に応じて、接続ノードの設定を構成します。
  - ノードの最小数: 接続ノードの最小数を入力します。
  - ノードの最大数: 接続ノードの最大数を入力します。
  ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。
8. Company Id: 会社の一意の識別子。これは認証に必要です。
9. Data Format: データを取得するデータ形式。ATOM または JSON を選択します。
10. ナビゲーションプロパティを含める: 列のリストにナビゲーションプロパティを含めるかどうかを示すブール値。
11. Purge Type: Purge Type はオプションのパラメータで、エンティティに対して増分更新と完全な更新のどちらを行うかを決定します。
12. クライアントサイドページングを使用する: SAP SuccessFactors の CData ADO.NET プロバイダが、クライアントサイドページングを使用するかどうか。
13. 表示名を使用する: SAP ラベルを使用するかどうかを決定するブール値。
14. プロキシを使用: システムのプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するには、ProxyAutoDetect を FALSE に設定する必要があります。
15. Proxy Auth Scheme: ProxyServer プロキシへの認証に使用する認証タイプ。
16. Proxy User: ProxyServer プロキシへの認証に使用されるユーザー名。
17. Proxy Password: ProxyServer プロキシの認証に使用されるパスワード。
18. Proxy SSL Type: ProxyServer プロキシへの接続時に使用する SSL タイプ。
19. Use proxy: このチェックボックスを選択して、接続用のプロキシサーバーを構成し、次の値を構成します。
20. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
21. [次へ] をクリックします。
[宛先] セクションに、接続するリモートホスト（バックエンドシステム）の詳細を入力します。
1. 宛先の種類: 宛先の種類を選択します。
  - リストから [ホストアドレス] を選択し、宛先のホスト名または IP アドレスを指定します。
  - バックエンドシステムへのプライベート接続を確立する場合は、リストからエンドポイントアタッチメントを選択し、次にエンドポイントアタッチメントリストから必要なエンドポイントアタッチメントを選択します。
    注: エンドポイントアタッチメントの作成方法については、PSC サービスアタッチメントとエンドポイントアタッチメントをご覧ください。エンドポイントアタッチメントを作成すると、[エンドポイントアタッチメント] リストに表示されます。
  セキュリティをさらに強化してバックエンドシステムへのパブリック接続を確立する場合は、接続用の静的アウトバウンド IP アドレスの構成を検討してから、特定の静的 IP アドレスのみを許可リストに登録するようファイアウォールルールを構成します。
  
  他の宛先を入力するには、[+ 宛先を追加] をクリックします。
2. [次へ] をクリックします。
[認証] セクションで、認証の詳細を入力します。
1. [認証タイプ] を選択し、関連する詳細を入力します。
  SAP SuccessFactors 接続でサポートされる認証タイプは、次のとおりです。
  - ユーザー名とパスワードを指定する
2. [次へ] をクリックします。
Review: 接続と認証の詳細を確認します。
[作成] をクリックします。

認証を構成する

使用する認証に基づいて詳細を入力します。

ユーザー名とパスワード
- ユーザー名: コネクタのユーザー名
- パスワード: コネクタに関連付けられたパスワードを含む Secret Manager の Secret。
- Auth Scheme: 認証に使用されるスキーム

基本認証接続タイプのサンプル

次の表に、基本認証接続タイプのサンプル構成値を示します。必須フィールドと省略可能なフィールドについては、コンソールの接続作成インターフェースをご覧ください。

フィールド名	値のサンプル
リージョン	us-central1
コネクタ	SAP SuccessFactors
コネクタのバージョン	1
接続名	sapsf-basicauth-conn
説明	SuccessFactors 接続
サービスアカウント	SERVICE_ACCOUNT_NAME@developer.gserviceaccount.com
Company ID	SFPART068178
ホストアドレス	https://HOST_NAME.successfactors.eu/
ユーザー名	sfadmin
パスワード	パスワード
認証スキーム	基本

エンティティ、オペレーション、アクション

すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。

エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベースコネクタでは、テーブルがエンティティであり、ファイルサーバーコネクタでは、フォルダがエンティティです。また、メッセージングシステムコネクタでは、キューがエンティティです。
ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。
オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
- リスト
- 取得
- 作成
- 更新
- 削除
使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティオペレーションをご覧ください。ただし、コネクタがいずれかのエンティティオペレーションをサポートしていない場合、サポートされていないオペレーションは Operations リストに含まれません。
アクション: コネクタインターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

システムの上限

SAP SuccessFactors コネクタは、ノードごとに 1 秒あたり最大 10 件のトランザクションを処理することができ、この上限を超えるトランザクションはすべてthrottlesされます。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます（可用性を高めるため）。

Integration Connectors に適用される上限の詳細については、上限をご覧ください。

注: Integration Connectors ノードの数は、使用状況に応じて動的に自動スケーリングされます。ただし、自動スケーリングを待たずに大量の容量を確保する場合は、接続の最小ノード値を調整できます。1 つの接続により多くのトランザクションを処理するには、より多くのノードが必要です。逆に、接続が処理するトランザクションが少ない場合は、必要なノードの数が少なくなります。ノードの値を構成するには、次の手順を行います。

従量課金制をご利用のお客様は、接続の編集ページでノードの最小値と最大値を構成します。
サブスクリプションベースで利用されているお客様は、サポートにお問い合わせください。

ノードが処理できる最大トランザクションは、さまざまな要因によって異なります。そのため、スループットを高めるために最小ノードを調整する前に、バックエンドシステムが必要なトラフィックを処理するために最適に設定されているかどうかを確認することをおすすめします。

アクション

このセクションでは、SuccessFactors 接続でサポートされているすべてのアクションを一覧表示します。

UpsertEntity アクション

この操作により、エンティティのレコードをアップサートできます。

UpsertEntity アクションの入力パラメータ

パラメータ名	データ型	必須	説明
entityType	文字列	True	アップサートするエンティティタイプ。
payload	オブジェクト	True	JSON 形式のペイロードをアップサートします。

UpsertEntity アクションの出力パラメータ

このアクションは、すべてのアップサートの結果を示すレスポンスの本文でステータス 200（OK）を返します。

UpsertEntity アクションの構成例については、例をご覧ください。

アクションの例

このセクションでは、このコネクタでいくつかのアクションを実行する方法について説明します。

例 - PerPersonal エンティティのレコードを更新する

次の例では、PerPersonal エンティティ内のレコードを更新します。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[UpsertEntity] アクションを選択してから、[完了] をクリックします。

[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

{
"entityType": "PerPersonal",
"payload": {
  "personIdExternal": "109031",
  "startDate": "1800-01-01 00:00:00.0",
  "firstName": "John",
  "lastName": "Job",
  "nationality": "IND"
  }
}

アクションの実行に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。

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

例 - PaymentInformationDetailV3 エンティティのレコードを更新する

次の例では、PaymentInformationDetailV3 エンティティ内のレコードを更新します。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[UpsertEntity] アクションを選択してから、[完了] をクリックします。

[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

{
  "entityType": "PaymentInformationDetailV3",
  "payload": {
    "PaymentInformationV3_effectiveStartDate": "2015-01-21 00:00:00.0",
    "PaymentInformationV3_worker": "82096",
    "externalCode": 563.0,
    "currency": "EUR"
  }
}

アクションの実行に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。

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

例 - エンティティにレコードを作成する

次の例では、TodoEntryV2 エンティティにレコードを作成します。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[UpsertEntity] アクションを選択してから、[完了] をクリックします。

[コネクタ] タスクの [タスク入力] セクションで、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"
      }
    }
  }
}

アクションの実行に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。

[{
  "todoEntryId": 221443.0
}]

エンティティの例

例 - エンティティのレコードを一覧表示する

この例では、FOCompany エンティティのレコードを一覧表示します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から FOCompany を選択します。
[LIST] オペレーションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、要件に応じて filterClause を設定できます。

たとえば、フィルタ句を externalCode='5100' and startDate='1900-01-01 00:00:00' に設定すると、employeeCode が 5100 であり、startDate が 1900-01-01 00:00:00 であるレコードのみが一覧表示されます。

例 - エンティティからレコードを取得する

この例では、User エンティティからレコードを取得します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から User を選択します。
[GET] オペレーションを選択し、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで [EntityId] をクリックし、[デフォルト値] フィールドに 103032 を入力します。
ここで、103032 は Users エンティティの主キーです。

例 - エンティティからレコードを削除する

この例では、FOCompany エンティティからレコードを削除します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から FOCompany を選択します。
[DELETE] オペレーションを選択してから、[完了] をクリックします。
[コネクタタスクの [タスク入力 セクションで [entityId] をクリックし、[デフォルト値] フィールドに 113132 を入力します。
または、エンティティに複合主キーがある場合、entityId を指定する代わりに、filterClause を設定できます。たとえば、externalCode='5100' and startDate='1900-01-01 00:00:00' です。

例 - エンティティにレコードを作成する

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から FOCompany を選択します。
[Create] オペレーションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、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 エンティティにレコードを作成する

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から TimeZone を選択します。
[Create] オペレーションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、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 エンティティにレコードを作成します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から FOCompany を選択します。
[Update] オペレーションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"description": "BestRun India"
}
```
[コネクタタスクの [タスク入力 セクションで [entityId] をクリックし、[デフォルト値] フィールドに 103032 を入力します。
または、エンティティに複合主キーがある場合、entityId を指定する代わりに、filterClause を設定できます。たとえば、externalCode='5100' and startDate='1900-01-01 00:00:00' です。

統合に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。

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

Terraform を使用して接続を作成する

Terraform リソースを使用して、新しい接続を作成できます。

Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。

接続作成用の Terraform テンプレートのサンプルを表示するには、サンプルテンプレートをご覧ください。

Terraform を使用してこの接続を作成する場合は、Terraform 構成ファイルで次の変数を設定する必要があります。

パラメータ名	データ型	必須	説明
company_id	STRING	True	会社の一意の識別子。これは認証に必要です。
purge_type	STRING	False	PurgeType はオプションのパラメータで、エンティティに対して増分更新と完全な更新のどちらを行うかを決定します。
use_client_side_paging	BOOLEAN	False	SAP SuccessFactors の CData ADO.NET プロバイダが、クライアントサイドページングを使用するかどうか。
use_display_names	BOOLEAN	False	SAP ラベルを使用するかどうかを決定するブール値。
詳細度	STRING	False	接続の詳細レベルは 1～5 です。詳細レベルが高いと、すべての通信の詳細（リクエスト、レスポンス、SSL 証明書）がログに記録されます。
proxy_enabled	BOOLEAN	False	接続用のプロキシサーバーを構成するには、このチェックボックスをオンにします。
proxy_auth_scheme	ENUM	False	ProxyServer プロキシへの認証に使用する認証タイプです。サポートされている値は、BASIC、DIGEST、NONE です。
proxy_user	STRING	False	ProxyServer プロキシへの認証に使用されるユーザー名です。
proxy_password	SECRET	False	ProxyServer プロキシの認証に使用されるパスワード。
proxy_ssltype	ENUM	False	ProxyServer プロキシへの接続時に使用する SSL のタイプです。サポートされている値は AUTO、ALWAYS、NEVER、TUNNEL です。

統合で SAP SuccessFactors 接続を使用する

接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。

Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。

Google Cloud コミュニティの助けを借りる

Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。

SAP SuccessFactors

始める前に

コネクタを構成する

認証を構成する

基本認証接続タイプのサンプル

エンティティ、オペレーション、アクション

システムの上限

アクション

UpsertEntity アクション

UpsertEntity アクションの入力パラメータ

UpsertEntity アクションの出力パラメータ

アクションの例

例 - PerPersonal エンティティのレコードを更新する

例 - PaymentInformationDetailV3 エンティティのレコードを更新する

例 - エンティティにレコードを作成する

エンティティの例

例 - エンティティのレコードを一覧表示する

例 - エンティティからレコードを取得する

例 - エンティティからレコードを削除する

例 - エンティティにレコードを作成する

例 - TimeZone エンティティにレコードを作成する

例 - エンティティ内のレコードを更新する

Terraform を使用して接続を作成する

統合で SAP SuccessFactors 接続を使用する

Google Cloud コミュニティの助けを借りる

次のステップ