intra-mart Accel Platform ユーザモジュール開発ガイド 第4版 2016-12-01

モジュール情報の設定

概要

本項ではIM-Juggling等で表示される、ユーザモジュール情報の定義方法について説明します。
本項でのモジュール情報とは、IM-Jugglingの「モジュールプロパティビュー」にて表示される情報を指します。

モジュール情報の定義

モジュール情報は、プロジェクト直下にあるmodule.xmlにて<module>内にて定義します。
定義したモジュールの情報はIM-Jugglingの「モジュールプロパティビュー」にて確認することができます。
<?xml version="1.0" encoding="UTF-8"?>
<module conf:schemaLocation="urn:intramart:jackling:toolkit:configurations configurations.xsd" xmlns="urn:intramart:jackling:module" xmlns:conf="urn:intramart:jackling:toolkit:configurations" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemeLocation="urn:intramart:jackling:module module.xsd">
  <id>jp.co.sample.sample_module</id>
  <version>1.0.0</version>
  <type>module</type>
  <name>サンプルモジュール</name>
  <vendor>サンプル会社</vendor>
  <description>サンプルモジュールです</description>
  <dependencies>
    <dependency>
      <module-id>jp.co.intra_mart.im_workflow</module-id>
      <verified-version min="8.0.5" max="8.0.7">8.0.6</verified-version>
    </dependency>
  </dependencies>
</module>
モジュールプロパティビューの表示
<module>内に設定する各要素は以下の値を設定します。
要素名 モジュールプロパティビューのプロパティ 説明
id ID モジュールID
version バージョン モジュールのバージョン
type
モジュールタイプ。
ユーザモジュールは、この値を変更しないでください。
name 名称 モジュールの名称。
vender ベンダー モジュールの提供ベンダー
description プロパティテーブルの下の説明欄 モジュールの説明文
dependencies 依存関係のリスト
モジュールで定義されている依存関係のリスト。
詳細は「モジュール間の依存関係」を参照してください。

コラム

IM-Jugglingを別のロケールで動作させた場合の多言語表示をプロパティファイルを用いて行うことができます。
プロパティファイルはモジュール直下にあるmessage.propertiesファイルです。
このプロパティは標準では日本語、中国語、英語、およびデフォルトの4種類を用意してあります。
またプロパティファイルを利用するのはname、vender、descriptionの3属性が対象です。

表示するロケールに置換するためには、置換文字列として ‘${‘ + プロパティ名 + ‘}’ の形で指定します。
書き方は以下のとおりです。
<?xml version="1.0" encoding="UTF-8"?>
<module conf:schemaLocation="urn:intramart:jackling:toolkit:configurations configurations.xsd" xmlns="urn:intramart:jackling:module" xmlns:conf="urn:intramart:jackling:toolkit:configurations" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemeLocation="urn:intramart:jackling:module module.xsd">
  <id>jp.co.sample.sample_module</id>
  <version>1.0.0</version>
  <type>module</type>
  <name>${module.name}</name>
  <vendor>${module.vendor}</vendor>
  <description>${module.description}</description>
  <dependencies>
    <dependency>
      <module-id>jp.co.intra_mart.im_workflow</module-id>
      <verified-version min="8.0.5" max="8.0.7">8.0.6</verified-version>
    </dependency>
  </dependencies>
</module>