Plugin Manager

Version

5.5.0 or newer

Table of contents

Introduction

The Plugin Manager has been restructured from the bottom up for Shopware 5. The module now offers a closer connection to the Community Store, making it even easier to purchase/download plugins. The Plugin Manager will now also notify you of expiring licenses and supports license renewal directly from the module itself. You can find the Plugin Manager in its usual location in the backend under Configuration > Plugin Manager.

Overview

Upon opening the Plugin Manager, you will see an overview of all options related to plugin management and purchasing. This can be accessed at any point by selecting the Home button.

Search (1): the Plugin Manager offers a direct link to the Community Store. Here you can search the Store for plugins, which you can purchase directly from the Plugin Manager.

Account area (2): you can log into your Shopware Account by clicking on the avatar. When you click on View account, the account.shopware.com website opens in a new browser tab, allowing you to make changes to your account. If you are already logged in, the My purchases button displays an overview of your purchased plugins and licenses.

Management (3): the Home view is automatically shown when you open the Plugin Manager. Installed directs you to the traditional view of installed (both activated and deactivated) plugins.

Discover (4): this category tree mirrors that of the Community Store. You can browse for plugins using the category tree or search directly for specific terms/plugins using the search options in the toolbar.

New in the store (5): the latest features and plugins to arrive in the Store.

Ready for integration (6): an overview of the plugins already available in your installation – the grey plugins can be downloaded and updated at any moment without login.

My purchases

Cick the My purchases button to open a login window (if not already logged in). Enter the Shopware ID associated with the domain from which you are working.

After login, you will see an overview of all plugins associated with your domain and Account.

The overview displays all plugins along with their respective licenses, license types (tested, rented or purchased) and current plugin version numbers. You have the possibility of downloading all verified plugins along with their respective licenses in batches. Please note that when downloading plugins, licenses are automatically imported.

Installed

This is the classic view of your installed plugins (activated and deactivated).

These plugins are separated into three groups: uninstalled, inactive and installed. Plugins can be activated of deactivated by clicking the green check of red X.

Plugin safe mode

The Safe Mode can temporarily disable all third-party plugins in your shop. To activate the safe mode, open the Plugin Manager, navigate to the list of installed plugins and check the checkbox at the bottom of the window (1).

Safe mode will remember which plugins were active and which were inactive, so when you leave the safe mode by clicking on the checkbox again, all disabled plugins will be activated again. If you don't have any third party plugin installed, the checkbox for the safe mode will be disabled.

This is very useful to determine if an error in your shop is caused by an external plugin. If you encounter an error, enable safe mode and check if the error persists. If it doesn't, you can leave safe mode and deactivate plugins one-by-one until you find the one causing the error.

Updates

If plugin updates are available, the Plugin Manager will automatically dispaly a notification within the Updates menu point. Clicking on this menu point opens to an overview of all possible updates for your installed plugins. Plugins can be updated directly from the Plugin Manager. After starting an update, the system will check whether or not the update was successful and notify you of the update status.

Plugin detail page

The plugin detail page will appear several places throughout the plugin manager (i.e. when opening a plugin in a category or the Installed listing. Depending on the status, the detail page can appear different for each plugin. If the plugin has yet to be purchased, the detail page appears like this:

In this case, you can either directly purchase the plugin, rent it or request a test version. For this, a test license is automatically created and imported into your system so you can immediately begin testing the plugin. If you have already purchased the plugin, the detail page appears like this:

The plugin status is updated live within the Plugin Manager. In you have purchased a plugin which requires configuration (i.e. PayPal), a new tab with the configuration settings will be shown following the plugin installation:

Buying a plugin

A plugin can be purchased directly from its detail page. Simply select the license version (test, rent or purchase) and finalize the process after logging into your Shopware account. Since licenses are domain-specific, you can select the domain which will always be associated with the plugin during the purchase process.

Discover

Beneath Discover, you can view all available plugins just as they appear in the Community Store.

This view provides a category tree (left of the Plugin Manager), filters (top portion of the window) and the current plugins available in the Store. Plugins which have already been installed and/or waiting for an update are marked within the listing.

Click on a plugin to open the plugin detail page. You can also purchase and install a plugin directly by simply clicking on the action buttons within the detail page. Plugins that have already been integrated (core plugins) can be activated following the same procedure.

Exception-Codes - Backend & Plugin-Manager

Below you will find a list of known error messages.

Binaries Exception

BinariesException-0 LINK_NOT_FOUND: -

BinariesException-1 DESERIALIZATION_FAILURE: -

BinariesException-2 INVALID_UPLOAD_FILE: -

BinariesException-3 INVALID_BINARY: -

BinariesException-4 CHANGESET_INVALID: -

BinariesException-5 CANNOT_DELETE_BIANRY_THAT_SUCCEEDED_CODE_REVIEW : -

BinariesException-6 BINARY_PATH_INVALID: There are problems with the provided versions. Please contact the Pluign manufacturer directly.

BinariesException-7 BINARY_DOUBLE_CHECK: -

BinariesException-8 STORING_ENCRYPTED_BINARY_FAILED: -

BinariesException-9 REMOTE_IONCUBE_ENCRYPTION_FAILED: -

BinariesException-10 SHOPWARE_VERSION_NOT_GIVEN: -

BinariesException-11 NO_FITTING_BINARY_FOUND: -

BinariesException-12 SHOPWARE_VERSION_INVALID: -

BinariesException-13 PLUGIN_NOT_FOUND: -

BinariesException-14 UNAUTHORIZED: The licenses for the installed Shopware version are not valid. Check via your Shopware account the license whether they match the used Shopware version or the licensed Url.

BinariesException-15 NO_LICENSE_FOUND: There is no valid license for the used shop url. Check the licenses for the plugin in your Shopware account. These will be assigned to another shop url.

BinariesException-16 SHOPWARE_MAJOR_VERSION_MISMATCH: The Pluign license is not valid for the Shopware version you use. Check your licenses in your account and update them. Check there also the used version of your Shopware instance.

BinariesException-17 LICENSE_EXPIRED: The license is no longer valid. You must purchase a valid license through the Community Store. Also check in the license manager if there are 2 licenses for the plugin and remove the trial license.

BinariesException-18 LICENSE_SUBSCRIPTION_DEFECT: -

BinariesException-19 LICENSE_SUBSCRIPTION_EXPIRED: The plugin can not be downloaded or updated due to an expired plugin-subscription. Please purchase a valid subscription via your Shopware account.

BinariesException-20 NO_COMPATIBLE_BINARY_FOUND: There is no approved plugin version for the Shopware version you are using. Please contact the plugin manufacturer to check this fact.

BinariesException-21 NO_RELEASED_BINARY_FOUND: -

BinariesException-22 CANNOT_ENCRYPT_BINARY: -

BinariesException-23 MISSING_OR_INSUFFICIENT_CHANGELOG: The plugin did not contain a changlog (is mandatory). Contact the provider of the plugin.

Plugin Licenses Exception

PluginLicensesException-1 LICENSE_NOT_FOUND: No valid license for your shop was found. Purchase a valid plugin license through the Shopware account.

PluginLicensesException-2 REFERENCED_PLUGIN_NOT_FOUND: -

PluginLicensesException-3 REFERENCED_PLUGIN_NOT_FOUND: The plugin license does not match the version of Shopware that you have licensed. Purchase a valid plugin license from the shop for your shop.

PluginLicensesException-4 MULTIPLE_LICENSE: The plugin has already been purchased and maybe installed for the licensed shop url.

PluginLicensesException-5 -

PluginLicensesException-6 LICENSE_OWNED_WITH_BETTER_PRICE_MODEL: -

PluginLicensesException-7 BINARY_DOUBLE_CHECK: -

PluginLicensesException-8 UNAUTHORIZED_ATTEMPT: The shopwareID does not match the shop. You have to register with the shopwareID belonging to your shop.

PluginLicensesException-9 INVALID_PARAMETERS: Probleme with the Composer: https//github.com/shopware/composer-project/commit/5ab6ed149b53436831fdd1ef14e3ac8d46604e22

PluginLicensesException-10 INVALID_SUBSCRIPTION_RENEWAL: -

PluginLicensesException-11 SUBSCRIPTION_RENEWAL_WITHOUT_PRICE: -

PluginLicensesException-12 NOT_ALLOWED_TO_REACTIVATE: -

PluginLicensesException-13 PLUGIN_ALREADY_LICENSED: -

PluginLicensesException-14 NOT_ALLOWED_TO_MOVE: -

PluginLicensesException-15 TARGET_CAN_NOT_BE_STAGING_SHOP: -