WCF アプリケーションで Jira Service Management のデータ の OData サービスを公開

Jerod Johnson
Jerod Johnson
Senior Technology Evangelist
この記事では、WCF サービスアプリケーションを開発してJira Service Management のデータの OData フィードを生成する方法を解説します。

CData ADO.NET Provider for Jira Service Management を使用すると、Windows Communication Foundation（WCF）フレームワークを活用してサービス指向アプリケーションを素早く開発し、Jira Service Management のデータを OData コンシューマーに提供できます。この記事では、接続用の Entity Data Model を作成し、WCF Data Service を構成して OData サービスを公開する方法を解説します。公開したフィードは、Power Pivot や CData ADO.NET Provider for OData を使用するアプリケーションなど、さまざまな OData クライアントから利用できます。

OData サービスの作成

以下の手順で、OData 経由でJira Service Management のデータへの接続を提供する WCF サービスアプリケーションを作成します。

  1. Visual Studio を開き、新しいプロジェクトを作成します。WCF Service Application テンプレートを選択します。
  2. 自動生成された IService.cs と Service1.svc を削除します。
  3. Entity Framework 6 をインストールします：

    Visual Studio のパッケージマネージャーコンソールを使用して、最新バージョンの Entity Framework をインストールします。以下のコマンドを実行すると、Entity Framework が自動的にダウンロード・インストールされます。 

    Install-Package EntityFramework
  4. Entity Framework プロバイダーを登録します：
    1. App.config または Web.config ファイルの "providers" セクションに、以下のプロバイダーエントリを追加します。Entity Framework のインストールが成功していれば、このセクションはすでに存在しているはずです。 
      <configuration>
...
<entityFramework>
  <providers>
    ...
    <provider invariantName="System.Data.CData.JiraServiceDesk" type="System.Data.CData.JiraServiceDesk.JiraServiceDeskProviderServices, System.Data.CData.JiraServiceDesk.Entities.EF6" />
  </providers>
</entityFramework>
</configuration>
    2. インストールディレクトリの lib/4.0 にある System.Data.CData.JiraServiceDesk.Entities.dll への参照を追加します。
    3. プロジェクトをビルドして、EF6 のセットアップを完了します。
  5. Project -> Add New Item -> ADO.NET Entity Data Model をクリックします。
  6. 表示される Entity Data Model ウィザードで、'EF Designer from Database' オプションを選択します。
  7. Choose Your Connection ダイアログが表示されたら、New Connection をクリックします。

  8. Connection properties ダイアログで、CData Jira Service Management Data Source を選択し、必要な認証情報を入力します。

    一般的な接続文字列は以下のとおりです：

    ApiKey=myApiKey;User=MyUser;

    Jira Service Management 接続プロパティの取得・設定方法

    任意のJira Service Management Cloud またはJira Service Management Server インスタンスへの接続を確立できます。接続するにはURL プロパティを設定します。

    • URL（例：https://yoursitename.atlassian.net）

    カスタムフィールドへのアクセス

    デフォルトでは、CData 製品はシステムフィールドのみを表示します。Issues のカスタムフィールドにアクセスするには、IncludeCustomFields を設定します。

    Jira Service Management への認証

    ベーシック認証

    ローカルサーバーアカウントで認証するためには、次の接続プロパティを指定します。

    • AuthScheme：Basic に設定。
    • User：認証ユーザーのユーザー名に設定。
    • Password：認証ユーザーのパスワードに設定。

    API トークン

    Cloud アカウントに接続するには、APIToken を取得する必要があります。API トークンを生成するには、Atlassian アカウントにログインして「API トークン」 -> 「API トークンの作成」をクリックします。生成されたトークンが表示されます。

    データに接続するには以下を設定します。

    • AuthScheme：APIToken に設定。
    • User：認証ユーザーのユーザー名に設定。
    • APIToken：作成したAPI トークンに設定。

    ちなみに、Cloud アカウントへの接続でパスワード認証を使うことも可能ですが、非推奨となっています。

    OAuth 2.0

    Jira Service Management のOAuth 2.0 サポート（3LO）を活用して、ログインクレデンシャルなしでデータに接続することもできます。

    この場合、AuthSchemeをすべてのOAuth フローでOAuth に設定する必要があります。また、すべてのシナリオでカスタムOAuth アプリケーションを作成して構成する必要があります。詳しくは、ヘルプドキュメントの「OAuth」セクションを参照してください。

  9. OData クライアントからアクセスさせたい Jira Service Management のテーブルとビューを選択します。
  10. Project -> Add New Item -> WCF Data Service をクリックします。

  11. データソースクラスを指定し、新しい WCF Data Service へのアクセスを構成します。以下の例では、エンティティの Access Rule が All に設定されています。これは、すべてのユーザーがデータの読み取りと変更を行えることを意味します。

      
using System;
using System.Collections.Generic;
using System.Data.Services;
using System.Data.Services.Common;
using System.Linq;
using System.ServiceModel.Web;
using System.Web;

namespace JiraServiceDeskService{
  public class JiraServiceDeskDataService : DataService<JiraServiceDeskEntities> {
    public static void InitializeService(DataServiceConfiguration config) {
      config.SetEntitySetAccessRule("*", EntitySetRights.All);
      config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V3;
    }
  }
}
  12. プロジェクトを実行します。これで、OData 対応アプリケーションから Salesforce データにアクセスし、変更を反映できるようになります。ブラウザでフィードにアクセスできます。フィードは次のように表示されます：

Power Pivot から OData サービスを利用する

これで、任意の OData クライアント（例：Excel Power Pivot）からサービスを利用できます。

  1. Excel を開き、Power Pivot Window ボタンをクリックします。
  2. 新しいポップアップが表示されます。From Data Feeds オプションを選択します。
  3. 表示される Table Import Wizard で、OData URL を入力します（例：http://localhost:12449/JiraServiceDeskDataService.svc/）。
  4. OData サービスへの接続後、ウィンドウ下部の Next ボタンをクリックします。
  5. ウィザードの次のウィンドウに、利用可能なテーブルの一覧が表示されます。インポートするテーブルを選択し、Finish をクリックします。
  6. Close をクリックして、Power Pivot にデータをインポートします。

はじめる準備はできましたか？

Jira Service Management Data Provider の無料トライアルをダウンロードしてお試しください：

 ダウンロード

詳細：

Jira Service Management Icon Jira Service Management ADO.NET Provider お問い合わせ

Jira Service Desk データに連携する.NET アプリケーションを素早く、簡単に開発できる便利なドライバー。

この記事の内容

関連記事