Using standard formats

You can use catalogue standard formats to export data from your PlentyONE system to a file in the formats CSV, JSON, TXT or XML. There are a variety of different standard formats for exporting different types of data. Not all types of data can currently be exported using catalogues. Until standard formats are available for all types of data, you can continue using the FormatDesigner for any data that is not currently supported by catalogues.

The following standard formats are currently available:

1. Understanding the catalogue menu for standard formats

When you open the menu Data » Catalogues, the first thing you see is the catalogue overview. You can get to know this catalogue overview here.

Click on a catalogue in order to open its detail view. The layout of this menu is the same for all standard formats, so it should look like this:

menu structure standard format

Tip: Your catalogue looks different? Then you probably opened a catalogue with a marketplace format instead. Marketplace formats used to export item data to specific markets and price portals and are elaborated on here instead.

When you open a catalogue, the view Data sources is shown by default. Use the navigation to switch to other views of the catalogue:

catalogue default navigation

Catalogue overview

Go back to the catalogue overview, that is to the list of catalogues.

List of opened catalogues

The navigation shows all catalogues that you accessed during your current session and allows you to easily switch between them.

Tip: You can remove a catalogue from the navigation by hovering over it with your cursor and clicking on the X that appears.

Settings

This menu contains all settings for the catalogue. The settings are grouped into four sections:

  • Basic settings: Basic information associated with the catalogue itself, such as its name and template type.

  • Format settings: Settings for the structure of export files generated by this catalogue.

  • Export settings: Settings for the automatic export of data via this catalogue to external storage.

  • Download settings: Settings for generating shareable URLs that can be used to access export files generated by this catalogue.

These sections also appear in the navigation bar, but do not need to be accessed separately.

Data fields

This menu is shown when you open the catalogue. In this view, you select the data sources that you want to export.

filter_alt Filter

Add filters to only export specific records.
Note: Filters are not available for all catalogues.

Tip: The number of filters that you activated for a catalogue is always displayed next to this menu item. Template filters, i.e. filters that are applied by default, are not included in the count.

filters number of filters

Own data sources

Own data sources are currently not available for most exports.

The toolbar provides quick access to various actions you can perform with the currently opened catalogue:

catalogue default toolbar

save Save

Saves any changes you made to the current view of the catalogue.

preview Preview

Creates a preview of the export data. The preview contains the first 5 data rows of the export file.

Important: The preview function is not available for all catalogue formats.

Asynchronous download

Starts a manual download of the catalogue data. The export is carried out as a background process, and the export file is available for download in your system’s Notifications once the process is finished.

play_circle Live download

Starts a manual download of the catalogue data. The download starts immediately in a new tab, and the file is automatically saved to your computer if you allowed your system to display popups in your browser.

playlist_play Status

Opens the menu Data » Catalogue export status and filters the list for this catalogue. This view allows you to check the status of all exports of the catalogue that have been initiated so far.

more_vert More

Shows additional actions:

history Restore catalogue version

Restores a previously saved version of the catalogue. The last 100 versions of the catalogue are available.

How do I restore other catalogue versions?
  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Alternative 1: In the catalogue overview

    1. In the row of the catalogue, open the further actions (more_vert).

    2. Click on Restore catalogue version (history).

  3. Alternative 2: In the catalogue menu

    1. Open the catalogue.

    2. In the toolbar, click on the additional actions ().

    3. Click on Restore catalogue version (history).

  4. In the window shown, select the version that you want to restore.
    Tip: The last 100 versions of the catalogue are available.

  5. Click on Restore.
    → The catalogue version is restored and displayed in the catalogue overview.

delete Delete catalogue

Deletes the catalogue.

How do I delete a catalogue?
  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. In the row of the catalogue that you want to delete, click on the further actions (more_vert).

  3. Click on Delete (delete).
    → You are asked to confirm your decision.

  4. Confirm the deletion.
    → The catalogue is deleted.
    Or: Open a catalogue.

  5. Click on the further actions (more_vert) at the top.

  6. Click on Delete catalogue (delete).
    → You are asked to confirm your decision.

  7. Confirm the deletion.
    → The catalogue is deleted.

To the right of the navigation, all PlentyONE data sources that you can export are listed in groups. To add a data source to the export, hover over the data source with your cursor and click on the + icon that appears on its right-hand side.

catalogue default data fields

Tips:

  • Use the field Search data source to quickly find and add data sources.

  • In addition to the data sources listed, you can also add own values to the export. The same value is then exported for each record.

  • Add the option Formula to recalculate numerical values during the export. For example, you could use this option to update all exported variation prices during the export.

On the right-hand side of the Data fields view, any data sources you have added to the catalogue so far are shown. These data sources will be exported to your file when an export is carried out. If no data sources have been added yet, then the message “No data sources were selected”. will be displayed instead. In the following screenshot a few data sources have already been added:

catalogue default added fields

Tips:

  • You can move the data sources using drag-and-drop. This will change the order in which the data sources are displayed in the export file.

  • You can optionally change the export keys of the data sources. “Export keys” are the names of the column headers as they will appear in your export file. Keep in mind that every export key used in the catalogue must be unique.

  • You can optionally add fallback data sources. If the primary data source provides an empty or invalid value, then the system will check the fallback data sources in sequence for usable values instead.

2. Creating catalogues

Creating a standard format catalogue is relatively simple. Proceed as follows:

Creating a catalogue:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Click on Create catalogue (add).
    → The Create catalogue pop-up menu opens.

  3. Carry out the settings. Pay attention to the explanations given in Table 1.

  4. Click CREATE CATALOGUE (save).
    → The catalogue is created.
    → The tab Settings (settings) opens.

Table 1. Creating a catalogue
Setting Explanation

Name
(required)

Enter a name for the catalogue.

Marketplace
(required)

Select the option Standard format.

Export type
(required)

Select a format type from the drop-down list. Different format types are used to export different kinds of data.

Category
(required)

Select a format from the drop-down list.
Note: For most format types only one format is selectable in this field. If the format type you selected offers multiple formats, then you can find an explanation of those formats on the format type’s manual page.

3. Setting up the catalogue export

Once you have created a catalogue you can customize it to suit your individual data export needs. This chapter explains the different customisation options for standard format catalogues in further detail.

Certain format types offer additional customisation options in the Settings menu of the catalogue. These additional options are explained on the manual pages dedicated to those format types.

3.1. Carrying out the format settings

The format settings are used to specify the file format in which the data is exported and how the export file is formatted.

Configuring the settings:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Click on the catalogue you want to customize.
    → The catalogue opens.

  3. In the navigation on the left, click on the tab Settings (settings).
    → The different settings are shown.

  4. Navigate to the section Format settings.

  5. Carry out the settings. Pay attention to the explanations given in Table 2.

  6. Save (save) the settings.

Table 2. Carrying out the format settings
Setting Explanation

File name

Enter a file name. The exported file is saved with this name.
Tip: The file extension is automatically added during the export. As such, enter the file name without a file extension. File extensions are for example .csv and .txt.

Tip: You can use placeholders in the file name. Placeholders are automatically replaced by additional information relating to the file name during export.

List of available placeholders

The following placeholders are available:

$$name

The catalogue name.

$type

The export type.

$format

The format type.

$timestamp

The time stamp of the export.

$datetime

The date and time when the export was started.

$year

The year when the export was started.

$month

The month the export was started in.

$day

The day the export was started on.

$hour

The hour the export was started in.

$minute

The minute the export was started in.

$second

The second at which the export was started

$lastChangeTimestamp

The timestamp of when the catalogue was last changed.

$lastChangeDatetime

The date and time when the catalogue was last changed.

$lastChangeYear

The year in which the catalogue was last changed.

$lastChangeMonth

The month in which the catalogue was last changed.

$lastChangeDay

The day on which the catalogue was last changed.

$lastChangeHour

The hour in which the catalogue was last changed.

$lastChangeMinute

The minute at which the catalogue was last changed.

$lastChangeSecond

The second at which the catalogue was last changed.

Examples for using placeholders:

Entry Result

item-export_$year_$month_$day

  • item-export_2022_01_02.csv

$type_$format_$year_$month_$day

  • order_order_2022_01_02.csv

    • check24_offer_2020_10_25.csv

Format

Select the file format for the export.

Possible values:

  • CSV

  • CSV - Array to JSON

  • JSON

  • TXT

  • XML

Field separator

Specify which character should be used to separate the contents of the file into individual data fields.

Possible values:

  • Comma = ,

  • Semicolon = ;

  • Pipe = |

  • Tabulator = ␉

Text delimiter

Specify which character should be used to separate text strings into individual values.

Possible values:

  • "

  • '

Encode special characters ()

If you activate this option, unicode characters (e.g. umlauts: ä, ö, ü) will be exported in encrypted form.
Note: This option is only available for the formats JSON and CSV - Array to JSON.

Line break

How do you want to handle line brakes in the export file?

Possible values:

  • Carriage return

  • Line feed

  • Carriage return an line feed

Header is included

Activate the option if you want the export file to contain a header line. The export keys are used as headings for the columns.

Decimal separator

Select the character that is used to separate the decimal part of a number from its integer part.

Possible values:

  • Comma
    Example: 20,00 Euro

  • Period
    Example: 20.00 Euro

3.2. Carrying out the export settings

The export settings determine where your export file is saved.

Carrying out the export settings:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Click on the catalogue for which you want to carry out the export settings.
    → The catalogue opens.

  3. In the navigation on the left, click on the tab Settings (settings).
    → The different settings options are shown.

  4. Navigate to the section Export settings.

  5. Carry out the settings. Pay attention to the explanations given in Table 3.

  6. Save (save) the settings.

Table 3. Carrying out the export settings
Setting Explanation

Limit

In this field you can optionally enter an upper limit for the amount of data sets that are included in the export.
Tip: You can use the Preview or Live download functions to determine how your data is organised in the export file and which data sets are excluded by the limit.

Skip empty files

If this toggle is activated, then empty files will not be exported to the target location.

Provisioning

Where do you want to save the export?
Important: This setting does not export any data to markets.

None

The export is not saved.

FTP

The export is saved on an FTP server.

FTPS

The export is saved on an FTPS server.

SFTP

The export is saved on an SFTP server.

SFTP extended

The export is saved on an SFTP server.
This option uses an alternate implementation of the SFTP protocol. As it is still relatively untested it should only be used if the regular SFTP option does not function as expected.

Server
(for FTP, SFTP, FTPS, SFTP extended)

Enter the server where you want to save the export.
Note: Do not enter a protocol prefix. Some examples for protocol prefixes are ftp:// and ftps://.

Port
(for FTP, SFTP, FTPS, SFTP extended)

Enter a port or use the default setting.

Recommended port settings:

  • For FTP and FTPS = Port 21

  • For SFTP = Port 22

User name
(for FTP, SFTP, FTPS, SFTP extended)

Enter the user name for the server.

Password
(for FTP, SFTP, FTPS, SFTP extended)

Enter the password for the server.

Path
(for FTP, SFTP, FTPS, SFTP extended)

Enter the path to a location on your server where the export files should be saved.
Note: If you use SFTP, enter the complete path.

Test connection
(for FTP, SFTP, FTPS, SFTP extended)

Tests the server settings that you entered:

  • Can PlentyONE connect to the server?

  • Can an export file be saved at the storage location?

Tip: A test file is saved at the storage location. This test file is called plentymarkets_ConnectionTestFile.txt.

Transfer

Select an interval in which the export should be carried out automatically.

Never

The export is never carried out automatically.

Every 20 minutes

The export is carried out every 20 minutes.

Once per hour

The import is carried out at every full hour (e.g. 3:00pm, 4:00pm etc.)

Once per day

The export is carried out once a day at around 2am German time.

Schedule: times

The export is carried out at specific times of day. You can specify these times of day in the Schedule: times field that appears while this option is selected.

Schedule: times
(Only appears when Schedule: times is selected)

Click into the field. In the drop-down list shown, select one or more points in time. The export is carried out at these times.

Weekdays
(for TransferNever)

By default, all weekdays are selected. To deactivate exports for specific days of the week:

  1. Click in the field Weekdays.
    → A drop-down list with weekdays is shown.

  2. Uncheck the checkbox for one or more weekdays (icon:check_box_outline_blank).
    → Exports are only started on weekdays with a check mark ().

Tip: The setting Weekdays is only shown if you select an interval or schedule for the setting Transfer.

3.3. Setting up download links

In the Download settings of the catalogue you can generate download links. These download links give you direct access to the export file.

  • The admin link only allows you to access the exported file if you are currently logged into your PlentyONE System as an admin.

  • You can limit how your data can be accessed via the public link by using the Use version and/or Use token options.

The catalogue must be active to create an export file. The export file can only be accessed after the first export.

Setting up the download:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Select the catalogue.
    → The catalogue opens.

  3. In the navigation on the left, click on Settings (settings).

  4. Navigate to the area Download settings.

  5. Carry out the settings. Pay attention to the explanations given in Table 4.

  6. Save the settings.
    → The link for downloading the file is shown. The export can be accessed using this link after the first export is completed.
    → The menu always shows the link for the last exported file.

  7. Click on the links or copy the links (content_copy) to use them.

Table 4. Download settings
Setting Explanation

Shop URL

Select the domain name that should be used to generate the download links. Each client managed in your system will offer two options in the list of available domain names:

  • The client’s domain name.
    Note: If you assigned a name to the client, then that name will be displayed instead of the domain name.

  • A domain name based on the client’s Plenty ID (e.g. if its PID is 12345, then the domain name will be p12345.my.plentysystems.com)
    Note: If this option is picked, then the domain will also be included in the links shown in the Admin link and Public link fields.

Receive notifications

Activate to get a notification at the top right of the system once the export is completed.

Options for admin link

Admin link

An admin link is automatically created for each file. This admin link only allows you to access the exported file if you are currently logged into your PlentyONE System as an admin.

Tip: Click on the icon to the right (content_copy) to copy the URL to your clipboard.

Use version

If this option is active, then a new admin link is generated every time any catalogue settings or mappings are changed. Export files created after the change are made available via this new admin link, while the export file created before the change remains available via the old link for 15 days. Tip: Do not activate this option if you always want to access the most current export file via the same admin link.

Options for public link

Activate options

No public link is created. The options Use version and Use token cannot be selected.

A public link is created. After the first export, the file can be accessed by anyone who knows this link.

Tip: In the row Public link, click on the icon to the very right (content_copy) to copy the URL to your clipboard.

Use version

If this option is active, then a new public link is generated every time any catalogue settings or mappings are changed. Export files created after the change are made available via this new public link, while the export file created before the change remains available via the old link for 15 days. Tip: Do not activate this option if you always want to access the most current export file via the same public link.

Use token

If this option is active, then a randomly generated security token is appended to the public link. A new security token can be generated at any time, and links containing the current security token can be used to access export files created by the catalogue.

Security token

Click on the symbol on the right () to generate a new token.

Tip: The current token is automatically added to the public link in the Public link field.

Public link

Shows the public link. After the first export, the file can be accessed by anyone who knows this link.

Tip: In the row Public link, click on the icon to the very right (content_copy) to copy the URL to your clipboard.

4. Selecting data for export

Now decide what PlentyONE data you want to export with this catalogue.

This is how the information in this chapter is structured:

4.1. Adding data sources to export

Now it’s time to decide which PlentyONE data source data sources you want to export from PlentyONE with this catalogue. To do so, add the data sources to the export as described below.

Adding data source to the export:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Click on the catalogue.
    → The view Data sources () of the catalogue opens.
    → The available PlentyONE data sources are listed in groups. In addition, the options Own value and calculate Formula are shown.

  3. Expand a data source group to see the list of data sources in that group.

  4. Click on the plus icon next to the data source that you want to export.
    Tip: Alternatively, enter the name of the data source into the search field. Select the data source from the search results.
    → The data source is added to the export.

  5. Check if the export key suits your needs.
    What is an export key and how should it be structured?
    The Export Key is the name of the column header that will be shown in your export file.

    • Each export key can only be used once in this catalogue.
      Important: If several data sources have the same export key, only one data source is exported.

    • Export keys cannot contain any spaces.

    • If the export key contains a dot, the data is exported in a tree structure. In most cases, this means that the data is not exported as expected. As such, we recommend that you do not use dots in export key names.

  6. Add all data sources that you want to export.

  7. Save (save) the settings.
    → The data sources are exported with this catalogue.

You can also use a variety of more complex export features that are explained in the collapsible boxes below:

Export a different data source if the first data source is empty (Add fallback data source)

Fallback data sources can be used to ensure that a particular type of data is exported, even when the preferred source of that data fails to provide it. Here is how they work:

  • If the primary data source provides a usable value for a record, then that value is exported and the fallback data sources linked to the primary data source are ignored.

  • If the primary data source does not provide a usable value for a record, then the fallback data sources are checked for usable values in sequence, going from top to bottom.

    • If a usable value is found, then that value is exported for that record and any remaining data sources are ignored.

    • If no usable value is found in any of the data sources, then no value is exported for that record.

Adding fallback data sources:

  • Initial setup:
    → You added a data source to the export. For this data source, you want to specify an alternative in case the data source is empty or invalid for one or more records.

    1. Below the data sources, click on + Add fallback data source.

    2. In the list of available data sources on the left-hand side of the screen, click on the plus to the right of the PlentyONE data source you want to use as a fallback.
      → The PlentyONE data source is added as a fallback data source to the field on the right.
      → The value provided by the fallback data source is exported if the data source above it does not return a usable value.

Note the following logic for fallback data sources:

  • Even if you assign one or more fallback data sources, the value of only one field is exported.

  • For each record, the PlentyONE data sources are checked in the order in which you mapped them, i.e. first the one at the top of the list, then the one below it etc.

  • Tip: You can use the data source Own value as a fallback data source in order to ensure that a value is exported for every record.

Optional: Export the same value for every record (Own value)

The data source Own value can be used to export the exact same value for every record.

Exporting an own value:

  1. In the list of available data sources, select the data source Own value near the top of the list.
    → The data source is added to the export.

  2. Check the export key. Own values are automatically assigned the export key own-value. As such, make sure that you adjust the export key, especially if you want to export more than one own value.
    Important: If several data sources have the same export key, only one data source is exported.

  3. Enter a value into the input field Value.
    → This value is exported for all records.

Combining multiple data sources

When you combine data sources, the following logic is applied:

  • The data sources are to be combined during the export.

  • The combined values of the data sources are inserted into a single column of the export file.

  • The character separating the values is specified with the option Separator.

Combining data sources:

  • Initial setup:
    You already added a data source to the export. You want to combine this data source with another data source.

    1. Next to the marketplace data source, click on + Add data source ().

    2. Click on the plus next to the data source you want to select.
      → The data source is added to the right of the first data source.

    3. Click on Confirm.

    4. To the right of the column, click on Settings ().

    5. Select a separator from the drop-down list Separator or specify a custom separator.

    6. Click on Save.

    7. Save () the catalogue.
      → The settings are saved.
      The content of these data sources is combined in the same column.

Recalculating numerical values (Formula)

Mathematical calculations allow you to modify numerical values automatically during the export.

This feature is not available for all export formats yet. Additionally, it can only be used with data sources that return numerical values.

Recalculating numerical values:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Open the catalogue you want to edit.
    → The tab Data sources opens.

  3. In the list of data sources, click on the plus next to the data source Formula (calculate).
    → The field Formula is added to the view on the right.

  4. Click on the field Formula.
    → The Create a formula window opens.

  5. At the bottom right of the window, select a data source to add it to the calculation (add).
    Tip: Use the search function. This helps you to find data sources quickly.
    → The data source is added to the calculation.

  6. Optional: If the symbol more_vert is shown in the data source, select the correct assignment for the data source.
    Tip: A number tells you how many assignments are necessary for the data source.

    1. Click on the icon more_vert.

    2. In the window shown, select the assignments from the drop-down list.

    3. Save the settings.

  7. Enter numbers and mathematical operators with the on-screen calculator or the keyboard.

  8. Save the settings.
    → The entered formula is displayed in the overview.
    Tip: If a preview is available for the format, check the result by using the preview function (preview).
    → The formula is used to calculate the values to be inserted into the records during the export.

Changing the order of data sources

The order of the data rows in the catalogue determines the order of the matching columns in the export file. In other words, the data from the first data row in the list is inserted into the first column from the left of the export file, the data from the second data row is inserted into the second column from the left etc.

If you would like your data to be presented in a different order in the export file you can rearrange it by dragging individual data sources or whole data rows around in the list with your cursor.

  • To move a single data source:

    • Point your mouse at the data source and drag and drop it to the new position.

  • To move a whole data row:

    • Click on the symbol (drag_indicator) on the left side and drag and drop the row to the new position.

4.2. Removing data sources from export

In the Mapping tab of a catalogue with a standard format you can remove individual or several data sources at once.

Removing data sources from export:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Open a catalogue with standard format.
    → The tab Data sources () with all available data sources opens.

  3. Click on the further actions (more_vert) on the right of the data source that you want to remove.

  4. Click on Delete data source (delete).
    → The data source is removed.
    Or: If you want to remove a complete row, click on Delete data row (delete) to the right of the data row.
    → The complete row is removed.
    Or: Tick the box on the left for all rows containing data sources that you want to remove. Then, click on Delete selected data sources (delete) at the top right.
    → All selected data rows are removed.

4.3. Filtering export data

You can use filters to limit the data that should be exported.

Adding a filter:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Open the catalogue you want to apply a filter to.

  3. In the navigation on the left, click on Filters (filter_alt).
    → The filter overview opens.

  4. Select a filter from the drop-down list.
    Tip: Different filters are available for different standard formats. You can find descriptions of the individual filters here:

  5. On the right, click on Add filter (add).
    → The filter is added.

  6. If an operator is available for this filter:

    • Select an operator from the drop-down list.

    • Enter a value into field next to it.

  7. Save (save) the settings.
    → The filter is saved.

  8. Add additional filters as necessary.
    → Only data that meets the filter criteria is exported.

5. Exporting catalogue data

There are several ways to export the catalogue data:

5.1. Creating an export preview

After you have selected data sources for export, you can test the catalogue export using the preview function. This preview function allows you to download the first 5 data rows of the export.

The preview function is not available for all catalogue formats.
  • Show a preview in the catalogue

  • Show a preview from the catalogue list

Showing a preview in the catalogue:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Open the catalogue you want to preview.

  3. In the toolbar at the top, click on Preview (preview).
    → A preview of the first 5 data rows of the export is shown in the Preview window.

  4. Examine the preview. Is your data being displayed as intended?

  5. Optional: Click on Download data (file_download) in order to download the preview to your device.

You can also show a preview in the list of catalogues.

Creating a preview from the catalogue list:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Navigate to the catalogue you want to preview.

  3. Open the further actions () of the catalogue.

  4. Click on Preview (preview).
    → A preview of the first 5 data rows of the export is shown in the Preview window.

  5. Examine the preview. Is your data being displayed as intended?

  6. Optional: Click on Download data (file_download) in order to download the preview to your device.

5.2. Activating automatic catalogue export

You have added all data sources that you want to export? Then your data is ready to be exported. Activate the catalogue in order to enable the automatic export schedule you set earlier.

Make sure that you have carried out all necessary export settings. Otherwise, no data is exported.

Activating automatic catalogue export:

  1. Go to Data » Catalogues.
    → The catalogues are listed.

  2. Scroll to the catalogue.

  3. In the column Active, move the toggle button () to the right.
    → The catalogue is active.
    → The data is exported to the storage location and at the intervals you selected in the catalogue settings.

5.3. Starting a manual export

Have you added at least one data field to the export? Then download the catalogue data manually. The format of the download file depends on the format settings of the catalogue. You can export data in CSV, TXT, JSON and XML files.

There are two ways to manually export the catalogue data:

Asynchronous download

The export runs in the background. Once the download is completed, you download the export file from the Notifications (notifications).

Live download

The file is downloaded to your computer automatically. You can follow the export progress in real time.
However:

  • Do not close or reload the browser tab or the PlentyONE tab Data export while the export is in progress. If you do so, the export will be cancelled.

  • The import can run into a timeout if you try to import large amounts of data. If that happens, the download is cancelled. For lots of data or if a timeout occurs, use the asynchronous download instead.

  • Starting an asynchronous download

  • Starting a live download

For asynchronous downloads, the export runs in the background. So note that there will be no window for downloading the file straight away. Even exporting small amounts of data will take around 30 minutes. When the export is completed, you can download the export file from the Notifications (notifications).

Starting an asynchronous download:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Open the catalogue.

  3. In the toolbar at the top, click on Download data (file_download).
    Or: Even quicker: Start the download from the Additional actions (more_vert) in the catalogue overview.
    → The export starts.
    Important: The export runs in the background. Note that there will be no window for downloading the file straight away. Even exporting small amounts of data will take around 30 minutes.
    Once the export is finished, you will be notified (notifications_none) that the export file can be downloaded.

  4. In the notification centre, click on link Download.
    Tip: The notification is no longer shown? Use the URL shown in the Download settings to access the file at any time.

  5. Save the file on your computer.

The live download creates the file and automatically downloads it to your computer. In the tab Data export, you can follow the download progress in real time. However:

  • When you start the live download, a new browser tab opens. In this browser tab, the PlentyONE tab Data export is shown. Do not close or reload the browser tab and the PlentyONE tab Data export while the export is in progress. If you do, the export stops and is cancelled.

  • You can start live downloads for several catalogues at the same time. However, you can only start a new live download for the same catalogue once the current export is complete.

  • The import can run into a timeout if you try to import large amounts of data. If that happens, the download is cancelled. For lots of data or if a timeout occurs, use the asynchronous download instead.

Starting a live download:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Open the catalogue.

  3. In the toolbar at the top, click on Live download (play_circle_outline).
    Or: Even quicker: Start the download from the Additional actions (more_vert) in the catalogue overview.
    → A new browser tab opens. PlentyONE and the tab Data export are shown.
    No new tab was opened? Then your browser is probably blocking pop-ups by PlentyONE. Allow pop-ups for your system to continue.
    → The export starts.
    Important: Do not close or reload the browser tab or the PlentyONE tab Data export while the export is in progress. If you do, the export stops and is cancelled.
    → The progress is shown in real time.
    → The file is automatically saved on your computer when the export is done.

Stopping a live download

Do you want to stop a live download? No problem:

  • In the tab Data export, click on Cancel export (highlight_off) at the top right.
    → The download is stopped.
    Important: The download cannot be restarted. If necessary, start a new download.

6. FAQ: Questions and answers

Which catalogue format do I need for which export?
What does “Export Key” mean?

The “Export Keys” are the names of the column headers, as they will appear in your export file. Every “Export Key” needs to be unique.

  • Negative example: You use the data sources Item ID and Variation ID. You give both “Export Keys” the name “id”. As a result, the export file only includes one of the two IDs. A column is missing in the export file.

  • Positive example: You use the data sources Item ID and Variation ID. You give one “Export Key” the name “VariationID” and the other “ItemID”.

catalogue export keys
How should an export key be structured?

The Export Key is the name of the column header that will be shown in your export file.

  • Each export key can only be used once in each catalogue.
    Important: If several data fields have the same export key, only one data field is exported.

  • Export keys cannot contain any spaces.

  • If the export key contains a period, then the data is exported in a tree structure. In most cases, this means that the data is not exported as expected. As such, we recommend that you do not use dots in export key names.

My export file is missing a column. Why?

You might have data sources with the same “Export Key”. Every “Export Key” needs to be unique.

  • Negative example: You use the data sources Item ID and Variation ID. You give both “Export Keys” the name “id”. As a result, the export file only includes one of the two IDs. A column is missing in the export file.

  • Positive example: You use the data sources Item ID and Variation ID. You give one “Export Key” the name “VariationID” and the other “ItemID”.

catalogue export keys
Only the word “Array” is exported. Why?

If you export a file in CSV or TXT format, then you might only see the word "Array" instead of the actual export values. This happens e.g. when exporting multiple images or when exporting multi-selection properties. This is a known issue and it will be fixed in the future.

Possible workaround 1: Would it be an option for you to download a JSON or XML file instead? With these file types, you can see the actual export values.

  1. Click on Settings.

  2. Scroll down to the section Format settings.

  3. Select CSV - Array to JSON, JSON or XML from the drop-down list Format.

  4. Save () the settings and download the file (file_download).

    • Caution: If you want to revise the file and import it again. Note that the import tool only accepts the file types CSV and TXT.

Possible workaround 2: Export the data with the tools FormatDesigner and Elastic Export instead.

Can I revise the file and import it again?

Yes. Export the file in CSV or TXT format. Then revise the file and import it again. Note that the import tool only accepts the file types CSV and TXT.

No file is available through the catalogue’s download URL. Why?
  1. Is the catalogue active?

  2. Has an export taken place? Check the export settings.

  3. Did you use the right URL?

The download URL leads to the message "Unauthenticated." instead of to file. Why?

You used the admin URL. However, you are not logged into your PlentyONE system as an admin user.

  1. Log in as an admin user.

  2. Generate a public URL. The file can always be accessed with this URL.

Why can I not see the catalogues?

Users with back end access rights can only see catalogues if an admin gave them access.

  1. Find someone who has administrator rights for the PlentyONE system.

  2. This person will open the menu Setup » Settings » User » Rights » User.

  3. Then they will open your user account and activate the necessary rights:

    • Data > Data exchange > Export > Catalogue > Show

  4. Save () the settings.

I want to import, export, delete, copy or restore catalogues. How do I do that?