システムの文言変更に関する設定(custom-resources.xml)

SmartDBシステムで表示される文言の一部をSmartDBサーバ管理者がカスタマイズすることができます。変更するには以下のファイルを使用します。

  • プロパティファイル
  • ファイルパス ：
    /etc/hibiki/ custom-resources/

  • ファイル名 ：
    [任意のファイル名].properties
    [任意のファイル名]_en.properties

  • 設定ファイル

  • ファイルパス： /etc/hibiki/
  • ファイル名 ： custom-resources.xml

文言の変更手順

SmartDBに表示される文言にはそれぞれ固有の「キー」が存在しています。それらのキーに対して新しい文言を設定したプロパティファイルを作成し、設定ファイルで適用することによって文言を変更することができます。

1 プロパティファイルの作成

プロパティファイルは、言語設定に合わせてそれぞれ/etc/hibiki/custom-resources/配下に以下のように作成します。以下のファイル名の太字部分は変更可能ですが共通である必要があります。
CustomResources.properties → SmartDB日本語版の表示を変更
CustomResources_en.properties → SmartDB英語版の表示を変更

プロパティファイルには以下のように記述します。

文言のキー=任意の文字列

※「' （シングルクォーテーション）」「” （ダブルクォーテーション）」等の特殊文字列は使用できません。
※ CustomResources_en.propertiesに記述する場合、文字列は全て半角英数字である必要があります。

  • 設定例
category.1002.name=人事部・総務部
category.1003.name=営業部

2 設定ファイルの編集

作成したプロパティファイルを適用するには、設定ファイル「custom-resources.xml」を編集してプロパティファイルの“bundle”属性、“filename”属性を設定します。
# vi /etc/hibiki/custom-resources.xml

表 プロパティファイル適用時の設定

要素 custom-resources
属性 “bundle”属性 “filename”属性 説明
リソースバンドル 作成したファイル名 プロパティファイルの文言をシステムに適用
記述例 <custom-resources base="/etc/hibiki/custom-resources">
  <message-resources bundle="IMP" filename="IMPCustomResources"/>
</custom-resources>

3 文字コードの確認

IMPのプロパティファイルの文字コードは「UTF-8」である必要があります。それ以外の文字コードでは表示の文字化けなどが生じますのでご注意ください。

fileコマンドで文字コードを確認する事が可能です。

# file CustomResources.properties
CustomResources.properties: UTF-8 Unicode text

※SmartDB Ver.4.5 以降、プロパティファイルに「UTF-8エンコード」がそのまま利用できるようになりました。 過去のバージョンで、プロパティファイルの文字コードを「ASCII」に変換している場合は、「UTF-8」へ変換してください。 下記は、Java8 が/opt/jdk18/として残っている場合の例です。

# /opt/jdk18/bin/native2ascii -reverse CustomResources.properties CustomResources.properties

または、 

# /opt/jdk18/bin/native2ascii -reverse -encoding UTF-8 CustomResources.properties CustomResources.properties

4 SmartDB AP サーバの再起動

上記設定後、SmartDB APサーバの再起動を行います。

# service tomcat stop
# service tomcat start

IMPサイドメニューのカテゴリ名とカテゴリアイコンの変更

IMPトップページのサイドメニューにあるアプリのカテゴリ名とカテゴリアイコンを任意に変更することが可能です。

※ カテゴリ数を増減させることはできません。

1 IMPのプロパティファイル作成

SmartDB APサーバにログインし、プロパティファイルを作成/編集します。

# vi /etc/hibiki/custom-resources/IMPCustomResources.properties

カテゴリ名の変更

プロパティファイルにカテゴリ名のキーおよび新しく表示する文言を設定します。カテゴリ名のキー、初期値はそれぞれ以下になります。

表 カテゴリ名のキーと初期値

番号 キー 初期値(日本語) 初期値(英語)
① category.1001.name 業務一般 General Task
② category.1002.name 人事・総務 Human Resource
③ category.1003.name 営業業務 Sales
④ category.1004.name 申請・承認 Submission
⑤ category.1005.name データベース Database
⑥ category.1006.name 各種掲示板 Bulletins
⑦ category.1007.name その他 Other

カテゴリアイコンの変更

カテゴリアイコンを変更するにはプロパティファイルにカテゴリアイコンのキー、新しいアイコンの画像ファイルへのパスもしくはURLを設定する必要があります。

※ 使用可能な画像ファイルの拡張子は、「jpg」,「jpeg」,「gif」,「bmp」,「png」です。
※ 使用する画像のサイズは、３０px×３０pxの正方形サイズを推奨します。

カテゴリアイコンのキー、初期設定はそれぞれ以下になります。

表 カテゴリアイコンのキーと初期設定

番号 キー アイコンの初期設定
① category.1001.icon
② category.1002.icon
③ category.1003.icon
④ category.1004.icon
⑤ category.1005.icon
⑥ category.1006.icon
⑦ category.1007.icon

■ ファイルパスで指定

以下のサーバ・ディレクトリ配下にカテゴリアイコンの画像ファイルを配置します。

  • 配置先サーバ
    INSUITE® AP サーバもしくはファイルサーバ

  • 配置先ディレクトリ
    /home/DreamArts/share/insuite/配下

プロパティファイルに以下のように記述します。

カテゴリアイコンのキー=/[/home/DreamArts/share/insuite/配下から画像ファイルへのパス]

※ ファイルパスの文字列の先頭に「/」を指定すると、自動的に/home/DreamArts/share/insuite/配下が参照されますので、それ以降のパスを指定してください。また、/home/DreamArts/share/insuite/部分のパスは変更できません。

  • /home/DreamArts/share/insuite/custom/hibiki/sdb/images配下のimage.pngを適用する設定例

category.1002.icon=/custom/hibiki/sdb/images/image.png

■ URLで指定

プロパティファイルに以下のように記述します。
カテゴリアイコンのキー=画像ファイルの配置先URL

  • 設定例
    category.1002.icon=http://smartdb.dreamarts.co.jp/images/image.png

2 文字コードの確認

IMPのプロパティファイルの文字コードは「UTF-8」である必要があります。それ以外の文字コードでは表示の文字化けなどが生じますのでご注意ください。

fileコマンドで文字コードを確認する事が可能です。

# file IMPCustomResources.properties
IMPCustomResources.properties: UTF-8 Unicode text

※SmartDB Ver.4.5 以降、プロパティファイルに「UTF-8エンコード」がそのまま利用できるようになりました。 過去のバージョンで、プロパティファイルの文字コードを「ASCII」に変換している場合は、「UTF-8」へ変換してください。 下記は、Java8 が/opt/jdk18/として残っている場合の例です。

# /opt/jdk18/bin/native2ascii -reverse IMPCustomResources.properties IMPCustomResources.properties

または、 

# /opt/jdk18/bin/native2ascii -reverse -encoding UTF-8 IMPCustomResources.properties IMPCustomResources.properties

3 設定ファイルcustom-resources.xmlの編集

設定ファイルを編集し、上記手順で作成したプロパティファイルを適用します。

表 IMPプロパティファイル適用時の設定

要素 custom-resources
属性 “bundle”属性 “filename”属性 説明
IMP IMPCustomResources
※作成したファイル名		 IMPプロパティファイルに設定した文言をシステムに適用
記述例 <custom-resources base="/etc/hibiki/custom-resources">
  <message-resources bundle="IMP" filename="IMPCustomResources"/>
</custom-resources>