JPiereエンティティの命名規則

　ここではオープンソースのERP iDempiere(アイデンピエレ)の日本商慣習対応ディストリビューションであるJPiere(ジェイピエール)の各種エンティティの命名規則をまとめています。

ページ目次

オープンソース(OSS) ERP Solutions

エンティティタイプ(Entity Type)

　大原則として、JPiereとして追加された各種エンティティのエンティティタイプは"JPiere(定数:JP)"とします。

エンティティタイプ
エンティティタイプ

エレメント(Element)

YES-NOのBoolean

◆Is○○○JP

　最初の２文字が"Is"ではじまるYES(true)-NO(false)のBooleanとして利用するエレメントについては、末尾に"JP"を付けます。これは、今後iDempiereの標準機能として追加される新しいエレメントと名称が重複することを避けるためです。

通常の命名規則

◆JP_○○○○

JPAditionalHeaderLineはエレメントの命名規則の例外です。

テーブル(Table)&ビュー(View)

◆JP_○○○

　JPiereで追加したテーブルは"JP_○○○"とします。これは、今後iDempiereの標準機能として追加される新しいテーブルと名称が重複する事を避けるためです。またＭクラスが重複しないように○○○にも充分配慮する必要があります。

　名称には、はじめに"JP"を入れます。そして説明欄にカスタマイズの管理番号"JPIERE-○○○○"を入れます。翻訳は特に命名規則はありません。

テーブルとビューの設定
テーブルとビューの設定

◆○○_○○○_JP（イレギュラーケース）

　iDempiereの仕様で、定型レポートを作成する場合、頭に"JP"を付したビューでは定型レポートが表示できない事があります。そういう場合は、一番最後に"_JP"と入れるようにします。

テーブル&ビューの設定（イレギュラーケース）
テーブル&ビューの設定（イレギュラーケース）

ウィンドウ(Window)

　ウィンドウの名称は、わかりやすい名称にして下さい。そして説明欄にカスタマイズの管理番号"JPIERE-○○○○"を入力して下さい。

ウィンドウ/タブ/フィールドの設定
ウィンドウ/タブ/フィールドの設定

　翻訳データも同様です。

レポートビュー(Report View)

　レポートビューの名称には、はじめに"JP"を入れます。そして、説明欄にカスタマイズの管理番号"JPIERE-○○○○"を入れます。

レポートビューの設定
レポートビューの設定

レポートとプロセス(Report & Process)

  • 検索キー(Value)…検索キーの最初の3文字は必ず"JP_"にして下さい。その後に続く文字は作成するレポートとプロセスが識別しやすいに適切に設定して下さい。文字と文字との間は"_"でつなげて下さい。英数字を使用するようにして下さい。
  • 名称(Name)…英数字を使用する以外は特に制限はありませんので、わかりやすい名称にして下さい。日本語名称は翻訳タブに入力して下さい。※標準機能で用意されているレポートとプロセスの機能をカスタマイズしJPiereとして別途提供する場合には、もととなるオリジナルの機能と同じ名称で一番最後に"(JPiere)"と入力して下さい。
  • 説明(Description)…カスタマイズの管理番号"JPIERE-○○○○"とJPiereの分類略称4文字を":"で区切って入力して下さい。例)JPIERE-0106:JPBP
  • コメント(help)…レポートとプロセスの説明を入力して下さい。主言語の説明は英語が好ましいですが、日本語でもかまいません。日本語の説明は必ず翻訳タブのコメント欄にも入力して下さい。
レポートとプロセス
レポートとプロセス

フォーム(Form)

　フォームの"名称"は、わかりやすい名称にして下さい。説明欄にカスタマイズの管理番号"JPIERE-○○○○"を入れます。

フォーム設定
フォーム設定

　翻訳データも同様です。

検索ウィンドウ(Info Window)

　検索ウィンドウの"名称"は"○○○Search"にします。そして、説明欄にカスタマイズの管理番号"JPIERE-○○○○"を入れます。

検索ウィンドウの設定
検索ウィンドウの設定

　翻訳データの名称は"○○○検索"にします。説明欄に、カスタマイズの管理番号"JPIERE-0000"を入力するのは主言語と同様です。

ダイナミックバリデーション

　ダイナミックバリデーションの名称のはじめに"JP"を付します。そして説明欄にJPiereのカスタマイズ管理番号を付します。

ダイナミックバリデーションウィンドウ
ダイナミックバリデーションウィンドウ

リファレンス

テーブルバリデーション

　リファレンスのテーブルバリデーションの名称は、"JP "+"テーブル名"+"-適切な説明"にします。そして説明欄にJPiereのカスタマイズ管理番号を付します。

　翻訳は"JP "+"テーブル名"+"(日本語訳テーブル名"+"-適切な説明)"

リストバリデーション

　リファレンスのリストバリデーションの名称には、はじめに"JP "+"-適切な説明"にします。そして説明欄にJPiereのカスタマイズ管理番号を付します。

　翻訳は"JP "+"-英語の適切な説明(+"(日本語の適切な説明)"

印刷書式

印刷書式の設定
印刷書式の設定

一覧レポートの場合、その名称には"チェックリスト"なのか、"詳細レポート"なのか、"合計レポート"なのかわかるようにします。

例

  • ○○○チェックリスト・・・英語の場合は、Check List of ○○○
  • ○○○詳細レポート・・・英語の場合は、Detail of ○○○
  • ○○○合計レポート・・・英語の場合は、Summary of ○○○

マルチラインの印刷書式場合は、その旨がわかるように印刷書式の名称の後ろに(マルチライン）とします。集計行がある場合はその集計キーにあたる項目を同様に(品目別集計)などのように記述します。マルチラインの印刷書式で集計行がある場合は（マルチライン‐品目別集計）などのように"-"で繋ぎます。

 

前のページに戻る