CookBook

テナント環境セットアップでテナント固有の属性を登録する。

投稿日:2016-03-29 更新日:

この CookBook では以下の方法を紹介します。

  • テナント環境セットアップでテナント固有の属性を登録する方法。
  • システム管理者のテナント管理画面で、テナント固有の属性を編集する方法。

今回は「外部サーバの接続情報」をテナント固有の属性として登録・更新するサンプルを作成します。

完成イメージ

tenant_setup_extension

完成サンプル

以下の完成サンプルをダウンロードしてご活用ください。

e builder プロジェクト : im_cookbook_111299_tenant_setup_extension.zip
imm ファイル : im_cookbook_111299_tenant_setup_extension-1.0.0.imm

ローカル環境で表示させる場合は、システム管理者でログイン後、以下のURLにアクセスしてください。
http://localhost:8080/imart/system/settings/tenant
なおベースURLである以下の部分は、環境に合わせて適宜変更してください。
http://localhost:8080/imart

レシピ

  1. initializer 設定ファイルを作成します。
  2. 初期化処理を実装します。
  3. セットアップ画面を実装します。
  4. バリデータを実装します。
  5. 登録・更新処理の拡張プログラムを実装します。
  6. テナント属性確認用プログラムを実装します。
  7. 依存関係を設定します。
  8. [確認] テナント管理画面から「外部サーバの接続情報」を更新します。
  9. [確認] テナント属性が更新されていることを確認します。

1. initializer 設定ファイルを作成します。

はじめに e Builder のモジュールプロジェクト内に「initializer 設定ファイル」を作成します。initializer 設定ファイルには、intra-mart Accel Platform の起動時に実行する初期化処理を設定します。

src/main/conf/products/initializer/initializer-im_cookbook_111299_tenant_setup_extension.xml

行数 説明
8 実行する初期化処理のパスを設定します。
各モジュールで重複しないパスを設定してください。

initializer 設定ファイルの詳細は「設定ファイルリファレンス - initializer 設定」を参照してください。

2. 初期化処理を実装します。

intra-mart Accel Platform の起動時に実行する初期化処理で、テナント環境セットアップの拡張プログラムを登録します。e Builder のモジュールプロジェクト内に以下のファイルを作成します。

src/main/jssp/src/im_cookbook_111299_tenant_setup_extension/setup.js

行数 説明
3 拡張ポイントを指定します。
テナントの登録時は「create」、 更新時は「edit」を指定してください。
拡張ポイントの指定方法の例を後述します。
4 セットアップ画面パスを指定します。
5 バリデータのパスを指定します。
6 登録・更新処理の拡張プログラムパスを指定します。
拡張ポイントの指定方法

3. セットアップ画面を実装します。

テナント環境セットアップの拡張プログラムは、以下の3つから構成されます。いずれも、スクリプト開発モデルで作成します。

  1. セットアップ画面
  2. バリデータ
  3. 登録・更新処理の拡張プログラム

まず、セットアップ画面を作成します。

セットアップ画面とは、テナント登録時、および、更新時に表示される画面です。今回のサンプルでは、外部サーバ接続情報として「ホスト名」と「ポート番号」を入力項目とする画面を作成します。

src/main/jssp/src/im_cookbook_111299_tenant_setup_extension/tenant/extension/views/tenant_extension.js

行数 説明
1 「im_cookbook_111299_tenant_setup_extension/tenant/extension/common.js」をロードしています。common.jsでは、画面間で共通的に利用する定数 PREFIX_4_TENANT_ATTR_KEY を定義しています。
5 init関数に渡される引数「data」は以下の形式です。
 data
  ├── point : 拡張ポイント("create" or "edit")
  └── tenantInfo : TenantInfo オブジェクト
7〜12 テナント登録時の処理を実装しています。
ここでは、デフォルト値として空文字を設定しています。
14 テナント更新時の処理を実装しています。
15〜18 init関数の引数「data」に格納されているテナント属性をループし、この画面に関係する属性だけを処理します。
22 テナント属性として保存されていた「ホスト名」と「ポート番号」をバインド変数「$parameter」に設定しています。
src/main/jssp/src/im_cookbook_111299_tenant_setup_extension/tenant/extension/views/tenant_extension.html

行数 説明
14 入力項目「ホスト名」を定義しています。<imart type="imuiTextbox">を利用しています。
17 バインド変数「$parameter」に格納された「ホスト名」を設定しています。
29 入力項目「ポート番号」を定義しています。<imart type="imuiTextbox">を利用しています。
32 バインド変数「$parameter」に格納された「ポート番号」を設定しています。

4. バリデータを実装します。

次に、バリデータを実装します。テナント登録時と更新時のバリデーションを JSSP Validator 形式で設定します。

JSSP Validator の詳細は「スクリプト開発モデル プログラミングガイド - JSSP Validator - バリデーション設定ファイル」を参照してください。

src/main/jssp/src/im_cookbook_111299_tenant_setup_extension/tenant/extension/validators/tenant_extension.js

行数 説明
1 テナント登録時のバリデーションを、変数「create」に設定しています。
17 テナント更新時のバリデーションを、変数「edit」に設定しています。

5. 登録・更新処理の拡張プログラムを実装します。

次に、登録・更新処理の拡張プログラムを実装します。

src/main/jssp/src/im_cookbook_111299_tenant_setup_extension/tenant/extension/ajax/tenant_extension.js

登録・更新処理の拡張プログラムでは、2つの関数「validation」と「setAttribute」を実装します。

1. validation(request, point)

複数項目のバリデーションを行う際に実装します。バリデーションを行わない場合は、実装する必要はありません。なお、単項目のバリデーションは、手順4 の JSSP Validator で行います。

引数 request : 画面上に入力された値を含んだオブジェクトです。
point : 拡張ポイント("create" or "edit")
返却値 以下の形式の結果オブジェクトを返却します。
 object
  ├── error : バリデーション結果を示すboolean値。
  │      エラー時には true、それ以外は false。
  └── errorMessage : エラーメッセージ。

今回は、ホスト名に「localhost」が指定された際、ポート番号が「1024」以下の場合にバリデーションエラーとなるような処理を実装しています。

2. setAttribute(request, point, attributes)

テナント属性を設定します。

引数 request : 画面上に入力された値を含んだオブジェクトです。
point : 拡張ポイント("create" or "edit")
    テナント登録時と更新時で異なる処理を行う場合に利用します。
attributes : このオブジェクトに設定した値がテナント属性として登録されます。
返却値 なし

行数 説明
6 この画面に関係する古い属性を一旦削除しています。
13 この画面に関係する属性を、テナント属性として設定しています。

4. テナント属性確認用プログラムを実装します。

次に、テナント属性確認用プログラムを実装します。

src/main/jssp/src/im_cookbook_111299_tenant_setup_extension/show_tenant_attributes.js

行数 説明
4 TenantInfoManager を利用して、テナント属性を取得します。
6〜11 Debug.browse() を利用して、この Cookbook に関係する属性だけを表示しています。
src/main/conf/routing-jssp-config/im_cookbook_111299_tenant_setup_extension.xml

ルーティングテーブルを以下のように定義します。

5. 依存関係を設定します。

最後に、依存関係を設定します。

module.xml

行数 説明
11〜14 依存するモジュールを設定しています。

今回は「im_tenant」を指定します。(手順2 の初期化処理内で利用している ImTenantSetupオブジェクトが im_tenant モジュール内で定義されているため)

実装した拡張プログラムの動作に必要なモジュールを適宜設定してください。

以上でモジュールの準備が整いました。
作成したプログラムをユーザモジュールとして出力し、warファイルの作成とデプロイを行ってください。

6. [確認] テナント管理画面から「外部サーバの接続情報」を更新します。

システム管理者のテナント管理画面で、外部サーバの接続情報を更新してください。具体的な手順は以下の通りです。

  1. システム管理者でログインしてください。
  2. メニュー [システム環境構築] - [テナント管理] を選択してください。
  3. 「Connection Info (cookbook_111299)」タブを選択してください。
  4. 「Host name」と「Port number」を変更し、更新ボタンをクリックしてください。

tenant_setup_extension

7. [確認] テナント属性が更新されていることを確認します。

以下のURLにアクセスし、テナント属性が更新されていることを確認してください。

  • http://localhost:8080/imart/im_cookbook/111299/show_tenant_attributes

まとめ

この CookBook では以下の方法を紹介しました。

  • テナント環境セットアップでテナント固有の属性を登録する方法。
  • システム管理者のテナント管理画面で、テナント固有の属性を編集する方法。

お客様の用途にあわせて自由に作ることが可能です。是非ご活用ください。

-CookBook
-

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

intra-mart WebPlatform 7.2 の Docker を作成する

この CookBook では、intra-mart WebPlatform 7.2 の Docker の作成手順について紹介しています。 レシピ ベースイメージの作成 intra-mart WebPl …

画面アイテム「スプレッドシート」の特定セルをIM-ContentsSearchの検索対象にする方法

画面アイテム「スプレッドシート」の特定セルをIM-ContentsSearchの検索対象にする方法について紹介します。 本CookBookでは、スプレッドシート上の個人情報や、外部に公開したくない内容 …

IM-LogicDesignerを利用して、IM-Workflowの未処理案件の処理対象者を再展開する

このCookBookでは、IM-LogicDesignerを利用して、IM-Workflowの未処理案件の処理対象者を再展開する方法について紹介しています。 人事異動を重ねることで、未処理案件の中には …

画面アイテム「グリッドテーブル」で全行クリアする方法

このCookBookでは、IM-BISの画面アイテムであるグリッドテーブルで、入力データを全行クリアする方法について紹介します。 「グリッドテーブル」は、jqGridを利用しており、入力されたデータを …

スプレッドシートでForma入力チェックユーザプログラムを利用して入力チェックを実行する方法

このCookBookでは、スプレッドシートでForma入力チェックユーザプログラムを利用して入力チェックを実行する方法について紹介しています。 Formaの入力チェックプログラムでは以下の2つのチェッ …

まだデータがありません。

RSSRSSRSSRSS