項目ルールを定義する（データ辞書としての利用）

最終更新日: 2020年3月14日
R8 | R9

データ辞書

「データ辞書」とは、開発するアプリケーションが管理するデータの説明文をまとめたものを指します。一般的にはデータの型や有効桁数といった情報を一元的に管理する目的で整備します。入力ルールや説明用の補助情報といったものを含めて管理できれば、なお良いとされています。Wagbyの設計情報（リポジトリ）は、データ辞書そのものです。

「データ辞書」は、データ同士の関連情報を持っています。そのため、例えばモデル項目を削除しようとしたとき、この項目を参照している影響範囲を調べるといったことにも活用できます。

図1 モデル項目削除時の確認ダイアログ（関連する項目を確認できる）

項目ルールを定義する

項目ルールとは

モデル項目に関するいくつかの設定を、複数の項目に同じように設定するというケースを考えてみます。 例えば、次のようなルールです。

Wagbyでは、共通で利用できる設計情報を部品化することができます。これを「項目ルール」と呼びます。
ここでは、定義方法と使い方を説明します。

定義方法

Designerの「項目ルール」タブを選択します。

図2 「項目ルール」タブ

初期状態では、項目ルールはありません。左上のギアアイコンから「新規」を選択します。

図3 新しい項目ルールを作成する

項目ルール設定ダイアログが開きます。

図4 項目ルール設定ダイアログ

「設定名」と「概要」を用意します。設定名は必須項目です。

図5 「設定名」と「概要」を用意する

リポジトリを用意します。「追加」ボタンを押下します。

図6 リポジトリを用意する

モデル項目詳細設定ダイアログのタブ名が「カテゴリ」として選択できます。はじめに、このカテゴリを指定します。

図7 カテゴリを選択する

選択したカテゴリ内に含まれる、リポジトリ一覧が表示されます。設定したいリポジトリを選択してください。

図8 リポジトリ一覧

ワンポイント

すべてのリポジトリは「リポジトリ構造とチーム開発 > リポジトリ一覧をご覧ください。

続いて「設定値」を指定します。リポジトリによって、選択式か、あるいは手動入力となります。

図9 設定値を指定する

一つの項目ルールに、複数のリポジトリ設定を含めることができます。この例では入力フォーマットと出力フォーマットの両方を設定しています。

図10 複数のリポジトリ設定を行う

「保存」ボタンを押下し、この設定を保存します。

図11 保存ボタン

項目ルールを一つ、作成しました。同じ手順で、複数の項目ルールを用意することができます。

図12 作成した項目ルール

優先順位

複数の項目ルールを用意したとき、先頭から順に適用の優先度が高くなっています。同じリポジトリキーに関する設定を含んでいたとき、より上位の項目ルールに含まれているリポジトリ設定が有効になります。

図12で、ドラッグ&ドロップによって項目ルールを並び替えることができます。

項目ルールを使う

モデル項目詳細設定ダイアログの「項目ルール」タブを開きます。用意した項目ルールを適用することができます。

図13 項目ルールタブ

項目ルール名にチェックすることで、適用できます。

図14 適用したい項目ルールを選択する

ワンポイント

一つのモデル項目に、複数の項目ルールを適用することもできます。

設定後、ビルド処理を行ってください。項目ルールが反映されます。

項目ルールの適用状況を確認する

図12で、項目ルール設定タブの「閲覧」ボタンを押下すると、この項目ルールが適用されているモデルおよびモデル項目一覧を表示することができます。これによって、どの項目が適用済みかを把握することができます。

図15 項目ルール適用状況を確認する

項目ルールの内容を変更する

図12で、項目ルール設定タブの「編集」ボタンを押下すると、リポジトリ情報の追加・変更・削除を行うことができます。

図16 リポジトリ情報の編集

編集後、ビルド処理を行ってください。適用されているすべての項目が一斉に変更されます。

名前と型の扱い

モデル項目の一覧で設定する「項目名」「型」「検索（条件に利用する）」「一覧（表示に利用する）」を設定することができます。

図17 基本カテゴリの設定欄

型の設定

型の設定では、次の値を入力することができます。

区分設定できる型入力欄に記載する文字
文字列 文字列 string
郵便番号 string
メールアドレス mailaddress
URL URL
ファイル名 filename
数値 整数 number
1バイト整数 byte
2バイト整数 short
4バイト整数 integer
8バイト整数 long
4バイト浮動小数点 float
8バイト浮動小数点 double
日付・時刻 日付 date
日付と時刻 dateTime
時刻 time
他モデルの項目参照 モデル参照(リストボックス) reference_listbox
モデル参照(ラジオボタン) reference_radiobutton
モデル参照(チェックボックス) reference_checkbox
モデル参照(検索画面) reference_searchWindow
参照連動 reference_lookup
繰り返しコンテナ 繰り返し項目のコンテナ container
繰り返しコンテナID 繰り返し項目コンテナ用のID containerId

型の設定に関する注意点

Designerで型を変更した場合、いくつかの設定は初期状態に戻ります。しかしこの項目ルール設定では、型を変更してもその他の設定は初期状態に戻さず、維持されます。そのため、型の変更に伴い影響のありそうな関連設定は、開発者自身で注意深く見直しを行なってください。

具体的には、型の変更を行なったとき、この項目ルールを適用しているすべての項目について、次の設定をチェックすることを推奨します。

  • 検索画面の範囲検索。（数字型や日付型から文字列型に変更した場合でも、範囲検索の設定は残っている。）
  • 入力チェック。許容文字種を含む。
  • 暗黙条件。
  • 初期値。
  • 日付、数値フォーマット。
  • 入力フィルタ。
  • 主キーの順序設定。
  • 絞り込みの設定。
  • 入力制御。（入力可・不可の式、必須、禁止文字、正規表現など）
  • 計算式。
  • データベースのユニーク制約。
  • ロック名。
  • トランザクション設定。
  • SQL式。

重要

このように型の変更に伴う影響は大きいため、項目ルールにおける型の指定は「将来、変更する可能性」を考えるのではなく、「この型を使っている項目一覧を洗い出す」目的で利用することがよいでしょう。

仕様・制約

  • 項目ルールに関する設定情報は、repository/trunk フォルダ内の .userDefinedItem フォルダに格納されます。
  • モデル項目には model/modelitem/userDefinedItem というリポジトリキーで、どの項目ルールを適用するかという情報を含みます。複数適用時はカンマ区切りとなります。
  • 項目ルールは、モデル項目詳細設定ダイアログで指定可能なリポジトリキーが対象となります。画面、レイアウト、権限、メニュー、環境設定などに関するものを含めることはできません。

関連する機能

変更履歴

  • [FIX1178401] モデル項目の追加を行ったとき、追加したモデル項目に設定していない項目ルールが付与されていた。R8.3.10/R8.5.4で修正した。
  • [FIX1162301] R8.5.0で、Designerから項目ルールの設定タブが不可視となっていた。R8.5.1で修正した。
  • [FIX1131201] R8.3.1まで、項目ルールの設定が反映されないことがあった。R8.3.2で修正した。
  • [FIX1092601] R8.2.xまで、項目ルールの設定欄が数値項目の場合に設定した値が表示されない。R8.3.0で修正した。
  • [FIX1070201] R8.1.xまで、項目ルールの設定値がチェックボックスとなっている場合にチェックを外して保存しても再表示するとチェックが付いた状態で表示されていた。R8.2.0で修正した。
  • [FIX1066901] R8.1.xまで、項目ルールで初期値の自動計算の設定を行なうとビルドエラーが発生する場合があった。R8.2.0で修正した。
  • [FIX1060801] R8.1.1まで、項目ルールは常に最後に設定した内容で表示されていた。R8.1.2で修正した。