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

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

EnterpriseConnect Agent のセットアップ

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

JDBC Adapter のセットアップ

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

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

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

2. "sqlDriver" フィールドに CData JDBC Driver のクラス名を設定します。例：
   cdata.jdbc.shopify.ShopifyDriver
3. "sqlSource" フィールドに Shopify に接続するための JDBC URL を設定します。例：
   jdbc:shopify:AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;

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

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

   java -jar cdata.jdbc.shopify.jar
   

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

   それでは、Shopify への接続・認証について説明していきましょう。Shopify では、アクセストークンとOAuth の2つの接続方法をサポートしています。

   アクセストークンによる接続

   アクセストークン経由の接続には、以下の2つのステップが必要です。

   1. Shopify の管理画面でアクセストークンを作成
   2. アクセストークンを使用して認証

   アクセストークンの作成

   まず、アプリを登録してアクセストークンを取得してみましょう。手順は以下のとおりです。

   1. 管理画面からShopify にログインし、Apps → Apps and sales channels に進みます
   2. Develop apps をクリックしてCreate an app を選択します
   3. Overview タブのConfiguration で、Admin API integration をクリックし、アプリに許可するストアのアクセス権を選択してください。CData製品が必要とするAdmin API 権限については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」セクションをご確認ください
   4. Save をクリックします
   5. Overview タブのConfiguration で、Storefront API integration をクリックし、アプリに許可するストアのアクセス権を選択します。CData製品が必要とするStorefront API 権限は以下のとおりです：
      • unauthenticated_read_content
   6. Save をクリックします
   7. API Credentials を選択します
   8. "Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます
   9. Admin API Access token のアクセストークンをコピーします。注意：トークンの公開およびコピーは1回のみ可能ですので、必ず保存してください

   アクセストークンによる認証

   続いて、アクセストークンで認証するには、以下のプロパティを設定してください。

   • AuthScheme：AccessToken に設定
   • AccessToken：カスタムアプリからコピーしたアクセストークンの値に設定

   OAuth 認証を介した接続については、ヘルプドキュメントの「OAuth 認証の使用」をご確認ください。

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

JDBC.config ファイルの例

#DBAgent Configuration
Shopify = {"sqlDriver" : "cdata.jdbc.shopify.ShopifyDriver", "sqlSource" = "jdbc:shopify:AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;","sqlDriverPath" = "cdata.jdbc.shopify.jar" }

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

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

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

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

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

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

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

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

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