ColdFusion から Freshservice のデータにクエリ

CData JDBC ドライバーを使用すると、ColdFusion の高速開発ツールを使って Freshservice のデータ にシームレスに接続できます。本記事では、ColdFusion から Freshservice のデータ に接続し、Freshservice テーブルにクエリを実行する方法を説明します。

ColdFusion で Freshservice 用JDBC データソースを作成

JDBC データソースを設定すると、cfquery タグや executeQuery などのCFScript から標準SQL を実行できるようになります。

1. インストールディレクトリから、ドライバーのJAR ファイルと.lic ファイルをColdFusion のクラスパスにコピーします。例えば、C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib にコピーします。または、ColdFusion Administrator の［Java と JVM］ページで、［ColdFusion Class Path］ボックスにファイルへのパスを入力します。

   ドライバーのJAR ファイルとライセンスファイルは、インストールディレクトリの lib サブフォルダにあります。

   この手順の後、サーバーを再起動してください。

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

   ColdFusion Administrator 画面で、［データ＆サービス］ノードを展開し、［データソース］をクリックします。［新しいデータソースの追加］セクションで、データソースの名前を入力し、［ドライバー］メニューから［Other］を選択します。

   

3. ドライバーのプロパティを設定します。

   • JDBC URL：JDBC URL に接続プロパティを入力します。JDBC URL は jdbc:api: で始まり、その後にセミコロン区切りで name=value 形式の接続プロパティを指定します。

     まず、Profile 接続プロパティをディスク上の Freshservice プロファイルの場所に設定します（例：C:\profiles\Freshservice.apip）。次に、ProfileSettings 接続プロパティを Freshservice の接続文字列に設定します（以下を参照）。

     Freshservice API プロファイル設定

     Freshservice 画面右上の Profile Settings から API キーを取得します。Domain はアカウント URL のサブドメインです。

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

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

     java -jar cdata.jdbc.api.jar
     

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

     

     一般的なJDBC URL は次のようになります。

     jdbc:api:Profile=C:\profiles\Freshservice.apip;ProfileSettings='APIKey=your_api_key;Domain=your_subdomain';

   • Driver Class：ドライバークラスを入力します。ドライバークラスは cdata.jdbc.api.APIDriver です。
   • Driver Name：ドライバーのユーザー定義名を入力します。
   • Username：認証に使用するユーザー名を入力します。
   • Password：認証に使用するパスワードを入力します。

これで、［操作］列で CData Freshservice データソースを有効にして接続をテストできます。ステータスがOK と表示されたら、Freshservice データソースの準備完了です。

クエリの実行

cfquery タグで Freshservice にSQL ステートメントを送信できます。cfqueryparam タグを使用して、パラメータ化クエリを作成し、クエリ文字列によるSQL インジェクションを防止します。

注意：cfquery とcfscript を使用するには、.cfm ファイルを作成します。その.cfm ファイル内に、クエリを実行するコードを記述します（下記参照）。ファイルをWeb サーバーのルートディレクトリ（Adobe ColdFusion の場合はwwwroot など）に直接配置します。変更を反映するには、ファイル配置後にサービスを再起動してください。

<cfquery name="APIQuery" dataSource="CDataAPI">
  SELECT * FROM AgentGroups WHERE Name = <cfqueryparam value="#Name#" cfsqltype="cf_sql_varchar">
</cfquery>
<cfdump var="#APIQuery#">

CFScript で記述すると以下のようになります。

<cfscript>
result = queryExecute(
  "SELECT * FROM AgentGroups WHERE Name = ?",
  [
    { value="Support Team", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataAPI" }
);

writeDump( var= result );
</cfscript>

その後、以下のように.cfm ファイルにリクエストを送信できます。

http://MyServer:8500/query.cfm?Name=Support Team