SAP Commerce Cloud を使用した開発 developing-with-sap-commerce-cloud
統合フレームワークには、API を備えた統合レイヤーが含まれます。 次の操作が可能です。
- e コマースシステムをプラグインし、製品データをAEMに取り込む
- 特定の e コマースエンジンに依存しない、コマース機能用のAEMコンポーネントの作成
この統合レイヤーを使用するために、すぐに使える AEM コンポーネントが多数用意されています。現在、次のものがあります。
- 製品表示コンポーネント
- 買い物かご
- チェックアウト
検索には、AEM検索、e コマースシステムの検索、サードパーティ検索またはその組み合わせを使用できる統合フックが提供されます。
e コマースエンジンの選択 ecommerce-engine-selection
e コマースフレームワークは任意の e コマースソリューションと組み合わせて使用できますが、使用されるエンジンは AEM によって識別できる必要があります。
-
e コマースエンジンは、
CommerceServiceインターフェイスをサポートする OSGi サービスです。- エンジンは、
commerceProviderサービスプロパティによって区別できます。
- エンジンは、
-
AEM では、
CommerceServiceとProductに対してResource.adaptTo()をサポートしています。-
adaptTo実装は、リソースの階層内でcq:commerceProviderプロパティを探します。- 見つかった場合、値は、コマースサービス参照のフィルターに使用されます。
- 見つからない場合は、最上位のコマースサービスが使用されます。
-
厳密に型指定されたリソースに
cq:commerceProviderを追加できるように、cq:CommerceMixin が使用されます。
-
-
適切なコマースファクトリ定義を参照するために、
cq:commerceProviderプロパティも使用されます。-
例えば、
cq:commerceProviderという値を持つhybrisプロパティは、向け Day CQ コマースファクトリ（com.adobe.cq.commerce.hybris.impl.HybrisServiceFactory）の OSGi 設定に関連付けられます（ここでも、commerceProviderパラメーターの値はhybrishybris となります）。 -
ここで、カタログバージョン など、さらに別のプロパティを設定できます（適切かつ使用可能な場合）。
-
以下の例を参照してください。
cq:commerceProvider = geometrixxcq:commerceProvider = hybris例 example
/content/store
+ cq:commerceProvider = hybris
+ mens
+ polo-shirt-1
+ polo-shirt-2
+ employee
+ cq:commerceProvider = jcr
+ adobe-logo-shirt
+ cq:commerceType = product
+ price = 12.50
+ adobe-logo-shirt_S
+ cq:commerceType = variant
+ size = S
+ adobe-logo-shirt_XL
+ cq:commerceType = variant
+ size = XL
+ price = 14.50
/apps/geometrixx-outdoors/components/hybris/product/product.jsphybris 4 向けの開発 developing-for-hybris
e コマース統合フレームワークの Hybris 拡張が更新されて、Hybris 4 との下位互換性を保ちながら、Hybris 5 がサポートされるようになりました。
コード内のデフォルト設定は、Hybris 5 向けに調整されています。
Hybris 4 向けの開発には、以下が必要です。
-
Maven を呼び出す場合は、次のコマンドライン引数をコマンドに追加します。
-P hybris4事前設定済みの Hybris 4 配布物がダウンロードされ、バンドルに埋め込まれます。
code language-none cq-commerce-hybris-server -
OSGi 設定マネージャーで、
- Default Response Parser サービスの Hybris 5 サポートを無効にします。
- Hybris Basic Authentication Handler サービスのサービスランクが Hybris OAuth Handler サービスよりも低いことを確認します。
セッション処理 session-handling
hybris は、ユーザーセッションを使用して、顧客の買い物かごなどの情報を保存します。 hybris はセッション ID を JSESSIONID cookie に返し、以降の hybris への要求ではこの cookie を送信する必要があります。セッション ID をリポジトリに保存しないように、セッション ID は買い物客のブラウザーに保存される別の cookie にエンコードされます。 次の手順を実行します。
- 最初のリクエストでは、買い物客のリクエストに Cookie が設定されません。したがって、hybris インスタンスにリクエストが送信され、セッションが作成されます。
- その応答からセッション cookie が抽出され、新しい cookie 内でエンコードされ（例えば
hybris-session-rest）、買い物客への応答に設定されます。元の cookie は特定のパスに対してのみ有効で、それ以外の場合は後続のリクエストでブラウザーから返送されないので、新しい cookie でのエンコードが必要です。 また、パス情報を Cookie の値に追加する必要があります。 - 以降のリクエストでは、これらの Cookie が
hybris-session-<*xxx*>Cookie からデコードされ、hybris のデータを要求するための HTTP クライアントに設定されます。
CommerceSession commercesession
-
このセッションは、 買い物かご を「所有」しています
-
追加や削除などを実行します。
-
買い物かごについての様々な計算を実行します。
commerceSession.getProductPrice(Product product)
-
-
注文 データの保存場所を管理します 。
CommerceSession.getUserContext() -
また、 支払い 処理接続
-
また、 達成 接続
製品の同期と公開 product-synchronization-and-publishing
hybris で管理される製品データは、AEMで使用できる必要があります。 次のメカニズムが実装されました。
- ID の最初の読み込みは、hybris によってフィードとして提供されます。 このフィードは更新される場合があります。
- hybris は、(AEMがポーリングする ) フィードを介して更新情報を提供します。
- AEMが製品データを使用している場合、現在のデータのリクエストを hybris に送り返します（最終変更日を使用した条件付き取得リクエスト）。
- hybris 上では、宣言的な方法でフィードの内容を指定できます。
- フィード構造とAEMコンテンツモデルのマッピングは、AEM側のフィードアダプターでおこなわれます。
-
インポーター (b) は、カタログ用のAEMのページツリー構造の初期設定に使用されます。
-
hybris でのカタログの変更は、フィードを介してAEMに示され、その後AEMに反映されます (b)
- カタログバージョンに関して追加、削除、変更された製品です。
- 製品が承認されました。
-
hybris 拡張機能は、ポーリングインポーター（「hybris」スキーム）を提供します。このインポーターは、指定した間隔（例えば、24 時間ごとに間隔が秒単位で指定される）でAEMに変更をインポートするように設定できます。
code language-none http://localhost:4502/content/geometrixx-outdoors/en_US/jcr:content.json { * "jcr:mixinTypes": ["cq:PollConfig"], * "enabled": true, * "source": "hybris:outdoors", * "jcr:primaryType": "cq:PageContent", * "interval": 86400 } -
AEM のカタログ構成は、ステージング済み カタログバージョンと オンライン カタログバージョンを認識します。
-
カタログバージョン間で製品を同期するには、対応するAEMページ (a、c) のアクティベートを（解除）する必要があります
- 製品の オンライン カタログバージョンでは、製品のページをアクティベートする必要があります。
- 製品を削除するには、アクティベートを解除する必要があります。
-
AEMでページをアクティベートする場合 © にはチェック (b) が必要で、次の場合にのみ可能です。
- 製品が、製品ページの オンライン カタログバージョン内にある
- 参照される製品が、他のページ（キャンペーンページなど）の オンライン カタログバージョン内で利用できる
-
アクティベートされた製品ページは、製品データの オンライン バージョンにアクセスする必要があります（d）。
-
AEMパブリッシュインスタンスは、製品とパーソナライズされたデータ (d) を取得するために、hybris へのアクセス権が必要です。
アーキテクチャ architecture
製品とバリアントのアーキテクチャ architecture-of-product-and-variants
1 つの製品に複数のバリエーションを含めることができます。例えば、色やサイズによって異なる場合があります。 製品では、バリエーションを構成するプロパティを定義する必要があります。このようなプロパティを バリアント軸 と呼びます。
ただし、すべてのプロパティがバリアント軸であるわけではありません。 バリエーションは他のプロパティにも影響を与えます。例えば、価格はサイズに依存する場合があります。 買い物客はこれらのプロパティを選択できないので、バリアント軸とは見なされません。
各製品やバリアントはリソースで表されるので、1:1 がリポジトリノードにマッピングされます。 特定の製品やバリアントをそのパスで一意に識別できるのも当然です。
製品/バリアントリソースは、必ずしも実際の製品データを保持するわけではありません。これは、別のシステム（hybris など）で実際に保持されているデータを表したものである可能性があります。 例えば、製品の説明や価格などは AEM には格納されておらず、e コマースエンジンからリアルタイムで取得されます。
すべての製品リソースは、Product API で表現できます。製品 API の呼び出しのほとんどはバリエーションごとに固有ですが（ただし、バリエーションは 1 つのオリジナルから共有される値を継承する場合があります）、一連のバリエーションを一覧で表示する呼び出しもあります（getVariantAxes() や getVariants() など）。
Product.getVariantAxes() の戻り値で決定されます。- hybris は hybris 実装用に定義します。
-
size -
さらにもう 1 つ
この追加バリアントは、製品リファレンスの
variationAxisプロパティ（Geometrixx Outdoors の場合、通常はcolor）を使用して選択されます。
製品の参照と製品データ product-references-and-product-data
一般に、
-
製品データは
/etcの配下に配置され、 -
製品リファレンスは
/contentの配下に配置されます。
製品バリエーションと製品データノードの間には 1 対 1 のマッピングが必要です。
製品リファレンスには、各バリエーションを表すノードも必要ですが、すべてのバリエーションを表す必要はありません。例えば、製品に S、M、L のバリエーションがある場合、製品データは次のようになります。
etc
commerce
products
shirt
shirt-s
shirt-m
shirt-l
「Big and Tall」カタログには次のバリエーションだけが含まれます。
content
big-and-tall
shirt
shirt-l
最後に、製品データを使用するための要件はありません。すべての製品データをカタログ内のリファレンスの配下に配置できますが、実際には、すべての製品データを複製せずに複数のカタログを用意することはできません。
API
com.adobe.cq.commerce.api.Product インターフェイス com-adobe-cq-commerce-api-product-interface
public interface Product extends Adaptable {
public String getPath(); // path to specific variation
public String getPagePath(); // path to presentation page for all variations
public String getSKU(); // unique ID of specific variation
public String getTitle(); // shortcut to getProperty(TITLE)
public String getDescription(); // shortcut to getProperty(DESCRIPTION)
public String getImageUrl(); // shortcut to getProperty(IMAGE_URL)
public String getThumbnailUrl(); // shortcut to getProperty(THUMBNAIL_URL)
public <T> T getProperty(String name, Class<T> type);
public Iterator<String> getVariantAxes();
public boolean axisIsVariant(String axis);
public Iterator<Product> getVariants(VariantFilter filter) throws CommerceException;
}
com.adobe.cq.commerce.api.VariantFilter com-adobe-cq-commerce-api-variantfilter
/**
* Interface for filtering variants and AxisFilter provided as common implementation
*
* The <code>VariantFilter</code> is used to filter variants,
* e.g. when using {@link Product#getVariants(VariantFilter filter)}.
*/
public interface VariantFilter {
public boolean includes(Product product);
}
/**
* A {@link VariantFilter} for filtering variants by the given
* axis and value. The following example returns a list of
* variant products that have a value of <i>blue</i> on the
* <i>color</i> axis.
*
* <p>
* <code>product.getVariants(new AxisFilter("color", "blue"));</code>
*/
public class AxisFilter implements VariantFilter {
private String axis;
private String value;
public AxisFilter(String axis, String value) {
this.axis = axis;
this.value = value;
}
/**
* {@inheritDoc}
*/
public boolean includes(Product product) {
ValueMap values = product.adaptTo(ValueMap.class);
if(values != null) {
String v = values.get(axis, String.class);
return v != null && v == value;
}
return false;
}
}
-
一般的なストレージメカニズム
-
製品ノードは nt:unstructured です。
-
製品ノードは、次のいずれかになります。
-
参照。製品データは別の場所に保存されます。
- 製品リファレンスには、
productDataプロパティが含まれます。このプロパティは、製品データ（一般的には/etc/commerce/productsの下にあります）を指します。 - 製品データは階層的です。製品属性は、製品データノードの上位ノードから継承されます。
- また、製品の参照には、ローカルのプロパティを含めることもできます。このプロパティは、製品データで指定されたプロパティを上書きします。
- 製品リファレンスには、
-
製品自体：
productDataプロパティはありません。- すべてのプロパティをローカルに格納する product ノード（productData プロパティを含まない）は、独自の上位ノードから製品属性を直接継承します。
-
-
-
AEM-generic 製品構造
- 各バリアントには、独自のリーフノードが必要です。
- 製品インターフェイスは製品とバリアントの両方を表しますが、関連するリポジトリノードは、それがどれであるかに固有です。
- product ノードは、製品の属性とバリアント軸を表します。
例 example-1
+ banyan_shirt
- cq:commerceType = product
- cq:productAttributes = [jcr:title, jcr:description, size, price, color]
- cq:productVariantAxes = [color, size]
- jcr:title = Banyan Shirt
- jcr:description = Flowery, all-cotton shirt.
- price = 14.00
+ banyan_shirt_s
- cq:commerceType = variant
- size = S
+ banyan_shirt_s_red
- cq:commerceType = variant
- color = red
+ banyan_shirt_s_blue
- cq:commerceType = variant
- color = blue
+ banyan_shirt_m
- cq:commerceType = variant
- size = M
+ banyan_shirt_m_red
- cq:commerceType = variant
- color = red
+ banyan_shirt_m_blue
- cq:commerceType = variant
- color = blue
+ banyan_shirt_l
- cq:commerceType = variant
- size = L
+ banyan_shirt_l_red
- cq:commerceType = variant
- color = red
+ banyan_shirt_l_blue
- cq:commerceType = variant
- color = blue
+ banyan_shirt_xl
- cq:commerceType = variant
- size = XL
- price = 18.00
買い物かごのアーキテクチャ architecture-of-the-shopping-cart
コンポーネント
-
買い物かごは、
CommerceSession:によって管理されます。CommerceSessionは、追加や削除などを実行します。CommerceSessionは、買い物かごに対する様々な計算も実行します。
-
買い物かごに直接関連はしませんが、
CommerceSessionはカタログの価格情報も提供する必要があります（価格を管理しているので）。-
価格には、次の複数の修飾子があります。
- 数量割引。
- 様々な通貨。
- VAT 対応および VAT 対応です。
-
修飾子は、次のインターフェイスを使用して完全にオープンエンドになります。
int CommerceSession.getQuantityBreakpoints(Product product)String CommerceSession.getProductPrice(Product product)
-
ストレージ
-
ストレージ
- hybris の場合、hybris サーバーが買い物かごを所有します。
- AEM汎用の場合、買い物かごは、 ClientContext.
パーソナライズ機能
-
パーソナライズは、常に ClientContext から取得する必要があります。
-
買い物かごの ClientContext
/version/は、すべてのケースで作成されます。- 製品は、
CommerceSession.addCartEntry()メソッドを使用して追加する必要があります。
- 製品は、
-
次の図は、ClientContext に格納される買い物かご情報の例を示しています。
チェックアウトのアーキテクチャ architecture-of-checkout
買い物かごと注文データ
CommerceSession は、次の 3 つの要素を管理します。
-
買い物かごの内容
-
価格
-
注文の詳細
-
買い物かごの内容
買い物かごのコンテンツスキーマは、次の API で固定されます。
code language-java public void addCartEntry(Product product, int quantity); public void modifyCartEntry(int entryNumber, int quantity); public void deleteCartEntry(int entryNumber); -
価格
価格のスキーマも、API によって決められています。
code language-java public String getCartPreTaxPrice(); public String getCartTax(); public String getCartTotalPrice(); public String getOrderShipping(); public String getOrderTotalTax(); public String getOrderTotalPrice(); -
注文の詳細
しかし、注文の詳細は API によって決められていません 。
code language-java public void updateOrderDetails(Map<String, String> orderDetails); public Map<String, String> getOrderDetails(); public void submitOrder();
送料の計算
-
注文フォームでは、多くの場合、複数の配送オプション（および価格）を提示する必要があります。
-
価格は、品目や注文の詳細（重み付けや配送先住所など）に基づく場合があります。
-
CommerceSessionはすべての依存関係にアクセスするので、製品価格と同じ方法で扱うことができます。CommerceSessionは送料を管理します。updateOrder(Map<String, Object> delta)を使用して、配送の詳細情報を取得または更新できます。
yourProject/commerce/components/shippingpicker の下）で、次の手順をおこないます。-
これは基本的に
foundation/components/form/radioのコピーですが、以下を行うためのCommerceSessionへのコールバックを備えています。 -
メソッドが使用可能かどうかの確認
-
価格情報の追加
-
関連する
CommerceSession情報の公開に関する制御権を持ちつつ、買い物客が AEM 内の注文ページ（発送方法のスーパーセットとその説明テキストを含む）を更新できるようにする
支払い処理
CommerceSessionは、支払い処理の接続も管理します。CommerceSession実装には、選択された支払い処理サービスへの具体的な呼び出しを追加する必要があります。
注文のフルフィルメント
CommerceSessionは、フルフィルメントの接続も管理します。CommerceSession実装には、選択された支払い処理サービスへの具体的な呼び出しを追加する必要があります。
検索定義 search-definition
標準のサービス API モデルに従って、e コマースプロジェクトは、個々のコマースエンジンで実装できる検索関連の API のセットを提供します。
e コマースプロジェクトには、次の場所にあるデフォルトの検索コンポーネントが含まれています。
/libs/commerce/components/search
これにより、検索 API を使用して、選択したコマースエンジンに対するクエリを実行できます ( e コマースエンジンの選択):
検索 API search-api
コアプロジェクトには、次のような汎用/ヘルパークラスが用意されています。
-
CommerceQuery検索クエリの記述に使用します（クエリテキスト、現在のページ、ページサイズ、並べ替え、選択されているファセットについての情報を含みます）。検索 API を実装するすべての e コマースサービスは、検索を実行するために、このクラスのインスタンスを受け取ります。
CommerceQueryは、リクエストオブジェクト（HttpServletRequest）からインスタンス化できます。 -
FacetParamHelper1 つの静的メソッド（
toParams）を提供するユーティリティクラス。このメソッドを使用して、ファセットのリストと 1 つのトグル値からGETパラメーター文字列を生成します。これは、UI 側で役立ちます。各ファセットの値ごとにハイパーリンクを表示する必要があります。ユーザーがハイパーリンクをクリックすると、それぞれの値が切り替えられます（つまり、選択した場合はクエリから削除され、それ以外の場合は追加されます）。 これは、複数値/単一値ファセットの処理、値の上書きなどのすべてのロジックを処理します。
検索 API のエントリポイントは、CommerceService#search オブジェクトを返す CommerceResult メソッドです。詳しくは、 API ドキュメント を参照してください。
ユーザーの統合 user-integration
AEMと様々な e コマースシステム間で統合が提供されます。 AEM固有のコードがAEMについてのみ知る必要があり、またその逆も知る必要があるように、様々なシステム間で買い物客を同期する戦略が必要です。
-
認証
AEM は 唯一 の Web フロントエンドと見なされるので、すべて の認証は AEM が実行します。
-
Hybris のアカウント
AEM は、買い物客ごとに対応する（セカンダリ）アカウントを Hybris に作成します。 このアカウントのユーザー名は、AEM ユーザー名と同じです。暗号化されたランダムパスワードが自動生成され、暗号化された状態で AEM に保存されます。
既存のユーザー pre-existing-users
AEMのフロントエンドは、既存の hybris 実装の前に配置できます。 また、hybris エンジンを既存のAEMインストールに追加できます。 これを行うには、システムは、次のいずれかのシステムで既存のユーザーを適切に処理できる必要があります。
-
AEM -> hybris
-
hybris へのログイン時に、AEM ユーザーがまだ存在していない場合は、
- 暗号化されたランダムパスワードを使用して新規 hybris ユーザーを作成します。
- この hybris ユーザー名を AEM ユーザーのユーザーディレクトリに保存します。
-
参照先:
com.adobe.cq.commerce.hybris.impl.HybrisSessionImpl#login()
-
-
hybris -> AEM の場合
-
AEM へのログイン時に、システムがユーザーを認識していない場合は、
- 提供されたユーザー名/pwd を使用して hybris にログインしようとします。
- 成功した場合は、AEMで同じパスワードを使用して新しいユーザーを作成します (AEM固有の salt はAEM固有のハッシュになります )。
-
上記のアルゴリズムは Sling の
AuthenticationInfoPostProcessorで実装されます。- 参照先:
com.adobe.cq.commerce.hybris.impl.user.LazyUserImporter.java
- 参照先:
-
読み込みプロセスのカスタマイズ customizing-the-import-process
既存の機能を基にカスタムインポートハンドラーを構築するには：
-
ImportHandlerインターフェイスを実装する必要があります。 -
拡張可能
DefaultImportHandler
/**
* Services implementing the <code>ImportHandler</code> interface are
* called by the {@link HybrisImporter} to create actual commerce entities
* such as products.
*/
public interface ImportHandler {
/**
* Not used.
*/
public void createTaxonomie(ImporterContext ctx);
/**
* Creates a catalog with the given name.
* @param ctx The importer context
* @param name The catalog's name
* @return Path of created catalog
*/
public String createCatalog(ImporterContext ctx, String name) throws Exception;
/**
* Creates a product from the given values.
* @param ctx The importer context
* @param values The product's properties
* @param parentCategoryPath The containing category's path
* @return Path of created product
*/
public String createProduct(ImporterContext ctx, ValueMap values, String parentCategoryPath) throws Exception;
/**
* Creates a variant product from the given values.
* @param ctx The importer context
* @param values The product's properties
* @param baseProductPath The base product's path
* @return Path of created product
*/
public String createVariantProduct(ImporterContext ctx, ValueMap values, String baseProductPath) throws Exception;
/**
* Creates an asset for a product. This is usually a product
* image.
* @param ctx The importer context
* @param values The product's properties
* @param baseProductPath The product's path
* @return Path of created asset
*/
public String createAsset(ImporterContext ctx, ValueMap values, String productPath) throws Exception;
/**
* Creates a category from the given values.
* @param ctx The importer context
* @param values The category's properties
* @param parentPath Path of parent category or base path of import in case of root category
* @return Path of created category
*/
public String createCategory(ImporterContext ctx, ValueMap values, String parentCategoryPath) throws Exception;
}
カスタムハンドラーをインポーターが認識するには、次を指定する必要があります。 service.rankingプロパティの値が 0 より大きい値。例：
@Component
@Service
@Property(name = "service.ranking", value = 100)
public class MyImportHandler extends DefaultImportHandler {
...
}