Workday

Workday コネクタを使用すると、Workday インスタンスに接続され、従来のデータベースとして Workday データにアクセスできます。

始める前に

Workday コネクタを使用する前に、次の作業を行います。

• Google Cloud プロジェクトで次の操作を行います。
  • ネットワーク接続が設定されていることを確認します。ネットワーク パターンの詳細については、Network Connectivity をご覧ください。
  • コネクタを構成するユーザーに 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 アカウントを作成します。Workday コミュニティについては、Workday コミュニティをご覧ください。REST API の詳細については、REST API をご覧ください。

Oauth 2.0 認証用のクライアント ID とクライアント シークレットを設定する

Workday で API クライアントを作成して登録する手順は次のとおりです。

1. Workday で [API クライアントを登録] をクリックします。
2. クライアント名を入力します。
3. クライアントの権限付与タイプとして認証コード権限付与を選択します。
4. ベアラ アクセス トークンのタイプを選択し、必要に応じて他のスコープを追加して、[OK] をクリックします。
5. API クライアントの登録に必要なすべての詳細とスコープを入力します。
6. SOAP 認証タイプを設定するには、ユーザー名とパスワードを追加します。

コネクタを構成する

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

1. Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。

   [接続] ページに移動

2. [+ 新規作成] をクリックして [接続の作成] ページを開きます。
3. [ロケーション] セクションで、接続のロケーションを選択します。
   1. リージョン: プルダウン リストからロケーションを選択します

      サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。

   2. [次へ] をクリックします。
4. [接続の詳細] セクションで、次の操作を行います。
   1. コネクタ: 使用可能なコネクタのプルダウン リストから [PayPal] を選択します。
   2. コネクタのバージョン: 使用可能なバージョンのプルダウン リストからコネクタのバージョンを選択します。
   3. [接続名] フィールドに、接続インスタンスの名前を入力します。

      接続名は次の条件を満たす必要があります。

      • 接続名には英字、数字、ハイフンを使用できます。
      • 文字は小文字のみを使用できます。
      • 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
      • 接続名は 49 文字以内で指定してください。
   4. 必要に応じて、接続インスタンスの [説明] を入力します。
   5. 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは Error に設定されています。
   6. サービス アカウント: 必要なロールを持つサービス アカウントを選択します。
   7. 必要に応じて、接続ノードの設定を構成します。
      • ノードの最小数: 接続ノードの最小数を入力します。
      • ノードの最大数: 接続ノードの最大数を入力します。

      ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。

   注: 接続ノード値をカスタマイズできるのは、従量課金制のお客様のみです。
   8. テナント: アカウントのテナント。 たとえば、abc_cms1 のようにします。テナントの名前は、Workday インスタンスの構成の詳細で確認できます。
   9. サービス: データを取得する特定のサービスまたは複数のサービス。カンマ区切りのリストとして入力します。 例: absenceManagement,common,compensation,recruiting,payroll,person
   10. WSDL Version: 使用する WSDL のバージョン。
   11. Use proxy: このチェックボックスを選択して、接続用のプロキシ サーバーを構成し、次の値を構成します。
   • Proxy Auth Scheme: プロキシ サーバーで認証する認証タイプを選択します。次の認証タイプがサポートされています。
     • 基本: 基本的な HTTP 認証。
     • ダイジェスト: ダイジェスト HTTP 認証。
   • Proxy User: プロキシ サーバーでの認証に使用されるユーザー名。
   • プロキシ パスワード: ユーザーのパスワードの Secret Manager シークレット。
   • Proxy SSL Type: プロキシ サーバーへの接続時に使用する SSL タイプ。次の認証タイプがサポートされています。
     • 自動: デフォルトの設定。URL が HTTPS URL の場合は、[トンネル] オプションが使用されます。URL が HTTP URL の場合、[なし] オプションが使用されます。
     • 常に: 接続は常に SSL 対応です。
     • なし: 接続は SSL に対応していません。
     • トンネル: 接続はトンネリング プロキシ経由で行われます。プロキシ サーバーがリモートホストへの接続を開き、トラフィックはプロキシを経由するようになります。
   • [Proxy Server] セクションで、プロキシ サーバーの詳細を入力します。
     1. [+ 宛先を追加] をクリックします。
     2. [宛先の種類] を選択します。
        • Host address: 宛先のホスト名または IP アドレスを指定します。

          バックエンドへのプライベート接続を確立する場合は、次のようにします。

          • PSC サービス アタッチメントを作成します。
          • エンドポイント アタッチメント作成してから、ホストアドレスフィールドにあるエンドポイント アタッチメントの詳細を入力します。
   12. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
   13. [次へ] をクリックします。
5. [宛先] セクションに、接続するリモートホスト（バックエンド システム）の詳細を入力します。
   1. 次のいずれかの宛先タイプを構成できます。
      • ベース URL: [+ 宛先を追加] をクリックし、Workday インスタンスのベース URL を入力します。例: https://wd5-impl-service23.workday.com
      • API URL: [+ 宛先を追加] をクリックし、Workday インスタンスの API URL を入力します。例: https://wd5-impl-service23.workday.com/srx/api/v1/TENANT
      • WSDL URL: [+ 宛先を追加] をクリックし、Workday インスタンスの WSDL URL を入力します。

      Workday インスタンスとの通信には、REST プロトコルまたは SOAP プロトコルのいずれかを使用できます。各プロトコルの接続を構成する方法については、REST または SOAP の接続を構成するをご覧ください。

   2. [次へ] をクリックします。
6. [認証] セクションで、認証の詳細を入力します。
   1. [認証タイプ] を選択し、関連する詳細を入力します。

      Workday 接続でサポートされる認証タイプは次のとおりです。

      • ユーザー名とパスワードを指定する
      • OAuth 2.0 - 認証コード

   これらの認証タイプの構成方法については、認証を構成するをご覧ください。

   2. [次へ] をクリックします。
7. Review: 接続と認証の詳細を確認します。
8. [作成] をクリックします。

REST または SOAP の接続を構成する

REST の構成

REST プロトコルを使用して接続するには、OAuth 2.0 - 認証コードの認証タイプを使用し、次のフィールドを構成する必要があります。

[接続の詳細] セクションで、次の操作を行います。

• テナント
• サービス
• WSDL バージョン

[宛先] セクションで、次の操作を行います。

• ベース URL
• API URL

[認証] セクションで次の操作を行います。

• クライアント ID
• クライアント シークレット

SOAP の構成

SOAP プロトコルを使用して接続するには、ユーザー名とパスワードの認証タイプを使用し、次のフィールドを構成する必要があります。

[接続の詳細] セクションで、次の操作を行います。

• テナント
• サービス
• WSDL バージョン

[宛先] セクションで、次の操作を行います。

• ベース URL

[認証] セクションで次の操作を行います。

• ユーザー名
• パスワード

認証を構成する

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

• ユーザー名とパスワード
  • ユーザー名: コネクタのユーザー名
  • パスワード: コネクタに関連付けられたパスワードを含む Secret Manager の Secret。

• OAuth 2.0 - 認証コード
• クライアント ID: 外部アプリケーションによって提供されるクライアント ID。
• スコープ: 権限スコープ。
• クライアント シークレット: Secret Manager のシークレットを選択します。 この認証を構成する前に、Secret Manager のシークレットを作成しておく必要があります。
• シークレットのバージョン: クライアント シークレットの Secret Manager シークレットのバージョン。
• 認可 URL: Workday インスタンスの作成時に生成された認可 URL を入力します。
• 接続タイプ: 接続タイプを選択します。

OAuth 2.0 - Authorization code 認証タイプの場合は、接続を作成した後、認証を構成するためにいくつかの追加手順を行う必要があります。詳しくは、接続作成後の追加手順をご覧ください。

注: OAuth 2.0 - Authorization code 認証タイプを使用しているユーザーが、Workday アプリケーションの構成を変更した場合は、Workday 接続を再認可する必要があります。再認可する方法については、認証コードの再認可をご覧ください。

接続作成後の追加手順

認証に OAuth 2.0 - Authorization code を選択した場合は、接続の作成後に次の追加の手順を行う必要があります。

1. 接続ページで、新しく作成された接続を見つけます。

   新しいコネクタの [ステータス] は [承認が必要] になります。

2. [承認が必要] をクリックします。

   これにより、[承認の編集] ペインが表示されます。

3. [リダイレクト URI] の値を外部アプリケーションにコピーします。
4. 認可の詳細を確認します。
5. [Authorize（承認）] をクリックします。

   認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。

認証コードの再認可

Authorization code 認証タイプを使用しているユーザーが、Workday アプリケーションの構成を変更した場合は、Workday 接続を再認可する必要があります。接続を再認可するには、次の手順を行います。

1. [接続] ページで必要な接続をクリックします。

   これにより、[接続の詳細] ページが開きます。

2. [編集] をクリックして、接続の詳細を編集します。
3. [認証] セクションで [OAuth 2.0 - 認証コード] の詳細を確認します。

   必要に応じて必要な変更を加えます。

4. [保存] をクリックします。接続の詳細ページに移動します。
5. [認証] セクションで [承認の編集] をクリックします。これにより、[承認] ペインが表示されます。
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
ベース URL	BASE_URL
認証	USER_PASSWORD
ユーザー名	ユーザー名
パスワード	パスワード
シークレット バージョン	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
ベース URL	BASE_URL
APIURL	API_URL
認証	OAuth 2.0 - 認証コード
クライアント ID	CLIENT_ID
スコープ	システム
クライアント シークレット	CLIENT_SECRET
シークレット バージョン	1
認証 URL	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
ベース URL	BASE_URL
認証	統合システムのユーザー
クライアント ID	CLIENT_ID
クライアント シークレット	CLIENT_SECRET
シークレット バージョン	8
更新トークン	REFRESH_TOKEN
シークレット バージョン	7

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

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

注: コネクタタスクで、コネクタのエンティティ、オペレーション、アクションを表示できます。

• エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベース コネクタでは、テーブルがエンティティであり、ファイル サーバー コネクタでは、フォルダがエンティティです。また、メッセージング システム コネクタでは、キューがエンティティです。

  ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。

• オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
  • リスト
  • 取得
  • 作成
  • 更新
  • 削除

  使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティ オペレーションをご覧ください。ただし、コネクタがいずれかのエンティティ オペレーションをサポートしていない場合、サポートされていないオペレーションは Operations リストに含まれません。

• アクション: コネクタ インターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

注: すべてのエンティティとアクションに、関連するスキーマがあります。たとえば、アクション スキーマにはパラメータの詳細（パラメータ名や対応するデータ型など）が含まれます。エンティティとアクションのスキーマ（メタデータ）は、ランタイムに接続によってバックエンドから取得されます。スキーマが更新されても、既存の接続には自動的に反映されません。スキーマを手動で更新する必要があります。接続のスキーマを更新するには、接続の [接続の詳細] ページを開き、[Refresh connection schema] をクリックします。

システムの上限

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

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

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

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

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

統合で Workday 接続を使用する

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

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

エンティティ オペレーションの例

このセクションでは、このコネクタでエンティティ オペレーションの一部を実行する方法について説明します。

Workday 接続を使用する場合、エンティティ名は「SCHEMA_NAME.ENTITY_NAME」の形式で表示されます。たとえば、「Staffing.Workers_training」では、Staffing はスキーマ名、Workers_training はテーブル名です。

ビューでは list オペレーションと get オペレーションのみがサポートされていますが、テーブルでは 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. [コネクタタスクの [タスク入力 セクションで [entityId] をクリックし、[デフォルト値] フィールドに 1|CN=admin,CN=Users,DC=test-ldap,DC=com を入力します。

   ここで、1|CN=admin,CN=Users,DC=test-ldap,DC=com は Scorecards エンティティの主キー値です。

例 - レコードを作成する

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

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から PayrollInputs を選択します。
3. [Create] オペレーションを選択してから、[完了] をクリックします。
4. [コネクタ] タスクの [タスク入力] セクションで、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. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {
   "ScorecardDescription": "New updated description",
   "ScorecardName": "Scorecard_1"
   }

5. [エンティティ ID] をクリックし、[デフォルト値] フィールドに「f368471438b14705a1178c6744d75853」と入力します。

例 - レコードを削除する

この例では、Scorecards エンティティ内の指定された ID のレコードを削除します。

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Scorecards を選択します。
3. [Delete] オペレーションを選択してから、[完了] をクリックします。
4. [コネクタタスクの [タスク入力 セクションで [entityId] をクリックし、[デフォルト値] フィールドに e002de05784910123c443f7eb0970722 を入力します。

注: エンティティに複合主キーがある場合は、フィルタ句を指定できます。例: Id='e002de05784910123c443f7eb0970722' and Inactive=false。

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

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

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

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

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

パラメータ名	データ型	必須	説明
テナント	STRING	False	アカウントのテナント。
サービス	STRING	False	データを取得する特定のサービスまたは複数のサービスです。カンマ区切りのリストとして入力します。
wsdlversion	STRING	False	使用する WSDL のバージョン。
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 です。

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

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

次のステップ

• 接続を一時停止して再開する方法を確認する。
• コネクタの使用状況をモニタリングする方法を確認する。
• コネクタログを表示する方法を確認する。