Sugar CRM のデータをWagby に繋いでみた

こんにちは！リードエンジニアの杉本です。

CData JDBC Driver for SugarCRM は、JDBC 標準をインプリメントし、BI ツールからIDE まで幅広いアプリケーションでSugar CRM への接続を提供します。この記事では、超高速開発ツールであるWagby からSugar CRM に接続一覧表示する方法を説明します。

完成イメージ

以下のようにWagbyの一覧画面で Sugar CRM から取得したデータを表示する画面を作成します。

1.CData Sugar CRM JDBC Driverのダウンロード・インストール

まず、WagbyとSugar CRMの連係のために使用するCData Sugar CRM JDBC Driverのダウンロード・インストールを実施します。

CData Sugar CRM JDBC Driverは下記URLより30日間試用版が入手できます。

https://www.cdata.com/jp/drivers/sugarcrm/jdbc/

ダウンロード後、ZIPファイルを解凍しsetup.jarを実行します。

2.ドライバーjarファイルおよびlicファイルの配置

1. 続いて、WagbyでCData Salesforce JDBC Driverを利用できるようにするため、Wagbyへライブラリを配置します。 CData Salesforce JDBC Driverインストール後、「C:/Program Files/CData/CData JDBC Driver for Salesforce 2017J/lib」のフォルダに含まれる以下のファイルをWagbyのライブラリフォルダへ配置します。 Wagbyへのファイル配置先は、/customize/tomcat/libです。

「cdata.jdbc.sugarcrm.jar」

「cdata.jdbc.sugarcrm.lic」

3.データベース設定ファイルの作成

続いてCData DriverをWagbyで使用できるようにするための、データベース設定ファイルをWagby上へ配置します。

1. 以下の内容で「database.txt」というファイルを作成します。
cdata.database_label=CData Sugar CRM Driver cdata.database_type=cdata cdata.driver=cdata.jdbc.sugarcrm.SugarCRMDriver cdata.url=jdbc:sugarcrm:User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True; cdata.quoteid=\" cdata.quotewhere= cdata.quoteidinwhere=\" cdata.quoteidforhibernate=\" cdata.hibernateDialect=jp.jasminesoft.jfc.hibernate.dialect.SQLServer2012Dialect cdata.maxTablenameLength=128 cdata.maxIndexnameLength=128 cdata.maxColumnnameLength=128 cdata.maxLengthStringDataType=nvarchar(1000) cdata.characterLargeObjectDataType=NVARCHAR(MAX) cdata.supportTimeDataType=false cdata.searchStringEscapeInLike=\\ cdata.createSequenceDDL=CREATE SEQUENCE $QUOTEID$SEQNAME$QUOTEID $MINVALUE$MAXVALUESTART WITH $START NO CACHE CYCLE cdata.sequenceDML=SELECT NEXT VALUE FOR $QUOTEID$SEQNAME$QUOTEID cdata.springBatchDDL=batch_sqlserver.ddl cdata.masterDDL=master_sqlserver2000.ddl cdata.validationQuery=SELECT 1
2. 作成したファイルは「/repository/trunk」へ配置します。

4.サブデータベースの指定

それでは実際にWagbyで Sugar CRM のデータを読み込むための設定を行っていきます。

Wagbyはシステムを構成するための基軸となるデータを保管するためのメインデータベースと外部データを参照するためのサブデータベースで構成されています。CData Driver はこのサブデータベースを利用することで、各データソースからシームレスにデータの参照を実施できます。

1. デスクトップに配置されたWagby Designer起動をクリックし、Wagby Designerを立ち上げます。
2. 起動後、以下URLにアクセスし、Wagby Designer画面を表示します。

http://localhost:8920/wagbydesigner/logon.jsp

3. 「環境」→「データベース」→「サブ」を選択し、サブデータベースにて以下のプロパティを設定します。

データベース：CData Sugar CRM Driver

接続URL：jdbc:sugarcrm:User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;

ユーザー名：使用しませんが、必須項目のため適当な文字列を入力します。

パスワード：使用しませんが、必須項目のため適当な文字列を入力します。

4.モデルの作成

続いて、対象サービスと連携するモデルの作成を実施します。

1. 「モデル」→「新規モデル」をクリックします。
2. モデル作成画面にて、取得したテーブル情報に合わせて、画面項目を作成します。 「モデルID」と「項目ID」は対象サービスのテーブル名・カラム名に基づいて指定します。
3. 上記設定後、一覧表示にも各行でチェックを入れます。
4. CData Driverはメタデータの生成に対応していないため、Wagbyが自動的に実行するテーブルの作成機能をOFFにする必要があります。 モデル画面から「画面」→「その他」を選択し以下の項目を設定します。

「テーブルを作成する」　←　チェックを外します。

「物理テーブル名」　←　上記テーブル名と同じ名称を指定します。

「サブデータベース」　←　手順2で指定したサブデータベースを選択します。

5.ビルドの実行

ビルドを実行し、サブデータベース・モデルの設定値をビルドファイルに反映させます。ビルドはサブデータベースを指定したため、フルビルドで行ってください。

1. 「ビルド」から「フルビルド」を選択し、「ビルド実行」をクリックします。

6.アプリケーションの起動

実際にユーザーが使用する画面を用いて、動作確認を実施します。

1. Wagby Designerの画面に戻り、「アプリケーション起動」をクリックします。
2. 対象の画面を表示することで、 Sugar CRM のデータ からシームレスにデータの取得が可能です。

このように SugarCRM 内のデータを API を書くことなく Wagby 上で処理することができるようになります。

サポートされるSQL についての詳細は、ヘルプドキュメントの「サポートされるSQL」をご覧ください。テーブルに関する情報は「データモデル」をご覧ください。