この記事では、IM-Repositoryの辞書項目について、用途に応じた設定方法を紹介します。
辞書項目では、アプリケーションで扱う用語と、そのデータ型や制約などの情報を定義します。定義した辞書項目は、エンティティや画面など、さまざまな機能で利用できます。また、辞書項目には、値を特定の選択肢に限定したり、入力できる値に条件を設定したり、既存の辞書項目を別名で利用したりする機能があります。
ここでは、辞書項目を利用する際に知っておきたい「列挙型」「制約」「エイリアス」の使い分けについて確認していきましょう。
辞書項目とは
辞書項目は、データベースにおけるカラムに相当するものです。データベースにおけるカラムとは、テーブル内でデータの特定の属性を表す縦の列を指します。 各カラムは特定のデータ型を持ち、テーブル内の各レコード（横の行）に一貫したデータを格納します。IM-Repositoryで辞書項目を設定することで、テーブルのカラムを作成・管理できます。
辞書項目を設定する際は、データ型を適切に定義することが重要です。たとえば、数値データには数値型を、テキストデータには文字列型を指定します。データ型を正しく設定することで、エンティティを設定する際に、データベースのテーブルを適切に作成・管理できます。辞書項目とエンティティの関係についても押さえておきましょう。
辞書項目の設定一覧
辞書項目の設定に関する項目の一覧を確認できます。設定した辞書項目は、ツリー形式やリスト形式で表示できます。
IM-Repository ユーザ操作ガイド – 5. 辞書項目
用途に合わせた辞書項目の設定
辞書項目は、アプリケーションでデータをどのように利用するかに応じて設定を追加できます。たとえば、以下のように使い分けます。
- 列挙型：あらかじめ決められた選択肢から値を選ばせたい場合
- 制約：入力できる値や形式などに条件を設定したい場合
- エイリアス：既存の辞書項目を別の名前で利用したい場合
ここでは、それぞれの設定方法と使いどころを紹介します。
辞書項目を列挙型として利用する
辞書項目の値をあらかじめ決められた選択肢に限定したい場合は、列挙型を利用します。列挙型とは、ラベル（表示名）とvalue（データベースに登録される値）を含むデータ型のことです。
たとえば、プルダウンメニューのように、選択肢から値を選択するUIを作成する場合に利用できます。辞書項目に列挙型を紐づけると、列挙型に定義した値を定数として利用できます。そのため、画面のプルダウンなどの選択肢として利用しやすくなります。
列挙型を利用する場合は、まず列挙情報を登録し、その後、辞書項目で列挙型を指定します。辞書項目に列挙型を指定すると、辞書項目に設定していた制約は、列挙型に定義した値に上書きされます。
列挙型の作成
列挙型を作成する際は、登録先のカテゴリを決めておきます。既存のカテゴリを利用するか、新しいカテゴリを作成するかを検討しておきましょう。
IM-Repository ユーザ操作ガイド - 6.3.1. 列挙を新規登録する
辞書項目に制約を設定する
辞書項目に入力できる値や形式などの条件を設定したい場合は、制約を利用します。
たとえば、以下のような条件を設定できます。
- 入力する値を制限する：桁数、バイト数、数値、アルファベットなど
- 入力する形式を指定する：メールアドレス、URLなど
- 特定の条件を指定する：日付時刻、ID、ユーザコードなど
たとえば、電話番号の最大桁数を10桁に設定すると、10桁を超える値を登録できないようにできます。このように、入力値に対するチェック（バリデーション）を辞書項目に設定できます。
制約には、あらかじめ用意された設定項目だけでなく、正規表現を利用して独自の条件を設定することもできます。
制約の種類と設定
辞書項目に対する制約の種類と設定項目について確認できます。制約は複数設定することが可能です。
IM-Repository ユーザ操作ガイド - 5.5. 辞書項目の制約
辞書項目を使ってエイリアスを作成する
既存の辞書項目を別の名前で利用したい場合は、エイリアスを作成します。エイリアスとは、既存の辞書項目を参照しながら、別の名前を付けて利用する機能です。
たとえば、「ID」という辞書項目を、特定のアプリケーションでは「ユーザID」という名前で利用したい場合などに使用できます。エイリアスを利用すると、参照先の辞書項目と同じデータ型や制約などの設定を引き継いだまま、用途に合わせた名前で利用できます。
作成したエイリアスは、参照先の辞書項目の設定画面に「エイリアス一覧」として表示されます。
エイリアスの作成
エイリアスIDは一意である必要があります。同じ辞書項目内でエイリアスIDが重複しないように注意してください。
IM-Repository ユーザ操作ガイド - 5.4.1. エイリアスを新規登録する
まとめ
IM-Repositoryでは、辞書項目の用途に応じてさまざまな設定を追加できます。あらかじめ値を限定したい場合は「列挙型」、入力できる値や形式を制限したい場合は「制約」、作成済みの辞書項目を別の名前で利用したい場合は「エイリアス」を使用します。用途に応じて設定を使い分けることで、アプリケーションで利用するデータを適切に管理できます。
intra-martでは、IM-Repositoryや各ローコード開発ツールを使ったアプリケーションの開発に役立つコンテンツなどを豊富にご用意しています。intra-martの機能を最大限に発揮させるためにも、ぜひご活用ください。