CData ADO.NET Provider for SharePoint Excel Services はじめに:インストールから接続まで
このガイドでは、CData ADO.NET Provider for SharePoint Excel Services の使い方を詳しく解説します。プロバイダーのインストール、SharePoint Excel Services のデータ への接続設定、そして .NET アプリケーションで ADO.NET パターンを使用した簡単なコマンドの実行方法を学べます。
デスクトップアプリ、Web アプリ、バックグラウンドサービスなど、どのような用途でも、このプロバイダーを使えば API の詳細を手動で管理することなく、ライブの SharePoint Excel Services のデータ に安全かつ高パフォーマンスで接続できます。
インストールとライセンス認証
システム要件
- 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] までお問い合わせください。
接続設定
インストールが完了したら、次のステップとして SharePoint Excel Services への接続を設定します。接続は、.NET アプリケーションのコードまたは構成ファイルで ADO.NET 接続文字列を使用して作成します。
接続マネージャーの作成
- Visual Studio を開きます。
- 表示メニューからサーバー エクスプローラーを選択します。
-
左サイドバーからデータベースへの接続をクリックします。
- 接続の追加ダイアログで、変更をクリックします。
-
CData SharePoint Excel Services のデータ source を選択し、OK をクリックします。
接続プロパティの設定
ワークブックへの接続
どちらのSharePoint エディションをお使いでも、File を Excel ワークブックに設定してください。このパスは以下のプロパティからの相対パスになります。
- Library:デフォルトではShared Documents ライブラリが使用されます。このプロパティを使って、組織内の別のドキュメントライブラリを指定してみてください。例えば、OneDrive for Business に接続する場合は、このプロパティを"Documents" に設定します。
- Folder:このプロパティを使って、ライブラリ内のサブフォルダへのパスを指定できます。パスはLibrary で指定されたライブラリ名に関連します。
テーブルとしてのスプレッドシートデータへの接続
CData 製品では、基底API で利用可能なオブジェクトに基づいて、使用可能なテーブルを検出していきます。
API では異なるAPI オブジェクトを表示します。スプレッドシートの構成とSharePoint のバージョンに基づいてAPI を選択しましょう。
- OData: OData API を使用すると、Excel で[挿入]->[テーブル]をクリックして作成されたExcel テーブルオブジェクト(範囲やスプレッドシートではありません)から定義されたテーブルにアクセスできます。OData API に接続する際、ワークブックにテーブルオブジェクトが定義されていない場合は、CData 製品がテーブルを返さないことがあります。テーブルとしてスプレッドシートまたは範囲に接続するには、UseRESTAPI をtrue に設定してください。
- REST: REST API を使用すると、Excel テーブルオブジェクト、範囲、およびスプレッドシートから定義されたテーブルへアクセスできます。これがデフォルトの API です。範囲およびスプレッドシートから多数の行をリクエストすることは REST API によって制限されており、CData 製品では返される行数をデフォルトで 100 に制限しています。また CData 製品では、デフォルトで1行目からカラム名を検出します。これを無効にするには、Header を設定してください。
DefineTables を追加設定すると、Excel の範囲の構文を使用して、範囲に基づいてテーブルを定義できます。大きすぎる範囲は、API によって制限されます。
SharePoint オンプレミスへの接続
URL をサーバー名もしくはIP アドレスに設定しましょう。さらに、SharePointVersion と認証値を設定します。
SharePoint OnPremises を認証するには、AuthScheme を認証タイプに設定し、必要に応じてUser と Password を設定してください。
Note:SharePoint On-Premises 2010 に接続する場合は、 UseRESTAPI をtrue に設定する必要があります。
- 接続テストをクリックします。
- 接続に成功すると、Visual Studio 内でデータを確認できます。
- テクニカルサポート: [email protected]
- コミュニティフォーラム: CData Community Site
- ヘルプドキュメント: ローカルにインストールされているほか、オンラインでも参照可能です
-
ADO.NET Provider のインストールには管理者権限が必要ですか?
はい、Visual Studio 全体で使用するコンポーネントをインストールするには管理者権限が必要です。 -
Azure Data Factory にデプロイする際に RTK は必要ですか?
はい。アプリケーションの接続文字列で RTK プロパティを設定してから公開してください。 -
複数の SharePoint Excel Services アカウントを使用できますか?
アカウントごとに個別の接続文字列を作成してください。 -
プロキシ経由で接続できますか?
はい。接続文字列でプロキシ設定を構成できます。 -
接続をテストするにはどうすればよいですか?
接続マネージャー UI で接続テストをクリックしてください。 -
クエリのパフォーマンスを改善するにはどうすればよいですか?
フィルターの適用、行数の制限、サーバー側のページングプロパティの活用をお試しください。 -
ログを有効にするにはどうすればよいですか?
接続マネージャーに以下を追加してください:- Logfile: /path/to/logfile.log
- Verbosity: 3
トラブルシューティングの際は、[email protected] にご連絡の上、ログファイルを安全にアップロードしてください。
この FAQ で解決しない場合は、[email protected] までお問い合わせください。
Windows(NTLM)
最も一般的な認証タイプです。CData 製品では NTLM をデフォルトとして使用するよう事前設定されています。Windows のUser と Password を設定して接続してください。
その他の認証方法については、ヘルプドキュメントの「はじめに」をご覧ください。
接続テスト
よくある接続の問題
認証エラー
解決策: SharePoint Excel Services の OAuth 設定、クライアント ID、シークレット、またはトークンの権限を確認してください。サポートが必要な場合は [email protected] までお問い合わせください。
サーバーに接続できない
解決策: ファイアウォール、プロキシ、VPN の設定を確認してください。必要なポート情報については [email protected] までお問い合わせください。
テーブルが見つからない
解決策: SharePoint Excel Services をクエリする際に、正しいスキーマまたはデータベースを選択しているか確認してください。
次のステップ
ADO.NET Provider のインストール、ライセンス認証、接続設定が完了しました。以下のシナリオを参考に、ADO.NET ツールをさらに活用してみてください:
| ADO.NET Provider | 記事タイトル |
|---|
サポート
ご不明な点がございましたら、お気軽にお問い合わせください: