intra-mart Accel Platform セットアップガイド 第29版 2019-08-01

アップデート時に IM-Juggling で必要なメンテナンス作業

アップデート版を適用前に環境を構築している場合、次の作業が必要です。
アップデート前のバージョン別に必要な作業が異なります。

注意

たとえば、アップデート前のバージョンが 2012 Winter(Bourbon)、 アップデート後のバージョンが 2013 Winter(Felicia) の場合、以下のとおり各アップデートの作業が必要です。
  • 「2012 Winter(Bourbon) からアップデート」
  • 「2013 Summer(Damask) からアップデート」
  • 「2013 Autumn(Eden) からアップデート」

項目

2012 Winter(Bourbon) からアップデート

【IM-Workflowを利用している場合】

サーバコンテキスト設定の ベースURL 設定

「conf/server-context-config.xml」のベースURL(base-url)を設定してください。
ベースURL が設定されていない場合、メール定義 および IMBox定義 の置換文字列 「IM_URL」 / 「Matter_Detail_URL」 の置換が行われません。
ベースURLの設定については「ベースURL 」を参照してください。
仕様の詳細については、「 IM-Workflow 仕様書 」を参照してください。

2013 Summer(Damask) からアップデート

【暗号化設定 (cryption-config.xml) を出力している場合】

暗号化設定ファイルの移動

IM-Juggling 内の「ProjectNavigator」-対象プロジェクトより、「conf/cryption-config」フォルダを作成し、「conf/cryption-config.xml」ファイルを、「conf/cryption-config」配下に移動してください。

【IMBoxを利用している場合】

  • IMBox設定 (imbox-config.xml) を出力している場合
    IM-Juggling 内の「ProjectNavigator」-対象プロジェクトより、下記の設定ファイルを削除してください。
    「conf/imbox-config.xml」内の設定値を変更されていた場合は、変更内容のバックアップを行ってください。
    • conf/imbox-config.xml
    • schema/imbox-config.xsd
    最新の設定ファイルを出力するため、 IM-Juggling 内の「設定ファイル」タブを選択してください。
    さらに一覧より「IMBox」-「IMBox設定」を選択した状態で右側の「出力」ボタンを押下すると、新たに上記の2ファイルが出力されます。

    変更内容がある場合には、バックアップから変更された項目ごとに修正を行ってください。

2013 Autumn(Eden) からアップデート

【IMBoxを利用している場合】

  • IMBox設定 (imbox-config.xml) を出力している場合
    IM-Juggling 内の「ProjectNavigator」-対象プロジェクトより、下記の設定ファイルを削除してください。
    「conf/imbox-config.xml」内の設定値を変更されていた場合は、変更内容のバックアップを行ってください。
    • conf/imbox-config.xml
    • schema/imbox-config.xsd
    最新の設定ファイルを出力するため、 IM-Juggling 内の「設定ファイル」タブを選択してください。
    さらに一覧より「IMBox」-「IMBox設定」を選択した状態で右側の「出力」ボタンを押下すると、新たに上記の2ファイルが出力されます。

    変更内容がある場合には、バックアップから変更された項目ごとに修正を行ってください。

2013 Winter(Felicia) からアップデート

【IMBoxを利用している場合】

  • IMBox設定 (imbox-config.xml) を出力している場合
    IM-Juggling 内の「ProjectNavigator」-対象プロジェクトより、下記の設定ファイルを削除してください。
    「conf/imbox-config.xml」内の設定値を変更されていた場合は、変更内容のバックアップを行ってください。
    • conf/imbox-config.xml
    • schema/imbox-config.xsd
    最新の設定ファイルを出力するため、 IM-Juggling 内の「設定ファイル」タブを選択してください。
    さらに一覧より「IMBox」-「IMBox設定」を選択した状態で右側の「出力」ボタンを押下すると、新たに上記の2ファイルが出力されます。

    変更内容がある場合には、バックアップから変更された項目ごとに修正を行ってください。
  • Cassandraサーバ接続設定(cassandra-config.xml)の使用用途が変更されました。
    cassandra-config.xmlの変更点に関する詳細は、「intra-mart Accel Platform 2014 Spring(Granada)からの変更点 」を参照してください。
    使用用途変更に伴い、テナント環境セットアップ時にCassandra接続情報の登録が必要です。
    Cassandra接続情報の登録に関する詳細は、「Apache Cassandra接続情報 」を参照してください。

2014 Summer(Honoka) からアップデート

【 TERASOLUNA Global Framework を利用している場合】

applicationContext-im_tgfw_common.xmlの編集

  • 2014 Winter(Iceberg) で以下の項目を変更しています。
    • IM-Juggling 内の「ProjectNavigator」-対象プロジェクトより、< classes/META-INF/spring/applicationContext-im_tgfw_common.xml >
      の設定を、下記を参考に修正します。
      exceptionCodeResolverのexceptionMappingsを修正します。
          <!-- Exception Code Resolver. -->
          <bean id="exceptionCodeResolver"
              class="org.terasoluna.gfw.common.exception.SimpleMappingExceptionCodeResolver">
              <!-- Setting and Customization by project. -->
              <property name="exceptionMappings">
                  <map>
                      <entry key="ResourceNotFoundException" value="w.im.fw.0001" />
                      <entry key="InvalidTransactionTokenException" value="w.im.fw.0004" />
                      <entry key="InvalidSecureTokenException" value="w.im.fw.0005" />
                      <entry key="BusinessException" value="w.im.fw.0002" />
                  </map>
              </property>
              <property name="defaultExceptionCode" value="e.im.fw.0001" />
          </bean>
      

applicationContext-im_tgfw_web.xmlの編集

  • 2014 Winter(Iceberg) で以下の項目を追加、変更しています。
    • IM-Juggling 内の「ProjectNavigator」-対象プロジェクトより、< classes/META-INF/spring/applicationContext-im_tgfw_web.xml >
      の設定を、下記を参考に修正します。
      mvc:annotation-drivenにmessage converterの設定を追加します。
         <!-- support for annotation-driven MVC controllers -->
         <mvc:annotation-driven conversion-service="conversionService">
           <!-- transaction token -->
           <mvc:argument-resolvers>
               <bean class="org.terasoluna.gfw.web.token.transaction.TransactionTokenContextHandlerMethodArgumentResolver" />
           </mvc:argument-resolvers>
           <!-- jackson message converter -->
           <mvc:message-converters register-defaults="true">
               <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
                   <property name="objectMapper">
                       <bean class="jp.co.intra_mart.framework.extension.spring.http.converter.json.AccountDateObjectMapper" />
                   </property>
               </bean>
           </mvc:message-converters>
         </mvc:annotation-driven>
      
      beans要素直下の任意の場所に、secureTokenValidatorのbean定義を追記します。
      <!-- secure token validator -->
      <bean id="secureTokenValidator" class="jp.co.intra_mart.framework.extension.spring.web.csrf.SecureTokenValidator" />
      
      SystemExceptionResolverのbean定義にsecureTokenErrorの設定を追加します。
         <!-- Setting Exception Handling. -->
         <!-- Exception Resolver. -->
         <bean class="org.terasoluna.gfw.web.exception.SystemExceptionResolver">
           <property name="exceptionCodeResolver" ref="exceptionCodeResolver" />
           <!-- Setting and Customization by project. -->
           <property name="order" value="3" />
           <property name="exceptionMappings">
               <map>
                   <entry key="ResourceNotFoundException" value="im_tgfw/common/error/resourceNotFoundError.jsp" />
                   <entry key="BusinessException" value="im_tgfw/common/error/businessError.jsp" />
                   <entry key="InvalidTransactionTokenException" value="im_tgfw/common/error/transactionTokenError.jsp" />
                   <entry key="InvalidSecureTokenException" value="im_tgfw/common/error/secureTokenError.jsp" />
               </map>
           </property>
           <property name="statusCodes">
               <map>
                   <entry key="im_tgfw/common/error/resourceNotFoundError" value="404" />
                   <entry key="im_tgfw/common/error/businessError" value="200" />
                   <entry key="im_tgfw/common/error/transactionTokenError" value="409" />
                   <entry key="im_tgfw/common/error/secureTokenError" value="403" />
               </map>
           </property>
           <property name="defaultErrorView" value="im_tgfw/common/error/systemError.jsp" />
           <property name="defaultStatusCode" value="500" />
         </bean>
      

2014 Winter(Iceberg) からアップデート

【 TERASOLUNA Global Framework を利用している場合】

2015 Spring(Juno) では、TERASOLUNA Global Framework から TERASOLUNA Server Framework for Java (5.x) へ変わります。それにあわせてモジュールと設定ファイルを入れ替えます。
  • IM-Juggling でのモジュール、設定修正
    IM-Juggling 内の「ProjectNavigator」-対象プロジェクトより、下記の操作を行ってください。
    applicationContext-im_tgfw_common.xml、applicationContext-im_tgfw_web.xmlを変更している場合は、変更内容のバックアップを行ってください。
    ../../../_images/8_0_9_tgfw_backup_files.png
    1. モジュールの削除
      アップデートの適用の実行前に以下のモジュールのチェックを外してください
      • TERASOLUNA Global Framework JPA module
        「ライブラリ - サードパーティ製ライブラリ」内にあります。
      • TERASOLUNA Global Framework MyBatis module
        「ライブラリ - サードパーティ製ライブラリ」内にあります。
      • TERASOLUNA Global Framework JPA module for AccelPlatform
        「開発フレームワーク - TERASOLUNA Global Framework on AccelPlatform」内にあります。
      • TERASOLUNA Global Framework MyBatis module for AccellPlatform
        「開発フレームワーク - TERASOLUNA Global Framework on AccelPlatform」内にあります。
      ../../../_images/8_0_9_tgfw_clear_module_1.png
      ../../../_images/8_0_9_tgfw_clear_module_2.png
    2. アップデートの適用
      「現行の環境にアップデートを適用します」を押下します。
      ../../../_images/8_0_9_tgfw_update_button.png
      上記のモジュールのチェックを外していない状態でアップデートを行いますと、以下の様なエラーメッセージが表示されます。
      チェックを外してからアップデートを行ってください。
      ../../../_images/8_0_9_tgfw_error_example.png
    3. モジュール、設定ファイルの更新
      • 設定ファイルの削除
        IM-Juggling 内の「ProjectNavigator」-対象プロジェクトから以下のファイルを削除します。
        • classes/META-INF/spring/applicationContext-im_tgfw_common.xml
          内容を変更している場合はバックアップを取ってください。
        • classes/META-INF/spring/applicationContext-im_tgfw_web.xml
          内容を変更している場合はバックアップを取ってください。
        • classes/META-INF/spring/applicationContext-jpa.xml
        • classes/META-INF/spring/applicationContext-mybatis.xml
        • classes/META-INF/mybatis/config/sqlMapConfig.xml
        ../../../_images/8_0_9_tgfw_delete_files.png
      • リソースの追加
        「追加リソースの選択」を押下します。
        ../../../_images/8_0_9_tgfw_append_resources_button.png
        「TERASOLUNA Server Framework for Java (5.x) 設定ファイル」と「TERASOLUNA Server Framework for Java (5.x) for MyBatis3設定ファイル」にチェックを入れます。
        ../../../_images/8_0_9_tgfw_append_resources_selection.png
        以下の4ファイルが追加されます。
        • classes/META-INF/spring/applicationContext-im_tgfw_common.xml
          設定を変更していた場合には、変更内容にあわせて修正してください。
        • classes/META-INF/spring/applicationContext-im_tgfw_web.xml
          設定を変更していた場合には、変更内容にあわせて修正してください。
        • classes/META-INF/spring/applicationContext-im_tgfw_mybatis3.xml
        • classes/META-INF/mybatis/mybatis-config.xml
        ../../../_images/8_0_9_tgfw_created_files.png
      • モジュールの追加
        以下のモジュールにチェックを入れてください。
        • TERASOLUNA Server Framework for Java (5.x) for MyBatis module for Accel Platform
          「開発フレームワーク - TERASOLUNA Server Framework for Java (5.x) for Accel Platform」内にあります。
        ../../../_images/8_0_9_tgfw_append_module_1.png
        「モジュールが不足しています。」のメッセージをクリックし、依存関係を解決します。
        ../../../_images/8_0_9_tgfw_resolve_dependency.png
        warを作成する準備ができました。
        ../../../_images/8_0_9_tgfw_append_module_2.png

2017 Summer(Quadra) からアップデート

【IM共通マスタ-設定ファイル (im-master-config.xml) を出力している場合】

IM-Juggling 内の「ProjectNavigator」-対象プロジェクトより、下記の設定ファイルを削除してください。
「conf/im-master-config.xml」内の設定値を変更されていた場合は、変更内容のバックアップを行ってください。
  • conf/im-master-config.xml
  • schema/im-master-config.xml.xsd
最新の設定ファイルを出力するため、 IM-Juggling 内の「設定ファイル」タブを選択してください。
さらに一覧より「IM-共通マスタ」-「IM-共通マスタ設定」を選択した状態で右側の「出力」ボタンを押下すると、新たに上記の2ファイルが出力されます。

変更内容がある場合には、バックアップから変更された項目ごとに修正を行ってください。

2017 Winter(Rebecca) からアップデート

【国際化機能-数値フォーマットマスタ (im-decimal-format-config.xml) を出力している場合】

2018 Spring(Skylark) より、 国際化機能-数値フォーマットマスタに csjs-path 属性が追加されました。
この属性はクライアントサイドJavaScriptのパスを指定します。指定されたパスは ImDecimalFormatter で変換する処理に利用されます。
詳細は 数値形式マスタ を参照してください。
以下の手順に従い、この属性を設定ファイルに追加してください。
IM-Juggling 内の「ProjectNavigator」-対象プロジェクトより、下記の設定ファイルを削除してください。
「conf/decimal-format-config/im-decimal-format-config.xml」内の設定値を変更されていた場合は、変更内容のバックアップを行ってください。
  • conf/decimal-format-config/im-decimal-format-config.xml
  • schema/decimal-format-config.xsd
最新の設定ファイルを出力するため、 IM-Juggling 内の「設定ファイル」タブを選択してください。
さらに一覧より「国際化機能」-「数値フォーマットマスタ」を選択した状態で右側の「出力」ボタンを押下すると、新たに上記の2ファイルが出力されます。

変更内容がある場合には、バックアップから変更された項目ごとに修正を行ってください。

コラム

csjs-path 属性は、 2018 Spring(Skylark) より追加された clientDecimalFormatScript タグを利用した場合にのみ、変換処理に利用されます。
そのため、この属性を指定しても指定していなくても、既存の機能に影響はありません。
開発者がクライアントサイドで変換処理が行いたいことを考慮し、製品の標準のパスを設定しておくことを推奨します。

2018 Spring(Skylark) からアップデート

スマートフォンテーマモジュールの選択

2018 Summer(Tiffany) より、スマートフォンテーマに「スマートフォン標準テーマ (白)」が追加されました。
2018 Summer(Tiffany) 時点でのスマートフォンテーマモジュールは以下の通りです。
  • 「intra-mart Accel Platform」-「画面テーマ」-「intra-mart Accel Platform スマートフォン標準テーマ」-「intra-mart Accel Platform スマートフォン標準テーマ (黒)」
  • 「intra-mart Accel Platform」-「画面テーマ」-「intra-mart Accel Platform スマートフォン標準テーマ」-「intra-mart Accel Platform スマートフォン標準テーマ (白)」
「intra-mart Accel Platform スマートフォン標準テーマ (黒)」は、intra-mart Accel Platform リリース時から存在するスマートフォンテーマです。
「intra-mart Accel Platform スマートフォン標準テーマ (白)」は、2018 Summer(Tiffany) より追加されたスマートフォンテーマです。
アップデートを行ったプロジェクトの juggling.im の上部にスマートフォンテーマが選択されていない旨のエラーメッセージが表示されている場合、スマートフォンテーマモジュールを1つ以上選択してください。

2018 Winter(Urara) からアップデート

メールモジュールでメール送信の日本語で使用するキャラクタセットのデフォルト値設定

2019 Spring(Violette) より メールモジュールのメール送信の日本語で使用するキャラクタセットのデフォルト値が “iso-2022-jp” から “UTF-8” に、ボディエンコード設定のデフォルト値が “7bit” から “base64” に変更されました。
「conf/javamail-config/javamail-config_ja.xml」 を出力していない場合は、デフォルトで “UTF-8” が利用されます。
“iso-2022-jp” を利用したい場合は、以下の手順に従い、設定ファイルを編集してください。
なお「conf/javamail-config/javamail-config_ja.xml」 が既に出力されている場合には、その設定が利用されます。
  • IM-Juggling 内の「設定ファイル」タブを選択してください。
  • さらに一覧より「メールモジュール」-「メール送信:多言語設定(ja)(/javamail-config/javamail-config_ja.xml)」を選択した状態で右側の「出力」ボタンをクリックしてください。
  • 出力されたファイル「javamail-config_ja.xml」のキャラクタセットの値を編集してください。

【IM-Spreadsheetを利用している場合】

2019 Spring(Violette)よりIM-Spreadsheetで利用しているSpreadJSのバージョンがV12Jに変更されました。
IM-Spreadsheet 8.0.2以前のバージョンのユーザモジュールを追加している場合はSpreadJSライセンスの新しいライセンスキーを設定ファイル(spreadsheet-config.xml)に設定する必要があります。
詳細は「 IM-Spreadsheet 利用ガイド 」 - 「 アップデート・パッチの適用 」を参照してください。

2019 Spring(Violette) からアップデート

【 TERASOLUNA Server Framework for Java (5.x) を利用している場合】

2019 Summer(Waltz) では、Dozerのバージョンアップによりパッケージ名が変わりました。
それに伴い、以下の修正が必要です。
  1. Bean定義ファイル
    IM-Juggling 内の「ProjectNavigator」-対象プロジェクトより、 < classes/META-INF/spring/applicationContext-im_tgfw_common.xml > の設定のうちDozerBeanMapperFactoryBeanのパッケージを修正します。
    <!-- dozer setting -->
    <bean class="com.github.dozermapper.spring.DozerBeanMapperFactoryBean">
        <property name="mappingFiles" value="classpath*:/META-INF/dozer/**/*-mapping.xml" />
    </bean>
    
  2. Javaファイル
    import宣言を修正します。以下はMapperクラスの例です。
    • 修正前

      import org.dozer.Mapper;
      
    • 修正後

    import com.github.dozermapper.core.Mapper;
    
2019 Summer(Waltz) では、Dozerのバージョンアップによりマッピング定義XMLファイルのXMLスキーマURLが変更されました。
それに伴い、以下の通りマッピング定義XMLファイルを修正します。

注意

intra-mart Accel Platform では配置していません。マッピング定義XMLファイルを作成した場合のみ修正が必要です。

  • 修正前
<?xml version="1.0" encoding="UTF-8"?>
<mappings xmlns="http://dozer.sourceforge.net"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://dozer.sourceforge.net http://dozer.sourceforge.net/schema/beanmapping.xsd">
  • 修正後
<?xml version="1.0" encoding="UTF-8"?>
<mappings xmlns="http://dozermapper.github.io/schema/bean-mapping"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://dozermapper.github.io/schema/bean-mapping https://dozermapper.github.io/schema/bean-mapping.xsd">

コラム

TERASOLUNAの機能を利用している環境のアップデートについては、 TERASOLUNA移行ガイド を参考に修正してください。

コラム

TERASOLUNA 5.5.1 では Hibernate Validator 6.0.14 を使用していますが、 intra-mart Accel Platform では Hibernate Validator 5.2.4を使用しています。
また、TERASOLUNA 5.5.1 では Bean Validation 2.0 を使用していますが、 intra-mart Accel Platform ではBean Validation 1.1 を使用しています。