オブジェクトモデルビルダーの使用

Liferay DXP 2023.Q4+/ポータル GA102+

Liferay Objects は、複雑なオブジェクト構造を設計するためのモデル ビルダー GUI を提供します。 このグラフィカル ツールは、各オブジェクト定義をカードとして表示し、オブジェクト定義間の関係を視覚化します。 これを使用すると、オブジェクトアプリケーションでデータモデルを作成、管理、拡張し、定義、フィールド、関連を迅速に構成できます。

モデルビルダービューにアクセスするには、

1. グローバル メニュー () を開き、 コントロール パネル タブに移動して、 オブジェクトをクリックします。

2. 目的の オブジェクト フォルダー に移動し、 モデル ビルダーで表示をクリックします。

   

ここからオブジェクト定義を作成、編集、管理できます。

オブジェクトの作成

1. 目的のオブジェクト フォルダーに移動します。

2. 新しいオブジェクトの作成をクリックします。

   

3. オブジェクトドラフトのこれらの詳細を提供します。

   ［Label］：オブジェクト管理およびサポートされているアプリケーションコンテキスト（ワークフロー、表示ページテンプレート、フォームなど）でオブジェクトを識別します。

   ［Plural Label］：UIでのオブジェクトアプリケーションの表示名を決定します。

   オブジェクト名: オブジェクトの 定義名 を決定します。公開後は変更できません。

4. [保存]をクリックします。

保存すると、ドラフト定義が中央の図領域に表示されます。 これをクリックすると、右側のパネルの設定オプションにアクセスできます。

サイド パネルでは、オブジェクトの詳細を編集したり、統合を有効にしたり、追加機能 (分類、ドラフト モードなど) を設定したりできます。

オブジェクト定義にフィールドとリレーションシップを追加することもできます。 ただし、一部の構成はモデル ビルダー ビューからは追加できません。 検証、 アクション、 ビュー、 レイアウト、および 状態 は、オブジェクトのページ ビューから追加する必要があります。 モデル ビルダー ビューからページ ビューにアクセスするには、オブジェクト カードで [アクション] () → [ページ ビューで編集] をクリックします。

データフィールドの追加

1. オブジェクト定義の フィールドまたはリレーションシップの追加 をクリックします。

2. フィールドの追加を選択します。

   

3. ラベル と フィールド名を入力します。

   ラベル: オブジェクト UI 内のフィールドを識別し、フィールドの作成後にローカライズできます。

   フィールド名: バックエンドでのフィールド名を決定し、キャメルケースを使用します。 フィールドが公開されると、この値は変更できません。

4. フィールドを選択 タイプ。 使用可能なフィールド タイプと構成オプションの詳細については、 フィールド タイプ リファレンス を参照してください。

5. [保存]をクリックします。

フィールドは定義にすぐに追加されます。 デフォルトでは、オブジェクト カードには 5 つのフィールドが表示されますが、 [すべてのフィールドを表示] をクリックすると他のフィールドも表示できます。 さらに、オブジェクト カード内のフィールドを選択して、右側のパネルでその構成オプションにアクセスすることもできます。

関係性の定義

1. オブジェクト定義の フィールドまたはリレーションシップの追加 をクリックします。

2. リレーションシップの追加を選択します。

   

3. ラベル と 名前を入力します。

   ラベル：オブジェクトUIでリレーションシップを識別し、リレーションシップの作成後にローカライズできます。

   名前: バックエンドでの関係の名前を決定し、キャメルケースを使用します。 関連が公開されると、この値は変更できません。

4. 関係 タイプ と、関係のもう一方の側のオブジェクト定義を選択します。 詳細については、 オブジェクト関係の定義 を参照してください。

5. [保存]をクリックします。

保存すると、ダイアグラム領域にオブジェクト定義間の論理接続が視覚化され、1 対多の関係と多対多の関係が区別されます。 リレーションシップ コネクタをクリックすると、右側のパネルにある構成オプションにアクセスします。

他のフォルダー内のオブジェクト定義との関係を定義すると、ダイアグラム領域に破線の境界線が付いたカードが表示されます。 これは関係を視覚化するためだけのものであり、ユーザーにオブジェクト定義を編集する権限を与えるものではありません。 定義を編集するには、オブジェクトのソース フォルダーに移動する必要があります。

オブジェクトの管理

モデル ビルダーのダイアグラム領域でオブジェクト カードをドラッグ アンド ドロップして、視覚的に再編成することができます。 Liferay は位置の更新を自動的に保存します。 さらに、オブジェクト定義をフォルダー間で移動することもできます。

1. 目的の保存先フォルダに移動します。

2. 左側のサイドバーにある別のフォルダのオブジェクトの アクション () をクリックします。

3. 現在のフォルダーに移動を選択します。

   

これにより、定義が現在のフォルダーに移動します。 オブジェクト定義を移動してもその関係には影響せず、組織とオブジェクト管理の改善のみを目的としています。

オブジェクト カードの [アクション] () をクリックすると、追加の管理オプションにアクセスできます。 利用可能なオプションには以下が含まれます

• ページ ビューで編集: デフォルトのオブジェクト UI に切り替えます。
• ERC の編集: オブジェクトの外部参照コード (ERC) を更新します。
• JSON としてエクスポート: JSON オブジェクト定義をダウンロード します。
• 権限の管理: オブジェクト に対してどのロールが操作できるかを決定します。
• オブジェクトの削除: オブジェクト定義を削除します

オブジェクトドラフトの公開

モデル ビルダーを使用すると、個々のオブジェクト定義だけでなく、複数のオブジェクトを含む複雑なデータ モデルも公開できます。

1. オブジェクトの下書きがあるフォルダに移動します。

2. 公開をクリックします。

3. 公開する下書きを選択します。

   

4. 「オブジェクトの公開」をクリックします。

選択された下書きは同時に公開を開始します。

モデルビルダーの可用性

モデルビルダーは、Liferay DXP 2023.Q4/Portal GA102 で リリース機能フラグ の背後でリリースされました。 2024.Q1/GA112 に一般提供 (GA) されました。

関連トピック

• オブジェクトの作成
• オブジェクトへのフィールドの追加
• オブジェクトリレーションの定義