Documentation

スコープ設定

Liferay DXPでは、アプリケーションの構成をさまざまなレベルのスコープ(システム、インスタンス、サイト、またはポートレット)に設定できます。 たとえば、インスタンススコープ構成のアプリケーションを作成する場合、Liferay DXPのインストールでセットアップしたインスタンスごとにアプリケーションを個別に構成できます。 これは、各ユーザーに柔軟性とコントロールを提供するため、便利です。 たとえば、DXPインスタンスの管理者は、他のインスタンスから独立した独自のインスタンスの構成を設定できます。

スコープの詳細については、 構成スコープについて を参照してください。

インスタンススコープ構成の例を確認するには、 構成の設定とアクセス のポートレットの例を参照してください。

ポートレットスコープの構成は異なるアプローチを取ることに注意してください。 詳細については、 ポートレットレベルの設定 を参照してください。

構成インターフェイスでスコープを指定する

構成のスコープを設定するには、構成インターフェイスでスコープを指定します。 @ExtendedObjectClassDefinitionアノテーションを使用して、スコープを設定します。 システムスコープの場合はScope.SYSTEMを使用します。 インスタンススコープの場合はScope.COMPANYを使用します。 サイトスコープの場合はScope.GROUPを使用します。

@ExtendedObjectClassDefinition(
	category = "n2f3", scope = ExtendedObjectClassDefinition.Scope.COMPANY
)

構成プロバイダーを使用する

構成を取得するには、ConfigurationProviderを使用します。 構成プロバイダーAPIは、構成にアクセスする簡単な方法を提供します。 アプリケーションのニーズに合わせて特定の方法を選択してください。

  • getSystemConfiguration():システムスコープの構成を取得します。 アプリケーションのシステムレベルの構成は、 [コントロールパネル] → [設定] → [システム設定] にあります。

  • getCompanyConfiguration():インスタンススコープの構成を取得します。 Portalのインスタンスを使用してcompanyIdを取得します。 たとえば、_portal.getCompanyId(renderRequest)となります。 アプリケーションのインスタンスレベルの構成は、 [コントロールパネル] → [設定] → [Instance Settings] にあります。

  • getGroupConfiguration():サイトスコープの構成を取得します。 Portalのインスタンスを使用してgroupIdを取得します。 たとえば、_portal.getScopeGroupId(renderRequest)となります。 アプリケーションのサイトレベルの構成は、 [コントロールパネル] → [設定] → [サイト設定] にあります。 これは Liferay 7.4で利用できることに注意してください。

ポートレットスコープの構成については、 ポートレットレベルの設定 を参照してください。