エンティティの編集

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

注意

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

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

基本操作

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

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

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

その他の操作

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

いずれの場合も、エンティティIDを入力した後、下記の手順に従って設定を進めてください。

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

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

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

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

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

説明を変更する

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

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

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

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

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

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

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

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

辞書項目を追加する

［エンティティ項目編集］をクリックします。
└ 「辞書項目/エイリアス検索」画面が表示されます。
使用したい辞書項目を選択します。
└ 「選択済み項目」に辞書項目が追加されます。
［決定］をクリックします。
└ 「エンティティ項目」に辞書項目が追加されます。
└ 必要に応じて、主キー・必須設定を行ってください。

その他の操作

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

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

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

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

その他の操作

エンティティ項目の詳細を確認したい場合は、［］をクリックしてください。
└ 「エンティティ項目詳細」ダイアログが表示されます。
エンティティ項目を削除したい場合は、［］をクリックしてください。
└ 「削除確認」ダイアログから、［決定］をクリックしてください。
サブエンティティの情報を確認したい場合は、エンティティ項目名のリンクをクリックしてください。
└ 対象のエンティティ情報の詳細に切り替わります。

注意

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

データ定義を削除する

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

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

データ定義を追加する

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

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

操作手順の詳細は、下記「 「データ定義」ダイアログの操作（追加）」を参照してください。

「データ定義」ダイアログの操作（追加）

「データ定義」ダイアログのウィザード表示に従って、操作を進めていきます。

1 テーブルの設定
2 テーブル定義の設定
3 検索条件の設定
4 楽観的排他制御の設定
5 追加内容確認

エンティティに紐づけるテーブルを設定します。

テナントデータベースを利用する場合：

テナントデータベースでは、intra-mart Accel Platformのテナント内で利用するデータを保存します。

(1) 既存のテーブルを利用する場合は、チェックを入れます。

(2) 「データベース種別」で「テナントデータベース」を選択します。

(3) 「テーブル名」を設定します。
└ 新規でテーブルを作成する場合は、テーブル名を入力します。
└ 既存のテーブルを利用する場合は、［▼］をクリックしてテーブルを選択します。

(4) ［次へ］をクリックします。
└ 「2 テーブル定義の設定」の画面が表示されます。

シェアードデータベースを利用する場合：

シェアードデータベースでは、intra-mart Accel Platform外のデータを保存します。外部システムと連携したい場合に利用するデータベースです。

(1) 「データベース種別」で「シェアードデータベース」を選択します。
└ 「接続ID」の項目が表示されます。

(2) 「接続ID」でデータベースの接続IDを選択します。

(3) 「テーブル名」を入力します。

(4) ［次へ］をクリックします。
└ 「2 テーブル定義の設定」の画面が表示されます。

コラム

新規でテーブルを作成する場合に、テーブル名で使用できる文字は、以下のとおりです。
　【半角英数字】　a b c d e... 0 1 2 3 4 5...
　【半角記号】　_
先頭文字に使用できるのは、半角英字のみです。

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

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

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

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

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

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

応用操作

エンティティの編集では、用途に応じて、次のような応用操作が可能です。基本的な操作とあわせて確認してみましょう。

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

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

メモ

多くの業界では、データ操作の記録保持が法的に義務付けられている場合があります。操作ログを適切に管理することで、コンプライアンス要件を満たし、法的リスクの軽減にもつながります。

ログ出力設定を有効にする

「エンティティ」画面の「データ定義」タブからログ出力設定を変更できます。

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

その他の操作

ログ出力設定は、下記「エンティティ操作ログ一覧」画面からも行うことが可能です。この画面を利用すると、複数のエンティティに対して一括で設定ができるため、効率的に操作ログを管理できます。

エンティティの操作ログを確認する

［］をクリックします。
└ サイトマップが表示されます。
「Repository」内にある［エンティティ操作ログ一覧］をクリックします。
ログを確認したいエンティティを選択します。
ログ内容を確認します。
└ 出力される項目は以下のとおりです。

更新日時：ログの更新日時
リクエストID
操作：INSERT, UPDATE, DELETEのいずれかが表示
更新ユーザコード：エンティティを更新したユーザを表示
エンティティデータ：主キーを表示

その他の操作

操作ログをエクスポートしたい場合は、［エクスポート］をクリックしてください。
└ 「im-repository-{エンティティID}.json」ファイルが、お使いのPCの「ダウンロード」フォルダに保存されます。

エンティティの編集