SAP Commerce Cloud を使用した開発

統合フレームワークには、API を備えた統合レイヤーが含まれます。以下を実行できます。

• e コマースシステムを組み込んで、製品データを AEM に取り込む

• 特定の e コマースエンジンに依存しないコマース機能用の AEM コンポーネントを作成する

この統合レイヤーを使用するために、すぐに使える AEM コンポーネントが多数用意されています。現時点では、以下のようなものがあります。

• 製品表示コンポーネント
• 買い物かご
• チェックアウト

検索のために、AEM 検索、e コマースシステムの検索、サードパーティ検索（Search&Promote など）、またはこれらを組み合わせた検索をおこなうための、統合フックが提供されています。

e コマースエンジンの選択

e コマースフレームワークは任意の e コマースソリューションと組み合わせて使用できますが、使用されるエンジンは AEM によって識別できる必要があります。

• e コマースエンジンは、CommerceService インターフェイスをサポートする OSGi サービスです。

  • エンジンは、commerceProvider サービスプロパティによって区別できます。

• AEM では、CommerceService と Product に対して Resource.adaptTo() をサポートしています。

  • adaptTo 実装は、リソースの階層内で cq:commerceProvider プロパティを探します。

    • 見つかった場合は、その値を使用してコマースサービスの検索をフィルタリングします。

    • 見つからなかった場合は、最上位のコマースサービスが使用されます。

  • 厳密に型指定されたリソースに cq:commerceProvider を追加できるように、cq:Commerce Mixin が使用されます。

• 適切なコマースファクトリ定義を参照するために、cq:commerceProvider プロパティも使用されます。

  • 例えば、cq:commerceProvider という値を持つ hybris プロパティは、向け Day CQ コマースファクトリ（com.adobe.cq.commerce.hybris.impl.HybrisServiceFactory）の OSGi 設定に関連付けられます（ここでも、commerceProvider パラメーターの値は hybrishybris となります）。

  • ここで、カタログバージョン​など、さらに別のプロパティを設定できます（適切かつ使用可能な場合）。

以下の例を参照してください。

例

/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

hybris 4 向けの開発

e コマース統合フレームワークの Hybris 拡張が更新されて、Hybris 4 との下位互換性を保ちながら、Hybris 5 がサポートされるようになりました。

コード内のデフォルト設定は hybris 5 向けに最適化されています。

hybris 4 向けの開発をおこなうには、以下が必要です。

• Maven を呼び出す場合は、次のコマンドライン引数をコマンドに追加します。

  -P hybris4

  事前設定済みの Hybris 4 ディストリビューションをダウンロードして、バンドル cq-commerce-hybris-server に組み込みます。

• OSGi 設定マネージャーで、

  • Default Response Parser サービスの Hybris 5 サポートを無効にします。

  • Hybris Basic Authentication Handler サービスのサービスランキングが Hybris OAuth Handler サービスより低くなるようにします。

セッション処理

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.getProductPrice(Product product)

• 注文​データの保存場所を管理します​。

  CommerceSession.getUserContext()

• 支払​処理の接続も管理します。

• フルフィルメント​の接続も管理します。

製品の同期と公開

hybris で管理されている製品データを AEM で使用できるようにする必要があります。以下のような構成が実装されています。

• 最初の ID 読み込みは、hybris からフィードとして提供されます。このフィードに対して更新がおこなわれる場合があります。
• hybris が、フィードを通じて更新情報を提供します（AEM によってポーリングされます）。
• AEM は、製品データを使用するときに、最新データについての要求を hybris に戻します（最終変更日に基づく条件付き GET 要求）。
• hybris 上では、宣言的な方法でフィードコンテンツを指定できます。
• AEM 側のフィードアダプター内で、フィード構造と AEM コンテンツモデルとのマッピングがおこなわれます。

• インポーター（b）は、カタログ用に AEM 内で最初のページツリー構造を設定するために使用されます。

• hybris 内でのカタログ変更はフィードを通じて AEM に通知され、それが AEM（b）に反映されます。

  • カタログバージョンについて、製品が追加、削除、変更されます。

  • 製品が承認されます。

• hybris 拡張はポーリングインポーター（"hybris" scheme"）を提供します。このインポーターは、変更を指定の時間間隔で AEM に読み込むように設定できます（例えば 24 時間おきにする場合は、秒単位で以下のように指定します）。

      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 内のページをアクティベート（c）するには確認が必要で（b）、以下の場合にのみアクティベートできます。

  • 製品が、製品ページの​オンライン​カタログバージョン内にある

  • 参照される製品が、他のページ（キャンペーンページなど）の​オンライン​カタログバージョン内で利用できる

• アクティベートされた製品ページは、製品データの​オンライン​バージョンにアクセスする必要があります（d）。

• AEM パブリッシュインスタンスは、製品データやパーソナライズされたデータを取得するために、hybris にアクセスする必要があります（d）。

アーキテクチャ

製品とバリアントのアーキテクチャ

1 つの製品に複数のバリエーションがある場合があります。例えば、カラーやサイズで異なるバリエーションがある場合があります。製品では、バリエーションを構成するプロパティを定義する必要があります。このようなプロパティを​バリアント軸​と呼びます。

ただし、すべてのプロパティがバリアント軸になるわけではありません。バリエーションは、他のプロパティにも影響を与えることがあります。例えば、価格はサイズに依存することがあります。買い物客はこのようなプロパティを選択できないので、バリアント軸とは見なされません。

各製品やバリアントはリソースによって表現されるので、リポジトリノードに 1 対 1 でマップされます。必然的に、特定の製品やバリアントはそのパスによって一意に識別できます。

製品／バリアントリソースは、実際の製品データを持つとは限らず、本当は別のシステム（hybris など）に格納されているデータの表現にすぎない場合があります。例えば、製品の説明や価格などは AEM には格納されておらず、e コマースエンジンからリアルタイムで取得されます。

すべての製品リソースは、Product API で表現できます。製品 API の呼び出しのほとんどはバリエーションごとに固有ですが（ただし、バリエーションは 1 つのオリジナルから共有される値を継承する場合があります）、一連のバリエーションを一覧で表示する呼び出しもあります（getVariantAxes() や getVariants() など）。

製品リファレンスと製品データ

一般的に、

• 製品データは /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 インターフェイス

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

/**
 * 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 プロパティはありません。

      • すべてのプロパティをローカルに保持している（そして productData プロパティを含まない）製品ノードは、製品属性を自身の祖先から直接継承します。

• AEM の汎用の製品構造

  • 各バリアントには、独自のリーフノードが必要です。

  • 製品インターフェイスは、製品とバリアントの両方を表しますが、関連リポジトリノードはそれぞれに固有です。

  • 製品ノードは、製品属性とバリアント軸を示します。

例

+ 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

買い物かごのアーキテクチャ

コンポーネント

• 買い物かごは、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 に格納される買い物かご情報の例を示しています。

チェックアウトのアーキテクチャ

買い物かごと注文データ

CommerceSession は、次の 3 つの要素を管理します。

1. 買い物かごコンテンツ

2. 価格

3. 注文の詳細

4. 買い物かごコンテンツ

   買い物かごコンテンツのスキーマは、API によって決められています。

   public void addCartEntry(Product product, int quantity);
   public void modifyCartEntry(int entryNumber, int quantity);
   public void deleteCartEntry(int entryNumber);
   

5. 価格

   価格のスキーマも、API によって決められています。

   public String getCartPreTaxPrice();
   public String getCartTax();
   public String getCartTotalPrice();
   public String getOrderShipping();
   public String getOrderTotalTax();
   public String getOrderTotalPrice();
   

6. 注文の詳細

   しかし、注文の詳細は API によって決められていません​。

   public void updateOrderDetails(Map<String, String> orderDetails);
   public Map<String, String> getOrderDetails();
   public void submitOrder();
   

送料の計算

• 多くの場合、注文フォームには複数の出荷オプション（および価格）を表示する必要があります。

• 価格は、品目と注文の詳細（重さや配送先住所など）に基づきます。

• CommerceSession はすべての依存関係にアクセスするので、製品価格と同じ方法で扱うことができます。

  • CommerceSession は送料を管理します。
  • updateOrder(Map<String, Object> delta) を使用して、配送の詳細情報を取得または更新できます。

支払い処理

• CommerceSession は、支払い処理の接続も管理します。

• CommerceSession 実装には、選択された支払い処理サービスへの具体的な呼び出しを追加する必要があります。

注文のフルフィルメント

• CommerceSession は、フルフィルメントの接続も管理します。
• CommerceSession 実装には、選択された支払い処理サービスへの具体的な呼び出しを追加する必要があります。

検索の定義

標準のサービス API モデルに従い、e コマースプロジェクトは、個々のコマースエンジンで実装できる一連の検索関連 API を提供しています。

e コマースプロジェクトには、デフォルトの検索コンポーネントが含まれます。このコンポーネントは次の場所にあります。

/libs/commerce/components/search

ここでは、検索 API を利用して、選択されたコマースエンジンをクエリしています（e コマースエンジンの選択を参照）。

検索 API

コアプロジェクトは、いくつかの汎用クラスまたはヘルパークラスを提供します。

1. CommerceQuery

   検索クエリの記述に使用します（クエリテキスト、現在のページ、ページサイズ、並べ替え、選択されているファセットについての情報を含みます）。検索 API を実装するすべての e コマースサービスは、検索を実行するために、このクラスのインスタンスを受け取ります。CommerceQuery は、リクエストオブジェクト（HttpServletRequest）からインスタンス化できます。

2. FacetParamHelper

   1 つの静的メソッド（toParams）を提供するユーティリティクラス。このメソッドを使用して、ファセットのリストと 1 つのトグル値から GET パラメーター文字列を生成します。これは、UI 側で、ユーザーがハイパーリンクをクリックすると対応する値に切り替わる（選択された場合はクエリから削除され、選択されていない場合は追加される）ように、各ファセットの値ごとのハイパーリンクを表示する必要がある場合に役立ちます。これによって、複数または単一の値を持つファセットの処理や値のオーバーライドなど、すべてのロジックを扱うことができます。

検索 API のエントリポイントは、CommerceService#search オブジェクトを返す CommerceResult メソッドです。このトピックについて詳しくは、API ドキュメントを参照してください。

ユーザー統合

AEM は様々な e コマースシステムと統合できます。これを実現するには、AEM 固有のコードは AEM のみを把握すればよく、その逆も同様となるように、各種システム間で買い物客を同期するための戦略が必要です。

• 認証

  AEM は​唯一​の Web フロントエンドと見なされるので、すべて​の認証は AEM が実行します。

• Hybris のアカウント

  AEM は、買い物客ごとに対応する（セカンダリ）アカウントを Hybris に作成します。 このアカウントのユーザー名は、AEM ユーザー名と同じです。暗号化されたランダムパスワードが自動生成され、暗号化された状態で AEM に保存されます。

既存ユーザー

AEM フロントエンドは、既存の hybris 実装の前面に置くことができます。また、hybris エンジンを既存の AEM インストールに追加することもできます。これを実現するには、双方のシステムが相手側システムの既存ユーザーを適切に扱えなければなりません。

• AEM -> hybris の場合

  • hybris へのログイン時に、AEM ユーザーがまだ存在していない場合は、

    • 暗号化されたランダムパスワードを使用して新規 hybris ユーザーを作成します。
    • この hybris ユーザー名を AEM ユーザーのユーザーディレクトリに保存します。

  • 参照先: com.adobe.cq.commerce.hybris.impl.HybrisSessionImpl#login()

• hybris -> AEM の場合

  • AEM へのログイン時に、システムがユーザーを認識していない場合は、

    • 提供されたユーザー名とパスワードを使用して、hybris にログインを試みます。
    • 成功した場合は、同じパスワードを使用して AEM 内に新規ユーザーを作成します（AEM 固有のソルトにより、AEM 固有のハッシュが生成されます）。

  • 上記のアルゴリズムは Sling の AuthenticationInfoPostProcessor で実装されます。

    • 参照先: com.adobe.cq.commerce.hybris.impl.user.LazyUserImporter.java

読み込みプロセスのカスタマイズ

既存の機能に基づいてカスタムの読み込みハンドラーを作成するには、次のようにします。

• 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
{
...
}