RunMyProcess DSEC を使用して DigitalSuite Studio で Backlog のデータ に接続

CData JDBC Driver for Backlog は JDBC 標準を実装しており、BI からIDE まで幅広いアプリケーションから Backlog への接続を可能にします。この記事では、Arkobi Digital RunMyProcess の DSEC から Backlog のデータ に接続し、RunMyProcess で Backlog に接続する方法を説明します。

EnterpriseConnect Agent のセットアップ

RunMyProcess ドキュメントの EnterpriseConnect ページに従って、EnterpriseConnect Agent を設定します。

JDBC Adapter のセットアップ

JDBC Adapter のセクションでは、JDBC を使用して RDBMS に接続する手順が説明されています。手順に従って JDBC.config ファイルを開きます。

1. CData JDBC Driver for Backlog 用の JSON エントリを作成します。例：

   Backlog = {
     "sqlDriver" : "...",
     "sqlSource" : "...",
     "sqlDriverPath" : "..."
   }
   

2. "sqlDriver" フィールドに CData JDBC Driver のクラス名を設定します。例：
   cdata.jdbc.backlog.BacklogDriver
3. "sqlSource" フィールドに Backlog に接続するための JDBC URL を設定します。例：
   jdbc:backlog:ApiKey=YOUR_API_KEY;Url=https://yourURL.backlog.com;

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

   JDBC URL の作成には、Backlog JDBC Driver に組み込まれている接続文字列デザイナーをご利用ください。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行します。

   java -jar cdata.jdbc.backlog.jar
   

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

   Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。

   API キー認証

   ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには：

   1. Backlog の個人設定ページを開きます。
   2. 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
   3. ApiKey にAPI キーを指定します。
   4. URL はBacklog のテナントURL から取得できます。

   OAuth 認証

   ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントを参照してください。
4. "sqlDriverPath" フィールドに CData JDBC Driver JAR ファイルの名前を設定します。例：
   cdata.jdbc.backlog.jar

JDBC.config ファイルの例

#DBAgent Configuration
Backlog = {"sqlDriver" : "cdata.jdbc.backlog.BacklogDriver", "sqlSource" = "jdbc:backlog:ApiKey=YOUR_API_KEY;Url=https://yourURL.backlog.com;","sqlDriverPath" = "cdata.jdbc.backlog.jar" }

JDBC ドライバー JAR ファイル（cdata.jdbc.backlog.jar）を unified-adapter-[version].jar と同じディレクトリに配置します。

注意：CData ライセンスファイル（cdata.jdbc.backlog.lic）も同じディレクトリに配置してください。ライセンスは製品がインストールされているマシンの一意の識別子に基づいて生成されるため、ファイルを別のマシンに配置する場合はオフラインアクティベーションが必要になります。

DigitalSuite EnterpriseConnect Agent の起動

Windows では、Windows サービスから RunMyProcess DigitalSuite EnterpriseConnect Agent を起動します。コマンドラインでアプリケーションを起動する場合は、RunMyProcess ドキュメントの Starting the EnterpriseConnect Agent を参照してください。

JDBC Adapter の起動

runAdapter.bat から JDBC Adapter を起動します。Adapter が起動したら、エージェントアドレス（例：127.0.0.1:8080）を通じてアプリケーションにアクセスできます。以下は Windows でコマンドを実行した例です。

... > java -Djava.util.logging.config.file=./log.properties -cp lib/* org.runmyprocess.sec2.AdapterHandler :
2021-06-09 14:37:58|INFO|correlationId=|Searching for config file...
2021-06-09 14:37:58|INFO|correlationId=|Adapter Handler started with [JDBC] configuration
2021-06-09 14:37:59|INFO|correlationId=|agent address: 127.0.0.1:8080
2021-06-09 14:38:00.251:INFO::ConnectionThread: Logging initialized @1820ms to org.eclipse.jetty.util.log.StdErrLog
2021-06-09 14:38:00|INFO|correlationId=|onConnect() websocket connection between Agent and Adapter established

DigitalSuite EnterpriseConnect Agent と JDBC Adapter が起動したら、ブラウザで http://localhost:(指定したポート番号)/ にアクセスして、以下のページを開きます。

Postman や cURL などのツールを使用して JDBC Adapter の接続確認を行います。ここでは Postman を使用して HTTP POST リクエストを送信します。

RequestHeader を以下のように設定します：

Content-Type application/json

RequestBody を以下のように設定します：

{
	"protocol":"JDBC",
	"data":{
		"DBType":"Backlog",
		"sqlUsername":"",
		"sqlPassword":"",
		"sqlStatement":"SELECT * FROM Issues"
	}
}

JDBC.config ファイルに認証情報が含まれている場合、sqlUsername と sqlPassword は空のままにできます。テーブル名が不明な場合は、SELECT * FROM sys_tables リクエストを使用してテーブルの一覧を取得できます。

ステータスが 200 で、ボディに JSON 形式の Backlog のデータ データが含まれていれば、リクエストは成功です。

DigitalSuite Studio で DSEC Agent を介して Backlog に接続

DigitalSuite Studio プロジェクトを作成し、プロジェクト内に Provider を作成します。

• URL：JDBC Agent にアクセスするための URL（例：http:localhost:8080/）
• Authentication Scheme：Login/password
• Login：application.properties ファイルの agent.user の値
• Password：application.properties ファイルの agent.password の値
• Secured：チェックを入れる
• Use DigitalSuite EnterpriseConnect：チェックを入れる
• With domain：application.properties ファイルの agent.domain の値

次に、Provider 内に Connector を作成します。

• Connector URL：空のままにする
• Architecture：REST/XML-RPC
• Method：POST
• Result format：JSON
• Accept media type：application/json
• Character set：Automatic
• Content：JDBC Adapter で使用した Request body と同じ内容
• Content type: application/json

JDBC Adapter で Request body として使用した JSON データ：

{
	"protocol":"JDBC",
	"data":{
		"DBType":"Backlog",
		"sqlUsername":"",
		"sqlPassword":"",
		"sqlStatement":"SELECT * FROM Issues"
	}
}

Launch Test を開いてテストを実行します。右側のペインの Result に Backlog のデータ データが表示されれば、テストは成功です。

これで、DSEC を介して RunMyProcess DigitalSuite Studio で Backlog のデータ を使用できるようになりました。

サポートされる SQL コマンドの詳細については、ヘルプドキュメントの「SQL Compliance」セクションを参照してください。テーブルの詳細については、「Data Model」セクションを参照してください。