サポート > リポジトリ > メッセージの変更・国際化 > リソースファイルの編集

ja | en

標準のリソースファイルを編集する方法を説明します。画面のメッセージやエラーメッセージを変更することができます。

設計情報に含まれる「項目名」などの文字は、すべて「リソースファイル」に格納されています。代表的なリソースファイルを表に示します。

ファイル名説明
errormsgconv_ja.properties データベース固有のエラーメッセージを変換します。
errormsg_ja.properties Wagbyが内部で管理するエラーメッセージです。
jfcapp_ja.properties アプリケーション全体のメッセージです。
logcode_ja.properties system.logに出力するメッセージです。

これらのファイルは次のように管理されています。

アプリケーションメッセージ

wagbydesigner/bin/template フォルダに含まれている jfcapp_ja.properties.UTF8 というファイルです。拡張子からわかるように UTF-8 形式のテキストファイルとなっています。

このファイルを土台として、設計情報で用意した項目名がリソースに追加されます。これは wagbydesigner/webapps/wagbydesigner/WEB-INF/env/work/srcgen/webpage/WEB-INF/classes/jfcapp_ja.properties.UTF8 というファイルになります。

エラーメッセージ

wagbydesigner/bin/webpage/WEB-INF/src フォルダに含まれている errormsg_ja.properties.UTF8 というファイルです。拡張子からわかるように UTF-8 形式のテキストファイルとなっています。

最終的なリソースファイル

ビルドされた wagbyapp フォルダ内の WEB-INF/classes フォルダに用意されます。拡張子 UTF8 が除かれた、".properties" ファイルが最終形式です。上記の「テンプレート」に、アプリケーション固有の情報が加わったものとなっています。

ファイル名に "_ja" が付与されているものが日本語リソースです。"_en"など、その他のファイルは「国際化」のページで説明します。
これらのファイルは直接、テキストエディタで変更することはありません。次節以降に説明する方法で書き換えます。

リソースファイルはテキストファイルです。内部は key-value 形式になっています。

wagbydesigner/webapps/wagbydesigner/WEB-INF/env/work/srcgen/webpage/WEB-INF/classes/jfcapp_ja.properties.UTF8 ファイルの一部を抜粋します。

__jfc_common.logon.title=ログオン
__jfc_common.logon.userid=ユーザ名
__jfc_common.logon.password=パスワード
__jfc_common.logon.submit=ログオン
__jfc_common.logon.message={0} さんがログオンしています。
__jfc_common.logon.language=言語:
__jfc_common.logon.class.waku=frmLogon
__jfc_common.logon.class.logonbutton=btnLogon
__jfc_common.logon.display.mobile=表示:モバイル
__jfc_common.search.notfound=検索条件に合致したデータは見つかりませんでした。
__jfc_common.search.action=検索条件を入力してください。

ファイル内の 1 行は「キー=メッセージ」というペアで表現されます。キーの部分(「=」の左側)を変更することはできません。

メッセージ部では「プレースホルダ」を使うことができます。これは {0}, {1} という表記です。実際にはこの部分に適切な文字が設定されます。

  1. wagbyapp/webapps/wagby/WEB-INF/classes/jfcapp_ja.properties.UTF8 をテキストエディタで開きます。(Windowsに付属の「メモ帳」は使いません。TeraPad など別のテキストエディタをご用意ください。)
  2. リソースファイルの値部分(イコールの右側)を変更します。
    ...
    qa_report.title=タイトル
    ...
    
    リソースファイルのキー部分(上記では "qa_report.title" の部分)は変更してはいけません。
  3. 編集したファイルを customize/resources フォルダに保存します。これによって次回以降のビルド時に、今回編集したファイルが用いられるようになります。

この方法はファイルの置き換えになりますが、非推奨です。このあとの説明にある「差分ファイルの作成」までお読みください。

リソースファイルの置き換え方式とは別に、差分ファイルを作成する方法を提供しています。差分ファイルとして個別に管理した場合でも、ビルド時にマージ(結合)され、一つの .properties ファイルとしてまとめられます。

  1. jfcapp_ja.properties.UTF8 ファイルに対して、接頭語 "my" をつけたファイルである myjfcapp_ja.properties.UTF8 ファイルを新規に作成します。ファイルの中身は空です。このファイルを customize/resources フォルダに保存します。
  2. my ではじまるファイルを編集します。このとき、元々あったメッセージと同じ行を記述することで、置き換えることができます。例えば次の行を加えることで、もともと "ログオフ" だったメッセージを書き換えます。
    __jfc_common.globallink.logoff=ログオフ!
    
  3. ビルド時にマージ(結合)されます。
この "my" をつけたファイルの拡張は、すべてのリソースファイルに対応しています。カスタマイズしたい部分のみを管理することができます。

差分ファイル方式を推奨します

jfcapp_ja.properties.UTF8 は「システムが標準で提供するリソース」と「開発者が追加したモデルに関するリソース」が一つになっています。このファイルを直接、編集すると、Wagbyのバージョンアップ時にシステムが提供するリソースが追加・変更された場合、開発者が手動で修正する必要が生じます。

この手間を省略するため、myjfcapp_ja.properties.UTF8 ファイルを作成することを推奨します。開発者が追加したモデルに関するリソースを、このmyファイルに分離して管理します。

標準で提供される文言を変更する場合も、このmyファイルに記述するとよいです。myファイルに記述したリソースが、標準のリソースを上書きします。

myerrormsg_ja.properties.UTF8 を用意します。例えば model1 モデルの新規登録が成功した場合のメッセージを変更したい場合、次のように記述します。

model1.success.normal.termination.insert={0}データを登録しました!

{0}には、モデル名(日本語)が入ります。

このファイルを customize/resources フォルダに保存し、再ビルドしてください。

ja | en