Skip to main content

Managing plugins

Manage and deploy plugins that you purchased on the plentyMarketplace or developed yourself in the Plugins menu. Install new plugins, change the state of existing plugins or delete plugins. Find out how to create your own plugins on plentyDevelopers.

Plugin functionalities are extended continuously

The plentymarkets plugin module and the possibilities for editing plugins are extended continuously. The number of available plugins will increase over time.

1. Purchasing marketplace plugins

The plentyMarketplace is our platform for distributing software extensions for plentymarkets developed by plentymarkets or external developers. This platform makes plugins easily accessible and ensures that you can benefit from the advantages the new technology offers. To purchase a plugin, proceed as follows.

Purchasing plugins:

  1. Open the plentyMarketplace.

  2. Click on the Login button.

  3. Enter your email address and plentyID.
    → Use the same login data as for the service centre.

  4. Enter your password.

  5. Click on the Login button.

  6. Select a category and a plugin you want to purchase.

  7. In the detail view of the plugin, click on the Go to checkout button.
    → The Checkout window opens.

  8. Accept the terms and conditions.

  9. Click on Order now.
    → The purchased plugin is now available in the Plugins » Plugin overview menu.

2. Adding your own plugins from git

If you cannot find the plugin you need on the plentyMarketplace, you can also add your own plugins to your plentymarkets system. To add a plugin to plentymarkets that is managed by Git versioning, proceed as follows.

Adding a Git repository to plentymarkets:

  1. Go to Plugins » Git.

  2. Click on Add new Repository.
    → The options for the repository settings are displayed.

  3. Enter the necessary information for the Git repository. Pay attention to the explanations given in <tabelle-git-plugins-hinzufuegen>.

  4. Save the settings.
    → The connection to the Git repository is checked and established. The success message Repository saved appears.

Table 1. Adding git plugins
Setting Explanation

Repository URL

HTTPS or HTTP URL of the Git repository

User name

The user name is part of the user data of the provider (e.g. GitHub) for the Git repository.
For public repositories, enter a value into the field, e.g. guest.

Password or token

The password is part of the user data of the provider (e.g. GitHub) for the Git repository.
For public repositories, enter a value into the field, e.g. guest.
If two factor authentication has been activated, a token is needed.

Branch name

The Git repository has to include a valid Plugin.json. This input is required for the initial installation.

2.1. Deleting a Git repository

In the Plugins » Git menu, repositories can be deleted by clicking the Delete button.

3. 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 2. 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 plugins

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.

Plenty-Drive automatic build

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.
Pluginset 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.

Version to be installed

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

Version productive

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

Installing 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.

4. 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. Click Copy Plugin Set to copy settings from an existing plugin set.

  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 be installed 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. That is why you should set the IO plugin to the highest position and the Ceres plugin to the second highest.

Previewing Plugin Sets:

  1. Click on Plugin Set Preview.

  2. Select the online store that you want to preview. Before previewing a plugin, it set has to be deployed by clicking the Save & publish plugin button.
    → The selected online store and its selected plugin set open in a new browser tab.

Publishing plugin sets:

  1. Click on Publish plugin Set.
    → The Activate Sets window opens.

  2. Select the plugin set you want to use for your online store.

  3. Save the settings.

Publishing plugin sets

Publishing a plugin set for 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.

5. Editing plugin sets

5.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. Click on the Save button. → 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.

5.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. Click Copy Plugin Set to copy settings from an existing plugin set.

  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 be installed 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. That is why you should set the IO plugin to the highest position and the Ceres plugin to the second highest.

Previewing Plugin Sets:

  1. Click on Plugin Set Preview.

  2. Select the online store that you want to preview. Before previewing a plugin, it set has to be deployed by clicking the Save & publish plugin button.
    → The selected online store and its selected plugin set open in a new browser tab.

Publishing plugin sets:

  1. Click on Publish plugin Set.
    → The Activate Sets window opens.

  2. Select the plugin set you want to use for your online store.

  3. Save the settings.

Publishing plugin sets

Publishing a plugin set for 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.

5.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. Click Copy Plugin Set to copy settings from an existing plugin set.

  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 be installed 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. That is why you should set the IO plugin to the highest position and the Ceres plugin to the second highest.

Previewing Plugin Sets:

  1. Click on Plugin Set Preview.

  2. Select the online store that you want to preview. Before previewing a plugin, it set has to be deployed by clicking the Save & publish plugin button.
    → The selected online store and its selected plugin set open in a new browser tab.

Publishing plugin sets:

  1. Click on Publish plugin Set.
    → The Activate Sets window opens.

  2. Select the plugin set you want to use for your online store.

  3. Save the settings.

Publishing plugin sets

Publishing a plugin set for 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.

5.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.

5.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. Click Copy Plugin Set to copy settings from an existing plugin set.

  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. Before previewing a plugin, it set has to be deployed by clicking the Save & publish plugin button.
    → The selected online store and its selected plugin set open in a new browser tab.

Publishing plugin sets:

  1. Click on Publish plugin Set.
    → The Activate Sets window opens.

  2. Select the plugin set you want to use for your online store.

  3. Save the settings.

Publishing plugin sets

Publishing a plugin set for 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.

5.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. Click Copy Plugin Set to copy settings from an existing plugin set.

  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. Before previewing a plugin, it set has to be deployed by clicking the Save & publish plugin button.
    → The selected online store and its selected plugin set open in a new browser tab.

Publishing plugin sets:

  1. Click on Publish plugin Set.
    → The Activate Sets window opens.

  2. Select the plugin set you want to use for your online store.

  3. Save the settings.

Publishing plugin sets

Publishing a plugin set for 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.

6. Deleting plugin sets

Deleting plugin sets:

  1. Go to Plugins » Plugin overview.

  2. Click on the Delete Plugin Set button associated with the plugin set you want to delete.
    → The Delete Plugin Set window opens.

  3. Confirm the deletion.
    → The plugin set will be deleted.

7. Activating a back end plugin set

You can use active plugins in a plugin set not only to add additional features to your store, but also to add new menu items or user interfaces to your back end. Every user can select their own back end plugin set to load the plugins the set contains for their own back end. If you want to change the plugin set for your back end view, proceed as follows.

Selecting a back end plugin set:

  1. In the plentyMarkets back end, click on the account symbol in the upper right corner.

  2. Click on Backend Plugin set.
    → The Backend Plugin set window opens.

  3. Click on a plugin set.

  4. Save the settings. → The selected plugin set is now active in your back end.

8. Plugin configuration

After installing a plugin, you might want to configure it. Depending on the plugin, you will have one of two options. Either, when clicking on the name of the plugin in the plugin set, a window with configuration options opens, or a new interface is added to the System menu when installing the plugin. Any options you change within a plugin set only applies to that specific set. Any options you change in the System menu apply globally and affect all plugin sets, even when installing the plugin in a set at a later time.

Exceptions

For plugins developed before the introduction of plugin sets, configuration may be different.

To top