1. はじめに

ここでは、Windows環境のPCで iPLAss を動作させる手順を紹介します。
手順中では、アプリケーションサーバとしてApache Tomcat、DBMSとしてMySQLを使用します。

iPLAssのインストーラ(war)自体は、Apache Tomcatに最適化されていますが、OS/DBMSは(iPLAssが動作環境と定義する)他のものでも動作します。

2. 前提条件

本手順は以下を前提条件としています。

・Windows環境であること。
・JRE8がインストール済みであること。

3. 環境構築

  1. Apache Tomcat(以下、Tomcat)のインストール

    1. Tomcatの ダウンロードサイト からTomcat 8のインストーラをダウンロードします。

      Coreの"32-bit/64-bit Windows Service Installer"をダウンロード
    2. ダウンロードしたインストーラを実行し任意の場所にインストールします。

  2. MySQLのインストール

    1. MySQLの ダウンロードサイト からMySQL Community Server(5.7以上)のインストーラをダウンロードします。

      "Windows (x86, 32 & 64-bit), MySQL Installer MSI"をダウンロード
    2. ダウンロードしたインストーラを実行し任意の場所にインストールします。
      インストールの際は以下を設定してください。

      Setup Type = Server only
      Type and Networking:ConfigType = Dedicated Machine
    3. MySQL(my.ini及びmy.cnf)を設定します。

      以下の例の通り、設定を変更してください。

      設定ファイルはデフォルトでMySQL Server本体のフォルダにmy-default.iniがありますが、こちらではなく、
      データベースに紐づくmy.ini(Windowsの場合、デフォルトC:\ProgramData\MySQL以下にあるmy.ini)を編集してください。
        [client]
        default-character-set=utf8mb4
      
        [mysql]
        default-character-set=utf8mb4
      
        [mysqld]
        character-set-server=utf8mb4
        max_allowed_packet=100M
        transaction-isolation=READ-COMMITTED
        query_cache_size=0 (1)
        lower_case_table_names=1
        innodb_file_format=Barracuda (1)
        innodb_file_per_table=1
        innodb_large_prefix=1 (1)
        default-time-zone='Asia/Tokyo' (2)
      1 MySQL 8.0以上では不要です。
      2 Connector/J 8.0以上では必要です。
      事前にタイムゾーンデータをインポートしている必要があります。 タイムゾーンのインポートについてはMySQLのタイムゾーンの ダウンロードサイト を参照してください。

      その他の項目は適宜状況に応じて変更してください。
      ファイルの修正が完了したら、MySQLを再起動してください。

      注意事項
      MySQLのバイナリログを有効にしている場合、ファンクション作成にてエラーが発生します。
      対応として、log_bin_trust_function_creatorsを有効にしてください。
  3. MySQL JDBCドライバのインストール

    1. MySQLの ダウンロードサイト からConnector/J(GA版)をダウンロードします。

      "Platform Independent (Architecture Independent), ZIP Archive"をダウンロード
    2. ダウンロードしたファイルを任意の場所に展開します。

    3. 展開したフォルダにあるJDBCドライバファイルを前手順でインストールしたTomcatの次の場所へコピーします。

      %CATALINA_HOME%\lib

      ※「CATALINA_HOME」はTomcatをインストールしたディレクトリを指します。

  4. データベースの準備
    iPLAssインストーラがデータベース及びユーザの作成を行うため準備は不要です。

4. iPLAssのインストール

  1. インストーラファイル(iplass.war)の取得

    インストーラファイルが手元にない場合、次のいずれかの方法で取得します。

    1. ダウンロードサイトからiPLAss Installerをダウンロードします。

    2. (Enterprise Editionの場合)手元のiPLAss SDKのinstallerディレクトリからiplass.warを取得します。

  2. Tomcatへのiplass.warのデプロイ

    1. 取得した「iplass.war」をTomcatの次の場所へコピーします。

      %CATALINA_HOME%\webapps

      Tomcatが起動していない場合はWARファイルをコピー後、Tomcatを起動してください。
      Tomcatが既に起動している場合、WARファイルをコピーすると自動的にデプロイが開始されます。

  3. セットアップ画面の表示

    1. Webブラウザに次のURLを入力しセットアップ画面にアクセスします。
      iPLAssセットアップ画面のURLは下記となります。

      http://localhost:8080/iplass

      または

      http://<サーバのホスト名またはIPアドレス>:8080/iplass

      ※Tomcatのポート番号を変更した場合は設定したポート番号を指定してください。

  4. iPLAssセットアップの実行

    1. セットアップ情報の入力

      1. データベースへの接続情報の入力

        iPLAssセットアップ画面から、以下の要領で環境情報を入力します。

        方式

        'DataSource’を選択

        データベース

        'MySQL’を選択

        DBAユーザ名

        MySQLのDBA権限を持つユーザのユーザ名

        DBAパスワード

        MySQLのDBA権限を持つユーザのパスワード

        バイナリデータファイル保存場所

        バイナリデータファイルの保存先ルートディレクトリ
        MySQL及びPostgreSQLの場合、Binary型のデータは標準でファイル形式により外部保存されます。Oracle及びSQLServerの場合は保存場所を設定した場合のみ外部保存されます。

        テーブル自動作成

        テーブルを作成する場合はチェックします。
        既にテーブルが存在する場合は再作成されます。再セットアップ等で既存のデータを削除したくない場合はチェックを外してください。
        ※新規にセットアップを行う場合は必ずチェックしてください。

        JDBCドライバクラス名

        com.mysql.jdbc.Driver (デフォルト)

        JDBC URL

        ホスト名、ポート番号を入力すると自動的に設定されます。
        直接編集を行う場合は’編集’をチェックしてください。

        ホスト名

        MySQLをインストールしたホスト名またはIPアドレス

        ポート番号

        3306 (デフォルト)
        ※ポート番号を変更した場合は変更したポート番号を入力してください。

        スキーマ名

        mtdb (変更不可)

        ユーザ名

        作成する任意のMySQLのユーザ名

        パスワード

        作成する任意のMySQLのパスワード

        データソース名

        jdbc/iplass (デフォルト)
        変更する場合は’編集’をチェックしてください。

        データソース自動設定

        Tomcatにデータソースの設定を行う場合はチェックします。
        Tomcat以外のサーバの場合は無効となります。

      2. iPLAss テナント情報の入力

        テナント名

        任意のテナント名 (半角推奨)

        管理者ユーザID

        任意の管理者ユーザID

        管理者パスワード

        任意の管理者パスワード
        ※パスワードを表示する場合は「パスワード表示」をチェックします。
        ブラウザがIEの場合は「パスワード表示」のチェックボックスは表示されません。

        管理者のユーザIDおよびパスワードについて
        ユーザIDには4文字以上の「英数字」および「-」(マイナス)「@」「_」「.」(ピリオド)のみ入力可能です。
        パスワードは6文字以上の英数字のみ入力可能です。

        iPLAssセットアップ画面

        01_iPlassSetup
    2. セットアップの開始
      セットアップ情報を入力後、セットアップ開始ボタンを押下しiPLAssのセットアップを開始します。
      セットアップが正常に完了した場合は「アプリケーションサーバを再起動してください。」のメッセージが表示されます。

      正常完了時のメッセージ

      iplassSetupSuccess
  5. アプリケーションサーバ(Tomcat)の再起動

    1. アプリケーションサーバ(Tomcat)を再起動します。

  6. テナントへのアクセス

    1. Webブラウザに以下のURLを入力しアプリケーションサーバにアクセスします。

      http://localhost:8080/iplass

      または

      http://<サーバのホスト名またはIPアドレス>:8080/iplass

      ※Tomcatのポート番号を変更した場合は設定したポート番号を指定してください。

    2. テナントのログイン画面表示
      初回アクセス時、初期テナントが自動で作成されます。
      作成後、テナントへリダイレクトされログイン画面が表示されます。

      iPLAssログイン画面

      iplassLogin
      次回以降(初期テナント作成後)のアクセス時はリダイレクトされないため、リダイレクト後のURLのメモを取るかブックマークの追加を推奨します。
      これまでの手順に従って作成した場合、ログイン画面のURLは下記の通りです。
      http://<サーバのホスト名またはIPアドレス>:8080/iplass/<テナント名>/gem/
    3. テナントへのログイン
      ユーザIDにセットアップで入力したテナント情報の管理者ユーザIDを、パスワードに管理者パスワードをそれぞれ入力しログインボタンを押下します。
      ログイン後、テナントのgem画面が表示されることを確認します。
      ログインが完了しgem画面が表示できたら、iPLAssのインストールは完了です。

      iPLAss トップ画面

      iplassTop

5. 標準機能の利用例

ここからは、iPLAssの標準機能を利用して簡単なアプリケーションを作成します。
下記の手順に従って、商品マスタデータの管理画面を作成してみましょう。

  1. 2種類の画面機能を理解する

    1. 汎用画面とAdminConsole
      iPLAss上に作成されたテナントでは、初期状態で「汎用画面」と「AdminConsole」という2つのWebアプリケーションが利用可能です。

      汎用画面

      エンドユーザ向けの画面
      デフォルトでログイン後に表示されているトップ画面がこれにあたります。
      AdminConsoleを利用して定義された情報をもとに画面が生成されます。

      AdminConsole

      システム管理者、開発者向けの画面群
      後述するエンティティ定義の作成や画面設計など、アプリケーションに対する様々な操作を行います。

    2. AdminConsoleの起動

      AdminConsoleを起動してみましょう。
      テナントの管理者でログインした状態で、ヘッダ領域の「UserAdmin」をクリックすることで、「管理・設定」メニューが表示されます。
      「管理・設定」メニューをクリックすると、AdminConsoleが起動します。

      AdminConsoleの起動

      startAdminConsole

      AdminConsole トップページ

      iplsassAdminConsole
    3. AdminConsoleについて

      AdminConsole画面の左側には「MetaDataSettings」と「Tools」という2つのメニューグループが表示されています。
      「MetaDataSettings」は各テナント上に定義されたメタデータが、その種類ごとにツリー表示されます。
      メタデータとはiPLAss上で動作するアプリケーションの設定情報のことをさします。
      各メタデータの追加、編集はこのツリーから行います。
      「Tools」は、開発者向けの管理ツール群です。開発段階で利用します。

      「MetaDataSettings」と「Tools」

      metadataSetting

      ※テナント作成時点でいくつかのメタデータが定義されています。
      「mtp」や「gem」はiPLAss FWとして提供される機能で利用するメタデータ群です。

  2. メタデータの作成:Entityを定義する

    Entityは、RDBにおける「テーブル」にあたるメタデータです。
    iPLAss では汎用機能として、Entity定義を利用した検索/編集/集計機能などがあらかじめ提供されています。

    1. Entityの作成

      ここではサンプルとして、商品のカテゴリを管理する商品カテゴリマスタEntityと商品を管理する商品マスタEntityの2つを作成します。

      Entityを作成する際は、MetaDataSettingsの「Entity」を選択し、右クリックメニューから、「エンティティを作成する」を押下してください。Entityの作成画面が表示されます。

      「エンティティを作成する」

      CreateEntity01

      Entity作成画面

      CreateEntity02

      Entity作成時の入力要素

      Name

      エンティティの名称です。
      エンティティは「.(ドット)」で階層を表現できます。

      Display Name

      エンティティを表示する際の名称です。
      汎用画面等での表示に使用されます。

      Description

      エンティティの説明です。

      1. 必要なEntityを作成する

        以下の要領でデータを入力し、「Save」ボタンを押下してください。

        商品カテゴリマスタ

        CreateCategoryEntity

        商品マスタ

        CreateProductEntity
      2. EntityにPropertyを追加する。

        PropertyはEntityの持つ属性です。RDBでいうと、Entity = テーブル、 Property = 列 のような関係を持ちます。

        EntityにPropertyを追加するには、対象Entityをダブルクリックするか、
        対象Entityを選択し、右クリックメニューから「エンティティを開く」を選択します。

        「エンティティを開く」

        setupEntity

        「エンティティを開く」を押下すると、Entityの設定画面が開きます。
        Propertyを追加する際は、Propertiesの「Add」ボタンを押下します。

        「Add」ボタン

        setupProperty

        商品カテゴリマスタエンティティでPropertyの追加画面を開き、
        商品カテゴリマスタ自身を参照する、親カテゴリというPropertyを追加してみます。

        「親カテゴリ」Propertyの追加

        setupProductCategory01

        入力値サンプル

        Name

        parentCategory

        Display Name

        親カテゴリ

        Type

        Reference

        参照エンティティ

        ProductCategory

        参照関係

        通常の参照

        Entityへの更新を行った場合は「Save」を押下することで更新が反映されます。

        「Save」ボタン

        setupProductCategory02

        商品カテゴリマスタへのProperty追加が完了したら、商品マスタにもPropertyを追加します。
        以下の要領でPropertyを作成し、保存してください。

        「商品カテゴリ」Propertyの追加

        setupProduct01

        サンプル入力値

        Name

        productCategory

        Display Name

        商品カテゴリ

        Type

        Reference

        参照エンティティ

        ProductCategory

        参照関係

        通常の参照

        「価格」Propertyの追加

        setupProduct02

        サンプル入力値

        Name

        price

        Display Name

        価格

        Type

        Integer

        これでEntityへのProperty追加は完了です。

  3. 汎用画面から確認する。

    これまでに作成したメタデータが、画面にどう反映されているか確認してみましょう。
    汎用画面で「ホーム」ボタンを押下しリロードを行うと、先ほどの定義をもとに2つのボタンが追加されています。

    汎用画面の確認

    TopPage

    各ボタンを押下すると、設定したPropertyが反映されていることが分かります。

    設定したPropertyの確認

    prudoctCategoryMaster
    prudoctMaster

    上記の画面の「新規登録」、「検索」などのボタンを利用して商品データの登録、検索、編集を行うことが可能です。
    以下に紹介するのは、各操作を行った際の画面例です。

    商品カテゴリ登録の例

    entryProductCategory

    商品登録の例

    entryProduct

    商品検索の例

    searchProduct

6. 次のステップ

iPLAssに初めてふれている場合、次に チュートリアル を実施してみてください。

Install and Run