CData ADO.NET Provider for SharePoint はじめに:インストールから接続まで
このガイドでは、CData ADO.NET Provider for SharePoint の使い方を詳しく解説します。プロバイダーのインストール、SharePoint のデータ への接続設定、そして .NET アプリケーションで ADO.NET パターンを使用した簡単なコマンドの実行方法を学べます。
デスクトップアプリ、Web アプリ、バックグラウンドサービスなど、どのような用途でも、このプロバイダーを使えば API の詳細を手動で管理することなく、ライブの SharePoint のデータ に安全かつ高パフォーマンスで接続できます。
SharePoint データ連携について
CData を使用すれば、SharePoint のライブデータへのアクセスと統合がこれまでになく簡単になります。お客様は CData の接続機能を以下の目的で利用しています:
- Windows SharePoint Services 3.0、Microsoft Office SharePoint Server 2007 以降、SharePoint Online を含む、幅広い SharePoint バージョンのデータにアクセスできます。
- 非表示カラムとルックアップカラムのサポートにより、SharePoint のすべてにアクセスできます。
- フォルダを再帰的にスキャンして、すべての SharePoint データのリレーショナルモデルを作成できます。
- SQL ストアドプロシージャを使用して、ドキュメントや添付ファイルをアップロード・ダウンロードできます。
多くのお客様は、SharePoint データをデータベースやデータウェアハウスに統合するために CData ソリューションを活用していますが、Power BI、Tableau、Excel などのお気に入りのデータツールと SharePoint データを統合しているお客様もいます。
お客様が CData の SharePoint ソリューションで問題を解決している方法については、ブログをご覧ください:Drivers in Focus: Collaboration Tools
はじめに
インストールとライセンス認証
システム要件
- 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] までお問い合わせください。
接続設定
インストールが完了したら、次のステップとして SharePoint への接続を設定します。接続は、.NET アプリケーションのコードまたは構成ファイルで ADO.NET 接続文字列を使用して作成します。
接続マネージャーの作成
- Visual Studio を開きます。
- 表示メニューからサーバー エクスプローラーを選択します。
-
左サイドバーからデータベースへの接続をクリックします。
- 接続の追加ダイアログで、変更をクリックします。
-
CData SharePoint のデータ source を選択し、OK をクリックします。
接続プロパティの設定
Microsoft SharePoint への接続
URL の設定:
Microsoft SharePoint では、2つの範囲でデータを操作できます。グローバルなMicrosoft SharePoint サイト全体を対象にするか、個々のサイトのみを対象にするかを選択できます。
グローバルなMicrosoft SharePoint サイトですべてのリストおよびドキュメントを操作したい場合は、URL 接続プロパティをサイトコレクションURL に設定しましょう。以下のような形式です。
https://teams.contoso.com
個々のサイトのリストおよびドキュメントのみを扱いたい場合は、URL 接続プロパティを個々のサイトURL に設定してください。以下のような形式です。
https://teams.contoso.com/TeamA
続いて、お使いの環境に適した認証プロパティを設定していきましょう。詳細な設定手順については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」をご参照ください。
Microsoft SharePoint Online
SharePointEdition を"SharePoint Online" に設定し、User およびPassword にはSharePoint へのログオンで使用するクレデンシャル(例:Microsoft Online Services アカウントのクレデンシャル)を設定します。
Microsoft SharePoint Online は様々なクラウドベースアーキテクチャをサポートしており、それぞれ異なる認証スキームが利用できます。
- Microsoft Entra ID(Azure AD)
- ADFS、Okta、OneLogin、またはPingFederate SSO ID プロバイダーを介したシングルサインオン(SSO)
- Azure MSI
- Azure パスワード
- OAuthJWT
- SharePointOAuth
Microsoft SharePoint オンプレミス
Microsoft SharePoint オンプレミスでは、多くのオンプレミス環境に対応した認証方式をサポートしています。
- Windows(NTLM)
- Kerberos
- ADFS
- 匿名アクセス
まずSharePointEdition を"SharePoint On-Premises" に設定しましょう。
Windows(NTLM)認証
これは最も一般的な認証方式です。そのため、CData 製品ではNTLM をデフォルトとして使用するよう事前設定されています。Windows のUser およびPassword を設定するだけで接続できます。
接続テスト
- 接続テストをクリックします。
- 接続に成功すると、Visual Studio 内でデータを確認できます。
よくある接続の問題
認証エラー
解決策: SharePoint の OAuth 設定、クライアント ID、シークレット、またはトークンの権限を確認してください。サポートが必要な場合は [email protected] までお問い合わせください。
サーバーに接続できない
解決策: ファイアウォール、プロキシ、VPN の設定を確認してください。必要なポート情報については [email protected] までお問い合わせください。
テーブルが見つからない
解決策: SharePoint をクエリする際に、正しいスキーマまたはデータベースを選択しているか確認してください。
次のステップ
ADO.NET Provider のインストール、ライセンス認証、接続設定が完了しました。以下のシナリオを参考に、ADO.NET ツールをさらに活用してみてください:
| ADO.NET Provider | 記事タイトル |
|---|---|
| LINQPad | LINQPad でSharePoint のデータを操作する方法 |
| Microsoft SSAS | SSAS でSharePoint のデータに連携するOLAP Cube を作成 |
| SSRS Server | SSRS レポートサーバーにADO.NET Provider を配置してSharePoint 連携 |
| TIBCO Spotfire | ADO.NET 経由でTIBCO Spotfire でSharePoint のデータに連携してをビジュアライズ |
| .NET Charts | Visual Studio でチャートコントロールと SharePoint をデータバインド |
| Blazor | Blazor でSharePoint のデータにリアルタイムで連携するアプリを構築 |
| DevExpress | SharePoint のデータをDevExpress Data Grid にデータバインドする。 |
| EF - Code First | Entity Framework 6 からSharePoint のデータに連携 |
| EF - LINQ | LINQ を使ってSharePoint のデータに連携する方法 |
| EF - MVC | 【徹底解説】SharePoint とのデータ連携ができるMVC アプリケーションの作り方 |
| Flexsche | 生産スケジューラFLEXSCHE へSharePoint からデータを取り込む |
| Infragistics DataGrid | Infragistics XamDataGrid を使用してSharePoint のダイナミックグリッドを作成 |
| OD Server | WCF アプリケーションで SharePoint データのOData サービスを公開 |
| Xamarin DataGrid | Infragistics WPF XamDataGrid と SharePoint をデータバインド |
| ADO.NET Setup | CData ADO.NET Provider for SharePoint はじめに:インストールから接続まで |
| SSIS Task | SharePoint をSSIS 経由でSQL サーバーにバックアップする |
サポート
ご不明な点がございましたら、お気軽にお問い合わせください:
- テクニカルサポート: [email protected]
- コミュニティフォーラム: CData Community Site
- ヘルプドキュメント: ローカルにインストールされているほか、オンラインでも参照可能です
FAQ
インストールとライセンス
-
ADO.NET Provider のインストールには管理者権限が必要ですか?
はい、Visual Studio 全体で使用するコンポーネントをインストールするには管理者権限が必要です。 -
Azure Data Factory にデプロイする際に RTK は必要ですか?
はい。アプリケーションの接続文字列で RTK プロパティを設定してから公開してください。
接続
-
複数の SharePoint アカウントを使用できますか?
アカウントごとに個別の接続文字列を作成してください。 -
プロキシ経由で接続できますか?
はい。接続文字列でプロキシ設定を構成できます。 -
接続をテストするにはどうすればよいですか?
接続マネージャー UI で接続テストをクリックしてください。
パフォーマンスとトラブルシューティング
-
クエリのパフォーマンスを改善するにはどうすればよいですか?
フィルターの適用、行数の制限、サーバー側のページングプロパティの活用をお試しください。 -
ログを有効にするにはどうすればよいですか?
接続マネージャーに以下を追加してください:- Logfile: /path/to/logfile.log
- Verbosity: 3
トラブルシューティングの際は、[email protected] にご連絡の上、ログファイルを安全にアップロードしてください。
この FAQ で解決しない場合は、[email protected] までお問い合わせください。