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

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

EnterpriseConnect Agent のセットアップ

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

JDBC Adapter のセットアップ

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

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

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

2. "sqlDriver" フィールドに CData JDBC Driver のクラス名を設定します。例：
   cdata.jdbc.bitbucket.BitbucketDriver
3. "sqlSource" フィールドに Bitbucket に接続するための JDBC URL を設定します。例：
   jdbc:bitbucket:Workspace=myworkspaceslug;Schema=Information

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

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

   java -jar cdata.jdbc.bitbucket.jar
   

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

   ほとんどのクエリでは、ワークスペースを設定する必要があります。唯一の例外は、Workspacesテーブルです。このテーブルはこのプロパティの設定を必要とせず、クエリを実行すると、Workspaceの設定に使用できるワークスペーススラッグのリストが提供されます。このテーブルにクエリを実行するには、スキーマを'Information'に設定し、SELECT * FROM Workspacesクエリを実行する必要があります。

   Schemaを'Information'に設定すると、一般的な情報が表示されます。Bitbucketに接続するには、以下のパラメータを設定してください。

   • Schema: ワークスペースのユーザー、リポジトリ、プロジェクトなどの一般的な情報を表示するには、これを'Information'に設定します。それ以外の場合は、クエリを実行するリポジトリまたはプロジェクトのスキーマに設定します。利用可能なスキーマの完全なセットを取得するには、sys_schemasテーブルにクエリを実行してください。
   • Workspace: Workspacesテーブルにクエリを実行する場合を除き、必須です。Workspacesテーブルへのクエリにはこのプロパティは必要ありません。そのクエリはWorkspaceの設定に使用できるワークスペーススラッグのリストのみを返すためです。

   Bitbucketでの認証

   BitbucketはOAuth認証のみをサポートしています。すべてのOAuthフローからこの認証を有効にするには、カスタムOAuthアプリケーションを作成し、AuthSchemeをOAuthに設定する必要があります。

   特定の認証ニーズ（デスクトップアプリケーション、Webアプリケーション、ヘッドレスマシン）に必要な接続プロパティについては、ヘルプドキュメントを必ず確認してください。

   カスタムOAuthアプリケーションの作成

   Bitbucketアカウントから、以下のステップを実行します。

   1. 設定（歯車アイコン）に移動し、ワークスペース設定を選択します。
   2. アプリと機能セクションで、OAuthコンシューマーを選択します。
   3. コンシューマーを追加をクリックします。
   4. カスタムアプリケーションの名前と説明を入力します。
   5. コールバックURLを設定します。
      • デスクトップアプリケーションとヘッドレスマシンの場合、http://localhost:33333または任意のポート番号を使用します。ここで設定するURIがCallbackURLプロパティになります。
      • Webアプリケーションの場合、信頼できるリダイレクトURLにコールバックURLを設定します。このURLは、ユーザーがアプリケーションにアクセスが許可されたことを確認するトークンを持って戻るWebの場所です。
   6. クライアント認証情報を使用して認証する予定の場合、これはプライベートコンシューマーですを選択する必要があります。ドライバーでは、AuthSchemeをclientに設定する必要があります。
   7. OAuthアプリケーションに与える権限を選択します。これにより、読み取りおよび書き込みできるデータが決まります。
   8. 新しいカスタムアプリケーションを保存するには、保存をクリックします。
   9. アプリケーションが保存された後、それを選択して設定を表示できます。アプリケーションのKeyとSecretが表示されます。これらを将来の使用のために記録してください。Keyを使用してOAuthClientIdを設定し、Secretを使用してOAuthClientSecretを設定します。
   
4. "sqlDriverPath" フィールドに CData JDBC Driver JAR ファイルの名前を設定します。例：
   cdata.jdbc.bitbucket.jar

JDBC.config ファイルの例

#DBAgent Configuration
Bitbucket = {"sqlDriver" : "cdata.jdbc.bitbucket.BitbucketDriver", "sqlSource" = "jdbc:bitbucket:Workspace=myworkspaceslug;Schema=Information","sqlDriverPath" = "cdata.jdbc.bitbucket.jar" }

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

注意：CData ライセンスファイル（cdata.jdbc.bitbucket.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":"Bitbucket",
		"sqlUsername":"",
		"sqlPassword":"",
		"sqlStatement":"SELECT * FROM Issues"
	}
}

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

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

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

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":"Bitbucket",
		"sqlUsername":"",
		"sqlPassword":"",
		"sqlStatement":"SELECT * FROM Issues"
	}
}

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

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

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