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

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

EnterpriseConnect Agent のセットアップ

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

JDBC Adapter のセットアップ

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

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

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

2. "sqlDriver" フィールドに CData JDBC Driver のクラス名を設定します。例：
   cdata.jdbc.zendesk.ZendeskDriver
3. "sqlSource" フィールドに Zendesk に接続するための JDBC URL を設定します。例：
   jdbc:zendesk:URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;

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

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

   java -jar cdata.jdbc.zendesk.jar
   

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

   Zendesk 接続プロパティの取得・設定方法

   Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL（Zendesk Support URL）を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。

   また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。

   Zendesk への認証

   Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証（レガシー）です。

   API トークン認証

   API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthScheme をAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。

   1. Token アクセスを有効にします。
   2. Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。
   最後に、APIToken をアクティブなAPI トークンに設定します。

   その他の認証方法についてはヘルプドキュメントを参照してください。

   
4. "sqlDriverPath" フィールドに CData JDBC Driver JAR ファイルの名前を設定します。例：
   cdata.jdbc.zendesk.jar

JDBC.config ファイルの例

#DBAgent Configuration
Zendesk = {"sqlDriver" : "cdata.jdbc.zendesk.ZendeskDriver", "sqlSource" = "jdbc:zendesk:URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;","sqlDriverPath" = "cdata.jdbc.zendesk.jar" }

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

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

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

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

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

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

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

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

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