Servoy で Square 連携Web アプリを構築

Jerod Johnson
Jerod Johnson
Senior Technology Evangelist
Servoy Developer を使用して Square のデータ に簡単に接続し、リアルタイムSquare のデータ 連携Web アプリを構築できます。

Servoy は、迅速なアプリケーション開発およびデプロイメントプラットフォームです。CData JDBC Driver for Square と組み合わせることで、リアルタイムのSquare のデータ と連携するSquare 接続アプリを構築できます。この記事では、Servoy からSquare に接続し、Square のデータ を表示・検索するシンプルなWeb アプリを構築する方法を説明します。

CData JDBC Driver は、最適化されたデータ処理機能を組み込んでおり、リアルタイムのSquare のデータ を操作する際に比類のないパフォーマンスを提供します。Square に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作を直接Square にプッシュし、サポートされていない操作(多くの場合SQL 関数やJOIN 操作)は組み込みのSQL エンジンを使用してクライアント側で処理します。組み込みの動的メタデータクエリにより、ネイティブのデータ型を使用してSquare のデータ を操作できます。

Servoy Developer でSquare に接続

Square 連携アプリを構築するには、まずCData JDBC Driver for Square を使用してServoy Developer でデータプロバイダーを作成する必要があります。

  1. JDBC Driver をインストールします。
  2. JDBC Driver の JAR ファイル(cdata.jdbc.square.jar)を、Servoy のインストールディレクトリにある /application_server/drivers/ ディレクトリにコピーします。
  3. Servoy Developer を開きます。
  4. Solution Explorer で、Database Server(Resources 配下)を右クリックし、「Connect to existing database」->「empty」を選択します。
    1. サーバーに名前を付けます。
    2. クリックして詳細サーバー設定を表示します。
      • URL を設定します(例:jdbc:square:OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;

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

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

        				java -jar cdata.jdbc.square.jar
        				

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

        Square OAuth 認証標準を使用します。OAuth を使用して認証するには、Square にアプリを登録してOAuthClientId、OAuthClientSecret、CallbackURL を入手します。OAuth の使用方法については、ヘルプドキュメントの「はじめに」セクションをご覧ください。

        追加でLocationId を指定する必要がある場合があります。Locations テーブルをクエリすることでLocations のId を取得できます。または、クエリの検索項目にLocationId を設定することもできます。

      • 先ほどコピーしたDriver クラスを選択します(例:cdata.jdbc.square.SquareDriver

Square 連携Web アプリの構築

Servoy Developer のリソースでSquare への接続を設定したら、リアルタイムのSquare のデータ にアクセスできるアプリを構築する準備が整います。

新しいソリューションの作成

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

新しいフォームの作成

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

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

フォームにデータグリッドを追加

  1. Data Grid コンポーネント(Servoy NG-Grids から)をフォームにドラッグします。
  2. カラムコンポーネントをData Grid にドラッグし、各カラムコンポーネントの「dataprovider」プロパティをSquare の「テーブル」のカラムに設定します(例:Refunds テーブルの Reason)。

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

アプリに検索機能を追加

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

  1. Text Field コンポーネントをフォームにドラッグします。
  2. フォームを右クリックし、「Open in Script Editor」を選択します。
  3. 検索値を保持する新しい変数(JavaScript)を作成します:
    var searchText = '';
    
  4. フォームに戻り、Text Field のプロパティで:
    1. 「dataprovider」プロパティを先ほど作成したフォーム変数に設定します。
    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 Square の30日間無償トライアルをダウンロードして、Servoy でSquare 連携アプリの構築を始めましょう。ご不明な点があれば、サポートチームまでお問い合わせください。

はじめる準備はできましたか?

Square Driver の無料トライアルをダウンロードしてお試しください:

 ダウンロード

詳細:

Square Icon Square JDBC Driver お問い合わせ

Square のTransaction、Items、Subscriptions データをJava ベースのアプリケーションから手軽に連携。