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 Description

Create new set

Open a window for creating a new plugin set.
Save: Saves the new plugin set.
New Set: Name of the plugin set.
Copy Plugin Set: Select an existing plugin set from the dropdown menu to copy all of its settings.

Publish plugin set

Publishes the selected plugin set.

Name of the plugin set

Loads the plugin overview for the selected plugin set.

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 for the selected plugin set.
Not installed: Filters for plugins which are not installed for 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 & publish plugin set

Saves changes made to the plugin set and publishes 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 published 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 published automatically.

Plugin set settings

Opens a window for editing the selected plugin set.
Save: Saves the edited plugin set.
Name: Changes the name of the plugin set.
Plugin set ID: ID of the plugin set.

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 latest version of the plugin currently installed. A symbol indicates when a newer version of the plugin exists.

Active version

The activated version of the plugin. Will be loaded for the selected plugin set in both the front end and back end.

Source

The source of the plugin. 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 visible 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 plugin sets:

  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 dropdown menu to copy that plugin set’s settings.

  5. Save the settings.

Installing plugins:

  1. Click on the plugin set you want to edit.
    → This loads the plugin overview for the selected set.

  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.
    → The plugin overview will be 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 dropdown menu. The newest version is selected by default. A text field below the dropdown menu shows the changelog of the currently selected version. Click on the Install button to install the selected version.
    → The plugin will be installed and is then available in the plugin overview of the plugin set. The overview shows all currently installed plugins.

Activating plugins:

  1. To activate a plugin, 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 plugins:

  1. To set the position of a plugin, under Action, click on the Set position button associated with the plugin.
    → The Plugin position window will open. Enter the position you want to assign the plugin in the text field and click on Save.
    → The position of the plugin will be updated.

Position of plugins

A plugin’s relative position determines the order in which plugins of the plugin set are loaded. Plugins with a lower position will be 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.

Previewing plugin sets:

  1. Click on Plugin set preview.

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

Once you are satisfied with the changes you have made, you still need to save them.

Save and deploy plugin set:

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

Linking plugin sets:

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

  2. 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. 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.
    → This loads the plugin overview for the selected set.

  3. Click on the Plugin Set Settings button.
    → The Settings window will open.

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

  5. Save the settings.
    → The name of the plugin set changes.

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 using 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 dropdown menu to copy that plugin set’s settings.

  5. Save the settings.

Installing plugins:

  1. Go to Plugins » Plugin overview.

  2. Click on the plugin set you want to edit.
    → This loads the plugin overview for the selected set.

  3. 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.
    → The plugin overview will be updated according to the selected filters.

  4. 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 dropdown menu. The newest version is selected by default. A text field below the dropdown menu shows the changelog of the currently selected version. Click on the Install button to install the selected version.
    → The plugin will be installed and is then available in the plugin overview of the plugin set. The overview shows all currently installed plugins.

Activating plugins:

  1. To activate a plugin, 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 plugins:

  1. To set the position of a plugin, under Action, click on the Set position button associated with the plugin.
    → The Plugin position window will open. Enter the position you want to assign the plugin in the text field and click on Save.
    → The position of the plugin will be updated.

Position of plugins

A plugin’s relative position determines the order in which plugins of the plugin set are loaded. Plugins with a lower position will be 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.

Previewing plugin sets:

  1. Click on Plugin set preview.

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

Once you are satisfied with the changes you have made, you still need to save them.

Save and deploy plugin set:

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

Linking plugin sets:

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

  2. 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 publishing 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 dropdown menu to copy that plugin set’s settings.

  5. Save the settings.

Updating plugins:

  1. If there is an update for a plugin, the Update button associated with the plugin under Action 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 dropdown menu shows the changelog of the currently selected version. Click on the Install button to install the selected version.
    → The plugin will be updated.

Setting the position of plugins:

  1. To set the position of a plugin, under Action, click on the Set position button associated with the plugin.
    → The Plugin position window will open. Enter the position you want to assign the plugin in the text field and click on Save.
    → The position of the plugin will be updated.

Position of plugins

A plugin’s relative position determines the order in which plugins of the plugin set are loaded. Plugins with a lower position will be 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.

Previewing plugin sets:

  1. Click on Plugin set preview.

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

Once you are satisfied with the changes you have made, you still need to save them.

Save and deploy plugin set:

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

Linking plugin sets:

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

  2. 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 having to reinstall it. 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 dropdown menu to copy that plugin set’s settings.

  5. Save the settings.

Deactivating plugins:

  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.

Previewing plugin sets:

  1. Click on Plugin set preview.

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

Once you are satisfied with the changes you have made, you still need to save them.

Save and deploy plugin set:

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

Linking plugin sets:

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

  2. 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 dropdown menu to copy that plugin set’s settings.

  5. Save the settings.

Deleting plugins:

  1. To delete a plugin, under Action, click on the Delete button associated with the plugin.
    → Deleted plugins will be removed from the plugin set.

Previewing plugin sets:

  1. Click on Plugin set preview.

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

Once you are satisfied with the changes you have made, you still need to save them.

Save and deploy plugin set:

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

Linking plugin sets:

  1. Click on Link plugin set.
    → The Link sets window opens.

  2. 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 plugin sets:

  1. Go to Plugins » Plugin overview.

  2. Click on Link plugin set.
    → The Link sets window opens.

  3. Ensure that the plugin set you want to delete is not selected for any online store.

  4. Save the settings.

Deleting plugin sets:

  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 the deletion.
    → The plugin set will be deleted.

To top