ColdFusion で JDBC 経由でリアルタイム ServiceDesk Plus のデータをインポートしてアプリケーションを構築

Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
CData JDBC Driver を使用して、ColdFusion で ServiceDesk Plus のデータをインポートして活用する方法を説明します。

Adobe ColdFusion は、Web およびモバイルアプリケーションの開発プラットフォームです。独自のスクリプト言語である ColdFusion Markup Language（CFML）を使用して、データ駆動型のWeb サイトを構築したり、REST などのリモートサービスを生成したりできます。

ColdFusion と CData API Driver for JDBCを組み合わせると、ColdFusion の Web およびモバイルアプリケーションを ServiceDesk Plus の運用データに接続できます。 これにより、アプリケーションをより堅牢で完成度の高いものにできます。この記事では、 JDBC Driver を使用して、ColdFusion マークアップファイル内で ServiceDesk Plus データを含むテーブルを作成する方法を説明します。

CData JDBC Driver は、最適化されたデータ処理機能を組み込んでおり、ServiceDesk Plus のデータとのリアルタイム連携において圧倒的なパフォーマンスを提供します。 複雑な SQL クエリを ServiceDesk Plus に発行すると、ドライバーはフィルタや集計などのサポートされている SQL 操作を ServiceDesk Plus に直接プッシュし、 サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンがクライアント側で処理します。 組み込みの動的メタデータクエリ機能により、ネイティブのデータ型を使用して ServiceDesk Plus のデータを操作・分析できます。

ServiceDesk Plus への接続を設定

ColdFusion と ServiceDesk Plus 間の接続を確立するには、JDBC 接続文字列が必要です。

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 Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行してください。

java -jar cdata.jdbc.api.jar

データソースの追加とテーブルの作成

接続を設定したら、次の手順に従って CData JDBC Driver を ColdFusion の lib ディレクトリに追加し、新しいデータソースを追加し、接続をテストし、 ColdFusion マークアップファイルを作成して、最終的に ServiceDesk Plus のデータとリアルタイムに接続し、ColdFusion Markup Language（CFML）で記述されたテーブルに表示します。

  1. ServiceDesk Plus 用の JDBC Driver と lic ファイルを「C:\Program Files\CData[product_name]\lib」から 「C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib」にコピーします。 
                cdata.jdbc.api.jar
            cdata.jdbc.api.lic

    注意：.lic ファイルを jar と一緒にコピーしないと、有効なライセンスがインストールされていないことを示すライセンスエラーが表示されます。 これはトライアル版と製品版の両方に当てはまります。

  2. ColdFusion 管理画面から、Data & Services を選択します。
  3. ここで「Add New Data Source」をクリックします。データソース名は、ColdFusion の変数命名規則に従っていれば任意の名前を指定できます。 JDBC Driver の場合は「other」を選択し、「Add」ボタンをクリックします。
  4. 次に、ドライバーのプロパティを入力します。
    • JDBC URL は次の形式で指定します： jdbc:api:|connectionString|
    • 一般的な接続文字列は次のようになります：

      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 は任意で、ColdFusion 管理コンソールでデータソースを識別するためだけに使用されます。
  5. 作成した CDataServiceDesk PlusJDBC データソースの左側にあるチェックマークをクリックして、接続をテストします。 データソースが「OK」ステータスを報告すれば、使用可能な状態です。
  6. 次に、新しい ColdFusion マークアップファイル（.cfm）を作成し、ColdFusion の wwwroot ディレクトリ（「C:\ColdFusion2021\cfusion\wwwroot」）に配置します。

    以下のコードでデータソースにクエリを実行します：

                
        <cfquery name="ServiceDesk PlusQuery" dataSource="CDataServiceDesk PlusJDBC">
          SELECT * FROM AnnouncementComments
        </cfquery>
    CFTable を使用すると、HTML でテーブルを素早く出力できます： 
                
          <cftable
          query = "ServiceDesk PlusQuery"
          border = "1"
          colHeaders
          colSpacing = "2"
          headerLines = "2"
          HTMLTable
          maxRows = "500"
          startRow = "1">

          <cfcol header="<b></b>" align="Left" width=2 text=""/>

          <cfcol header="<b></b>" align="Left" width=15 text=""/>

          ...

        </cftable>
    HTML 部分を含む完全なコードは以下のとおりです： 
                
        <html>
        <head><title>CData Software | ServiceDesk Plus AnnouncementComments Table Demo </title></head>
        <body>
        <cfoutput>#ucase("ServiceDesk Plus AnnouncementComments Table Demo")#</cfoutput>
        <cfquery name="ServiceDesk PlusQuery" dataSource="CDataServiceDesk PlusJDBC">

          SELECT * FROM AnnouncementComments

        </cfquery>
        <cftable
          query = "ServiceDesk PlusQuery"
          border = "1"
          colHeaders
          colSpacing = "2"
          headerLines = "2"
          HTMLTable
          maxRows = "500"
          startRow = "1">
          <cfcol header="<b></b>" align="Left" width=2 text=""/>

          <cfcol header="<b></b>" align="Left" width=15 text=""/>

          ...

        </cftable>
        </body>

        </html>
  7. 最後に、デフォルトポート 8500 でブラウザからコードをローカルで実行します。ServiceDesk Plus データが入力されたテーブルが表示されます。

なお、CData JDBC Driver は cfqueryparam 要素を使用したパラメータ化クエリもサポートしています。 例： 

SELECT * FROM Account WHERE name =

おわりに

CData JDBC Driver for ServiceDesk Plus の30日間の無償トライアルをダウンロードして、 Adobe ColdFusion で ServiceDesk Plus に接続したアプリケーションの構築を始めましょう。 ご不明な点があれば、サポートチームまでお問い合わせください。

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

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

ServiceDesk Plus に接続

この記事の内容

関連記事