Skip to main content

Plugins and plugin sets

1. Plugin overview - managing plugin sets

The following tables lists all UI elements of the Plugin overview menu and provides a short description for each of them. Furthermore, this section includes instructions for creating, editing and deleting your plugin sets.

Table 1. Table view of the Plugin » Plugin overview menu
Element Explanation

Create new set

Open a window for creating a new plugin set.
Save: Saves the new plugin set.
Plugin set name: Name of the plugin set.
Copy plugin set: Select an existing plugin set from the drop-down list to copy all of its settings.

Link plugin sets

A new window opens. From the drop-down list, select a plugin set for each client. Save the settings to link the clients to the selected plugin sets. Unlink a client completely by selecting the empty line from the drop-down list.

Name of the plugin set

The plugin overview of the plugin set opens.

Delete plugin set

Deletes the plugin set. Requires confirmation.

Filter

Search: Loads all plugins of the plugin set in the plugin overview that conform to the selected filter settings.
Reset: Resets the filter settings to the default settings.
Name: Filters for plugins whose name includes the entered string.
plentyMarketplace: Filters for plugins which were added to the system via plentyMarketplace.
Git: Filters for plugins which were added to the system via a Git repository.
Local: Filters for plugins which were added to the system via local storage.
Installed: Filters for plugins which are installed in the selected plugin set.
Not installed: Filters for plugins which are not installed in the selected plugin set.
Active: Filters for plugins which are activated for the selected plugin set.
Not active: Filters for plugins which are not activated for the selected plugin set.

Save & deploy plugin set

Saves changes made to the plugin set and deploys plugins in the set for further use.

Plugin set preview

Opens a new tab displaying a preview of the front end with the current settings. Plugin sets must be deployed before changes are reflected in the preview.

plentyDrive: build automatically

When activated, whenever you add plugins to the plugin set via plentyDrive, the plugin set will be saved and deployed automatically.

Plugin set settings

A window for editing the selected plugin set opens.
Save: Saves the settings.
Name: Changes the name of the plugin set.
Plugin set ID: ID of the plugin set.
Export configuration: Exports configuration of all plugins in the plugin set as JSON.
Config file: Displays local file path of file selected for configuration import.
Select file: Opens file picker to select local file for configuration import.
Reset: Resets local file path.
Import configuration: Imports configuration for all plugins in the set from valid JSON file.

Log

Only visible when error messages exist. Displays the error messages.

Active

Shows whether the plugin is active or not.

Name

Name of the plugin. If the plugin is installed, click to view information and settings.

Installed version

The version of the plugin currently installed. A symbol indicates when a newer version of the plugin exists.

Active version

The deployed version of the plugin.

Source

Can be plentyMarkets, Git or a local storage.

Action

Install plugin: Installs the plugin. In a new window, you can select the version of the plugin you want to install and view the changelog. Only visible when the plugin is not installed.
Update: Updates the plugin to a newer version. In a new window, you can select the version of the plugin you want to install and view the changelog. Only enabled when there is a newer version of the plugin.
No update available: The latest version of the plugin is installed.
Set position: Determines the order in which plugins are loaded. Plugins set to a low position are loaded first.
Delete: Removes the plugin from the plugin set. Requires confirmation.

plentyMarketplace

Opens plentyMarketplace in a new tab.

A plugin set is a collection of multiple plugins. These sets can all be managed for one or multiple clients in the Plugin overview. They contain one or multiple plugins as well as settings for plugin configuration and layout containers. Plugin sets especially benefit sellers who use plentymarkets to manage multiple online stores at the same time. They can activate and configure different plugin sets for different clients.

The following sections describe how to create new plugin sets, edit plugin sets and delete plugin sets.

2. Creating plugin sets

Creating a new plugin set:

  1. Go to Plugins » Plugin overview.

  2. Click on Add ().
    → The New plugin set window opens.

  3. Enter a name for the plugin set.

  4. Save () the settings.

Plugin set name

Plugin set names may only contain certain characters. All letters from the German alphabet are permitted, including umlauts and 'ß'. You may also use numbers, the characters '-', '_', '.' and empty spaces. Plugin set names must contain between 3 and 255 characters.

3. Editing plugin sets

3.1. Changing the name of a plugin set

Changing the name of a plugin set:

  1. Go to *Plugins » Plugin overview.

  2. Click on the plugin set you want to edit.
    → The plugin overview for the selected set opens.

  3. Click on the Plugin set settings () button.
    → The Settings window opens.

  4. Under Name, enter the new name for your plugin set.

  5. Save () the settings.
    → The name of the plugin set is updated.

Backup

Whenever you want to edit a plugin set, either by adding new plugins to the set, updating existing plugins or deleting plugins, it is recommended that you first create a backup of the plugin set and use this backup to implement your changes. This prevents any unforeseen consequences of the changes from affecting your actual store.

3.2. Adding plugins

Copying a plugin set:

  1. Go to Plugins » Plugin overview.

  2. Click on Add ().
    → The New plugin set window opens.

  3. Enter a name for the plugin set.

  4. Select a plugin set from the Copy plugin set drop-down list to copy that plugin set’s settings.

  5. Save () the settings.

Plugin set name

Plugin set names may only contain certain characters. All letters from the German alphabet are permitted, including umlauts and 'ß'. You may also use numbers, the characters '-', '_', '.' and empty spaces. Plugin set names must contain between 3 and 255 characters.

Installing a plugin:

  1. Click on the plugin set you want to edit.
    → The plugin overview for the selected set opens.

  2. Use the filter by checking the Not installed checkbox and clicking on Search (). If you want to install plugins you have added via a Git repository or local storage, also check Git or Local respectively.
    → The plugin overview is updated according to the selected filters.

  3. To install a plugin, under Action, click on the Install plugin () button associated with the plugin.
    → A new window opens, allowing you select the version you want to install. Select the version you want to install from the Version to install drop-down list. The newest version is selected by default. A text field below the drop-down list shows the changelog of the currently selected version. Click on Install to install the selected version.
    → The plugin is installed and available in the plugin overview of the plugin set. The overview shows all currently installed plugins.

Activating a plugin:

  1. To activate a plugin in a plugin set, under Active, click on the Not active () button associated with the plugin.
    → Activated plugins will be loaded for the selected plugin set in both the front end and back end.

Setting the position of a plugin:

  1. To set the position of a plugin, under Action, click on the Set position () button associated with the plugin.
    → The Plugin position window opens.

  2. Enter the position you want to assign to the plugin in the text field.

  3. Save () the settings.
    → The position of the plugin is updated.

Plugin position

A plugin’s relative position determines the order in which plugins of the plugin set are loaded. The rule is that Plugins with a lower position are loaded earlier. Normally, you want to set the IO plugin to the highest position and the Ceres plugin to the second highest. An exception are theme plugins, which are usually placed in-between Ceres and IO.

Saving and deploying a plugin set:

  1. Click on Save & deploy plugin set ().
    → A progress bar appears. Once the deployment process has finished, it will be replaced by a timestamp indicating the last time the plugin set was deployed successfully. If any errors occur during the process, a flashing warning button appears instead. Click on it for further information on what caused the problem.

Opening the plugin set preview:

  1. Click on Plugin set preview ().

  2. Select the online store you want to preview the plugin set with.
    → The selected online store and its selected plugin set open in a new browser tab.

If you are satisfied with the changes you have made, you can link the set to your client.

Linking a plugin set:

  1. Click on Link plugin sets ().
    → The Link plugin sets window opens.

  2. From the drop-down list, select the plugin set you want to use for your online store.

  3. Save () the settings.

Linking plugin sets

Linking a plugin set to a client makes all plugins of that plugin set public. This happens immediately. You should test the plugin set thoroughly and utilize the preview function before linking it.

3.3. Updating plugins

Copying a plugin set:

  1. Go to Plugins » Plugin overview.

  2. Click on Add ().
    → The New plugin set window opens.

  3. Enter a name for the plugin set.

  4. Select a plugin set from the Copy plugin set drop-down list to copy that plugin set’s settings.

  5. Save () the settings.

Plugin set name

Plugin set names may only contain certain characters. All letters from the German alphabet are permitted, including umlauts and 'ß'. You may also use numbers, the characters '-', '_', '.' and empty spaces. Plugin set names must contain between 3 and 255 characters.

Updating a plugin:

  1. If there is an update for a plugin, under Action, the Update button associated with the plugin will be highlighted. Click this button to update the plugin.
    → A new window opens, allowing you select the version you want to install. Select the version you want to install from the Version to install dropdown menu. The newest version is selected by default. A text field below the drop-down list shows the changelog of the currently selected version. Click on Install to install the selected version.
    → The plugin is updated.

Setting the position of a plugin:

  1. To set the position of a plugin, under Action, click on the Set position () button associated with the plugin.
    → The Plugin position window opens.

  2. Enter the position you want to assign to the plugin in the text field.

  3. Save () the settings.
    → The position of the plugin is updated.

Plugin position

A plugin’s relative position determines the order in which plugins of the plugin set are loaded. The rule is that Plugins with a lower position are loaded earlier. Normally, you want to set the IO plugin to the highest position and the Ceres plugin to the second highest. An exception are theme plugins, which are usually placed in-between Ceres and IO.

Saving and deploying a plugin set:

  1. Click on Save & deploy plugin set ().
    → A progress bar appears. Once the deployment process has finished, it will be replaced by a timestamp indicating the last time the plugin set was deployed successfully. If any errors occur during the process, a flashing warning button appears instead. Click on it for further information on what caused the problem.

Opening the plugin set preview:

  1. Click on Plugin set preview ().

  2. Select the online store you want to preview the plugin set with.
    → The selected online store and its selected plugin set open in a new browser tab.

If you are satisfied with the changes you have made, you can link the set to your client.

Linking a plugin set:

  1. Click on Link plugin sets ().
    → The Link plugin sets window opens.

  2. From the drop-down list, select the plugin set you want to use for your online store.

  3. Save () the settings.

Linking plugin sets

Linking a plugin set to a client makes all plugins of that plugin set public. This happens immediately. You should test the plugin set thoroughly and utilize the preview function before linking it.

3.4. Removing plugins

There are two ways to remove a plugin’s functionality from a plugin set. When you deactivate a plugin, it remains part of the set and you can activate it again at a later point without reinstalling or deploying the plugin. When you delete a plugin, it is removed from the set completely.

3.4.1. Deactivating plugins

Copying a plugin set:

  1. Go to Plugins » Plugin overview.

  2. Click on Add ().
    → The New plugin set window opens.

  3. Enter a name for the plugin set.

  4. Select a plugin set from the Copy plugin set drop-down list to copy that plugin set’s settings.

  5. Save () the settings.

Plugin set name

Plugin set names may only contain certain characters. All letters from the German alphabet are permitted, including umlauts and 'ß'. You may also use numbers, the characters '-', '_', '.' and empty spaces. Plugin set names must contain between 3 and 255 characters.

Deactivating a plugin:

  1. To deactivate a plugin, under Active, click on the Active () button associated with the plugin.
    → Deactivated plugins will not be loaded for the selected plugin set in both the front end and back end.

Saving and deploying a plugin set:

  1. Click on Save & deploy plugin set ().
    → A progress bar appears. Once the deployment process has finished, it will be replaced by a timestamp indicating the last time the plugin set was deployed successfully. If any errors occur during the process, a flashing warning button appears instead. Click on it for further information on what caused the problem.

Opening the plugin set preview:

  1. Click on Plugin set preview ().

  2. Select the online store you want to preview the plugin set with.
    → The selected online store and its selected plugin set open in a new browser tab.

If you are satisfied with the changes you have made, you can link the set to your client.

Linking a plugin set:

  1. Click on Link plugin sets ().
    → The Link plugin sets window opens.

  2. From the drop-down list, select the plugin set you want to use for your online store.

  3. Save () the settings.

Linking plugin sets

Linking a plugin set to a client makes all plugins of that plugin set public. This happens immediately. You should test the plugin set thoroughly and utilize the preview function before linking it.

3.4.2. Deleting plugins

Copying a plugin set:

  1. Go to Plugins » Plugin overview.

  2. Click on Add ().
    → The New plugin set window opens.

  3. Enter a name for the plugin set.

  4. Select a plugin set from the Copy plugin set drop-down list to copy that plugin set’s settings.

  5. Save () the settings.

Plugin set name

Plugin set names may only contain certain characters. All letters from the German alphabet are permitted, including umlauts and 'ß'. You may also use numbers, the characters '-', '_', '.' and empty spaces. Plugin set names must contain between 3 and 255 characters.

Deleting a plugin:

  1. To delete a plugin, under Action, click on the Delete () button associated with the plugin.

  2. Confirm that you want to delete the plugin.
    → Deleted plugins are removed from the plugin set.

Saving and deploying a plugin set:

  1. Click on Save & deploy plugin set ().
    → A progress bar appears. Once the deployment process has finished, it will be replaced by a timestamp indicating the last time the plugin set was deployed successfully. If any errors occur during the process, a flashing warning button appears instead. Click on it for further information on what caused the problem.

Opening the plugin set preview:

  1. Click on Plugin set preview ().

  2. Select the online store you want to preview the plugin set with.
    → The selected online store and its selected plugin set open in a new browser tab.

If you are satisfied with the changes you have made, you can link the set to your client.

Linking a plugin set:

  1. Click on Link plugin sets ().
    → The Link plugin sets window opens.

  2. From the drop-down list, select the plugin set you want to use for your online store.

  3. Save () the settings.

Linking plugin sets

Linking a plugin set to a client makes all plugins of that plugin set public. This happens immediately. You should test the plugin set thoroughly and utilize the preview function before linking it.

4. Deleting plugin sets

You can delete plugin sets you no longer need. However, plugin sets cannot be deleted if they are linked to an online store - you must unlink them first.

Unlinking a plugin set:

  1. Go to Plugins » Plugin overview.

  2. Click on Link plugin sets ().
    → The Link plugin sets window opens.

  3. From the drop-down lists of all clients linked to the plugin set, select the empty line.

  4. Save () the settings.

Deleting a plugin set:

  1. Click on the Delete plugin set () button associated with the plugin set you want to delete.
    → The Delete plugin set window opens.

  2. Confirm that you want to delete the plugin set.
    → The plugin set is deleted.

To top