Java で Sage 300 のデータ エンティティのオブジェクト リレーショナル マッピング(ORM)を行う

Jerod Johnson
Jerod Johnson
Senior Technology Evangelist
オブジェクト リレーショナル マッピング(ORM)技術を使用すると、リレーショナルデータソースの操作が容易になり、論理的なビジネスモデルと物理ストレージモデルを橋渡しできます。本記事では、Java ベースの ORM フレームワーク Hibernate に Sage 300 のデータ への接続を組み込む方法を説明します。

Hibernate を使用して、オブジェクト指向のドメインモデルを従来のリレーショナルデータベースにマッピングできます。以下のチュートリアルでは、CData JDBC Driver for Sage 300 を使用して Hibernate で Sage 300 リポジトリの ORM を生成する方法を説明します。

本記事では IDE として Eclipse を使用していますが、CData JDBC Driver for Sage 300 は Java ランタイム環境をサポートするあらゆる製品で使用できます。Knowledge Base には、IntelliJ IDEA や NetBeans から Sage 300 のデータ に接続するためのチュートリアルも用意しています。

Hibernate のインストール

以下の手順に従って、Eclipse に Hibernate プラグインをインストールします。

  1. Eclipse で、Help -> Install New Software を選択します。
  2. Work With ボックスに「http://download.jboss.org/jbosstools/neon/stable/updates/」を入力します。
  3. フィルタボックスに「Hibernate」と入力します。
  4. Hibernate Tools を選択します。

新規プロジェクトの作成

以下の手順に従って、新しいプロジェクトにドライバー JAR を追加します。

  1. 新規プロジェクトを作成します。プロジェクトタイプとして Java Project を選択し、Next をクリックします。プロジェクト名を入力して Finish をクリックします。
  2. プロジェクトを右クリックして Properties をクリックします。Java Build Path をクリックし、Libraries タブを開きます。
  3. Add External JARs をクリックして、インストールディレクトリの lib サブフォルダにある cdata.jdbc.sage300.jar ライブラリを追加します。

Hibernate 設定ファイルの追加

以下の手順に従って、Sage 300 のデータ への接続プロパティを設定します。

  1. 新規プロジェクトを右クリックし、New -> Hibernate -> Hibernate Configuration File (cfg.xml) を選択します。
  2. src を親フォルダとして選択し、Next をクリックします。
  3. 以下の値を入力します:

    • Hibernate version:: 5.2
    • Database dialect: Derby
    • Driver class: cdata.jdbc.sage300.Sage300Driver
    • Connection URL: JDBC URL です。jdbc:sage300: から始まり、セミコロン区切りの接続プロパティが続きます。

      Sage 300 には、Sage 300 Web API で通信するための初期設定が必要となるます。

      • Sage 300 のユーザー向けのセキュリティグループを設定します。Sage 300 のユーザーに、Security Groups の下にあるbSage 300 Web API オプションへのアクセスを付与します(各モジュール毎に必要です)。
      • /Online/Web/Online/WebApi フォルダ内のweb.config ファイルを両方編集して、AllowWebApiAccessForAdmin のキーを true 設定します。webAPI アプリプールを再起動すると設定が反映されます。
      • ユーザーアクセスを設定したら、https://server/Sage300WebApi/ をクリックして、web API へのアクセスを確認してください。

      Basic 認証を使用してSage 300 へ認証します。

      Basic 認証を使用して接続する

      Sage 300 に認証するには、次のプロパティを入力してください。プロバイダーは、クッキーを使用してSage 300 が開いたセッションを再利用することに注意してください。 そのため、資格情報はセッションを開く最初のリクエストでのみ使用されます。その後は、Sage 300 が返すクッキーを認証に使用します。

      • Url:Sage 300 をホストするサーバーのURL に設定します。Sage 300 Web API 用のURL を次のように作成してください。 {protocol}://{host-application-path}/v{version}/{tenant}/ 例えば、 http://localhost/Sage300WebApi/v1.0/-/ です。
      • User:アカウントのユーザー名に設定します。
      • Password:アカウントのパスワードに設定します。

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

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

      java -jar cdata.jdbc.sage300.jar
      

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

      一般的な JDBC URL は以下のとおりです:

      jdbc:sage300:User=SAMPLE;Password=password;URL=http://127.0.0.1/Sage300WebApi/v1/-/;Company=SAMINC;

Hibernate から Sage 300 のデータ に接続

以下の手順に従って、前のステップで作成した設定を選択します。

  1. Hibernate Configurations パースペクティブに切り替えます: Window -> Open Perspective -> Hibernate。
  2. Hibernate Configurations パネルを右クリックし、Add Configuration をクリックします。
  3. Hibernate version を 5.2 に設定します。
  4. Browse ボタンをクリックし、プロジェクトを選択します。
  5. Configuration file フィールドで、Setup -> Use Existing をクリックし、hibernate.cfg.xml ファイルの場所(このデモでは src フォルダ内)を選択します。
  6. Classpath タブで、User Entries の下に何もない場合は、Add External JARS をクリックしてドライバー jar を再度追加します。設定が完了したら OK をクリックします。
  7. 新しく作成した Hibernate 設定ファイルの Database ノードを展開します。

Sage 300 のデータ のリバースエンジニアリング

以下の手順に従って、reveng.xml 設定ファイルを生成します。オブジェクトとしてアクセスするテーブルを指定します。

  1. Package Explorer に戻ります。
  2. プロジェクトを右クリックし、New -> Hibernate -> Hibernate Reverse Engineering File (reveng.xml) を選択します。Next をクリックします。
  3. src を親フォルダとして選択し、Next をクリックします。
  4. Console configuration ドロップダウンメニューで、上記で作成した Hibernate 設定ファイルを選択し、Refresh をクリックします。
  5. ノードを展開し、リバースエンジニアリングするテーブルを選択します。完了したら Finish をクリックします。

Hibernate の実行設定

以下の手順に従って、Sage 300 テーブルの POJO(Plain Old Java Object)を生成します。

  1. メニューバーから、Run -> Hibernate Code Generation -> Hibernate Code Generation Configurations をクリックします。
  2. Console configuration ドロップダウンメニューで、前のセクションで作成した Hibernate 設定ファイルを選択します。Output directory の横にある Browse をクリックし、src を選択します。
  3. Reverse Engineer from JDBC Connection チェックボックスを有効にします。Setup ボタンをクリックし、Use Existing をクリックして、hibernate.reveng.xml ファイルの場所(このデモでは src フォルダ内)を選択します。
  4. Exporters タブで、Domain code (.java) と Hibernate XML Mappings (hbm.xml) をチェックします。
  5. Run をクリックします。

前のステップのリバースエンジニアリング設定に基づいて、1 つ以上の POJO が作成されます。

マッピングタグの挿入

生成した各マッピングに対して、hibernate.cfg.xml にマッピングタグを作成し、Hibernate がマッピングリソースを参照できるようにする必要があります。hibernate.cfg.xml を開き、以下のようにマッピングタグを挿入します:





  
    
      cdata.sage300.Sage300Driver
    
    
      jdbc:sage300:User=SAMPLE;Password=password;URL=http://127.0.0.1/Sage300WebApi/v1/-/;Company=SAMINC;
    
    
      org.hibernate.dialect.SQLServerDialect
    
    
    
    

SQL の実行

前のステップで作成したエンティティを使用して、Sage 300 のデータ のデータの検索が可能になります:


import java.util.*;
import org.hibernate.Session;
import org.hibernate.cfg.Configuration;
import org.hibernate.query.Query;

public class App {
  public static void main(final String[] args) {
    Session session =  new
    Configuration().configure().buildSessionFactory().openSession();
    String SELECT = "FROM OEInvoices O WHERE AllowPartialShipments = :AllowPartialShipments";
    Query q = session.createQuery(SELECT, OEInvoices.class);
    q.setParameter("AllowPartialShipments","Yes");
    List<OEInvoices> resultList = (List<OEInvoices>) q.list();

    for(OEInvoices s: resultList){
      System.out.println(s.getInvoiceUniquifier());
      System.out.println(s.getApprovedLimit());
    }
  }
}

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

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

 ダウンロード

詳細:

Sage 300 Icon Sage 300 JDBC Driver お問い合わせ

Sage 300 に連携するJava アプリケーションを素早く、簡単に開発できる便利なドライバー。