Install the asset based catalog feature

Last updated:
Edit on GitHub

This document describes how you install the Self-Service Portal (SSP) asset-based catalog feature.

Install all SSP features

For the Self-Service Portal to work correctly, you must install all SSP features. Each feature depends on the others for proper functionality.

Features the asset-based catalog depends on

Prerequisites

Before you start the installation, make sure you have installed the following features:

FEATURE VERSION INSTALLATION GUIDE
Spryker Core 202512.0 Install the Spryker Core feature
Self-Service Portal 202512.0 Install Self-Service Portal

Install the required modules

Install the required modules using Composer:

composer require spryker-feature/self-service-portal:"^202512.0" --update-with-dependencies
Verification

Make sure the following packages are now listed in composer.lock:

MODULE EXPECTED DIRECTORY
SelfServicePortal vendor/spryker-feature/self-service-portal

Configure event triggering for catalog entities

src/Pyz/Zed/SelfServicePortal/Persistence/Propel/Schema/spy_ssp_model_to_product_list.schema.xml

<?xml version="1.0"?>
<database xmlns="spryker:schema-01" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="zed"
          xsi:schemaLocation="spryker:schema-01 https://static.spryker.com/schema-01.xsd"
          namespace="Orm\Zed\SelfServicePortal\Persistence" package="src.Orm.Zed.SelfServicePortal.Persistence">

    <table name="spy_ssp_model_to_product_list">
        <behavior name="event">
            <parameter name="spy_ssp_model_to_product_list_all" column="*"/>
        </behavior>
    </table>

</database>

src/Pyz/Zed/SelfServicePortal/Persistence/Propel/Schema/spy_ssp_model_to_ssp_asset.schema.xml

<?xml version="1.0"?>
<database xmlns="spryker:schema-01" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="zed"
          xsi:schemaLocation="spryker:schema-01 https://static.spryker.com/schema-01.xsd"
          namespace="Orm\Zed\SelfServicePortal\Persistence" package="src.Orm.Zed.SelfServicePortal.Persistence">

    <table name="spy_ssp_asset_to_ssp_model">
        <behavior name="event">
            <parameter name="spy_ssp_asset_to_ssp_model_all" column="*"/>
        </behavior>
    </table>

</database>

Apply database schema changes

Apply schema updates:

console propel:install
Verification
Make sure the following tables have been created in the database:
  • spy_ssp_model_to_product_list
  • spy_ssp_asset_to_ssp_model

Set up transfer objects

Generate transfer classes:

console transfer:generate

Set up behavior

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
SspModelAssetWritePublisherPlugin Publishes SSP model data by SpySspModel entity events. SprykerFeature\Zed\SelfServicePortal\Communication\Plugin\Publisher\SspAsset\Search
SspAssetToModelWritePublisherPlugin Publishes SSP model data by SpySspAssetToSspModel entity events. SprykerFeature\Zed\SelfServicePortal\Communication\Plugin\Publisher\SspAsset\Storage
SspAssetToModelWritePublisherPlugin Publishes SSP asset data by SpySspAssetToSspModel entity events to the search engine. SprykerFeature\Zed\SelfServicePortal\Communication\Plugin\Publisher\SspAsset\Search

src/Pyz/Zed/Publisher/PublisherDependencyProvider.php

<?php

declare(strict_types = 1);

namespace Pyz\Zed\Publisher;

use Spryker\Zed\Publisher\PublisherDependencyProvider as SprykerPublisherDependencyProvider;
use SprykerFeature\Zed\SelfServicePortal\Communication\Plugin\Publisher\SspAsset\Search\SspAssetToModelWritePublisherPlugin as SearchSspAssetToModelWritePublisherPlugin;
use SprykerFeature\Zed\SelfServicePortal\Communication\Plugin\Publisher\SspAsset\Storage\SspAssetToModelWritePublisherPlugin;
use SprykerFeature\Zed\SelfServicePortal\Communication\Plugin\Publisher\SspAsset\Search\SspModelAssetWritePublisherPlugin;

class PublisherDependencyProvider extends SprykerPublisherDependencyProvider
{
    /**
     * @return array<int|string, \Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface>|array<string, array<int|string, \Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface>>
     */
    protected function getPublisherPlugins(): array
    {
        return array_merge(
            $this->getSspAssetStoragePlugins(),
            $this->getSspAssetSearchPlugins(),
        );
    }

    /**
     * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface>
     */
    protected function getSspAssetStoragePlugins(): array
    {
        return [
            new SspModelAssetWritePublisherPlugin(),
            new SspAssetToModelWritePublisherPlugin(),
        ];
    }

    /**
     * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface>
     */
    protected function getSspAssetSearchPlugins(): array
    {
        return [
            new SearchSspAssetToModelWritePublisherPlugin(),
        ];
    }
}

Set up widgets

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
SspAssetInfoForItemWidget On the cart page, renders asset information for a cart item. SprykerFeature\Yves\SelfServicePortal\Widget
SspItemAssetSelectorWidget On the product details page, renders an autocomplete form field for selecting an asset. SprykerFeature\Yves\SelfServicePortal\Widget
SspCartItemAssetSelectorWidget On the cart page, renders an autocomplete form field for selecting an asset. SprykerFeature\Yves\SelfServicePortal\Widget
AssetCompatibilityLabelWidget Displays the compatibility label for assets. SprykerFeature\Yves\SelfServicePortal\Widget
SspAssetFilterNameWidget Displays the asset name in search result section. SprykerFeature\Yves\SelfServicePortal\Widget
SspAssetFilterWidget Display asset data. SprykerFeature\Yves\SelfServicePortal\Widget

src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php

<?php

namespace Pyz\Yves\ShopApplication;

use SprykerFeature\Yves\SelfServicePortal\Widget\SspAssetInfoForItemWidget;
use SprykerFeature\Yves\SelfServicePortal\Widget\SspItemAssetSelectorWidget;
use SprykerFeature\Yves\SelfServicePortal\Widget\SspAssetFilterNameWidget;
use SprykerFeature\Yves\SelfServicePortal\Widget\AssetCompatibilityLabelWidget;
use SprykerFeature\Yves\SelfServicePortal\Widget\SspAssetFilterWidget;
use SprykerFeature\Yves\SelfServicePortal\Widget\SspCartItemAssetSelectorWidget;
use SprykerShop\Yves\ShopApplication\ShopApplicationDependencyProvider as SprykerShopApplicationDependencyProvider;

class ShopApplicationDependencyProvider extends SprykerShopApplicationDependencyProvider
{
    /**
     * @return array<string>
     */
    protected function getGlobalWidgets(): array
    {
        return [
            SspAssetInfoForItemWidget::class,
            AssetCompatibilityLabelWidget::class,
            SspAssetFilterNameWidget::class,
            SspAssetFilterWidget::class,
            SspCartItemAssetSelectorWidget::class,
            SspItemAssetSelectorWidget::class,
        ];
    }
}

Import the Model relation data

Prepare your data according to your requirements using our demo data:

data/import/common/common/product_list_to_concrete_product.csv

>product_list_key,concrete_sku
ssp-pl-001,service-001-1
COLUMN REQUIRED DATA TYPE DATA EXAMPLE DATA EXPLANATION
product_list_key ✓ string ssp-pl-001 Unique identifier for the product list used as a reference.
concrete_sku ✓ string service-001-1 SKU of the concrete product to be associated with the product list.

data/import/common/common/ssp_model_asset.csv

>model_reference,asset_reference
MDL--1,AST--3
MDL--2,AST--4
COLUMN REQUIRED DATA TYPE DATA EXAMPLE DATA EXPLANATION
model_reference ✓ string MDL–1 Unique identifier for the model used as a reference.
asset_reference ✓ string AST–3 Unique identifier for the asset to be associated with the model.

data/import/common/common/ssp_model_product_list.csv

>model_reference,product_list_key
MDL--2,ssp-pl-001
COLUMN REQUIRED DATA TYPE DATA EXAMPLE DATA EXPLANATION
model_reference ✓ string MDL–2 Unique identifier for the model used as a reference.
product_list_key ✓ string ssp-pl-001 Unique identifier for the product list to be associated with the model.

Extend the data import configuration

/data/import/local/full_EU.yml

# ...

# SelfServicePortal
  - data_entity: ssp-model-asset
    source: data/import/common/common/ssp_model_asset.csv
  - data_entity: ssp-model-product-list
    source: data/import/common/common/ssp_model_product_list.csv

Register data import plugins

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
SspModelAssetDataImportPlugin Imports ssp asset model relations into persistence. SprykerFeature\Zed\SelfServicePortal\Communication\Plugin\DataImport
SspModelProductListDataImportPlugin Imports ssp asset model relations into persistence. SprykerFeature\Zed\SelfServicePortal\Communication\Plugin\DataImport

src/Pyz/Zed/DataImport/DataImportDependencyProvider.php

<?php

namespace Pyz\Zed\DataImport;

use Spryker\Zed\DataImport\DataImportDependencyProvider as SprykerDataImportDependencyProvider;
use SprykerFeature\Zed\SelfServicePortal\Communication\Plugin\DataImport\SspModelAssetDataImportPlugin;
use SprykerFeature\Zed\SelfServicePortal\Communication\Plugin\DataImport\SspModelProductListDataImportPlugin;

class DataImportDependencyProvider extends SprykerDataImportDependencyProvider
{
    /**
     * @return list<\Spryker\Zed\DataImport\Dependency\Plugin\DataImportPluginInterface>
     */
    protected function getDataImporterPlugins(): array
    {
        return [
            new SspModelAssetDataImportPlugin(),
            new SspModelProductListDataImportPlugin(),
        ];
    }
}

Import the data

Prerequisites

Before importing the data, make sure you have imported demo data for the following entities:

console data:import product-list
console data:import product-abstract
console data:import product-concrete
console data:import product-list-product-concrete
console data:import ssp-model-product-list
console data:import ssp-asset
console data:import ssp-model-asset
console data:import merchant-product-offer

Set up frontend templates

For information about setting up frontend templates, see Set up SSP frontend templates.