製品をチェック

Zendesk Driver の30日間無償トライアルをダウンロード

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

製品の詳細

Zendesk アイコン Zendesk JDBC Driver 相談したい

簡単にJava アプリケーションからZendesk のTickets、Groups、Users、Schedules への連携を実装。

Java のZendesk のデータエンティティを使用したObject-Relational Mapping (ORM)

Object-relational mapping (ORM) 技術により、リレーショナルデータソースの操作が容易になり、論理的なビジネスモデルと物理的なストレージモデルを橋渡しすることができます。このチュートリアルに従って、Zendesk への接続をJava ベースのORM フレームワークであるHibernate に連携します。

加藤龍彦
デジタルマーケティング

最終更新日:2022-04-25
zendesk ロゴ

CData

jdbc ロゴ画像
Hibernate ロゴ

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

Hibernate を使用することで、オブジェクト指向のドメインモデルを従来のリレーショナルデータベースにマッピングすることができます。以下のチュートリアルでは、CData JDBC Driver for Zendesk を使用し、Hibernate でZendesk リポジトリのORM を生成する方法を説明します。

この記事を通してEclipse がIDE として選択されていますが、CData JDBC Driver for Zendesk はJava Runtime Environment をサポートするすべての 製品で機能します。Knowledge Base には、IntelliJ IDEA やNetBeans からZendesk に接続するためのチュートリアルがあります。

Hibernate をインストール

以下のステップに従って、Eclipse にHibernate プラグインをインストールします。

  1. Eclipse で、[Help]->[Install New Software]と進みます。
  2. Work With ボックスに[http://download.jboss.org/jbosstools/neon/stable/updates/] と入力します。
  3. フィルタボックスに、[Hibernate]と入力します。
  4. [Hibernate Tools]を選択します。
Installing the Hibernate Framework in Eclipse.

新しいプロジェクトを開始

以下のステップに従って、新しいプロジェクトにドライバーJARs を追加します。

  1. 新しいプロジェクトを作成します。プロジェクトタイプとして[Java Project]を選択し、[Next]をクリックします。プロジェクト名を入力し、[Finish]をクリックします。
  2. [project]を右クリックし、[Properties]を選択します。[Java Build Path]をクリックし、[Libraries]タブを開きます。
  3. [Add External JARs]をクリックし、インストールディレクトリのlib サブフォルダにあるcdata.jdbc.zendesk.jar ライブラリを追加します。

Hibernate 構成ファイルを追加

以下のステップに従って、Zendesk に接続プロパティを構成します。

  1. [new project]で右クリックし、[New]->[Hibernate]->[Hibernate Configuration File (cfg.xml)]と進みます。
  2. 親フォルダとして[src]を選択し、[Next]をクリックします。
  3. 以下の値をインプットします。

    • Hibernate version:5.2
    • Database dialect:Derby
    • Driver class: cdata.jdbc.zendesk.ZendeskDriver
    • Connection URL:jdbc:zendesk: で始まり、セミコロンで区切られた接続プロパティのリストが続くJDBC URL

      Connecting to Zendesk

      接続するには、URL を設定して認証を提供します。URL は、Zendesk Support のURL:https://{subdomain}.zendesk.com です。

      Zendesk への接続

      Zendesk は、Basic 認証またはOAuth 2 認証標準を利用しています。

      ベーシック認証

      ベーシック認証では、E メールアドレスとパスワード、もしくは、E メールアドレスとAPI token で接続します。User をE メールアドレスに設定し、次の方法でPassword とAPI Token を提供します。

      • Admin、Channels、API でZendesk Support Admin からパスワードを有効化します。
      • Zendesk Support Admin からAdmin->Channels->API と操作し、API token を管理します。同時に複数のトークンを有効化させることが可能です。

      OAuth 認証

      詳細はヘルプドキュメントを参照してください。

      ビルトイン接続文字列デザイナ

      JDBC URL の構成については、Zendesk JDBC Driver に組み込まれている接続文字列デザイナを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。

      java -jar cdata.jdbc.zendesk.jar

      接続プロパティを入力し、接続文字列をクリップボードにコピーします。

      Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

      以下は一般的なJDBC URL です。

      jdbc:zendesk:URL=https://subdomain.zendesk.com;[email protected];Password=test123;InitiateOAuth=GETANDREFRESH

Hibernate のZendesk のデータへの接続

以下のステップに従って、前の手順で作成した構成を選択します。

  1. [Window]->[Open Perspective]->[Hibernate]と進み、Hibernate Configurations パースペクティブに切り替えます。
  2. [Hibernate Configurations]パネルで右クリックし、[Add Configuration]を選択します。
  3. Hibernate version を5.2に設定します。
  4. [Browse]ボタンをクリックし、[project]を選択します。
  5. [Configuration file]フィールドで、[Setup]->[Use Existing]とクリックし、(このデモのsrc フォルダー内にある)hibernate.cfg.xml ファイルを選択します。
  6. [Classpath tab]で、[User Entries]の下に何もなかった場合、[Add External JARS]をクリックしてドライバーjar をもう一度追加します。構成が完了したら、[OK]をクリックします。
  7. 新しく作成されたHibernate 構成ファイルのDatabase node を展開します。
Hibernate configuration properties.(NetSuite is shown.)

Zendesk のデータをリバースエンジニアリング

以下のステップに従って、reveng.xml 構成ファイルを生成します。アクセスするテーブルをオブジェクトとして指定します。

  1. Package Explorer に戻ります。
  2. プロジェクトを右クリックし、[New]->[Hibernate]->[Hibernate Reverse Engineering File (reveng.xml)]と進みます。[Next]をクリックします。
  3. 親フォルダとして[src]を選択し、[Next]をクリックします。
  4. [Console configuration drop-down]メニューで、上で作成した[Hibernate configuration]ファイルを選択し、[Refresh]をクリックします。
  5. ノードを展開し、リバースエンジニアリングするテーブルを選択します。完了したら、[Finish]をクリックします。
Tables to be reverse engineered.(NetSuite is shown.)

実行するためのHibernate を構成

以下のステップに従って、plain old Java objects (POJO) をZendesk テーブルに生成します。

  1. メニューバーから、[Run]->[Hibernate Code Generation]->[Hibernate Code Generation Configurations]と進みます。
  2. [Console configuration drop-down]メニューで、前のセクションで作成した[Hibernate configuration]ファイルを選択します。Output ディレクトリで[Browse]をクリックし、src を選択します。
  3. [JDBC Connection]チェックボックスから[Reverse Engineer]を有効にします。[Setup]ボタンをクリックし、[Use Existing]をクリックして(このデモのsrcフォルダ内にある) hibernate.reveng.xml ファイルの場所を選択します。
  4. [Exporters]タブで[Domain code (.java)]と[Hibernate XML Mappings (hbm.xml)]をチェックします。
  5. [Run]をクリックします。

POJO は、前のステップのリバースエンジニアリング設定に基づいて作成されます。

マッピングタグを挿入

生成したマッピングごとにhibernate.cfg.xml にマッピングタグを作成し、Hibernate がマッピングリソースを指定するようにする必要があります。hibernate.cfg.xml を開き、次のようにマッピングタグを挿入します。

cdata.zendesk.ZendeskDriver jdbc:zendesk:URL=https://subdomain.zendesk.com;[email protected];Password=test123;InitiateOAuth=GETANDREFRESH org.hibernate.dialect.SQLServerDialect

SQLを実行

前の手順で作成したエンティティを使用して、Zendesk の検索と変更を行うことができます。 import java.util.*; import org.hibernate.Session; import org.hibernate.cfg.Configuration; import org.hibernate.query.Query; public class App { public static void main(final String[] args) { Session session = new Configuration().configure().buildSessionFactory().openSession(); String SELECT = "FROM Tickets T WHERE Industry = :Industry"; Query q = session.createQuery(SELECT, Tickets.class); q.setParameter("Industry","Floppy Disks"); List<Tickets> resultList = (List<Tickets>) q.list(); for(Tickets s: resultList){ System.out.println(s.getId()); System.out.println(s.getSubject()); } } }

関連コンテンツ

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

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