CData ADO.NET Provider for PingOne はじめに:インストールから接続まで
このガイドでは、CData ADO.NET Provider for PingOne の使い方を詳しく解説します。プロバイダーのインストール、PingOne のデータ への接続設定、そして .NET アプリケーションで ADO.NET パターンを使用した簡単なコマンドの実行方法を学べます。
デスクトップアプリ、Web アプリ、バックグラウンドサービスなど、どのような用途でも、このプロバイダーを使えば API の詳細を手動で管理することなく、ライブの PingOne のデータ に安全かつ高パフォーマンスで接続できます。
インストールとライセンス認証
システム要件
- 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://www.cdata.com/lic/transfer/
承認されると、プロダクトキーにアクティベーションが追加され、以前のインストールは無効になります。
ライセンスサポートの詳細については、portal.cdata.com にアクセスするか、[email protected] までお問い合わせください。
接続設定
インストールが完了したら、次のステップとして PingOne への接続を設定します。接続は、.NET アプリケーションのコードまたは構成ファイルで ADO.NET 接続文字列を使用して作成します。
接続マネージャーの作成
- Visual Studio を開きます。
- 表示メニューからサーバー エクスプローラーを選択します。
-
左サイドバーからデータベースへの接続をクリックします。
- 接続の追加ダイアログで、変更をクリックします。
-
CData PingOne のデータ source を選択し、OK をクリックします。
接続プロパティの設定
PingOne に接続するには以下のプロパティを設定します。
- Region:自身のPingOne 組織のデータがホスティングされている地域。
- AuthScheme:PingOne に接続する際に使用する認証の種類。
- WorkerAppEnvironmentId (デフォルトのPingOne ドメインを使用する場合に必要)、またはAuthorizationServerURL のいずれかで、下で説明するように設定します。
WorkerAppEnvironmentId の設定
WorkerAppEnvironmentId は、Worker アプリケーションが存在するPingOne 環境のID です。 このパラメータは、環境がデフォルトのPingOne ドメイン(auth.pingone)を利用している場合のみ使用されます。 これは、ヘルプドキュメントのカスタムOAuth アプリケーションの作成で説明するように、PingOne への認証に使用するカスタムOAuth アプリケーションを作成した後に設定します。
はじめに、このプロパティの値を見つけます。
- 自身のPingOne 組織のホームページからナビゲーションサイドバーに移動し、Environments をクリックします。
- OAuth / Worker のカスタムアプリケーションを作成した環境(通常はAdministrators)を見つけ、Manage Environment をクリックします。 環境のホームページが表示されます。
- 環境のホームページのナビゲーションサイドバーで、Applications をクリックします。
- リストから、OAuth またはWorker アプリケーションの詳細を見つけます。
-
Environment ID フィールドの値をコピーします。
以下の例に似たものになるはずです:
WorkerAppEnvironmentId='11e96fc7-aa4d-4a60-8196-9acf91424eca'
次に、WorkerAppEnvironmentId をEnvironment ID フィールドの値に設定します。
AuthorizationServerURL の設定
AuthorizationServerURL は、お使いのアプリケーションが配置されている環境のPingOne 認可サーバーのベースURL です。 このプロパティは、PingOne プラットフォームAPI ドキュメントで説明されているように、環境にカスタムドメインを設定した場合にのみ使用されます。 Custom Domains を参照してください。
OAuth でのPingOne への認証
PingOne はOAuth とOAuthClient 認証の両方をサポートしています。 上述の設定手順に加え、OAuth またはOAuthCliet 認証をサポートするために、さらに2つの手順を完了する必要があります。
- ヘルプドキュメントのカスタムOAuth アプリケーションの作成で説明するように、カスタムOAuth アプリケーションを作成して設定します。
- ドライバーがデータモデル内のエンティティにアクセスできるようにするには、ヘルプドキュメントのAdministrator Roles での説明のとおり、使用するアドミンユーザー / ワーカーアプリケーションに対して正しいロールを設定していることを確認してください。
- 以下のサブセクションで説明されているように、選択した認証スキームと認証フローに適切なプロパティを設定します。
OAuth(認可コードグラント)
AuthScheme をOAuth に設定します。
デスクトップアプリケーション
OAuth アクセストークンの取得およびリフレッシュ
以下を設定して、接続してください。
- InitiateOAuth:GETANDREFRESH。繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要をなくすには、InitiateOAuth を使用します。
- OAuthClientId:カスタムOAuth アプリケーションを作成した際に取得したClient ID。
- OAuthClientSecret:カスタムOAuth アプリケーションを作成した際に取得したClient Secret。
- CallbackURL:カスタムOAuth アプリケーションの登録時に定義したリダイレクトURI。例:https://localhost:3333
接続すると、CData 製品 はデフォルトブラウザでPingOne のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。 ドライバーはこれでOAuth プロセスを完了します。
- ドライバーはPingOne からアクセストークンを取得し、それを使ってデータをリクエストします。
- OAuth 値はOAuthSettingsLocation で指定された場所に保存され、接続間で永続化されるようにします。
ドライバーはアクセストークンの期限が切れると自動的にリフレッシュします。
Web アプリケーションやヘッドレスマシン、クライアントクレデンシャルグラントを含むその他のOAuth メソッドについては、ヘルプドキュメントを参照してください。
接続テスト
- 接続テストをクリックします。
- 接続に成功すると、Visual Studio 内でデータを確認できます。
よくある接続の問題
認証エラー
解決策: PingOne の OAuth 設定、クライアント ID、シークレット、またはトークンの権限を確認してください。サポートが必要な場合は [email protected] までお問い合わせください。
サーバーに接続できない
解決策: ファイアウォール、プロキシ、VPN の設定を確認してください。必要なポート情報については [email protected] までお問い合わせください。
テーブルが見つからない
解決策: PingOne をクエリする際に、正しいスキーマまたはデータベースを選択しているか確認してください。
次のステップ
ADO.NET Provider のインストール、ライセンス認証、接続設定が完了しました。以下のシナリオを参考に、ADO.NET ツールをさらに活用してみてください:
| ADO.NET Provider | 記事タイトル |
|---|
サポート
ご不明な点がございましたら、お気軽にお問い合わせください:
- テクニカルサポート: [email protected]
- コミュニティフォーラム: CData Community Site
- ヘルプドキュメント: ローカルにインストールされているほか、オンラインでも参照可能です
FAQ
インストールとライセンス
-
ADO.NET Provider のインストールには管理者権限が必要ですか?
はい、Visual Studio 全体で使用するコンポーネントをインストールするには管理者権限が必要です。 -
Azure Data Factory にデプロイする際に RTK は必要ですか?
はい。アプリケーションの接続文字列で RTK プロパティを設定してから公開してください。
接続
-
複数の PingOne アカウントを使用できますか?
アカウントごとに個別の接続文字列を作成してください。 -
プロキシ経由で接続できますか?
はい。接続文字列でプロキシ設定を構成できます。 -
接続をテストするにはどうすればよいですか?
接続マネージャー UI で接続テストをクリックしてください。
パフォーマンスとトラブルシューティング
-
クエリのパフォーマンスを改善するにはどうすればよいですか?
フィルターの適用、行数の制限、サーバー側のページングプロパティの活用をお試しください。 -
ログを有効にするにはどうすればよいですか?
接続マネージャーに以下を追加してください:- Logfile: /path/to/logfile.log
- Verbosity: 3
トラブルシューティングの際は、[email protected] にご連絡の上、ログファイルを安全にアップロードしてください。
この FAQ で解決しない場合は、[email protected] までお問い合わせください。