LINQPad でHalo Service Desk のデータを操作する方法
CData ADO.NET Provider for API は、LINQ やEntity Framework などの標準のADO.NET インターフェースを使ってHalo Service Desk の操作を実現します。この記事では、LINQPad から接続してLINQ クエリを実行する方法を説明します。
必要なもの
本記事の手順を実行してLINQPad からHalo Service Desk に接続するには、以下の3つの製品が必要になります。
- Halo Service Desk の環境
- LINQPad
- CData ADO.NET Provider for API。右側のサイドバーから30日間無償トライアルがダウンロードできます
データモデルの作成
CData ADO.NET Provider for API およびLINQPad をダウンロード・インストールしたら、Visual Studio で新しいクラスライブラリプロジェクトを作成します。
ADO.NET Provider の利用に必要となるEF 6を設定する方法については、ヘルプドキュメントを参照してください。
プロジェクトを右クリックし、［追加］→［新しい項目］→［ADO.NET Entity Data Model］をクリックします。ダイアログが表示されたら、データベースから［Code First］を選択します。 ［New Connection］をクリックして、表示されたウィザードで接続文字列オプションを指定します。
- AuthScheme：APIKey に設定します。
- APIKey：HaloServiceDesk アカウントの API キーに設定します。
- Domain：HaloServiceDesk インスタンスのホスト名に設定します（例：yourcompany.haloservicedesk.com）。
希望するテーブルおよびビューを選択して［Finish］をクリックし、データモデルを作成します。
- プロジェクトをビルドします。生成されたファイルを使ってLINQPad でHalo Service Desk 接続を作成できます。
まず、Profile 接続プロパティをディスク上の HaloServiceDesk プロファイルの場所に設定します（例：C:\profiles\HaloServiceDesk.apip）。次に、ProfileSettings 接続プロパティを HaloServiceDesk の接続文字列に設定します（以下を参照）。
HaloServiceDesk API プロファイル設定
HaloServiceDesk では API キー認証を使用します。API キーは、HaloServiceDesk の「Administration」>「Integrations」>「Halo API」で確認・作成できます。
接続するには、以下の接続プロパティを設定します。
一般的な接続文字列は次のとおりです。
Profile=C:\profiles\HaloServiceDesk.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;Domain=yourcompany.haloservicedesk.com';LINQPad でHalo Service Desk のデータに接続
必要な接続プロパティを取得してデータモデルアセンブリを作成したら、以下の手順に従ってLINQPad でデータモデルを使いはじめましょう。
LINQPad を開き［接続の追加］をクリックします。
［Use a typed data context from your own assembly］オプションを選択します。
［Entity Framework DbContext］を選択します。
［Path to Custom Assembly］ボックスの横にある［参照］をクリックして、プロジェクトフォルダを参照します。bin フォルダの下の.dll または.exe を参照します。
- DbContext の名前を選択します。
- 接続文字列をApp.Config に保存した場合は、App.Config へのパスを指定します。
これでLINQPad 経由でHalo Service Desk にクエリできます。サポートされたLINQ クエリの例は、ヘルプドキュメントの「LINQ およびEntity Framework」を参照してください。
