Servoy で Jira Service Management 連携Web アプリを構築
Servoy は、迅速なアプリケーション開発およびデプロイメントプラットフォームです。CData JDBC Driver for Jira Service Management と組み合わせることで、リアルタイムの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 連携アプリを構築するには、まずCData JDBC Driver for Jira Service Management を使用してServoy Developer でデータプロバイダーを作成する必要があります。
- JDBC Driver をインストールします。
- JDBC Driver の JAR ファイル(cdata.jdbc.jiraservicedesk.jar)を、Servoy のインストールディレクトリにある /application_server/drivers/ ディレクトリにコピーします。
- Servoy Developer を開きます。
- Solution Explorer で、Database Server(Resources 配下)を右クリックし、「Connect to existing database」->「empty」を選択します。
- サーバーに名前を付けます。
- クリックして詳細サーバー設定を表示します。
URL を設定します(例:jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;)
組み込みの接続文字列デザイナー
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 のデータ にアクセスできるアプリを構築する準備が整います。
新しいソリューションの作成
- Server Explorer で「All solutions」を右クリックし、「Create new solution」を選択します。
- ソリューションに名前を付けます。
- 「search」モジュールを含めるチェックボックスを選択します。
- 「Finish」をクリックします。
新しいフォームの作成
「Forms」を右クリックし、「Create new form」を選択します。
- フォームに名前を付けます。
- データソースを選択します。
- タイプ(例:Simple)を設定し、「Finish」をクリックします。
フォームにデータグリッドを追加
- Data Grid コンポーネント(Servoy NG-Grids から)をフォームにドラッグします。
カラムコンポーネントをData Grid にドラッグし、各カラムコンポーネントの「dataprovider」プロパティをJira Service Management の「テーブル」のカラムに設定します(例:Requests テーブルの RequestId)。
必要に応じてカラムを追加します。
アプリに検索機能を追加
検索機能を追加するには「svySearch」拡張機能が必要です(新しいソリューションを作成する際にデフォルトで含まれています)。ソリューション作成時に拡張機能を追加しなかった場合や、既存のソリューションを変更する場合は、Modules(ソリューション内)を右クリックし、「Add Module」を選択して検索モジュールを追加できます。「svySearch」を選択し、「OK」をクリックします。
- Text Field コンポーネントをフォームにドラッグします。
- フォームを右クリックし、「Open in Script Editor」を選択します。
- 検索値を保持する新しい変数(JavaScript)を作成します:
var searchText = '';
- フォームに戻り、Text Field のプロパティで:
- 「dataprovider」プロパティを先ほど作成したフォーム変数に設定します。
- ダブルクリックしてonAction イベントのメソッドを追加します。
- クリックして「Form」にメソッドを作成し、メソッドに名前を付け(例:onEnter)、「Create private」をクリックします。
- 「OK & Show」をクリックします。
- 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 Jira Service Management の30日間無償トライアルをダウンロードして、Servoy でJira Service Management 連携アプリの構築を始めましょう。ご不明な点があれば、サポートチームまでお問い合わせください。