エンティティの編集

ここでは、作成済みのエンティティを後から編集する方法について説明します。

注意

アプリケーションの開発が進行している段階でエンティティを編集する場合は、影響範囲やテーブル定義との関係性に十分注意しながら作業を行ってください。特に、主キーやデータ型の変更、エンティティ間の関連設定などは、画面やロジックなどに影響を与える可能性があります。

画面変数にエンティティを利用している場合は、IM-Repositoryでエンティティを編集した後、IM-BloomMakerの画面変数に変更内容を反映してください。詳細は「画面変数の設定 - 応用操作 > データ定義の変更を反映する」を参照してください。

メモ

ここでは、メインエンティティとサブエンティティが存在する構成を前提とし、主にメインエンティティを編集する手順について説明します。データ構成の詳細は、「想定するデータ構成」を参照してください。なお、メインエンティティとサブエンティティの基本的な編集手順は共通ですが、「関連項目の編集」はメインエンティティ側で行います。サブエンティティ側では参照のみとなりますので、注意してください。

基本操作

作成済みのエンティティ定義を編集する場合は、変更が必要な項目を選び、それぞれ適切に修正してください。

編集したいエンティティ定義をクリックします。
└ 「エンティティ」画面が表示されます。
対象のタブをクリックして、編集内容に応じた情報を表示します。
└ 「エンティティ」タブ：エンティティ情報を表示
└ 「関連一覧」タブ：メイン・サブエンティティの関連項目を一覧表示
└ 「データ定義」タブ：テーブル情報および定義情報を表示

各タブで必要な編集を行います。
└ 操作手順の詳細は、下記の各項目を参照してください。

その他の操作

新しくエンティティを作成したい場合は、カテゴリを選択した後、［エンティティ新規作成］をクリックしてください。
既存のエンティティをコピーして作成したい場合は、エンティティを選択した後、［エンティティコピー作成］をクリックしてください。

各手順の詳細は、「エンティティの追加（新規作成）」を参照してください。

エンティティ情報を編集する

「エンティティ」タブを開くとエンティティ情報が表示されます。ここでは、必要に応じて各項目を編集できます。ただし、エンティティIDは一度設定すると変更できません。変更が必要な場合は、新しくエンティティを作成し直してください。

エンティティ名を変更する

「エンティティ名」にある「標準」の欄に変更したい名称を入力します。

多言語の名称を追加・変更したい場合：
［］をクリックすると、入力欄が表示されます。

説明を変更する

「説明」にある「標準」の欄に変更したい文章を入力します。

多言語の説明を追加・変更したい場合：
［］をクリックすると、入力欄が表示されます。

エンティティの有効・無効を切り替える

エンティティは、初期状態で「有効」に設定されています。有効にすると、アプリケーション内でエンティティが利用でき、さらに他のアプリケーションからも定義を追加できます。

必要に応じて特定のエンティティを無効にしたい場合は、「エンティティの有効化」のチェックを外してください。無効にすると、他のアプリケーションから定義を追加できません。

エンティティ項目を編集する

エンティティ定義を新規作成すると、まず設定された辞書項目がエンティティ項目として登録され、その内容に基づいてテーブル構造（カラム）が確定します。

辞書項目の追加やエンティティ項目の主キー・必須設定の変更をしたい場合は、以下の手順を行ってください。

辞書項目を追加する

［エンティティ項目編集］をクリックします。
└ 「辞書項目/エイリアス検索」画面が表示されます。
使用したい辞書項目を選択します。
└ 「選択済み項目」に辞書項目が追加されます。
［決定］をクリックします。
└ 「確定確認」ダイアログで［決定］をクリックします。
└ 「エンティティ項目」に辞書項目が追加されます。

その他の操作

エンティティ間で同じ名前や属性を持つ項目が複数ある場合は、「重複しているエンティティ項目のみを表示する」にチェックを入れると、該当項目だけに絞って表示できます。

主キー・必須の設定を変更する

「主キー」欄では、テーブル内で各レコードを識別する項目にチェックを入れます。

「必須」欄では、レコード登録時に必ず値を入力しなければならない項目にチェックを入れます。

エンティティ項目の詳細を確認する

確認したい項目にある［］をクリックします。
└ 「エンティティ項目詳細」ダイアログが表示されます。
［基本］タブをクリックします。
└ ID・種別・名前などの基本情報が表示されます。
［データ］タブをクリックします。
└ 各データのデータ型や変数名などが表示されます。

エンティティ項目を削除する

削除したい項目にある［］をクリックします。
└ 「削除確認」ダイアログで［決定］をクリックします。

その他の操作

メインエンティティにサブエンティティを紐づけている場合、エンティティ項目の一覧にサブエンティティが表示されます。サブエンティティの情報を確認したい場合は、エンティティ項目名のリンクをクリックしてください。サブエンティティ情報の詳細画面に切り替わります。

注意

エンティティ項目を変更すると、対応するデータ定義（テーブル）との間に差分が発生します。そのため、変更後はデータ定義を修正する必要があります。詳細は、下記「データ定義を編集する」を参照してください。

データ定義を編集する

「データ定義」タブをクリックすると、「テーブル情報」および「定義情報」が表示されます。「テーブル情報」には、「エンティティと辞書項目の設定」で設定したデータベース種別やテーブル名が表示されます。また、「定義情報」には、エンティティ項目に対応するテーブル情報が表示されます。

エンティティ定義とテーブルの情報の一致状況について、次のいずれかのメッセージが表示されます。

エンティティとテーブルの情報は一致しています。（緑色の表示）
エンティティとテーブルの情報が一致していません。差分を確認してください。（黄色の表示）

エンティティに紐づいている状態で辞書項目を編集すると、エンティティ項目に影響し、テーブル定義との間に差分が発生します。

差分がある場合、「テーブル定義」に相違箇所が色分けで表示されます。赤色は削除や差分のある項目、緑色は更新された項目を示しています。

たとえば、辞書項目で「資産管理番号」の最大桁数を「500」→「50」に変更した場合、エンティティ項目は「50」ですが、テーブルカラムは「500」という状態になります。テーブルカラムは自動更新されないため、エンティティ項目とテーブルカラムとの間に差分が生じます。

「差分」列には差異の理由が表示されるため、その内容を確認し、テーブル定義の情報を更新します。

参考

辞書項目の編集については、「辞書項目の編集 > データを編集する」を参照してください。

エンティティ操作ログを設定する

エンティティ定義を編集する際は、同時にエンティティ操作ログも設定しておくことをおすすめします。操作ログを有効にしておくことで、データの追加・更新・削除などの操作履歴を記録でき、エラー発生時の原因調査や対応にも役立ちます。

ログを有効にしたい場合は、トグルをオンに切り替えます。
└ トグルが緑色になれば、ログ出力が有効な状態です。

その他の操作

ログ出力設定は、「エンティティ操作ログ一覧」画面からも行うことが可能です。この画面を利用すると、複数のエンティティに対して一括で設定ができるため、効率的に操作ログを管理できます。詳細は「エンティティ操作ログの確認 > ログ出力設定を変更する」を参照してください。

定義情報を編集する

テーブル定義などの定義情報を編集したい場合は、以下の手順を行ってください。

［編集］をクリックします。
└ 「データ定義」ダイアログが表示されます。
定義情報を編集します。
└ 下記「 「データ定義」ダイアログの操作（編集）」を参照してください。

「データ定義」ダイアログの操作（編集）
「データ定義」ダイアログのウィザード表示に従って、操作を進めていきます。
1 テーブル定義の設定
2 検索条件の設定
3 楽観的排他制御の設定
4 更新内容確認
テーブルのカラム設定を確認し、差分を反映します。
(1) 差分を反映したい場合は、「適用」にチェックを入れます。
└ 更新時に項目の変更がテーブルのカラムに反映されます。
└ 差分を反映せず、エンティティ項目を修正したい場合は、上記「エンティティ項目を編集する」を参照してください。
(2) ［次へ］をクリックします。
└ 「2 検索条件の設定」の画面が表示されます。
その他の操作
データ定義で設定されているテーブルとは別のテーブルから値を参照したい場合は、［参照項目設定を追加］をクリックしてください。
参照先として設定できるのは、以下の3種類です。

同じデータベース内にある他のエンティティ

同じデータベース内にあるテーブル

intra-mart Accel Platformの共通マスタ

たとえば、エンティティ項目の「所有組織」や「所有者」を共通マスタから参照させたい場合は、これらを参照項目として設定します。参照項目に変更すると、通常のエンティティ項目（単純な文字列や数値項目）としては扱われなくなり、別エンティティとの関連（リレーション）を持つ項目として登録されます。
参照項目の設定により、値を直接入力するのではなく、参照先エンティティのデータを選択して保持する形式になります。マスタデータと整合性を保ちたい場合や、共通データを複数のエンティティで利用したい場合に有効です。詳細は「IM-Repository ユーザ操作ガイド - 7.6.4. 参照項目設定」を参照してください。

データ定義を削除する

データ定義を見直す必要がある場合などは、古いデータ定義を削除してから新しい定義を作成します。テーブルやカラムが不要になった場合は、データベースから削除することも可能です。

［削除］をクリックします。
└ 「削除確認」ダイアログが表示されます。
必要に応じて、「データベースからテーブルを削除する」にチェックを入れます。
［決定］をクリックします。
└ データ定義が削除されます。

データ定義を再設定する

データ定義を削除して、新しい定義を再設定します。

［データ定義の追加］をクリックします。
└ 「データ定義」ダイアログが表示されます。
定義情報を再設定します。

参考

データ定義の再設定手順について、詳細は「エンティティの追加（新規作成） > データ定義を新規作成する」を参照してください。

影響範囲を適用する（設定を保存する）

エンティティの編集が終了した後は、必ず影響範囲を確認してください。影響範囲の確認を行わないと、変更内容が保存されません。

［影響範囲確認］をクリックします。
└ 「影響範囲」画面が表示されます。
変更による影響範囲を確認します。
「コメント」に変更理由を入力します。
└ 必ず入力してください。

［適用］をクリックします。
└ 「適用確認」ダイアログで［決定］をクリックします。
└ 「タスク一覧」画面が表示されます。
［閉じる］をクリックします。
└ 「アプリケーション管理」画面が表示されます。

エラーメッセージが表示された場合
［影響範囲確認］をクリックしても「影響範囲」画面に遷移しない場合は、画面に表示されているエラーメッセージを確認してください。以下は、代表的なエラーメッセージと対処方法について記載しています。
エラーメッセージ一覧と対処方法
エラーメッセージ原因対処方法
エンティティ更新の前処理に失敗しました。 エンティティの更新処理時に問題が発生している更新対象のデータに不整合がないか確認してください。必須項目の未入力、データ型の誤り、参照整合性の不一致などが原因となる場合があります。
適用に失敗しました。 データ定義の適用処理中に問題が発生しているあわせて表示されているエラーメッセージの内容を確認し、原因に応じて対応してください。
カラムの追加に失敗しました。 データ定義の適用処理中に、新しいカラムの追加に失敗している該当のテーブルに同名のカラムが存在していないか確認してください。また、カラムの定義（データ型・長さ・制約など）が正しいか確認してください。

エンティティの編集