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

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

Jira Service Management のデータへの接続を作成

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

Jira Service Management 接続プロパティの取得・設定方法

任意のJira Service Management Cloud またはJira Service Management Server インスタンスへの接続を確立できます。接続するにはURL プロパティを設定します。

• URL（例：https://yoursitename.atlassian.net）

カスタムフィールドへのアクセス

デフォルトでは、CData 製品はシステムフィールドのみを表示します。Issues のカスタムフィールドにアクセスするには、IncludeCustomFields を設定します。

Jira Service Management への認証

ベーシック認証

ローカルサーバーアカウントで認証するためには、次の接続プロパティを指定します。

• AuthScheme：Basic に設定。
• User：認証ユーザーのユーザー名に設定。
• Password：認証ユーザーのパスワードに設定。

API トークン

Cloud アカウントに接続するには、APIToken を取得する必要があります。API トークンを生成するには、Atlassian アカウントにログインして「API トークン」 -> 「API トークンの作成」をクリックします。生成されたトークンが表示されます。

データに接続するには以下を設定します。

• AuthScheme：APIToken に設定。
• User：認証ユーザーのユーザー名に設定。
• APIToken：作成したAPI トークンに設定。

ちなみに、Cloud アカウントへの接続でパスワード認証を使うことも可能ですが、非推奨となっています。

OAuth 2.0

Jira Service Management のOAuth 2.0 サポート（3LO）を活用して、ログインクレデンシャルなしでデータに接続することもできます。

この場合、AuthSchemeをすべてのOAuth フローでOAuth に設定する必要があります。また、すべてのシナリオでカスタムOAuth アプリケーションを作成して構成する必要があります。詳しくは、ヘルプドキュメントの「OAuth」セクションを参照してください。

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

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

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

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

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

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

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

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

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

     SELECT RequestId, ReporterName FROM Requests WHERE CurrentStatus = 'Open'
     

   • Active：このプロパティを true に設定します。

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

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

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

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

FireDAC コンポーネントを使ってJira Service Management にコマンドを実行

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

Jira Service Management のデータに接続

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

FDConnection1->ConnectionDefName = "CData Jira Service Management ODBC Source";
FDConnection1->Connected = true;

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

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

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

FDQuery1->SQL->Text = "select * from Requests where currentstatus = :CurrentStatus";
FDQuery1->ParamByName("currentstatus")->AsString = "Open";
FDQuery1->Open();

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

ステートメントの準備

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

クエリの実行

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

FDQuery1->SQL->Text = "select * from Requests where currentstatus = :CurrentStatus";
FDQuery1->ParamByName("currentstatus")->AsString = "Open";
FDQuery1->Open();

結果セットを返さないクエリを実行するには、ExecSQL メソッドを使用します。クエリが結果セットを返す場合、ExecSQL メソッドはエラーを返します。影響を受けた行数を取得するには、TFD.RowsAffected プロパティを使用します。

FDQuery1->SQL->Text = "delete from Requests where Id = :Id";
FDQuery1->Params->Items[0]->AsString = "x12345";
FDQuery1->ExecSQL();
AnsiString i = FDQuery1->RowsAffected;
ShowMessage("Rows affected: " + i);

関連記事

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

• Delphi でJira Service Management のデータにデータバインドするコントロールを作成
• RAD Studio Data Explorer でJira Service Management のデータを表示
• Jira Service Management のデータ用のシンプルな VCL アプリケーションを作成