Skip to main content

properties

Use the properties data format creator to export the properties available in your system and save this data in the cloud. Depending on the plentyBI edition that has been booked, the raw data file is stored in the cloud for 6 to 48 months. Therefore, the data must be processed before this period of time ends. More detailed information on the storage periods are available on the Managing reports page of the manual. The following tables contain further information about the format.

1. Technical specifications

See Table 1 for further information on the available properties and their corresponding values.

Table 1. Technical specifications of the format properties
Property Meaning Value Explanation

dataName

Name

properties

Name of the creator process and prefix of the created file.
File name: properties-xxx.csv.gz

fileFormat

File format

CSV, GZIP

The data is provided as a GZIP-compressed CSV file (RFC 1952).

limitPage

Lines per request

up to 1,000

The maximum number of data rows that is written into a single file.

limitDay

Lines per day

up to 2,000

The maximum number of data rows that is written on one day in total.

earliestPossibleDataDate

Earliest point in time

2020-01-01

Point in time as of which the raw data can be collected. The data is not filtered.

filterType

Filter type

lastUpdate

Data are filtered based on the last update.

dataUpdatedAtColumnName

Column header

prop_updated_at

Name of the column that contains the time stamp of the last data update.

defaultActive

Activated by default

no

The data is only exported automatically in the background after you have activated the creator in the Setup » plentyBI » Raw data menu.

interval

Interval

daily

With this setting, all data that has been changed since the last run is exported once a day, usually during the night.

storableFromPlan

Storage starting from edition

plentyBI S

Minimum fee plan required for saving the data in cloud storage and making it available via REST.

processableFromPlan

Usage starting from edition

plentyBI L

Minimum fee plan required for making the data available in plentyBI Data Warehouse, i.e. for using, filtering and processing key figures.

2. Data columns

See Table 2 for further information on the properties data columns included in the CSV file during raw data export.

Table 2. Data columns of the format properties
Property Data type Full name Explanation

plenty_id

INTEGER NOT NULL

plenty id

ID of the plentymarkets system

prop_id (Primary key)

VARCHAR NOT NULL

property ID

ID of the property, as specified in the property’s settings.
Pattern: plentyID-propertyID

prop_cast

VARCHAR

property cast

Property type, as specified in the property’s settings, e.g. longText, selection, shortText, etc.

prop_type

VARCHAR

property type

Section in which the property is used, as specified in the property’s settings, e.g. item, contact, etc.

prop_position

INTEGER

property position

The property’s position number, as specified in the property’s settings.

prop_name

VARCHAR

property name

The property’s name, as specified in the property’s settings.

prop_created_at

TIMESTAMPTZ NOT NULL

property created at

Time stamp indicating when the property was created
Date format: MM/DD/YY HH:MI:SS TZ

prop_updated_at

TIMESTAMPTZ NOT NULL

property updated at

Time stamp indicating when the property was last updated
Date format: MM/DD/YY HH:MI:SS TZ

To top