Skip to main content

Configuration

General

A YAML file must be placed in the directory config/packages/shopware_connector.yaml of the Pimcore project. All configurations for the bundle are made in this file.

Structure of Configuration

twocream_shopware_connector:
  export_targets:
    - key: shop_staging
      target_type: shopware
      has_delta_management: true
      adapter_blocklist:
        - links
        - fairs
        - press
      export_directory: '/path/to/export/directory/'
      asset_domain: 'https://assets.tld'
      asset_directory: '/path/to/asset/directory/'
      reporting:
        from: 'sender@your-domain.tld'
        reply_to: 'reply-to@your-domain.tld'
        cc_recipients:
          - copy-recipient@your-domain.tld
      import_mail_subject: "Shopware-Import to STAGE"
      export_mail_subject: "Pimcore-Export to STAGE"
  adapters:
    - key: YOUR-ADAPTER-PACKAGENAME
      source_folder_ids:
        - 5
        - 7
language_mapping:
de: 'de_DE'
en: 'en_GB'
Best Practice

For flexible use in different instances, it is recommended to outsource the values into environment variables (.env). This allows easy adjustments for the respective instances without having to edit the service configuration file.

twocream_shopware_connector:
export_targets:
- key: shop_staging
target_type: shopware
has_delta_management: true
export_directory: '%env(SW_CONNECTOR_TARGETS_SHOP_STAGING_EXPORT_DIRECTORY)%'
asset_domain: '%env(SW_CONNECTOR_TARGETS_SHOP_STAGING_ASSET_DOMAIN)%'
asset_directory: '%env(SW_CONNECTOR_TARGETS_SHOP_STAGING_ASSET_DIRECTORY)%'
reporting:
from: '%env(SW_CONNECTOR_TARGETS_SHOP_STAGING_REPORTING_FROM)%'
reply_to: '%env(SW_CONNECTOR_TARGETS_SHOP_STAGING_REPORTING_REPLY_TO)%'
import_mail_subject: "%env(SW_CONNECTOR_TARGETS_SHOP_STAGING_IMPORT_MAIL_SUBJECT)%"
export_mail_subject: "%env(SW_CONNECTOR_TARGETS_SHOP_STAGING_EXPORT_MAIL_SUBJECT)%"
- key: shop_live
target_type: shopware
has_delta_management: true
export_directory: '%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_EXPORT_DIRECTORY)%'
asset_domain: '%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_ASSET_DOMAIN)%'
asset_directory: '%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_ASSET_DIRECTORY)%'
reporting:
from: '%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_REPORTING_FROM)%'
reply_to: '%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_REPORTING_REPLY_TO)%'
import_mail_subject: "%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_IMPORT_MAIL_SUBJECT)%"
export_mail_subject: "%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_EXPORT_MAIL_SUBJECT)%"
adapters:
- key: 'product'
source_folder_ids:
- '%env(SW_CONNECTOR_ADAPTERS_PRODUCT_SOURCE_FOLDER_ID)%'
- key: 'product-attribute'
hide_export_mask: true
source_folder_ids:
- '%env(SW_CONNECTOR_ADAPTERS_PRODUCT_ATTRIBUTE_SOURCE_FOLDER_ID)%'
SW_CONNECTOR_TARGETS_SHOP_STAGING_EXPORT_DIRECTORY=""
SW_CONNECTOR_TARGETS_SHOP_STAGING_ASSET_DOMAIN=""
SW_CONNECTOR_TARGETS_SHOP_STAGING_ASSET_DIRECTORY=""
SW_CONNECTOR_TARGETS_SHOP_STAGING_REPORTING_FROM=""
SW_CONNECTOR_TARGETS_SHOP_STAGING_REPORTING_REPLY_TO=""
SW_CONNECTOR_TARGETS_SHOP_STAGING_IMPORT_MAIL_SUBJECT=""
SW_CONNECTOR_TARGETS_SHOP_STAGING_EXPORT_MAIL_SUBJECT=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_EXPORT_DIRECTORY=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_ASSET_DOMAIN=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_ASSET_DIRECTORY=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_REPORTING_FROM=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_REPORTING_REPLY_TO=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_IMPORT_MAIL_SUBJECT=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_EXPORT_MAIL_SUBJECT=""
SW_CONNECTOR_ADAPTERS_PRODUCT_SOURCE_FOLDER_ID=""
SW_CONNECTOR_ADAPTERS_PRODUCT_ATTRIBUTE_SOURCE_FOLDER_ID=""

Configure Target Systems

KeyDescriptionMandatoryExample
keyUnique name for your target system (CamelCase notation)Yesshop_staging
target_typeType of the target system. Currently, this is only used in the case of the value "shopware" to distinguish code-side logicYesshopware | pimcore | wordpress | others...
adapter_blocklist Array of adapter names that are blocked for this export targetNofairs
has_delta_managementControls whether the target system can process delta exportsYestrue | false
export_directoryPath to the export directoryYes/path/to/export/
asset_domainAsset domainYeshttps://assets.tld
asset_directoryPath to the asset directoryYes/path/to/assets/
reporting > from/reply_toReporting email addresses for sender and reply-to recipientsYessender@your-domain.tld
reporting > cc_recipientsArray of CC email addresses for reportingNocopy-recipient@your-domain.tld
export_mail_subjectSubject for export email reportNoPimcore-Export to STAGE
import_mail_subjectSubject for import email reportNoShopware-Import to STAGE

Configure Adapters

KeyDescriptionMandatoryExample
keyUnique name for an adapter (corresponds to the package name of the adapter)Yesfairs
hide_export_maskHide the option in the export maskNotrue
source_folder_idsArray of folder IDs to be considered during exportYes5