CData ADO.NET Provider for Workday はじめに:インストールから接続まで
このガイドでは、CData ADO.NET Provider for Workday の使い方を詳しく解説します。プロバイダーのインストール、Workday のデータ への接続設定、そして .NET アプリケーションで ADO.NET パターンを使用した簡単なコマンドの実行方法を学べます。
デスクトップアプリ、Web アプリ、バックグラウンドサービスなど、どのような用途でも、このプロバイダーを使えば API の詳細を手動で管理することなく、ライブの Workday のデータ に安全かつ高パフォーマンスで接続できます。
Workday データ連携について
CData は、Workday のライブデータにアクセスし、統合するための最も簡単な方法を提供します。お客様は CData の接続機能を以下の目的で使用しています:
- Prism Analytics Data Catalog で作成したテーブルやデータセットにアクセスでき、Workday システムの忠実性を損なうことなく、ネイティブの Workday データハブを操作できます。
- Workday Reports-as-a-Service にアクセスして、Prism から利用できない部門データセットや、Prism の許容サイズを超えるデータセットのデータを表示できます。
- WQL、REST、または SOAP でベースデータオブジェクトにアクセスし、より詳細で細かいアクセスを実現できます(ただし、クエリの作成には Workday 管理者や IT の支援が必要な場合があります)。
ユーザーは、Tableau、Power BI、Excel などの分析ツールと Workday を統合し、当社のツールを活用して Workday データをデータベースやデータウェアハウスにレプリケートしています。アクセスは、認証されたユーザーの ID とロールに基づいて、ユーザーレベルで保護されます。
Workday を CData と連携させるための設定についての詳細は、ナレッジベース記事をご覧ください:Comprehensive Workday Connectivity through Workday WQL および Reports-as-a-Service & Workday + CData: Connection & Integration Best Practices
はじめに
インストールとライセンス認証
システム要件
- Windows: Windows 10/11 または Windows Server 2016 以降
- .NET バージョン: .NET Framework 4.0 以降、.NET 6 以降、.NET Standard アセンブリ
- IDE: Visual Studio 2017 以降
ADO.NET Provider のインストール
Windows でのインストール
- CData アカウントまたは評価版ダウンロードページから ADO.NET Provider インストーラーをダウンロードします。
- インストーラーを実行し、ウィザードに従ってインストールを完了します。
- インストーラーがプロバイダーを登録し、すべてのアセンブリを適切な CData インストールフォルダに配置します。
-
インストール中にライセンスキーの入力を求められます:
XXXX-XXXX-XXXX-XXXX-XXXX- Note: 試用版を使用する場合は、代わりにTrial Key を選択してください。
ライセンスの認証
ライセンスの動作は、.NET Framework と .NET Standard のどちらを使用しているかによって異なります。 以下の手順で、お使いの環境でプロバイダーを認証してください。
.NET Framework(Windows)
Windows で .NET Framework を使用する場合、追加の操作は必要ありません。インストーラーまたは NuGet パッケージが開発ライセンスを自動的にインストールします。
.NET Standard(Windows/Mac/Linux)
.NET Core、Mono、Xamarin などの .NET Standard プラットフォームでは、プロバイダーを使用する前に手動でライセンスをインストールする必要があります。
Install-License ツールの使用
ツールキットには、試用版または正規ライセンスを適用するための install-license ユーティリティが
lib/netstandard2.0フォルダに含まれています。
試用版ライセンスをインストールする場合:
dotnet ./install-license.dll
正規版ライセンスを認証する場合:
dotnet ./install-license.dll
ツールを実行すると、開発マシンがライセンス認証され、.NET アプリケーションでプロバイダーを使用できるようになります。
ランタイムライセンス
アプリケーションをデプロイする際は、接続文字列でランタイムキー(RTK)を指定して再配布を有効にします。
| プロパティ | 説明 |
|---|---|
| RTK | デプロイされた ADO.NET アプリケーション用のランタイムキーです。 |
ライセンスに関するよくある質問
ライセンスは複数のマシンで使用できますか?
はい、サブスクリプションプランによります。不明な場合は、注文確認メールを確認するか、[email protected] までお問い合わせください。
ライセンスキーを紛失しました。どうすれば取得できますか?
注文番号を添えて [email protected] までメールでお問い合わせください。
ライセンスを別のマシンに移行できますか?
ライセンス移行リクエストを送信してください:
https://jp.cdata.com/contact/
承認されると、プロダクトキーにアクティベーションが追加され、以前のインストールは無効になります。
ライセンスサポートの詳細については、portal.cdata.com にアクセスするか、[email protected] までお問い合わせください。
接続設定
インストールが完了したら、次のステップとして Workday への接続を設定します。接続は、.NET アプリケーションのコードまたは構成ファイルで ADO.NET 接続文字列を使用して作成します。
接続マネージャーの作成
- Visual Studio を開きます。
- 表示メニューからサーバー エクスプローラーを選択します。
-
左サイドバーからデータベースへの接続をクリックします。
- 接続の追加ダイアログで、変更をクリックします。
-
CData Workday のデータ source を選択し、OK をクリックします。
接続プロパティの設定
Workday 接続プロパティの取得・設定方法
ここでは、4つのWorkday API の接続パラメータを設定する方法、およびTenant とBaseURL を取得する方法について説明します。必要な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/
- https://domain.com(URL のサブディレクトリと会社名の前の部分)は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 への認証
Basic 認証以外のほとんどのWorkday 接続では、認証のためにOAuth ベースのカスタムAPI クライアントアプリケーションを作成する必要があります。これには、ユーザーがAzure AD 資格情報を介して接続するエンタープライズインストールも含まれます。 Workday への認証につての詳細は、ヘルプドキュメントの「Workday への認証」セクションを参照してください。
接続テスト
- 接続テストをクリックします。
- 接続に成功すると、Visual Studio 内でデータを確認できます。
よくある接続の問題
認証エラー
解決策: Workday の OAuth 設定、クライアント ID、シークレット、またはトークンの権限を確認してください。サポートが必要な場合は [email protected] までお問い合わせください。
サーバーに接続できない
解決策: ファイアウォール、プロキシ、VPN の設定を確認してください。必要なポート情報については [email protected] までお問い合わせください。
テーブルが見つからない
解決策: Workday をクエリする際に、正しいスキーマまたはデータベースを選択しているか確認してください。
次のステップ
ADO.NET Provider のインストール、ライセンス認証、接続設定が完了しました。以下のシナリオを参考に、ADO.NET ツールをさらに活用してみてください:
| ADO.NET Provider | 記事タイトル |
|---|---|
| LINQPad | LINQPad でWorkday のデータを操作する方法 |
| Microsoft SSAS | SSAS でWorkday のデータに連携するOLAP Cube を作成 |
| SSRS Server | SSRS レポートサーバーにADO.NET Provider を配置してWorkday 連携 |
| .NET Charts | Visual Studio でチャートコントロールと Workday をデータバインド |
| Blazor | Blazor でWorkday のデータにリアルタイムで連携するアプリを構築 |
| DevExpress | Workday のデータをDevExpress Data Grid にデータバインドする。 |
| EF - Code First | Entity Framework 6 からWorkday のデータに連携 |
| EF - LINQ | LINQ を使ってWorkday のデータに連携する方法 |
| EF - MVC | 【徹底解説】Workday とのデータ連携ができるMVC アプリケーションの作り方 |
| Flexsche | 生産スケジューラFLEXSCHE へWorkday からデータを取り込む |
| Infragistics DataGrid | Infragistics XamDataGrid を使用してWorkday のダイナミックグリッドを作成 |
| OD Server | WCF アプリケーションで Workday データのOData サービスを公開 |
| Xamarin DataGrid | Infragistics WPF XamDataGrid と Workday をデータバインド |
| ADO.NET Setup | CData ADO.NET Provider for Workday はじめに:インストールから接続まで |
| SSIS Task | Workday をSSIS 経由でSQL サーバーにバックアップする |
サポート
ご不明な点がございましたら、お気軽にお問い合わせください:
- テクニカルサポート: [email protected]
- コミュニティフォーラム: CData Community Site
- ヘルプドキュメント: ローカルにインストールされているほか、オンラインでも参照可能です
FAQ
インストールとライセンス
-
ADO.NET Provider のインストールには管理者権限が必要ですか?
はい、Visual Studio 全体で使用するコンポーネントをインストールするには管理者権限が必要です。 -
Azure Data Factory にデプロイする際に RTK は必要ですか?
はい。アプリケーションの接続文字列で RTK プロパティを設定してから公開してください。
接続
-
複数の Workday アカウントを使用できますか?
アカウントごとに個別の接続文字列を作成してください。 -
プロキシ経由で接続できますか?
はい。接続文字列でプロキシ設定を構成できます。 -
接続をテストするにはどうすればよいですか?
接続マネージャー UI で接続テストをクリックしてください。
パフォーマンスとトラブルシューティング
-
クエリのパフォーマンスを改善するにはどうすればよいですか?
フィルターの適用、行数の制限、サーバー側のページングプロパティの活用をお試しください。 -
ログを有効にするにはどうすればよいですか?
接続マネージャーに以下を追加してください:- Logfile: /path/to/logfile.log
- Verbosity: 3
トラブルシューティングの際は、[email protected] にご連絡の上、ログファイルを安全にアップロードしてください。
この FAQ で解決しない場合は、[email protected] までお問い合わせください。