intra-mart e Builder for Accel Platform アプリケーション開発ガイド 第14版 2018-08-01

module.xml

概要

  • 本項では、モジュールメタデータファイル(module.xml)について説明します。

module.xml

  • module.xmlは、ユーザ定義モジュールを作成するために必要なファイルです。
    module.xmlは通常モジュールプロジェクトのルートディレクトリに配置されます。
    module.xml

モジュール・エディタ

  • module.xmlを選択すると、module.xml専用のエディタ「モジュールエディタ」ビューが表示されます。
    各タブの機能について以下に示します。
  • 「概要」タブ
    モジュールのモジュールID・バージョンなどの基本情報を表示します。
    名前・ベンダ・記述はモジュールプロジェクト直下の各ロケールごとのメッセージプロパティファイル上に定義します。
    概要タブ

    注意

    ID(モジュールID)およびショートモジュールIDは、既存モジュールと重複しないようにしてください。
    既存モジュールのモジュール情報を確認するには、「 WARファイルに含まれるモジュール情報・ショートモジュールIDの一覧を確認する方法」を参照してください。
  • 「依存関係」タブ
    モジュールプロジェクトが依存するモジュールを設定します。
    依存関係タブ

    注意

    依存関係には必ず自分自身を除いたモジュールを依存関係として設定してください。

  • 「依存関係の階層」タブ
    「依存関係」タブで設定したモジュールについて、各モジュールの依存関係を階層構造で表示します。
    依存関係の階層タブ
  • 「module.xml」タブ
    <module.xml>ファイルをXMLエディタで表示します。
    module.xmlタブ

依存するモジュールを最新に更新する場合

Jugglingよりwarファイルを再出力するなどでWebアーカイブディレクトリ上のプロジェクトが変更されたとき、依存するモジュールが更新されている場合は初期化を行う必要があります。
「依存関係」タブより「初期化」ボタンを押下し、再度依存関係を設定してください。
依存するモジュールを最新に更新

モジュールのパッチの番号を更新する場合

モジュール・プロジェクトのバージョンは、以下の2つのファイルで管理されています。
モジュール・プロジェクトのバージョンを更新したい場合は、以下の2つのファイルの各version属性を更新する必要があります。
  • プロジェクト直下のmodule.xmlの4行目に記述されている<version>の値
  • プロジェクト直下の.ebuilder-export.xmlの7行目に記述されている<version>の値

module.xml を削除してしまった場合

プロジェクトから module.xml を削除してしまった場合、以下の手順で復旧してください。
  1. プロジェクト直下に「 module.xml 」を作成してください。

  2. module.xmlを開き、「module.xml」タブを表示します。その後、以下のフォーマットの記述を module.xml にコピーしてください。

    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <module xmlns="urn:intramart:jackling:module" xmlns:conf="urn:intramart:jackling:toolkit:configurations" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" conf:schemaLocation="urn:intramart:jackling:toolkit:configurations configurations.xsd" xsi:schemeLocation="urn:intramart:jackling:module module.xsd">
    
    	<id>${group_id}.${artifact_id}</id>
    	<version>${version}</version>
    	<type>module</type>
    
    	<name>${module.name}</name>
    	<vendor>${module.vendor}</vendor>
    	<description>${module.description}</description>
    
    	<!-- 変更を不可とする場合やサードパーティモジュールの場合のみ以下を指定する -->
    	<tags>
    		<tag>immutable</tag>
    		<tag>3rd-party</tag>
    	</tags>
    
    	<dependencies>
    		<dependency>
    		</dependency>
    	</dependencies>
    
    </module>
    
  3. 以下の文字列を、プロジェクト作成時に入力した内容に合わせて記述を行ってください。

${group_id} プロジェクトのグループID
${artifact_id} プロジェクトのショートモジュールID(プロジェクト名)
${version} プロジェクトのバージョン番号