ColdFusion から ServiceDesk Plus のデータにクエリ

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
ColdFusion の標準データアクセスコードで ServiceDesk Plus のデータ に接続。



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

ColdFusion で ServiceDesk Plus 用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 形式の接続プロパティを指定します。

      OAuth 認証の設定

      ServiceDeskPlus は、安全な認証のために Zoho OAuth 2.0 を使用します。OAuth アクセスをセットアップするには、以下のステップで進めます：

      1. https://api-console.zoho.com の Zoho Developer Console でアプリケーションを登録します
      2. アプリケーション構成に合わせてリダイレクト URI を設定します
      3. アプリケーション設定から Client ID と Client Secret を控えておきます

      以下の接続プロパティを設定して接続を確立してください：

      • AuthScheme：OAuth に設定します。
      • OAuthClientId：Zoho アプリケーションの Client ID に設定します。
      • OAuthClientSecret：Zoho アプリケーションの Client Secret に設定します。
      • Scope：必要な ServiceDeskPlus の権限に設定します（デフォルトでは requests、problems、assets、projects への読み取りアクセスが含まれます）。
      • Domain：ServiceDeskPlus のドメインに設定します。
      • Portal：ServiceDeskPlus のポータルに設定します。

      接続文字列の例

      Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;

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

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

      java -jar cdata.jdbc.api.jar

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

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

      jdbc:api:Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;
    • Driver Class：ドライバークラスを入力します。ドライバークラスは cdata.jdbc.api.APIDriver です。
    • Driver Name：ドライバーのユーザー定義名を入力します。
    • Username：認証に使用するユーザー名を入力します。
    • Password：認証に使用するパスワードを入力します。

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

クエリの実行

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

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


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

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


<cfscript>
result = queryExecute(
  "SELECT * FROM AnnouncementComments WHERE AnnouncementId = ?",
  [
    { value="12345", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataAPI" }
);

writeDump( var= result );
</cfscript>

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

http://MyServer:8500/query.cfm?AnnouncementId=12345

はじめる準備はできましたか？

API Driver で ServiceDesk Plus のライブデータに接続

ServiceDesk Plus に接続

この記事の内容

関連記事