Basic configuration

General settings

add-config

  • Active: Enable/Disable the endpoint.
  • Description: Provide a description for the endpoint.

Schema definition

schema-definition

  • Configure the exported data with drag & drop as you do it in the regular grid column definition in Pimcore.
  • Optionally define image / video thumbnails if you are going to export assets - if no thumbnail is selected, the original asset path is used.

Workspace definition

schema-definition

  • Workspaces - restrict the export to specific folders.
  • Custom export class - define a custom Class which should execute the export - default is to Pimcore\Bundle\DataHubProductsupBundle\Exporter\Productsup.
  • If you want to filter further items you can use the pimcore.datahub.fileExport.isValidExportItem event or overwrite the getQueryCondition() of the exporter class.

Trigger for delivery

trigger-for-delivery

  • Defines when the data should be written to the cache.
    • Disabled: The export ist just done by the export command in the ProcessManger (more details later on). Each export is a full export.
    • Deliver directly on save: When the object is saved, the data is directly written to the cache table. This should only be used if you have simple objects and inheritance is not enabled, because of possible save performance impacts.
    • Populate to queue: When an object is saved, only a queue item created. The export ist done later on (asynchronously). So there is no performance drawback when you save the object because the "heavy work" is done in the background later on.

Delivery endpoint

delivery-endpoint

  • Activate delivery endpoint: Generally enables the endpoint. productsup fetches the product data from this endpoint, the URL of the endpoint is shown in the configuration panel.
  • Security Token: This token has to be sent as Bearer Token by productsup (HTTP Header with the name Authorization). Please keep in mind, that the check for the token is disabled if you are logged in to Pimcore and have permission to access the Datahub.
  • Valid GET parameters for the endpoint are: page, per_page, since_modification_date.

Order endpoint

order-endpoint

  • Activate order endpoint: Generally enables the endpoint. productsup pushes the orders to this endpoint.
  • Parent folder: The folder where to productsup orders should be saved to.
  • Security Token: This token has to be sent as Bearer Token by productsup (HTTP Header with the name Authorization). Please keep in mind, that the check for the token is disabled if you are logged in to Pimcore and have permission to access the Datahub.
  • A sample request payload can be found here.
  • For development purpose you can load the data from a file e.g. /data-hub/productsup/order-push/products-up?file=/vendor/pimcore/data-hub-productsup/doc/examples/order.json. This will only work when Pimcore runs in debug mode.
  • The data/payload from productsup is logged in the ApplicationLogger. If you encounter any problems, please take a look at the logger (Component = data-hub-productsup).

Saving Configurations

There are two methods for saving configurations:

  • Save: Only saves configuration, does not have any influence on cached data or queue entries.
  • Save, reset and clear queue: Saves configurations, resets cache and resets and fills queue will all relevant elements for this export.