propertyRelations

Use the propertyRelations data format creator to export the links between properties and other data 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 propertyRelations
Property Meaning Value Explanation

dataName

Name

propertyRelations

Name of the creator process and prefix of the created file.
File name: propertyRelations-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 8,000

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

limitDay

Lines per day

up to 80,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

propr_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 propertyRelations data columns included in the CSV file during raw data export.

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

plenty_id

INTEGER NOT NULL

plenty id

ID of the PlentyONE system

propr_id (Primary key)

VARCHAR NOT NULL

property relation ID

ID of the property link
Pattern: plentyID-propertyRelationID

prop_id

VARCHAR NOT NULL

property ID

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

propr_type

VARCHAR NOT NULL

property relation type

Section in which the property link is used, e.g. item, contact, etc.

propr_target_id

VARCHAR NOT NULL

property relation target ID

The ID of whichever data record the property is linked to. For example, the variation ID if the property is linked to an item variation.
Pattern: plentyID-variationID (if the property is linked to a variation)

propr_value

VARCHAR

property relation value

The property link’s value. For example, if the property is linked to a variation, then the value is found within the item data record.

propr_value_lang

VARCHAR

property relation value language

The property link’s language. For example, the language that a short or long text was written in.

propr_created_at

TIMESTAMPTZ NOT NULL

property relation created at

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

propr_updated_at

TIMESTAMPTZ NOT NULL

property relation updated at

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