製品をチェック

Jira Service Desk Data Provider の30日間無償トライアルをダウンロード

 30日間の無償トライアルへ

製品の詳細

Jira Service Desk アイコン Jira Service Desk ADO.NET Provider 相談したい

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

Entity Framework 6 からJira Service Desk データに連携

この記事は、Entity Framework のcode-first アプローチを使って、Jira Service Desk に接続する方法を説明します。Entity Framework 6 は.NET 4.5 以上で利用可能です。

加藤龍彦
ウェブデベロッパー

最終更新日:2022-04-04
jiraservicedesk ロゴ

CData

ado ロゴ画像
Entity Framework ロゴ

こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでJira Service Desk にアクセスします。

  1. Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
  2. Visual Studio の [パッケージ マネージャー コンソール]から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
  3. プロジェクトのApp.config ファイルを修正して、Jira Service Desk Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。

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

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

    • URL(例:https://yoursitename.atlassian.net)

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

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

    Jira Service Management への認証

    ベーシック認証

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

    • AuthSchemeBasic に設定。
    • User:認証ユーザーのユーザー名に設定。
    • Password:認証ユーザーのパスワードに設定。

    API トークン

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

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

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

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

    OAuth 2.0

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

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

    <configuration> ... <connectionStrings> <add name="JiraServiceDeskContext" connectionString="Offline=False;ApiKey=myApiKey;User=MyUser;" providerName="System.Data.CData.JiraServiceDesk" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.JiraServiceDesk" type="System.Data.CData.JiraServiceDesk.JiraServiceDeskProviderServices, System.Data.CData.JiraServiceDesk.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>

  4. インストールディレクトリの[lib] > 4.0 サブフォルダにあるSystem.Data.CData.JiraServiceDesk.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
  5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
  6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はJiraServiceDeskContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます:
    • PluralizingTableNameConvention をModelBuilder Conventions から削除。
    • MigrationHistory テーブルへのリクエストを削除。
    using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class JiraServiceDeskContext :DbContext { public JiraServiceDeskContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<JiraServiceDeskContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
  7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているJira Service Desk のエンティティ、例えばRequests にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。 using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class Requests { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String RequestId { get; set; } } public class RequestsMap :EntityTypeConfiguration<Requests> { public RequestsMap() { this.ToTable("Requests"); this.HasKey(Requests => Requests.Id); this.Property(Requests => Requests.RequestId); } }
  8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します: public DbSet<Requests> Requests { set; get; }
  9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例: JiraServiceDeskContext context = new JiraServiceDeskContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Requests select line;

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。