Servoy でBigCommerce に接続されたWeb アプリを構築

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

Servoy は、迅速なアプリケーション開発とデプロイのためのプラットフォームです。CData JDBC Driver for BigCommerce と組み合わせることで、ユーザーはBigCommerce に接続してリアルタイムBigCommerce データを使用できるアプリケーションを構築できます。この記事では、Servoy からBigCommerce に接続し、BigCommerce データを表示、検索するための簡単なWeb アプリケーションを構築する方法を説明します。

ビルトインの最適化されたデータ処理により、CData JDBC Driver は、リアルタイムBigCommerce データとやり取りする際に圧倒的なパフォーマンスを提供します。BigCommerce に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作をBigCommerce に直接プッシュし、サポートされていない操作（主にSQL 関数とJOIN 操作）は組み込みのSQL エンジンを利用してクライアント側で処理します。組み込みの動的メタデータクエリを使用すると、ネイティブデータソース型を使用してBigCommerce データを操作できます。

Servoy Developer からBigCommerce に接続する

BigCommerce に接続するアプリケーションを構築するには、まず、Servoy Developer からCData JDBC Driver for BigCommerce を使用してデータプロバイダを作成する必要があります。

1. JDBC Driver をインストールします。
2. JDBC Driver JAR ファイル（cdata.jdbc.bigcommerce.jar）を、Servoy のインストールディレクトリの/application_server/drivers/ ディレクトリにコピーします。
3. Servoy Developer を開きます。
4. Solution Explorer で「Resources」の下の「Database Server」を右クリックし、「Connect to existing database」->「empty」を選択します。
   1. サーバーに名前を付けます。
   2. クリックすると、サーバーの詳細設定が表示されます。

      • 次のようにURL を設定します。例：jdbc:bigcommerce:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'InitiateOAuth=GETANDREFRESH

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

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

        java -jar cdata.jdbc.bigcommerce.jar

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

        BigCommerce 認証は標準のOAuth フローに基づいています。

        Store ID の取得

        BigCommerce Store に接続するには、StoreId が必要です。Store Id を確認するには、以下の手順に従ってください。

        1. BigCommerce アカウントにログインします。
        2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
        3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
        4. 画面にAPI Path という名前のテキストボックスが表示されます。
        5. テキストボックス内に、次の構造のURL が表示されます：https://api.bigcommerce.com/stores/{Store Id}/v3。
        6. 上記で示したように、Store Id は'stores/' と'/v3' パスパラメータの間にあります。
        7. Store Id を取得したら、「キャンセル」 をクリックするか、まだ持っていない場合はAPI Account の作成に進むことができます。

        パーソナルアクセストークンの取得

        加えて、自分のデータをテストおよびアクセスするには、個人用トークンを取得する必要があります。個人用トークンを取得する方法は次のとおりです。

        1. BigCommerce アカウントにログインします。
        2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
        3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
        4. アカウント名を入力します。
        5. 作成するAPI Account の「OAuth Scopes」を選択します。CData 製品 は"None" とマークされたデータにアクセスできません。また、"read-only" とマークされたデータを変更できません。
        6. 「保存」をクリックします。

        BigCommerce への認証

        次に、以下を設定してデータに接続できます。
        • StoreId：API Path テキストボックスから取得したStore ID に設定。
        • OAuthAccessToken：生成したトークンに設定。
        • InitiateOAuth：OFF に設定。

      • コピーしたDriver クラスを選択します。例：cdata.jdbc.bigcommerce.BigCommerceDriver

BigCommerceに接続するWeb アプリを構築する

Servoy Developer リソースでBigCommerce への接続を設定すると、リアルタイムBigCommerce へのアクセス権を持つアプリケーションを構築することができます。

新しいソリューションを作成する

1. Server Explorer で、「All solutions」を右クリックし、「Create new solution」を選択します。
2. ソリューションに名前を付けます。
3. 「search」モジュールを含むチェックボックスを選択します。
4. 「Finish」をクリックします。

新しいフォームを作成する

「Forms」を右クリックし、「Create new form」を選択します。

1. フォームに名前を付けます。
2. データソースを選択します。
3. タイプ（Simple など）を設定し、「Finish」をクリックします。

フォームにData Grid を追加する

1. Servoy NG-Grids からData Grid コンポーネントをフォームにドラッグします。

2. カラムコンポーネントをData Grid にドラッグし、各カラムコンポーネントの「dataprovider」プロパティをBigCommerce 「table」のカラム（例：Customers テーブルのFirstName）に設定します。

   必要に応じてカラムを追加します。

アプリケーションに検索を追加する

検索機能を追加するには、「svySearch」拡張機能が必要です。（新しいソリューションを作成する際にデフォルトで含まれます。）ソリューションの作成時に拡張機能を追加しなかった場合、または、既存のソリューションを変更する場合は、ソリューション内のModules を右クリックして「Add Module」を選択することで検索モジュールを追加できます。「svySearch」を選択し、「OK」をクリックします。

1. Text Field コンポーネントをForm にドラッグします。
2. Form を右クリックし、「Open in Script Editor」を選択します。
3. 検索値を保持する新しい変数（JavaScript）を作成します。

   var searchText = '';
   

4. Text Field プロパティでForm に戻ります。
   1. 「dataprovider」プロパティを作成したForm 変数に設定します。
   2. ダブルクリックしてonAction イベントのメソッドを追加します。
   3. クリックして「Form」でメソッドを作成し、名前を付けて（例：onEnter）、「Create private」をクリックします。
   4. 「OK & Show」をクリックします。
5. 以下の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 BigCommerce の30日の無償評価版をダウンロードし、Servoy でBigCommerce に接続されたアプリケーションの構築を開始します。ご不明な点があれば、サポートチームにお問い合わせください。