Install the SSP File Management feature

Last updated: April 11, 2025

Edit on GitHub

Self-Service Portal is currently running under an Early Access Release. Early Access Releases are subject to specific legal terms, they are unsupported and do not provide production-ready SLAs. They can also be deprecated without a General Availability Release. Nevertheless, we welcome feedback from early adopters on these cutting-edge, exploratory features.

This document describes how to install the Self-Service Portal (SSP) File Management feature.

Prerequisites

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

1) Install the required modules

composer require spryker-feature/ssp-file-management:"^0.1.6" --update-with-dependencies

Verification

Make sure the following modules have been installed:

MODULE	EXPECTED DIRECTORY
SspFileManagement	vendor/spryker-feature/ssp-file-management

Set up configuration

CONFIGURATION	SPECIFICATION	NAMESPACE
FileSystemConstants::FILESYSTEM_SERVICE	Flysystem configuration for file management.	Spryker\Shared\FileSystem
SspFileManagementConstants::STORAGE_NAME	Flysystem SspFileManagement used for uploaded files storage.	SprykerFeature\Shared\SspFileManagement

config/Shared/config_default.php

use Spryker\Service\FlysystemLocalFileSystem\Plugin\Flysystem\LocalFilesystemBuilderPlugin;
use Spryker\Shared\FileSystem\FileSystemConstants;
use SprykerFeature\Shared\SspFileManagement\SspFileManagementConstants;

$config[FileSystemConstants::FILESYSTEM_SERVICE] = [
    'ssp-files' => [
        'sprykerAdapterClass' => LocalFilesystemBuilderPlugin::class,
        'root' => '/data',
        'path' => '/data/ssp-files',
    ],
];

$config[SspFileManagementConstants::STORAGE_NAME] = 'ssp-files';

Add the Files section to navigation.xml:

config/Zed/navigation.xml

<?xml version="1.0"?>
<config>
    <content>
       <ssp-file-management>
          <label>File Attachments</label>
          <title>File Attachments</title>
          <bundle>ssp-file-management</bundle>
          <controller>list</controller>
          <action>index</action>
          <visible>1</visible>
       </ssp-file-management>
    </content>
</config>

Verification

Make sure that, in the Back Office, the **Content** > **Files** section is available.

Set up database schema and transfer objects

Apply database changes and generate entity and transfer objects:

console propel:install
console transfer:generate

Verification

Verify the following changes in your database:

DATABASE ENTITY	TYPE	EVENT
spy_company_file	table	created
spy_company_user_file	table	created
spy_company_business_unit_file	table	created
spy_file.file_reference	column	created
spy_file.uuid	column	created

Make sure the following transfer objects have been generated:

TRANSFER	TYPE	EVENT	PATH
FileAttachment	transfer	created	src/Generated/Shared/Transfer/FileAttachmentTransfer
File	transfer	created	src/Generated/Shared/Transfer/FileTransfer
FileStorageDataCriteria	transfer	created	src/Generated/Shared/Transfer/FileStorageDataCriteriaTransfer
FileStorageDataConditions	transfer	created	src/Generated/Shared/Transfer/FileStorageDataConditionsTransfer
FileStorageDataCollection	transfer	created	src/Generated/Shared/Transfer/FileStorageDataCollectionTransfer
FileAttachmentCollectionRequest	transfer	created	src/Generated/Shared/Transfer/FileAttachmentCollectionRequestTransfer
FileAttachmentCollectionResponse	transfer	created	src/Generated/Shared/Transfer/FileAttachmentCollectionResponseTransfer
FileAttachmentCollectionDeleteCriteria	transfer	created	src/Generated/Shared/Transfer/FileAttachmentCollectionDeleteCriteriaTransfer
FileAttachmentCriteria	transfer	created	src/Generated/Shared/Transfer/FileAttachmentCriteriaTransfer
CriteriaRangeFilter	transfer	created	src/Generated/Shared/Transfer/CriteriaRangeFilterTransfer
FileAttachmentConditions	transfer	created	src/Generated/Shared/Transfer/FileAttachmentConditionsTransfer
FileAttachmentSearchConditions	transfer	created	src/Generated/Shared/Transfer/FileAttachmentSearchConditionsTransfer
FileAttachmentFilter	transfer	created	src/Generated/Shared/Transfer/FileAttachmentFilterTransfer
FileAttachmentCollection	transfer	created	src/Generated/Shared/Transfer/FileAttachmentCollectionTransfer
FileCriteria	transfer	created	src/Generated/Shared/Transfer/FileCriteriaTransfer
FileConditions	transfer	created	src/Generated/Shared/Transfer/FileConditionsTransfer
FileStorageData	transfer	created	src/Generated/Shared/Transfer/FileStorageDataTransfer
Error	transfer	created	src/Generated/Shared/Transfer/ErrorTransfer
Sort	transfer	created	src/Generated/Shared/Transfer/SortTransfer
Pagination	transfer	created	src/Generated/Shared/Transfer/PaginationTransfer
FileUploadCollection	transfer	created	src/Generated/Shared/Transfer/FileUploadCollectionTransfer
FileCollection	transfer	created	src/Generated/Shared/Transfer/FileCollectionTransfer
FileManagerData	transfer	created	src/Generated/Shared/Transfer/FileManagerDataTransfer
FileUpload	transfer	created	src/Generated/Shared/Transfer/FileUploadTransfer
FileInfo	transfer	created	src/Generated/Shared/Transfer/FileInfoTransfer
FileLocalizedAttributes	transfer	created	src/Generated/Shared/Transfer/FileLocalizedAttributesTransfer
FileAttachmentFileTableCriteria	transfer	created	src/Generated/Shared/Transfer/FileAttachmentFileTableCriteriaTransfer
FileAttachmentFileViewDetailTableCriteria	transfer	created	src/Generated/Shared/Transfer/FileAttachmentFileViewDetailTableCriteriaTransfer
CompanyBusinessUnitCriteriaFilter	transfer	created	src/Generated/Shared/Transfer/CompanyBusinessUnitCriteriaFilterTransfer
CompanyCriteriaFilter	transfer	created	src/Generated/Shared/Transfer/CompanyCriteriaFilterTransfer
CompanyUserCriteriaFilter	transfer	created	src/Generated/Shared/Transfer/CompanyUserCriteriaFilterTransfer
Filter	transfer	created	src/Generated/Shared/Transfer/FilterTransfer
SequenceNumberSettings	transfer	created	src/Generated/Shared/Transfer/SequenceNumberSettingsTransfer
CompanyUserCollection	transfer	created	src/Generated/Shared/Transfer/CompanyUserCollectionTransfer
CompanyBusinessUnitCollection	transfer	created	src/Generated/Shared/Transfer/CompanyBusinessUnitCollectionTransfer
CompanyCollection	transfer	created	src/Generated/Shared/Transfer/CompanyCollectionTransfer
Company	transfer	created	src/Generated/Shared/Transfer/CompanyTransfer
CompanyUser	transfer	created	src/Generated/Shared/Transfer/CompanyUserTransfer
CompanyBusinessUnit	transfer	created	src/Generated/Shared/Transfer/CompanyBusinessUnitTransfer
Customer	transfer	created	src/Generated/Shared/Transfer/CustomerTransfer
FileAttachmentFileCriteria	transfer	created	src/Generated/Shared/Transfer/FileAttachmentFileCriteriaTransfer
FileAttachmentFileConditions	transfer	created	src/Generated/Shared/Transfer/FileAttachmentFileConditionsTransfer
FileAttachmentFileSearchConditions	transfer	created	src/Generated/Shared/Transfer/FileAttachmentFileSearchConditionsTransfer
FileAttachmentFileCollection	transfer	created	src/Generated/Shared/Transfer/FileAttachmentFileCollectionTransfer
FileAttachmentFileTypeFilter	transfer	created	src/Generated/Shared/Transfer/FileAttachmentFileTypeFilterTransfer
DashboardResponse	transfer	created	src/Generated/Shared/Transfer/DashboardResponseTransfer
DashboardComponentFiles	transfer	created	src/Generated/Shared/Transfer/DashboardComponentFilesTransfer
DashboardRequest	transfer	created	src/Generated/Shared/Transfer/DashboardRequestTransfer

Add translations

Append the glossary:

Glossary

>customer.account.button.filters,Filters,en_US
customer.account.button.filters,Filter,de_DE
permission.name.DownloadFilesPermissionPlugin,Download file(s) ,en_US
permission.name.DownloadFilesPermissionPlugin,Datei(en) herunterladen,de_DE
permission.name.ViewFilesPermissionPlugin,Open My Files page,en_US
permission.name.ViewFilesPermissionPlugin,Meine Dateien anzeigen,de_DE
permission.name.ViewCompanyFilesPermissionPlugin,View Company Files,en_US
permission.name.ViewCompanyFilesPermissionPlugin,Firmendateien anzeigen,de_DE
permission.name.ViewCompanyUserFilesPermissionPlugin,View My Files,en_US
permission.name.ViewCompanyUserFilesPermissionPlugin,Meine Dateien anzeigen,de_DE
permission.name.ViewCompanyBusinessUnitFilesPermissionPlugin,View Business unit files,en_US
permission.name.ViewCompanyBusinessUnitFilesPermissionPlugin,Geschäftseinheit Dateien anzeigen,de_DE
general.fileUpload.description,Maximum of %amount% files (%format%) up to %size%,en_US
general.fileUpload.description,Maximal %amount% Dateien (%format%) bis %size%,de_DE
general.fileUpload.mb,MB,en_US
general.fileUpload.mb,MB,de_DE
ssp_file_management.file_management.table.header.file_reference,File Reference,en_US
ssp_file_management.file_management.table.header.file_reference,Dateireferenz,de_DE
ssp_file_management.file_management.table.header.file_name,File Name,en_US
ssp_file_management.file_management.table.header.file_name,Dateiname,de_DE
ssp_file_management.file_management.table.header.file_type,File Type,en_US
ssp_file_management.file_management.table.header.file_type,Dateityp,de_DE
ssp_file_management.file_management.table.header.file_created_at,Date Added,en_US
ssp_file_management.file_management.table.header.file_created_at,Datum hinzugefügt,de_DE
ssp_file_management.file_management.table.header.file_size,Size,en_US
ssp_file_management.file_management.table.header.file_size,Größe,de_DE
ssp_file_management.file_management.table.header.actions,Actions,en_US
ssp_file_management.file_management.table.header.actions,Aktionen,de_DE
ssp_file_management.file_management.table.actions.download,Download,en_US
ssp_file_management.file_management.table.actions.download,Herunterladen,de_DE
ssp_file_management.file_management,My Files,en_US
ssp_file_management.file_management,Meine Dateien,de_DE
ssp_file_management.file_management.view.empty,You do not have any files yet.,en_US
ssp_file_management.file_management.view.empty,Sie haben noch keine Dateien.,de_DE
ssp_file_management.file_management.file_search_filter_form.field.type.placeholder,Select type,en_US
ssp_file_management.file_management.file_search_filter_form.field.type.placeholder,Typ auswählen,de_DE
ssp_file_management.file_management.file_search_filter_form.field.type.label,Type,en_US
ssp_file_management.file_management.file_search_filter_form.field.type.label,Typ,de_DE
ssp_file_management.file_management.file_search_filter_form.field.date_from.label,Date From,en_US
ssp_file_management.file_management.file_search_filter_form.field.date_from.label,Datum von,de_DE
ssp_file_management.file_management.file_search_filter_form.field.date_to.label,Date To,en_US
ssp_file_management.file_management.file_search_filter_form.field.date_to.label,Datum bis,de_DE
ssp_file_management.file_management.file_search_filter_form.field.access_level.placeholder,Select access level,en_US
ssp_file_management.file_management.file_search_filter_form.field.access_level.placeholder,Zugriffsebene auswählen,de_DE
ssp_file_management.file_management.file_search_filter_form.field.access_level.label,Access Level,en_US
ssp_file_management.file_management.file_search_filter_form.field.access_level.label,Zugriffsebene,de_DE
ssp_file_management.file_management.file_search_filter_form.field.search.label,Search,en_US
ssp_file_management.file_management.file_search_filter_form.field.search.label,Suche,de_DE
ssp_file_management.file_management.file_search_filter_form.field.apply.label,Apply,en_US
ssp_file_management.file_management.file_search_filter_form.field.apply.label,Anwenden,de_DE
ssp_file_management.file_management.file_search_filter_form.field.reset_all.label,Reset All,en_US
ssp_file_management.file_management.file_search_filter_form.field.reset_all.label,Alles zurücksetzen,de_DE
ssp_file_management.file_management.file_search_filter_form.label.active_filters,Active Filters:,en_US
ssp_file_management.file_management.file_search_filter_form.label.active_filters,Aktive Filter:,de_DE
ssp_file_management.file_management.file_search_filter_form.field.type.company,Company Files,en_US
ssp_file_management.file_management.file_search_filter_form.field.type.company,Unternehmensdateien,de_DE
ssp_file_management.file_management.file_search_filter_form.field.type.company_user,My Files,en_US
ssp_file_management.file_management.file_search_filter_form.field.type.company_user,Meine Dateien,de_DE
ssp_file_management.file_management.file_search_filter_form.field.type.company_business_unit,Business unit files,en_US
ssp_file_management.file_management.file_search_filter_form.field.type.company_business_unit,Geschäftseinheitsdateien,de_DE

Import data:

console data:import glossary

Verification

Make sure the data has been added to the spy_glossary_key and spy_glossary_translation database tables.

Set up behavior

PLUGIN	SPECIFICATION	NAMESPACE
ViewFilesPermissionPlugin	Enable viewing of files (generic).	SprykerFeature\Shared\SspFileManagement\Plugin\Permission
DownloadFilesPermissionPlugin	Enables downloading of files.	SprykerFeature\Shared\SspFileManagement\Plugin\Permission
ViewCompanyUserFilesPermissionPlugin	Enables company users to view the files they uploaded.	SprykerFeature\Shared\SspFileManagement\Plugin\Permission
ViewCompanyBusinessUnitFilesPermissionPlugin	Allows access to files uploaded within the same business unit.	SprykerFeature\Shared\SspFileManagement\Plugin\Permission
ViewCompanyFilesPermissionPlugin	Allows access to all files within the same company.	SprykerFeature\Shared\SspFileManagement\Plugin\Permission
SspFileManagementPageRouteProviderPlugin	Provides Yves routes for the SSP files feature.	SprykerFeature\Yves\SspFileManagement\Plugin\Router
SspFileManagerMenuItemWidget	Provides a menu item widget for the customer account side menu.	SprykerFeature\Yves\SspFileManagement\Widget
FileAttachmentFilePreDeletePlugin	Ensures files are deleted when a file is removed.	SprykerFeature\Zed\SspFileManagement\Communication\Plugin\FileManager

src/Pyz/Zed/Permission/PermissionDependencyProvider.php

<?php

namespace Pyz\Zed\Permission;

use Spryker\Zed\Permission\PermissionDependencyProvider as SprykerPermissionDependencyProvider;
use SprykerFeature\Shared\SspFileManagement\Plugin\Permission\DownloadFilesPermissionPlugin;
use SprykerFeature\Shared\SspFileManagement\Plugin\Permission\ViewCompanyBusinessUnitFilesPermissionPlugin;
use SprykerFeature\Shared\SspFileManagement\Plugin\Permission\ViewCompanyFilesPermissionPlugin;
use SprykerFeature\Shared\SspFileManagement\Plugin\Permission\ViewCompanyUserFilesPermissionPlugin;
use SprykerFeature\Shared\SspFileManagement\Plugin\Permission\ViewFilesPermissionPlugin;

class PermissionDependencyProvider extends SprykerPermissionDependencyProvider
{
    /**
     * @return array<\Spryker\Shared\PermissionExtension\Dependency\Plugin\PermissionPluginInterface>
     */
    protected function getPermissionPlugins(): array
    {
        return [
            new ViewFilesPermissionPlugin(),
            new DownloadFilesPermissionPlugin(),
            new ViewCompanyUserFilesPermissionPlugin(),
            new ViewCompanyBusinessUnitFilesPermissionPlugin(),
            new ViewCompanyFilesPermissionPlugin(),
        ];
    }
}

src/Pyz/Client/Permission/PermissionDependencyProvider.php

<?php

namespace Pyz\Client\Permission;

use Spryker\Client\Permission\PermissionDependencyProvider as SprykerPermissionDependencyProvider;
use SprykerFeature\Shared\SspFileManagement\Plugin\Permission\DownloadFilesPermissionPlugin;
use SprykerFeature\Shared\SspFileManagement\Plugin\Permission\ViewCompanyBusinessUnitFilesPermissionPlugin;
use SprykerFeature\Shared\SspFileManagement\Plugin\Permission\ViewCompanyFilesPermissionPlugin;
use SprykerFeature\Shared\SspFileManagement\Plugin\Permission\ViewCompanyUserFilesPermissionPlugin;
use SprykerFeature\Shared\SspFileManagement\Plugin\Permission\ViewFilesPermissionPlugin;

class PermissionDependencyProvider extends SprykerPermissionDependencyProvider
{
    /**
     * @return array<\Spryker\Shared\PermissionExtension\Dependency\Plugin\PermissionPluginInterface>
     */
    protected function getPermissionPlugins(): array
    {
        return [
            new ViewFilesPermissionPlugin(),
            new DownloadFilesPermissionPlugin(),
            new ViewCompanyUserFilesPermissionPlugin(),
            new ViewCompanyBusinessUnitFilesPermissionPlugin(),
            new ViewCompanyFilesPermissionPlugin(),
        ];
    }
}

src/Pyz/Yves/Router/RouterDependencyProvider.php

<?php

namespace Pyz\Yves\Router;

use Spryker\Yves\Router\RouterDependencyProvider as SprykerRouterDependencyProvider;
use SprykerFeature\Yves\SspFileManagement\Plugin\Router\SspFileManagementPageRouteProviderPlugin;

class RouterDependencyProvider extends SprykerRouterDependencyProvider
{
    /**
     * @return array<\Spryker\Yves\RouterExtension\Dependency\Plugin\RouteProviderPluginInterface>
     */
    protected function getRouteProvider(): array
    {
        return [
            new SspFileManagementPageRouteProviderPlugin(),
        ];
    }
}

src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php

<?php

namespace Pyz\Yves\ShopApplication;

use SprykerFeature\Yves\SspFileManagement\Widget\SspFileManagerMenuItemWidget;
use SprykerShop\Yves\ShopApplication\ShopApplicationDependencyProvider as SprykerShopApplicationDependencyProvider;

class ShopApplicationDependencyProvider extends SprykerShopApplicationDependencyProvider
{
    protected function getGlobalWidgets(): array
    {
        return [
            SspFileManagerMenuItemWidget::class,
        ];
    }
}

src/Pyz/Zed/FileManager/FileManagerDependencyProvider.php

<?php

namespace Pyz\Zed\FileManager;

use Spryker\Zed\FileManager\FileManagerDependencyProvider as SprykerFileManagerDependencyProvider;
use SprykerFeature\Zed\SspFileManagement\Communication\Plugin\FileManager\FileAttachmentFilePreDeletePlugin;

class FileManagerDependencyProvider extends SprykerFileManagerDependencyProvider
{
    protected function getFilePreDeletePlugins(): array
    {
        return [
            new FileAttachmentFilePreDeletePlugin(),
        ];
    }
}

Verification

Verify file upload and attachment:

In the Back Office, go to Content > File Attachments.
Click Upload.
Drag and drop three files into the upload area.
Click Upload. Make sure the File Attachments list page shows the files you’ve uploaded.
Next to the first file you’ve uploaded, click Attach.
For Company, enter and select the company you want to attach the file to.
Click Save.
Click Attach next to the second file you’ve uploaded.
For Company User, enter and select the business unit you want to attach the file to.
Click Save.
Attach the third file to a company user.

Verification

Verify permission management:

In the Back Office, go to Customers > Company Roles.
Click Add Company User Role.
Select a company.
Enter a name for the role.
In Unassigned Permissions, enable the following permissions:
- Open My Files page
- Download file
- View My Files
- View Business unit files
- View Company Files
Click Submit.
Go to Customers > Company Users.
Click Edit next to a user.
Assign the role you’ve just created to the user.

Verification

Verify permissions on Storefront:

On the Storefront, log in with the company user you’ve assigned the role to. Make sure the My Files menu item is displayed.
Go to Customer Account > My Files page. Make sure the three files you’ve uploaded are displayed.
Log out and log in with another company user that doesn’t have the role. Make sure the My Files menu item is not displayed and you can’t access the My Files page.

Was this article helpful?

Tell us what could be better

Name (Optional)

Email (Optional) Invalid email format.

Type your thoughts here

We appreciate the time you took to share the feedback
and will consider it as soon as possible.

Thank you!

For submitting the form

Install the SSP File Management feature

Prerequisites

1) Install the required modules

Set up configuration

Configure navigation

Set up database schema and transfer objects

Add translations

Set up behavior

Thank you!