Skip to main content

Installing added plugins


To use plugins, you first have to include them in a plugin set and deploy the set. Create or copy a plugin set. In the plugin set, you can install and deploy the plugin. Finally, to use the plugin productively, you have to link it to your client or user account.

1. Creating a new plugin set

Plugins can only be used as part of a plugin set. Before you install a plugin, you first have to create a new plugin set. Even if you want to install a plugin in an existing plugin set, you should work with a copy of the set, so that you can easily revert your changes if necessary.

Backup

If you want to edit your plugin set, create a backup copy first. This way, you can easily discard changes.

To create a copy of a plugin set, select the plugin set you want to edit from the Copy plugin set drop-down list when creating a new plugin set.

Creating new 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. Save () the settings.

You can change the name of the plugin set at any time in the Plugin set 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.

2. Installing a plugin in a plugin set

The whole plugin installation process includes three steps. First, you have to install the plugin in a plugin set. That’s when the plugin files are transferred to your system. In the second step, you activate the plugin. By activating a plugin, you indicate that you want to include it when your system or online store is loaded. Finally, you deploy the plugin set with all its active plugins. By deploying the set, you finish the installation process.

Installing plugins:

  1. Go to Plugins » Plugin overview.

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

  3. Select the filter Not installed.

  4. Search () for all uninstalled plugins.
    The overview shows all currently uninstalled plugins.

  5. To install a plugin, click in the Action column on the Install plugin button ().
    → A new window opens, allowing you select the version you want to install.

  6. Select the version you want to install from the Version to install dropdown menu.
    Note: A text field below the drop-down list shows the changelog of the currently selected version. The newest version is selected by default.

  7. To install the selected version, click on*Install*.
    → The plugin is installed. The overview shows all currently installed plugins.

    Configuring plugins

    Once you’ve installed a plugin, you can configure it.

    For more information on whether or not a plugin needs to be configured and which settings are necessary, see the description of the plugin on plentyMarketplace.

  8. To activate the plugin in the plugin set, click in the Active column on the Inactive button ().

  9. Save () the plugin set.
    → To evaluate the results, pay attention to [tabelle-results-deploy].

Table 1. Results when deploying a plugin set
Result Explanation

Timestamp
plugin set zeitstempel

The deployment process was successful. The timestamp shows the date of the last successful deploy.

Error message
plugin set fehlerlog

There was an error when deploying the plugin set. Click on to open the error log.

No display

The deployment process was aborted.

3. Switching plugin sets to live

Once you’re satisfied with your plugin set, you can switch it live by linking it to one of your clients. Proceed as described below.

Plugin set preview

Use the plugin set preview () to check what your online store looks like using the selected plugin set.

Linking plugin sets:

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

  2. Select the plugin set from the drop-down list you want to link to your client.

  3. Save () the settings.

4. Linking plugin sets to user accounts

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. This is useful if you only need to be able to access certain functionality, but not all. 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.


To top