Install the Back Office Product CSV Import and Export feature

The Back Office Product CSV Import and Export feature is the product data type of the Data Exchange Jobs feature. The engine that stores jobs and runs, processes files, and provides the Back Office Import & Export pages is installed separately; this document installs the product plugin on top of it.

Prerequisites

Install the required features:

For the Data Exchange Jobs feature, see Install the Data Exchange Jobs feature.

Install feature core

1) Install the required modules

composer require spryker-feature/product-experience-management:"202610.0" --update-with-dependencies

2) Set up configuration

The product plugin reads the Product Status column of the imported CSV file and relies on spryker/product-approval for the approval statuses of abstract products. The following settings are defined in SprykerFeature\Zed\ProductExperienceManagement\ProductExperienceManagementConfig:

To change the defaults, extend the module configuration on the project level:

src/Pyz/Zed/ProductExperienceManagement/ProductExperienceManagementConfig.php

<?php

namespace Pyz\Zed\ProductExperienceManagement;

use SprykerFeature\Zed\ProductExperienceManagement\ProductExperienceManagementConfig as SprykerProductExperienceManagementConfig;

class ProductExperienceManagementConfig extends SprykerProductExperienceManagementConfig
{
    /**
     * @return list<string>
     */
    public function getProductConcreteStatuses(): array
    {
        return ['active', 'inactive'];
    }

    public function getProductConcreteStatusActive(): string
    {
        return 'active';
    }
}

The engine settings, such as the batch size, the maximum upload size, and the number of errors shown inline, are defined in DataExchangeConfig; see Install the Data Exchange Jobs feature.

3) Set up transfer objects

Generate the transfer objects of the product plugin:

console transfer:generate

4) Register the product schema plugin

The engine learns about the products-csv-import job type from the schema plugin registered in the DataExchange dependency provider. Without this registration, the type is not offered when creating an import job.

src/Pyz/Zed/DataExchange/DataExchangeDependencyProvider.php

<?php

namespace Pyz\Zed\DataExchange;

use Spryker\Zed\DataExchange\DataExchangeDependencyProvider as SprykerDataExchangeDependencyProvider;
use SprykerFeature\Zed\ProductExperienceManagement\Communication\Plugin\ProductCsvImportSchemaPlugin;

class DataExchangeDependencyProvider extends SprykerDataExchangeDependencyProvider
{
    /**
     * @return array<\Spryker\Zed\DataExchangeExtension\Dependency\Plugin\ImportSchemaPluginInterface>
     */
    protected function getImportSchemaPlugins(): array
    {
        return [
            new ProductCsvImportSchemaPlugin(),
        ];
    }

    /**
     * @return array<\Spryker\Zed\DataExchangeExtension\Dependency\Plugin\ExportSchemaPluginInterface>
     */
    protected function getExportSchemaPlugins(): array
    {
        return [
            new ProductCsvImportSchemaPlugin(),
        ];
    }
}