Skip to main content

plentyBase

plentyBase is a tool that enables your local computer to communicate with plentymarkets.

1. Why do I need plentyBase?

You need to install and run plentyBase to perform the following tasks from the plentymarkets back end:

  • Carrying out processes that automatically print documents or shipping labels

  • Print documents from the plentymarkets back end

  • Show print history in the plentymarkets back end

  • Print plentyPOS receipts on local printers

Learn about plentyBase in our playful tutorial:

plentyBase

2. Installing plentyBase

Before you install plentyBase, make sure that the general system requirements that also apply to your regular plentymarkets system are fulfilled.

You can find the installation files for plentyBase in the plentyMarketplace. Select your operating system from the drop-down list the right side before clicking on Free download.

Then, install plentyBase on your computer just as you would any other program. Since the installation process differs depending on your operating system, only plentyBase specific settings are described in the following.

Installing plentyBase:

  1. Run the installation file.

  2. During the installation process, select the HTTPS port for communication between the computer and plentyBase for the option Enter a HTTPS port above 1023.
    Note: The HTTPS port 7331 is selected by default because it is free on most computers. Only change this default value if the port 7331 is already in use on your computer.
    Tip: Open the command line and use one of the following commands to see which ports of your computer are already in use:

    • Windows: netstat -ano | find/i “listening”

    • Mac OSX: sudo lsof -i -P | grep -i LISTEN
      Note: If you want to connect plentyBase to the plentymarkets app to print plentyPOS receipts using a local printer, activate the option Add HTTP server with the following port: and enter an HTTP port. The HTTP port 7332 is selected by default because it is free on most computers. Only change this default value if the port 7332 is already in use on your computer.

  3. Complete the installation process.
    → plentyBase is installed on the computer.
    → plentyBase is added to the auto-start programs of the operating system (Windows and MacOS only).

  4. Click on the plentyBase icon in the computer’s task bar.

  5. Select the option Open configuration from the drop-down list.
    → The Configuration window opens.

  6. Activate the option Check for updates on plentyBase startup.

  7. Click on OK to save the settings.

3. Saving plentyBase connection data in the plentymarkets back end

After installation, save the connection data in the plentymarkets back end. This ensures that your plentymarkets system can communicate with plentyBase.

Saving plentyBase connection data in the plentymarkets back end:

  1. Log in to the back end of your plentymarkets system.

  2. Go to plentymarkets Logo (Start) » plentyBase.
    → The plentyBase dashboard opens.

  3. Open the Settings view.

  4. Carry out the settings. Note Table 1.

  5. Save the settings.
    → plentyBase is now active and offers its functionalities to all users of your plentymarkets system.
    → The plentyBase icon is displayed in the computer’s task bar. This shows that the tool is running.

  6. Copy the access token to the clipboard.

  7. Click on the plentyBase icon in the computer’s task bar.

  8. Select the option Open configuration from the drop-down list.

  9. Activate the option Use authentication.

  10. Click on Manage access token.
    → The Manage access token window opens.

  11. Click on Add.
    → The Add access tokens window opens.

  12. Paste the access token from the clipboard to the Access token field.

  13. Enter a description of the token (optional).

  14. Click on Add.
    → The access token is saved.

Table 1. Saving plentyBase connection data in the plentymarkets back end

Setting

Explanation

Server address

Do not change the default address https://local.plentybase.de saved in this field.

Port

The HTTPS port that you assigned to plentyBase during installation. The default value is 7331. If a different HTTPS port was specified during installation, enter the number of that HTTPS port.
Note: The ports 0 to 1023 are system ports and cannot be used.

Test connection

Checks if plentymarkets is connected to plentyBase.

Generate system-wide access token

The access token is used for authentication with the plentyBase API interface. Click on Generate token and confirm your action to generate a new access token.
Note: The previous access token is overwritten whenever you generate a new access token. Save the new token immediately in the plentyBase settings after generating it. Are you using plentyBase on multiple computers? If yes, make sure that the token is saved on every device.

4. Limiting access to local directories via plentyBase

By default, plentyBase has access on all directories of your computer. Do you want to restrict access to specific directories? If so, proceed as described below to grant access to selected directories only. As a result, all directories on your computer that you have not selected will be automatically blocked for access via plentyBase.

Limiting access to local directories via plentyBase:

  1. Click on the plentyBase icon in the computer’s task bar.

  2. Select the option Open configuration from the drop-down list.

  3. Click on Manage directory access.
    → The Manage directory access window opens.

  4. Click on Add.
    → The directories available on the computer are listed in the Open window.

  5. Click on the directory that you want to grant access to.

  6. Click on Select.
    → The directory is shown in the list of the Manage directory access window. The option Access is automatically activated.

  7. To grant access to all subdirectories of the directory, activate the check box in the Subdirectories column.

  8. Add additional directories as necessary.

  9. Click on OK to save the settings.
    → plentyBase can now only access the directories activated in the Access column.

5. Granting plentyBase access to additional domains

plentyBase provides an interface between plentymarkets and the computer on which plentyBase is installed. To prevent unauthorised access, plentyBase can only access the local computer via the following plentymarkets domains:

  • plentymarkets-cloud-de.com

  • plentymarkets-cloud-ie.com

Additional domains must be specified in the plentyBase settings. To do so, proceed as described below.

Granting plentyBase access to additional domains:

  1. Click on the plentyBase icon in the computer’s task bar.

  2. Select the option Open configuration from the drop-down list.

  3. Click on Manage domain access.
    → The Manage domain access window opens.
    → A list of the saved domains is shown.

  4. Click on Add.
    → An additional empty line is inserted.

  5. In the Domain column, double-click on the empty line.

  6. Enter the domain without the leading https:// or http://.

  7. Activate the check box in the Access column.

  8. Add additional domains and grant accecss as necessary.

  9. Click on OK to save the settings.

6. Making plentyBase available in a network

You can install plentyBase on one computer of a network and make it available for other computers within the same network. To use plentyBase within a network, the IP address and the host name of the computer on which plentyBase is installed need to be saved in the HOSTS files of the other computers in the network.

6.1. Installing plentyBase on a network computer

  • First, install plentyBase on a computer within the network.

  • Write down the IP-address of the host computer on which plentyBase is installed.

  • Note: We recommend assigning a static IP address to the host computer.

  • If you did not use the default HTTPS port 7331, also write down the HTTPS port number you entered during installation.

6.2. Saving IP data in HOSTS file of other network computers

The HOSTS file is a local text file of the operating system in which host names are assigned to specific IP addresses. In the HOSTS file of the client computer, you enter the IP address and host name of the computer in the network on which plentyBase is installed. This way, the client computer can access plentyBase. You need admin rights to edit the HOSTS file of the client computer.

Edit the HOSTS file at your own risk

The HOSTS file is an important system file. You edit this file at your own risk. plentymarkets does not assume any guarantee or liability for any damages, subsequent damages or loss that may be caused by modifying the HOSTS file. Also note the following:

  • Before editing the host file, create a backup copy of the host file.

  • Do not delete or edit existing entries in the HOSTS file.

The process of editing the HOSTS file differs according to the operating system that you are using. Click on the appropriate tab to view instructions for your operating system.

Editing the HOSTS file in Windows:

  1. Click on the Windows symbol at the bottom left.
    Windows 8 only: Navigate to the tile view.

  2. Search for Editor.
    → The editor is shown in the list of programs.

  3. Right-click on the editor shortcut and select Run as administrator.

  4. Confirm the dialogue by clicking on Yes.
    → The editor opens.

  5. Click on File » Open.

  6. Navigate to the path C:\\Windows\\System32\\Drivers\\etc.
    Tip: From the drop-down list on the bottom right, select the option*All files*.
    → The HOSTS file opens and can be edited.

  7. At the bottom of the file, enter the IP address of the host computer on which plentyBase is installed followed by the host address local.plentybase.de. This results in the following pattern:
    [IP address of the host computer] local.plentybase.de
    Example: 123.123.1.123 local.plentybase.de
    Note: Lines beginning with are comments and will not be interpreted. Thus, your entry cannot start with .

  8. Save the file.
    Tip: If plentymarkets is open in a browser, reload the browser tab.

  9. If you did not enter the default port HTTPS port 7331during installation on the host computer, enter the HTTPS port of the host computer in the plentymarkets back end.

Editing the HOSTS file in MacOSX:

  1. Open the Finder.

  2. In the task bar, click on Go to » Go to folder …​.
    → The window Go to folder …​ window opens.

  3. Enter /private/etc into the field.
    → The file etc opens.

  4. Copy the hosts file.

  5. Paste the copy to a different folder or to the desktop.

  6. Open the copy of the hosts file with TextEdit or another editor.

  7. At the bottom of the file, enter the IP address of the host computer on which plentyBase is installed followed by the host address local.plentybase.de. This results in the following pattern:
    [IP address of the host computer] local.plentybase.de
    Example: 123.123.1.123 local.plentybase.de
    Note: Lines beginning with are comments and will not be interpreted. Thus, your entry cannot start with .

  8. Save the file.

  9. Drag and drop the edited copy of the file to the original folder /private/etc.
    → A warning is displayed.

  10. Confirm that you want to replace the unedited file.

  11. Enter your user password to confirm the replacement.
    → The file is saved.
    Tip: If plentymarkets is open in a browser, reload the browser tab.

  12. If you did not enter the default port HTTPS port 7331during installation on the host computer, enter the HTTPS port of the host computer in the plentymarkets back end.

Editing the HOSTS file in Linux:

  1. Open the file manager.

  2. Navigate to the path /etc.
    → Open the hosts file with a text editor and administrator rights.

  3. At the bottom of the file, enter the IP address of the host computer on which plentyBase is installed followed by the host address local.plentybase.de. This results in the following pattern:
    [IP address of the host computer] local.plentybase.de
    Example: 123.123.1.123 local.plentybase.de
    Note: Lines beginning with are comments and will not be interpreted. Thus, your entry cannot start with .

  4. Save the file.
    Tip: If plentymarkets is open in a browser, reload the browser tab.

  5. If you did not enter the default port HTTPS port 7331during installation on the host computer, enter the HTTPS port of the host computer in the plentymarkets back end.

6.3. Saving plentyBase connection data in the plentymarkets app

You can also connect plentyBase to the plentymarkets app. To establish a connection between plentyBase and the plentymarkets app, you need to activate the option HTTP port in the plentyBase configuration settings and enter a HTTP port. The HTTP port 7332 is selected by default.

After saving the plentyBase connection data in the plentymarkets app, you can:

  • Print plentyPOS receipts on any printers that can be accessed from the computer on which plentyBase is installed.

  • Run plugins that require plentyBase in the app.

You need the following data to save the plentyBase connection data in the plentymarkets app:

  • The IP address of the computer on which plentyBase is installed.

  • The HTTP port that was assigned to plentyBase on the computer.

Information on receipt printers

Receipt printers are linked to the plentymarkets app via their IP address. Thus, plentyBase is not required to run a receipt printer.

Saving plentyBase connection data in the plentymarkets app:

  1. Log into the plentymarkets app.

  2. In the menu bar, tap the menu symbol.

  3. Tap on Settings.

  4. Tap on plentyBase.
    → The plentyBase settings menu opens.

  5. Carry out the settings. Note Table 2.

  6. Save the settings.

Table 2. Saving plentyBase connection data in the plentymarkets app

Setting

Explanation

IP address

The IP address of the computer on which plentyBase is installed. If plentyBase is installed in a network and can be accessed by other computers, enter the IP address of the host computer.

HTTP port

Enter the HTTP port that was assigned to plentyBase on the computer. Port 7332 is selected by default. Click on the plentyBase icon in the computer’s task bar and then on Open configuration to see which HTTP port is used.

Test connection

Tap to test if a connection to the computer on which plentyBase is installed can be established.

Authentication

Access token

Enter the access token that is saved in plentyBase for this computer.
Tip: The access token is displayed as a QR code in the plentymarkets logo (Start) » plentyBase » View: Settings in the plentymarkets back end. To scan the QR code, tap the QR code symbol at the top right of the app screen and scan the QR code.

Generate access token

Tap to generate a new access token.
Note: If a new access token is generated in the plentymarkets app, this token must also be saved in the settings of the plentyBase tool. Make sure to save the new token on all computers and mobile devices on which plentyBase is used.

7. Installing a plugin for plentyBase

The following plugins are available in the plentyMarketplace and require that plentyBase is already installed:

Pay attention to the following instructions when installing one of those plugins.

Installing a plugin for plentyBase:

  1. Save the installation file of the plugin on the computer on which plentyBase is installed.
    Note: The installation files of plentyBase plugins always have the file ending .jar.

  2. Log in to the back end of your plentymarkets system.

  3. Go to plentymarkets Logo (Start) » plentyBase.
    → The plentyBase dashboard opens.

  4. Open the Plugins view.

  5. Click on Install plugin.

  6. Navigate to the plugin installation file.

  7. Select the installation file.
    → The plugin is installed.
    → The plugin is displayed in the list of plugins.

8. Sending plentyBase log files to the plentymarkets support

Proceed as described below to send plentyBase log files to the plentymarkets support.

Only send log files upon request

Always wait until a member of the plentymarkets support team requests the log files before sending them. Always send the file as an attachment of a private message to the group @plenty-prozesse in the plentymarkets forum.

Sending plentyBase log files to the plentymarkets support:

  1. Start plentyBase.

  2. Run the process until the behaviour that you would like to report occurs.

  3. Click on the plentyBase icon in the computer’s task bar.

  4. Click on Show log files.
    → The Logs file is displayed.

  5. Pack the plentyBase.log`file as a ZIP or RAR file.
    Tip: The `plentyBase.log
    file always contains the latest log data. Did the behaviour occur on a different day? Then pack the file with the date on which the behaviour occured.

  6. Send the file as an attachment of a private message to the group @plenty-prozesse in the plentymarkets forum. If possible, include a link to your original forum thread. Alternatively, include the error message(s) displayed and the IDs of orders and items that are affected by the behaviour. This helps the support team to analyse possible errors faster.

9. plentyBase: FAQ and error handling

The following sub-chapters list the questions and errors that frequently arise in connection with plentyBase.

9.1. "Authentication for plentyBase tool missing. Check access token settings.”

This message is not exactly an error message. Rather, it informs you that you have not yet set up an access token to establish a secure connection between plentymarkets and plentyBase.

Create a token in plentymarkets and save it in plentyBase to keep this message from appearing. To do so, proceed as described below.

Starting plentyBase and opening the menu:

  1. Start plentyBase.

  2. Log in to the back end of your plentymarkets system.

  3. Go to plentymarkets Logo (Start) » plentyBase.

  4. Open the Settings tab.

  5. Generate a token and copy it to the clipboard.

  6. Save () the changes.

accesstoken EN

Opening the settings:

  1. Click on the plentyBase logo in your computer’s task bar and click on Open configuration.

process
baseWin

Saving a token:

  1. Click on Manage access token.

  2. Click on Add.

  3. On the right, paste the copied token from the clipboard. To the right, enter plentymarkets, for example.

  4. Click on OK.

9.2. “plentyBase not connected. Check status”

The error message “plentyBase not conneected. Check status` refers to different connection problems that may occur with plentyBase. First, make sure that you have correctly generated and saved the plenty access token as described above.

If you are using a Fritz!Box, connection problems might be directly related to it. Users operating a Fritz!Box can find a suitable forum in this forum topic .

To top