ColdFusion でZendesk のデータに連携する方法

ColdFusion の標準的なデータアクセスコードでZendesk にデータ連携。

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

最終更新日:2021-02-06

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



CData JDBC Driver for Zendesk は、ColdFusion のrapid development tools を使ってZendesk への接続をシームレスに統合します。この記事では、ColdFusion でZendesk に連携しZendesk テーブルをクエリする方法を説明します。

ColdFusion にZendesk のJDBC データソースを作成

下記の手順に従ってZendesk のデータソースを作成し、ColdFusion アプリケーションへの連携を可能にします。

  1. ドライバーのJAR および.lic ファイルを、インストールディレクトリから C:\ColdFusion10\cfusion\wwwroot\WEB-INF\lib にコピーします。

    ドライバーのJAR およびlicense はインストールディレクトリの[lib]サブフォルダに配置されています。

  2. ドライバーをデータソースとして追加:

    ColdFusion Administrator インターフェースで[Data & Services]ノードを展開し、[Data Sources]>[Add New Data Source]をクリックします。ダイアログが表示されたら、以下のプロパティを入力します。

    • Data Source Name:データソースの名前を入力。名前はColdFusion 変数命名規則に一致する必要があります。
    • Driver:[Other]を選択。
    Adding a JDBC data source to ColdFusion. (Salesforce is shown.)
  3. JDBC Driver のプロパティ設定:

    • JDBC URL:JDBC URL に接続プロパティを入力。JDBC のURL は以下で始まり jdbc:zendesk: 次に、セミコロン区切りでname=value ペアの接続プロパティを入力します。以下は一般的なJDBC URL です:

      jdbc:zendesk:URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;

      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 トークンに設定します。

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

    • Driver Class:ドライバーのクラスを入力。ドライバークラスは、以下のとおりです。cdata.jdbc.zendesk.ZendeskDriver
    • Driver Name:ユーザー定義のドライバー名を入力。ドライバー名はColdFusion Administrator コンソールでデータソースを認識するために使われます。
    • Username:認証するユーザーネームを入力。
    • Password:認証するパスワードを入力。
Required connection properties specified in the JDBC URL. (Salesforce is shown.)

[Actions] カラムのCData Zendesk のデータソースを有効にして、接続をテストできます。ステータスがOK になったら、Zendesk のデータソースを使うことができます。

Test the connection in the Actions column. (Salesforce is shown.)

クエリを実行

下記の手順に従って、Zendesk の基準に合ったレコードをクエリし、結果をHTML テーブルに出力する簡単なアプリケーションを作成します。

  1. 新規ColdFusion markup ファイルでクエリを定義:C:\ColdFusion10\cfusion\wwwroot directory for ColdFusion の.cfm ファイルに次のコードを入力:

    <cfquery name="ZendeskQuery" dataSource="CDataZendesk"> SELECT * FROM Tickets </cfquery>

    Note:CData JDBC Drivers は、cfqueryparam エレメントを使ってパラメータ化されたクエリもサポートします。例:

    <cfquery name="ZendeskQuery" dataSource="CDataZendesk"> SELECT * FROM Tickets WHERE Industry = <cfqueryparam>Floppy Disks</cfqueryparam> </cfquery>
  2. 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> <cfcol header="<b>Subject</b>" align="Left" width=7 text="#Subject#"></cfcol> </cftable>
  3. コードを実行してグリッドを表示します。

    Query results in an HTML table. (Salesforce is shown.)

HTML 部分を含む以下のフルコードが利用できます。

<html> <head><title>Hello World</title></head> <body> <cfoutput>#ucase("hello world")#</cfoutput> <cfquery name="ZendeskQuery" dataSource="CDataZendesk"> 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> <cfcol header="<b>Subject</b>" align="Left" width=7 text="#Subject#"></cfcol> </cftable> </body> </html>

関連コンテンツ

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

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