接続の確立
接続プロファイルの設定
[CData]リボンから[データの取得]をクリックし、[取得元:Workday]> 設定済みの接続 を選択してCData クエリウィンドウを起動します。新しい接続を設定するには、[新しいWorkday 接続]をクリックします。ここでは、接続の設定、接続のテスト、および接続プロファイルの保存を行うことができます。
Workday への接続
このセクションでは、4つのWorkday API の接続パラメータを設定する方法、およびTenant とBaseURL を取得する方法について説明します。 各サービス(WQL、Reports、REST、SOAP)には独自のConnectionType があり、接続ごとに使用できる接続タイプは1つだけです。必要なAPI のパラメータを設定し、カスタムOAuth および / またはAzure AD API クライアントを作成したら、接続の準備は完了です。
接続の前提条件
API | 前提条件 | 接続パラメータ |
WQL | WQL サービスを有効化 (下記参照) | ConnectionType: WQL |
Reports as a Service | カタログレポートの設定 (データアクセスのファインチューニング を参照) | ConnectionType: Reports |
REST | 自動で有効化 | ConnectionType: REST |
SOAP | 自動で有効化 | 以下のWorkday SOAP API を参照 |
BaseURL およびTenant の取得
BaseURL およびTenant プロパティを取得するため、Workday にログインしてView API Clients を検索します。 この画面では、Workday はBaseURL とTenant の両方を含むURL であるWorkday REST API Endpoint を表示します。
REST API Endpoint のフォーマットは、
https://domain.com/subdirectories/mycompany です。ここで、
- https://domain.com/subdirectories/ はBaseURL です。
- mycompany(URL の最後のスラッシュの後の部分)はTenant です。
例えば、REST API エンドポイントがhttps://wd3-impl-services1.workday.com/ccx/api/v1/mycompany の場合、 BaseURL はhttps://wd3-impl-services1.workday.com であり、Tenant はmycompany です。
WQL サービスを有効化
Workday WQL API を介して接続するには、はじめにWQL Service を有効にする必要があります。- Workday を開きます。
- 検索バーで、View Domain を検索します。
- プロンプトにWorkday Query Language と入力します。
- Allowed Security Group Types のいずれかに、接続するユーザーが含まれていることを確認します。
Workday への認証
ほとんどのWorkday 接続で、認証のためにOAuth ベースのカスタムAPI クライアントアプリケーションを作成する必要があります。これには、ユーザーがAzure AD 資格情報を介して接続するエンタープライズインストールも含まれます。SOAP 経由で接続したい場合は、カスタムOAuth アプリケーションを必要としないBasic 認証を使用できます。このセクションでは、両方の認証方法について説明します。
OAuth
このセクションでは、SSO のない環境でOAuth 標準を使用して認証する方法について説明します。この環境で認証を行う前に、カスタムAPI クライアントアプリケーションの作成 で説明するように、はじめにカスタムOAuth アプリケーションを作成する必要があります。Note: これらはWorkday API への認証を容易にするため、このドキュメントではカスタムOAuth アプリケーションをカスタムAPI Clients として頻繁に参照します。
デスクトップアプリケーション
カスタムOAuth アプリケーションの資格情報を使用して認証するには、OAuth アクセストークンを取得し、更新する必要があります。これらを設定すると、接続の準備が整います。OAuth アクセストークンの取得およびリフレッシュ:
- InitiateOAuth:GETANDREFRESH。OAuthAccessToken を自動的に取得およびリフレッシュするために使用します。
- OAuthClientId:アプリケーションの登録時に割り当てられたクライアントId。
- OAuthClientSecret:アプリケーションの登録時に割り当てられたクライアントシークレット。
- CallbackURL:アプリケーションの登録時に定義されたリダイレクトURI。
接続すると、本製品 はデフォルトブラウザでWorkday のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。
アクセストークンの期限が切れたときは、本製品 は自動でアクセストークンをリフレッシュします。
標準ユーザーとして認証
Workday で標準ユーザーとして認証するには、カスタムAPI クライアントアプリケーションの作成 で説明するように、はじめにAPI クライアントを作成する必要があります。API クライアントを設定したら、Workday 認証情報を使用して接続するために以下のプロパティを設定します。
標準OAuth ユーザー
- ConnectionType および関連プロパティ
- AuthScheme:OAuth。
- OAuthClientId:View API Client ページで取得したClient ID。
- OAuthClientSecret:View API Client ページで取得したClient Secret。パブリッククライアントを使う場合には、この値をブランクにします。
- Tenant:アカウントのテナント。
- BaseURL:View API Clients ページにあるREST API Endpoint のベースURL。
AzureAD ユーザー
- ConnectionType および関連プロパティ
- AuthScheme:AzureAD。
- OAuthClientId:View API Client ページで取得したClient ID。
- Tenant:アカウントのテナント。
- BaseURL:View API Clients ページにあるREST API Endpoint のベースURL。
- SSOProperties:AzureTenant、AzureClientId、AzureClientSecret、Resource など、SSO に使用される Azure 固有のプロパティ。
ISU として認証
ISU として認証するには、カスタムAPI クライアントアプリケーションの作成 で説明するように、 はじめにAPI Client またはAPI Client for Integrations のいずれかを作成する必要があります。JWT bearer grant type を使用して、これらのクライアントのいずれかを作成できます。
適切なプロパティを設定したら、接続の準備は完了です。
API Client for Integrations
- ConnectionType および関連プロパティ
- AuthScheme:OAuthISU。
- OAuthClientId:View API Client ページで取得したClient ID。
- OAuthClientSecret:View API Client ページで取得したClient Secret。
- OAuthRefreshToken:Manage Refresh Tokens for Integrations ページで取得したリフレッシュトークン。
- Tenant:アカウントのテナント。
- BaseURL:View API Clients ページにあるREST API Endpoint のベースURL。
API Client(JWT)
- ConnectionType および関連プロパティ
- AuthScheme:OAuthJWT。
- OAuthJWTCertType:証明書の種類。keytool または openssl pkcs12 で証明書を作成した場合、PFXFILE になります。
- OAuthJWTCert:作成した証明書ファイルのパス。
- OAuthJWTCertPassword:作成した証明書ファイルのパスワード。
- OAuthJWTIssuer:View API Client ページで取得したClient ID。
- OAuthJWTSubject:使用しているISU のユーザー名。
- Tenant:アカウントのテナント。
- BaseURL:View API Clients ページにあるREST API Endpoint のベースURL。
SOAP API
SOAP API を使用する接続では、WQL およびレポートサービスと同じ認証スキームがすべてサポートされます。また、カスタムAPI クライアントを設定する必要のないBasic 認証もサポートしています。Basic 認証を使用するには、次の接続パラメータを設定します。
- ConnectionType:SOAP。
- AuthScheme:Basic。
- User:Workday ユーザーアカウント名。
- Password:Workday ユーザーのパスワード。
- Tenant:アカウントのテナント。
- BaseURL:View API Clients ページにあるREST API Endpoint のベースURL。
その他の認証方法は、WQL およびレポーティングサービスの場合と同じ方法で構成されます。
接続プロパティ
最後に、Connection プロパティを参照してください。接続の確立に使用できるさまざまなオプションの説明があります。
接続の管理
Workday への認証に成功すると、インポートするデータをカスタマイズすることができます。詳しくは、接続の管理 を参照してください。
関連項目
- データのクエリ:[データ選択]ウィザードを使用してスプレッドシートにデータをプルします。また、ここではスケジュールされたデータのリフレッシュも設定できます。
- Excel アドインの使用:利用可能なCData Excel 関数 を使用するなど、Workday データとやり取りする他の方法が見つかります。