Servoy でJira Service Management に接続されたWeb アプリを構築

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

Servoy は、迅速なアプリケーション開発とデプロイのためのプラットフォームです。CData JDBC Driver for JiraServiceDesk と組み合わせることで、ユーザーはJira Service Management に接続してリアルタイムJira Service Management のデータを使用できるアプリケーションを構築できます。この記事では、Servoy からJira Service Management に接続し、Jira Service Management のデータを表示、検索するための簡単なWeb アプリケーションを構築する方法を説明します。

ビルトインの最適化されたデータ処理により、CData JDBC Driver は、リアルタイムJira Service Management のデータとやり取りする際に圧倒的なパフォーマンスを提供します。Jira Service Management に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作をJira Service Management に直接プッシュし、サポートされていない操作（主にSQL 関数とJOIN 操作）は組み込みのSQL エンジンを利用してクライアント側で処理します。組み込みの動的メタデータクエリを使用すると、ネイティブデータソース型を使用してJira Service Management のデータを操作できます。

Servoy Developer からJira Service Management に接続する

Jira Service Management に接続するアプリケーションを構築するには、まず、Servoy Developer からCData JDBC Driver for JiraServiceDesk を使用してデータプロバイダを作成する必要があります。

1. JDBC Driver をインストールします。
2. JDBC Driver JAR ファイル（cdata.jdbc.jiraservicedesk.jar）を、Servoy のインストールディレクトリの/application_server/drivers/ ディレクトリにコピーします。
3. Servoy Developer を開きます。
4. Solution Explorer で「Resources」の下の「Database Server」を右クリックし、「Connect to existing database」->「empty」を選択します。
   1. サーバーに名前を付けます。
   2. クリックすると、サーバーの詳細設定が表示されます。

      • 次のようにURL を設定します。例：jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH

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

        JDBC URL の構築については、Jira Service Management JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

        java -jar cdata.jdbc.jiraservicedesk.jar

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

        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」セクションを参照してください。

        

      • コピーしたDriver クラスを選択します。例：cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver
   

Jira Service Managementに接続するWeb アプリを構築する

Servoy Developer リソースでJira Service Management への接続を設定すると、リアルタイムJira Service Management へのアクセス権を持つアプリケーションを構築することができます。

新しいソリューションを作成する

1. Server Explorer で、「All solutions」を右クリックし、「Create new solution」を選択します。
2. ソリューションに名前を付けます。
3. 「search」モジュールを含むチェックボックスを選択します。
4. 「Finish」をクリックします。

新しいフォームを作成する

「Forms」を右クリックし、「Create new form」を選択します。

1. フォームに名前を付けます。
2. データソースを選択します。
3. タイプ（Simple など）を設定し、「Finish」をクリックします。

フォームにData Grid を追加する

1. Servoy NG-Grids からData Grid コンポーネントをフォームにドラッグします。

2. カラムコンポーネントをData Grid にドラッグし、各カラムコンポーネントの「dataprovider」プロパティをJira Service Management 「table」のカラム（例：Requests テーブルのRequestId）に設定します。

   必要に応じてカラムを追加します。

アプリケーションに検索を追加する

検索機能を追加するには、「svySearch」拡張機能が必要です。（新しいソリューションを作成する際にデフォルトで含まれます。）ソリューションの作成時に拡張機能を追加しなかった場合、または、既存のソリューションを変更する場合は、ソリューション内のModules を右クリックして「Add Module」を選択することで検索モジュールを追加できます。「svySearch」を選択し、「OK」をクリックします。

1. Text Field コンポーネントをForm にドラッグします。
2. Form を右クリックし、「Open in Script Editor」を選択します。
3. 検索値を保持する新しい変数（JavaScript）を作成します。

   var searchText = '';
   

4. Text Field プロパティでForm に戻ります。
   1. 「dataprovider」プロパティを作成したForm 変数に設定します。
   2. ダブルクリックしてonAction イベントのメソッドを追加します。
   3. クリックして「Form」でメソッドを作成し、名前を付けて（例：onEnter）、「Create private」をクリックします。
   4. 「OK & Show」をクリックします。
5. 以下のJavaScript をJavaScript ファイルに追加することで、Servoy フレームワークを使用してText Field のテキストを使ったバインドデータの検索を実装します。

   var search = scopes.svySearch.createSimpleSearch(foundset).setSearchText(searchText);
   search.setSearchAllColumns();
   search.loadRecords(foundset);
   

アプリを保存して起動する

フォームとJavaScript ファイルを保存し、「Run」->「Launch NGClient」とクリックしてWeb アプリケーションを起動します。

CData JDBC Driver for JiraServiceDesk の30日の無償評価版をダウンロードし、Servoy でJira Service Management に接続されたアプリケーションの構築を開始します。ご不明な点があれば、サポートチームにお問い合わせください。