ColdFusion にリアルタイムZendesk のデータをインポートしてアプリケーションを構築

CData JDBC ドライバを使ってColdFusion にZendesk のデータをインポートして使用します。

古川えりか
コンテンツスペシャリスト

最終更新日:2023-02-02

この記事で実現できるZendesk 連携のシナリオ

こんにちは!ドライバー周りのヘルプドキュメントを担当している古川です。

Adobe ColdFusion は、Web アプリケーションおよびモバイルアプリケーション開発プラットフォームです。独自のスクリプト言語であるColdFusion Markup Language(CFML)を使用し、データドリブンなWeb サイトを作成したり、REST などのリモートサービスを生成したりすることができます。

ColdFusion とCData JDBC Driver for Zendesk を組み合わせると、ColdFusion のWeb アプリケーションやモバイルアプリケーションを、運用中のZendesk のデータにリンクできます。 これにより、アプリケーションの堅牢性と完成度を高めることができます。この記事では、JDBC ドライバーを使ってColdFusion マークアップファイルからZendesk のデータを入力したテーブルを作成する方法について詳しく説明します。

最適化されたデータ処理が組み込まれたCData JDBC ドライバは、リアルタイムZendesk のデータを扱う上で高いパフォーマンスを提供します。 Zendesk にSQL クエリを発行すると、CData ドライバーはフィルタや集計などのZendesk 側でサポートしているSQL 操作をZendesk に直接渡し、サポートされていない操作(主にSQL 関数とJOIN 操作)は組み込みSQL エンジンを利用してクライアント側で処理します。 組み込みの動的メタデータクエリを使用すると、ネイティブのデータ型を使ってZendesk のデータを操作および分析できます。

Zendesk への接続を設定する

Coldfusion とZendesk の接続を確立するには、JDBC 接続文字列が必要です。

Zendesk 接続プロパティの取得・設定方法

Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL(Zendesk Support URL)を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。

また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。

Zendesk への認証

Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証(レガシー)です。

API トークン認証

API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthSchemeAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。

  1. Token アクセスを有効にします。
  2. Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。
最後に、APIToken をアクティブなAPI トークンに設定します。

その他の認証方法についてはヘルプドキュメントを参照してください。

組み込みの接続文字列デザイナー

JDBC URL の作成の補助として、Zendesk JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

java -jar cdata.jdbc.zendesk.jar 組み込みの接続文字列デザイナーを使ってJDBC URL を生成(zendesk の場合)

データソースを追加してテーブルを作成する

接続を設定したのち、次の手順に従ってはじめにCData JDBC ドライバをColdFusion のlib ディレクトリに追加し、続けて新しいデータソースを追加、接続をテスト、ColdFusion マークアップファイルを作成し、最後にZendesk のデータとリアルタイム接続してColdFusion Markup Language(CFML)で記述されるテーブルに表示します。

  1. JDBC Driver for Zendesk およびlic ファイルを"C:\Program Files\CData\CData JDBC Driver for Zendesk\lib" から"C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib"にコピーします。 cdata.jdbc.zendesk.jar cdata.jdbc.zendesk.lic

    Note:.lic ファイルをjar ファイルとともにコピーしないと、有効なライセンスがインストールされていないことを示すライセンスエラーが表示されます。 これは評価版、製品版ともに同様です。

  2. ColdFusion Administrator インターフェースで「データとサービス」を選択します。 データとサービスを選択
  3. 「新規のデータソースの追加」を行います。データソース名は、ColdFusion の変数命名規則に従っていればどのような名前でもかまいません。 JDBC ドライバーの場合は、「その他」を選択して「追加」ボタンをクリックします。 データソース名を追加
  4. 次に、ドライバーのプロパティを入力します。
    • 「JDBC URL」は、次のような形式である必要があります: jdbc:zendesk:|connectionString|
    • 典型的な接続文字列は次のようになります:

      jdbc:zendesk:URL=https://subdomain.zendesk.com;[email protected];Password=test123;InitiateOAuth=GETANDREFRESH
    • 「ドライバクラス」は次のようになります:cdata.jdbc.zendesk.ZendeskDriver
    • 「ドライバ名」の入力は任意で、これは単にColdFusion Administrator コンソールでデータソースを認識するために使われます。
    ドライバーのプロパティを入力
  5. ここで、作成したCDataZendeskJDBC データソースの左側にあるチェックマークをクリックして、接続をテストしてください。 データソースのステータスが「OK」になると、使用可能な状態です。 接続をテスト
  6. 次に、ColdFusion Markup ファイル(.cfm)を新規作成し、ColdFusion のwwwroot ディレクトリ("C:\ColdFusion2021\cfusion\wwwroot")に配置します。

    次のコードは、データソースにクエリを実行します。

                
            <cfquery name="ZendeskQuery" dataSource="CDataZendeskJDBC">
              SELECT * FROM Tickets
            </cfquery>
        
    CFTable を使用すると、HTML で素早くテーブルを出力できます。
                
              <cftable
              query = "ZendeskQuery"
              border = "1"
              colHeaders
              colSpacing = "2"
              headerLines = "2"
              HTMLTable
              maxRows = "500"
              startRow = "1">
    
              <cfcol header="<b>Id</b>" align="Left" width=2 text="Id"/>
    
              <cfcol header="<b>Subject</b>" align="Left" width=15 text="Subject"/>
    
              ...
    
            </cftable>
        
    HTML 部分を含むコード全体を以下に掲載します。
                
            <html>
            <head><title>CData Software | Zendesk Tickets Table Demo </title></head>
            <body>
            <cfoutput>#ucase("Zendesk Tickets Table Demo")#</cfoutput>
            <cfquery name="ZendeskQuery" dataSource="CDataZendeskJDBC">
    
              SELECT * FROM Tickets
    
            </cfquery>
            <cftable
              query = "ZendeskQuery"
              border = "1"
              colHeaders
              colSpacing = "2"
              headerLines = "2"
              HTMLTable
              maxRows = "500"
              startRow = "1">
              <cfcol header="<b>Id</b>" align="Left" width=2 text="Id"/>
    
              <cfcol header="<b>Subject</b>" align="Left" width=15 text="Subject"/>
    
              ...
    
            </cftable>
            </body>
    
            </html>
        
  7. 最後に、デフォルトのポート8500のブラウザでコードをローカルに実行します。これでZendesk のデータが入力されたテーブルが作成されました! コードを実行

なお、CData JDBC ドライバはcfqueryparam 要素を使用したパラメータ化クエリもサポートしています。 次に例を示します。 SELECT * FROM Account WHERE name =

今日からはじめましょう

CData JDBC Driver for Zendesk の 30日間無償トライアル をダウンロードして、Adobe ColdFusion でZendesk と連携したアプリケーションの作成をはじめましょう!ご不明な点があれば、サポートチームにお問い合わせください。

関連コンテンツ

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

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