クラウドサービス設定 cloud-service-configurations

Last update: Thu Apr 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

トピック：
Developing

作成対象：

Developer

設定は、サービス設定を保存するためのロジックと構造を提供するように設計されています。

既存のインスタンスを拡張して、独自の設定を作成できます。

概念 concepts

設定の開発に使用される原則は、次の概念に基づいています。

サービス/アダプタは、構成を取得するために使用されます。
設定（プロパティや段落など）は、親から継承されます。
Analytics ノードからパス別に参照されます。
容易に拡張可能。
Adobe Analytics など、より複雑な設定に対応できる柔軟性がある。
依存関係のサポート（例： Adobe Analytics プラグインには、 Adobe Analytics 設定）。

構造 structure

設定のベースパスは次のとおりです。

/etc/cloudservices。

設定のタイプごとに、テンプレートとコンポーネントが用意されています。これにより、カスタマイズした後に大部分のニーズを満たすことができる設定テンプレートを使用できます。

新しいサービスの設定を指定するには、次の手順を実行します。

にサービスページを作成します。

/etc/cloudservices
この下で：
- 設定テンプレート
- 設定コンポーネント

テンプレートとコンポーネントは、sling:resourceSuperType をそれぞれ次の場所から継承する必要があります。ベーステンプレート：

cq/cloudserviceconfigs/templates/configpage

ベースコンポーネント：

cq/cloudserviceconfigs/components/configpage

サービスプロバイダーは、サービスページも提供する必要があります。

/etc/cloudservices/<service-name>

テンプレート template

テンプレートによって基本テンプレートが拡張されます。

cq/cloudserviceconfigs/templates/configpage

および定義 resourceType はカスタムコンポーネントを指しています。

/libs/cq/analytics/templates/sitecatalyst
sling:resourceSuperType = cq/cloudserviceconfigs/templates/configpage
allowedChildren = /libs/cq/analytics/templates/sitecatalyst
allowedPaths = /etc/cloudservices/analytics/*, /etc/cloudservices/analytics/.*
componentReference = cq/analytics/components/sitecatalyst
jcr:content/
cq:designPath = /etc/designs/cloudservices
sling:resourceType = cq/analytics/components/sitecatalystpage

/libs/cq/analytics/templates/generictracker
sling:resourceSuperType = cq/cloudservices/templates/configpage
allowedChildren = /libs/cq/analytics/templates/generictracker
allowedPaths = /etc/cloudservices/analytics/*, /etc/cloudservices/analytics/.*
jcr:content/
cq:designPath = /etc/designs/cloudservices
sling:resourceType = cq/analytics/components/generictrackerpage

コンポーネント components

コンポーネントは、次のように基本コンポーネントを拡張する必要があります。

cq/cloudserviceconfigs/templates/configpage

/libs/cq/analytics/components/sitecatalystpage

/libs/cq/analytics/components/generictrackerpage

テンプレートとコンポーネントを設定したら、次の場所の下にサブページを追加して、設定を追加できます。

/etc/cloudservices/<service-name>

コンテンツモデル content-model

コンテンツモデルは、次の場所の下に cq:Page として保存されます。

/etc/cloudservices/<service-name>(/*)

/etc/cloudservices
/etc/cloudservices/service-name
/etc/cloudservices/service-name/config
/etc/cloudservices/service-name/config/inherited-config

設定は、サブノード jcr:content の下に保存されます。

ダイアログで定義される固定プロパティは、jcr:node に直接保存する必要があります。
（parsys または iparsys を使用する）動的要素は、サブノードを使用してコンポーネントデータを保存します。

/etc/cloudservices/service/config/jcr:content as nt:unstructured
propertyname
*
par/component/ as cq:Component
propertyname
*

API api

API に関するリファレンスドキュメントについては、次を参照してください。 com.day.cq.wcm.webservicesupport.

AEM の統合 aem-integration

使用可能なサービスが、（foundation/components/page または wcm/mobile/components/page から継承されたいずれかのページの）ページのプロパティ ダイアログの「クラウドサービス」タブに一覧表示されます。

このタブには次の機能もあります。

サービスを有効にできる場所へのリンク
パスフィールドから設定（サービスのサブノード）を選択

パスワードの暗号化 password-encryption

サービスのユーザー資格情報を保存する場合、すべてのパスワードを暗号化する必要があります。

これを行うには、非表示のフォームフィールドを追加します。このフィールドには、注釈が必要です。 @Encrypted プロパティ名。つまり、 password フィールド名は次のように記述されます。

password@Encrypted

すると、CryptoSupport によって、プロパティが（EncryptionPostProcessor サービスを使用して）自動的に暗号化されます。

NOTE

これは、標準の [SlingPostServlet](https://sling.apache.org/site/manipulating-content-the-slingpostservlet-servletspost.html) アノテーションに似ています。

NOTE

デフォルトでは、EcryptionPostProcessor は、/etc/cloudservices に対する POST リクエストのみを暗号化します。

サービスページの jcr:content ノード用の追加プロパティ additional-properties-for-service-page-jcr-content-nodes

プロパティ

説明

componentReference

ページに自動的に含まれるコンポーネントへの参照パス。
これは、追加機能や JS の包含に使用されます。
このプロパティには、
cq/cloudserviceconfigs/components/servicecomponents
が（通常は body タグの前に）含まれるページ上のコンポーネントが含まれます。
Adobe AnalyticsおよびAdobe Targetの場合、このプロパティを使用して、訪問者の行動を追跡する JavaScript 呼び出しなどの追加機能を含めます。

description

サービスの簡単な説明。

descriptionExtended

サービスの詳細な説明。

ranking

Listings で使用するサービスランキング。

selectableChild

ページプロパティダイアログに設定を表示するためのフィルター。

serviceUrl

サービス web サイトへの URL。

serviceUrlLabel

サービス URL のラベル。

thumbnailPath

サービスのサムネールへのパス。

visible

ページプロパティダイアログでの表示。デフォルトで表示（オプション）

ユースケース use-cases

これらのサービスはデフォルトで提供されます。

Dynamic Media

NOTE

カスタムクラウドサービスの作成も参照してください。

recommendation-more-help

19ffd973-7af2-44d0-84b5-d547b0dffee2