CData ADO.NET Provider for SAP SuccessFactors はじめに：インストールから接続まで

このガイドでは、CData ADO.NET Provider for SAP SuccessFactors の使い方を詳しく解説します。プロバイダーのインストール、SAP SuccessFactors のデータ への接続設定、そして .NET アプリケーションで ADO.NET パターンを使用した簡単なコマンドの実行方法を学べます。

デスクトップアプリ、Web アプリ、バックグラウンドサービスなど、どのような用途でも、このプロバイダーを使えば API の詳細を手動で管理することなく、ライブの SAP SuccessFactors のデータ に安全かつ高パフォーマンスで接続できます。

インストールとライセンス認証

システム要件

• Windows： Windows 10/11 または Windows Server 2016 以降
• .NET バージョン： .NET Framework 4.0 以降、.NET 6 以降、.NET Standard アセンブリ
• IDE： Visual Studio 2017 以降

ADO.NET Provider のインストール

Windows でのインストール

1. CData アカウントまたは評価版ダウンロードページから ADO.NET Provider インストーラーをダウンロードします。
2. インストーラーを実行し、ウィザードに従ってインストールを完了します。
3. インストーラーがプロバイダーを登録し、すべてのアセンブリを適切な CData インストールフォルダに配置します。
4. インストール中にライセンスキーの入力を求められます：
   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）を指定して再配布を有効にします。

ライセンスに関するよくある質問

ライセンスは複数のマシンで使用できますか？
はい、サブスクリプションプランによります。不明な場合は、注文確認メールを確認するか、[email protected] までお問い合わせください。

ライセンスキーを紛失しました。どうすれば取得できますか？
注文番号を添えて [email protected] までメールでお問い合わせください。

ライセンスを別のマシンに移行できますか？
ライセンス移行リクエストを送信してください：
https://www.cdata.com/lic/transfer/

承認されると、プロダクトキーにアクティベーションが追加され、以前のインストールは無効になります。

ライセンスサポートの詳細については、portal.cdata.com にアクセスするか、[email protected] までお問い合わせください。

接続設定

インストールが完了したら、次のステップとして SAP SuccessFactors への接続を設定します。接続は、.NET アプリケーションのコードまたは構成ファイルで ADO.NET 接続文字列を使用して作成します。

接続マネージャーの作成

• Visual Studio を開きます。
• 表示メニューからサーバー エクスプローラーを選択します。
• 左サイドバーからデータベースへの接続をクリックします。
• 接続の追加ダイアログで、変更をクリックします。
• CData SAP SuccessFactors のデータ source を選択し、OK をクリックします。

接続プロパティの設定

SAP SuccessFactorsへの接続

それでは、SAP SuccessFactors に接続していきましょう。CData 製品は、デフォルトで有効になっているOData API を介してSAP SuccessFactors と通信します。追加の権限が必要な場合は、SAP サポートサイトをご確認ください。

認証方法として、Azure AD 認証、SAP IAS 認証、OAuth 認証（推奨）、Basic 認証（非推奨）のいずれかを使用してSAP SuccessFactors に認証できます。

必要な接続プロパティ

選択したAuthScheme に関わらず、SAP SuccessFactors 環境を識別するために以下の接続プロパティを設定しましょう。

• URL：SuccessFactors をホストするサーバーのURL
• CompanyId：SAP SuccessFactors テナントに割り当てられた一意の識別子。この値はAPI 認証に必要で、組織固有のものです

OAuth 認証

SAP SuccessFactors では、OAuth 認証を2種類のグラント種別でサポートしています。

• SAP SuccessFactors LMS インスタンスのクライアントグラント種別
• SAML-2 Bearer グラント種別

OAuth 認証を有効にするには、すべてのOAuth フローでカスタムOAuth アプリケーションを作成し、適切なプロパティを設定する必要があります。

デスクトップアプリケーションでカスタムOAuth アプリケーションの資格情報を使用して認証するには、OAuth アクセストークンを取得し、更新する必要があります。これらを設定すると、接続の準備が整います。

OAuth アクセストークンの取得およびリフレッシュ

以下のプロパティを設定してください。

• InitiateOAuth：GETANDREFRESH。OAuthAccessToken を自動的に取得およびリフレッシュするために使用します
• OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId
• CallbackURL：カスタムOAuth アプリケーションの登録時に定義されたリダイレクトURI
• OAuthClientSecret （クライアントグラント種別のみ）：アプリケーションの登録時に割り当てられたクライアントシークレット
• PrivateKey （SAML-2 Bearer グラント種別のみ）：カスタムOAuth アプリケーションの作成時にダウンロードした秘密鍵証明書のパス、またはその証明書のbase64 でエンコードされた内容

接続すると、CData 製品がデフォルトブラウザでSAP SuccessFactors のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えてください。

アプリケーションにアクセス許可を与えると、CData 製品がOAuth プロセスを完了します。

1. CData 製品がSAP SuccessFactors からアクセストークンを取得し、それを使ってデータをリクエストします
2. OAuth 値はOAuthSettingsLocation で指定されたパスに保存されます。これらの値は接続間で永続化されます

アクセストークンの期限が切れた際は、CData 製品が自動でアクセストークンをリフレッシュします。

カスタムOAuth アプリケーションの作成やその他の認証方法については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」をご確認ください。

接続テスト

• 接続テストをクリックします。

• 接続に成功すると、Visual Studio 内でデータを確認できます。

よくある接続の問題

認証エラー

解決策： SAP SuccessFactors の OAuth 設定、クライアント ID、シークレット、またはトークンの権限を確認してください。サポートが必要な場合は [email protected] までお問い合わせください。

サーバーに接続できない

解決策： ファイアウォール、プロキシ、VPN の設定を確認してください。必要なポート情報については [email protected] までお問い合わせください。

テーブルが見つからない

解決策： SAP SuccessFactors をクエリする際に、正しいスキーマまたはデータベースを選択しているか確認してください。

次のステップ

ADO.NET Provider のインストール、ライセンス認証、接続設定が完了しました。以下のシナリオを参考に、ADO.NET ツールをさらに活用してみてください：

サポート

ご不明な点がございましたら、お気軽にお問い合わせください：

• テクニカルサポート： [email protected]
• コミュニティフォーラム： CData Community Site
• ヘルプドキュメント： ローカルにインストールされているほか、オンラインでも参照可能です

FAQ

インストールとライセンス

• ADO.NET Provider のインストールには管理者権限が必要ですか？
  はい、Visual Studio 全体で使用するコンポーネントをインストールするには管理者権限が必要です。
• Azure Data Factory にデプロイする際に RTK は必要ですか？
  はい。アプリケーションの接続文字列で RTK プロパティを設定してから公開してください。

接続

• 複数の SAP SuccessFactors アカウントを使用できますか？
  アカウントごとに個別の接続文字列を作成してください。
• プロキシ経由で接続できますか？
  はい。接続文字列でプロキシ設定を構成できます。
• 接続をテストするにはどうすればよいですか？
  接続マネージャー UI で接続テストをクリックしてください。

パフォーマンスとトラブルシューティング

• クエリのパフォーマンスを改善するにはどうすればよいですか？
  フィルターの適用、行数の制限、サーバー側のページングプロパティの活用をお試しください。
• ログを有効にするにはどうすればよいですか？
  接続マネージャーに以下を追加してください：
  • Logfile: /path/to/logfile.log
  • Verbosity: 3

  トラブルシューティングの際は、[email protected] にご連絡の上、ログファイルを安全にアップロードしてください。

  この FAQ で解決しない場合は、[email protected] までお問い合わせください。