C++Builder でServiceDesk Plus のデータにデータバインドするコントロールを作成

Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
C++Builder で標準コンポーネントとコントロールを使ってServiceDesk Plus のデータ にデータバインド。



CData ODBC ドライバー for ServiceDesk Plus を使用すると、C++Builder の標準データアクセスコンポーネントを使ってライブのServiceDesk Plus のデータ への接続を簡単に統合できます。この記事では、C++Builder でシンプルな VCL（Visual Component Library）アプリケーションを作成し、ServiceDesk Plus のデータ に接続してクエリを実行し、グリッドに結果を表示する方法を説明します。さらに、FireDAC コンポーネントを使ってコードからコマンドを実行する方法も紹介します。

ServiceDesk Plus のデータへの接続を作成

まだ設定していない場合は、ODBC DSN（データソース名）で接続プロパティを指定します。これはドライバーインストールの最終ステップです。Microsoft ODBC データソースアドミニストレーターを使って ODBC DSN を作成・設定できます。

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;

次に、以下の手順に従って Data Explorer を使用し、ServiceDesk Plus への FireDAC 接続を作成します。

  1. 新しい VCL Forms アプリケーションで、Data Explorer の FireDAC ノードを展開します。
  2. Data Explorer の ODBC Data Source ノードを右クリックします。
  3. Add New Connection をクリックします。
  4. 接続の名前を入力します。
  5. 表示される FireDAC Connection Editor で、DataSource プロパティをServiceDesk Plus の ODBC DSN の名前に設定します。

ServiceDesk Plus のデータに接続する VCL アプリケーションを作成

以下の手順に従って、クエリの結果をグリッドに表示するシンプルな VCL アプリケーションからServiceDesk Plus のデータ のクエリを開始します。

  1. TFDConnection コンポーネントをフォームにドロップし、以下のプロパティを設定します：

    • ConnectionDefName：ServiceDesk Plus への FireDAC 接続を選択します。
    • Connected：メニューから True を選択し、表示されるダイアログで資格情報を入力します。

  2. TFDQuery コンポーネントをフォームにドロップし、以下のプロパティを設定します：

    • Connection：TFDConnection コンポーネントに設定します（まだ指定されていない場合）。

    • SQL：SQL プロパティのボタンをクリックし、クエリを入力します。例：

      SELECT ,  FROM AnnouncementComments WHERE AnnouncementId = '12345'
    • Active：このプロパティを true に設定します。

  3. TDataSource コンポーネントをフォームにドロップし、以下のプロパティを設定します：

    • DataSet：このプロパティのメニューで、TFDQuery コンポーネントの名前を選択します。

  4. TDBGrid コントロールをフォームにドロップし、以下のプロパティを設定します：

    • DataSource：TDataSource の名前を選択します。
  5. TFDGUIxWaitCursor をフォームにドロップします — これは実行時エラーを回避するために必要です。

FireDAC コンポーネントを使ってServiceDesk Plus にコマンドを実行

TFDConnection および TFQuery コンポーネントを使用して、ServiceDesk Plus のデータ にクエリを実行できます。このセクションでは、TFQuery コンポーネントを使ったクエリ実行のServiceDesk Plus 固有の例を紹介します。

ServiceDesk Plus のデータに接続

データソースに接続するには、TFDConnection コンポーネントの Connected プロパティを true に設定します。コードから同じプロパティを設定することもできます：

FDConnection1->ConnectionDefName = "CData ServiceDesk Plus ODBC Source";
FDConnection1->Connected = true;

TFDQuery コンポーネントをServiceDesk Plus のデータ に接続するには、コンポーネントの Connection プロパティを設定します。設計時に TFDQuery コンポーネントを追加すると、上記のアプリケーションのように、その Connection プロパティはフォーム上の TFDConnection を指すように自動的に設定されます。

パラメータ化クエリの作成

パラメータ化クエリを作成するには、以下の構文を使用します： 

FDQuery1->SQL->Text = "select * from AnnouncementComments where announcementid = :AnnouncementId";
FDQuery1->ParamByName("announcementid")->AsString = "12345";
FDQuery1->Open();

上記の例では、文字列型の入力パラメータを名前でバインドし、結果のデータセットを開いています。

ステートメントの準備

ステートメントの準備は、システムリソースと時間の両方でコストがかかります。ステートメントの準備中は、接続がアクティブで開いている必要があります。デフォルトでは、FireDAC は同じクエリを何度もコンパイルすることを避けるためにクエリを準備します。ステートメントの準備を無効にするには、ResourceOptions.DirectExecute を True に設定します。例えば、クエリを一度だけ実行する必要がある場合などです。

クエリの実行

SELECT クエリなど、結果セットを返すクエリを実行するには、Open メソッドを使用します。Open メソッドはクエリを実行し、結果セットを返して開きます。クエリが結果セットを生成しない場合、Open メソッドはエラーを返します。

FDQuery1->SQL->Text = "select * from AnnouncementComments where announcementid = :AnnouncementId";
FDQuery1->ParamByName("announcementid")->AsString = "12345";
FDQuery1->Open();

関連記事

以下に、RAD Studio、Delphi、C++ Builder で CData ODBC ドライバーを使用するための他の記事を紹介します。

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

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

ServiceDesk Plus に接続

この記事の内容

関連記事