url
stringlengths
50
196
text
stringlengths
3
17.2k
heading
stringlengths
2
103
embeddings
list
https://pimcore.com/docs/platform//Statistics_Explorer/Installation_and_Configuration#elasticsearch-configuration
Elasticsearch configuration The ElasticsearchAdapter needs an elasticsearch cluster to work. Elasticsearch client configuration takes place via Pimcore Elasticsearch Client Bundle # Configure an elasticsearch client pimcore_elasticsearch_client: es_clients: default: hosts: ['elastic:9200'] ...
Elasticsearch configuration
[ -0.25029897689819336, 0.0004530207079369575, -0.0918624997138977, -0.08537932485342026, -0.2262170910835266, -0.35211390256881714, 0.2428739219903946, -0.19412174820899963, -0.015102636069059372, 0.20729497075080872, -0.0837835967540741, 0.2539656460285187, -0.005172931123524904, 0.0705029...
https://pimcore.com/docs/platform//Statistics_Explorer/Usage/Using_Statistics_Explorer#using-statistics-explorer
Using Statistics Explorer
Using Statistics Explorer
[ -0.26779940724372864, -0.13426297903060913, -0.22698917984962463, 0.08245069533586502, 0.03620035946369171, -0.04955659061670303, -0.1347430795431137, -0.05881902575492859, -0.2851710319519043, 0.49099424481391907, 0.016567356884479523, 0.13257354497909546, 0.12519848346710205, 0.170241028...
https://pimcore.com/docs/platform//Statistics_Explorer/Usage/Using_Statistics_Explorer#embedding-into-application
Embedding Into Application The statistics explorer is a react application that can be embedded into any template with following steps. Include boostrap style sheets: Statistics explorer is using bootstrap markup. To provide proper styling it makes sense in include bootstrap style sheets Include statistics explorer s...
Embedding Into Application
[ -0.3307054936885834, -0.006979361642152071, -0.042874325066804886, 0.12494474649429321, 0.2111426591873169, -0.3109321892261505, -0.12389097362756729, 0.1440918892621994, -0.20282907783985138, 0.18289771676063538, 0.08193754404783249, 0.34290462732315063, 0.33938494324684143, 0.20958016812...
https://pimcore.com/docs/platform//Statistics_Explorer/Usage/Using_Statistics_Explorer#exploring-data
Exploring Data
Exploring Data
[ -0.06443183869123459, -0.15565787255764008, -0.3484683632850647, 0.2282934933900833, 0.02622576244175434, -0.23598293960094452, 0.018131021410226822, 0.21812646090984344, -0.15819387137889862, 0.20003445446491241, -0.11945200711488724, -0.08522770553827286, -0.13515032827854156, 0.17265489...
https://pimcore.com/docs/platform//Statistics_Explorer/Usage/Using_Statistics_Explorer#select-data-source
Select Data Source First step when exploring is to select a data source. For more information how to define data sources see Installation and Configuration.
Select Data Source
[ -0.4101983308792114, -0.11173400282859802, -0.20750625431537628, 0.06889430433511734, 0.07842953503131866, -0.4044458866119385, 0.15761980414390564, -0.0032553989440202713, -0.07045852392911911, 0.3230987787246704, -0.09390345960855484, 0.21788817644119263, 0.15537108480930328, 0.289138704...
https://pimcore.com/docs/platform//Statistics_Explorer/Usage/Using_Statistics_Explorer#select-statistics-mode
Select Statistics Mode The statistics explorer supports two different modes: Statistic: Standard mode that calculates statistics based on defined metrics and also builds pivot tables when rows and columns are defined. List: Simple list of data with defined columns.
Select Statistics Mode
[ -0.4611484408378601, -0.23233190178871155, -0.10320883989334106, -0.03153261914849281, 0.10860437154769897, -0.11188401281833649, -0.05854950100183487, -0.04049326106905937, 0.16749942302703857, 0.3062989413738251, -0.1408839225769043, 0.297835111618042, 0.2436112016439438, 0.2929412424564...
https://pimcore.com/docs/platform//Statistics_Explorer/Usage/Using_Statistics_Explorer#select-rows-and-columns
Select Rows and Columns Depending on the statistics mode either rows and columns or just columns can be defined. Which rows and columns are available is defined by the data source.
Select Rows and Columns
[ -0.1902720183134079, -0.07751599699258804, -0.13567207753658295, 0.06561227142810822, 0.05479881912469864, -0.02106715552508831, 0.3781132102012634, 0.023765433579683304, -0.2289620041847229, 0.4450269341468811, -0.14730852842330933, 0.07872623205184937, 0.35966068506240845, 0.302045464515...
https://pimcore.com/docs/platform//Statistics_Explorer/Usage/Using_Statistics_Explorer#define-field-settings
Define Field Settings As soon as rows and/or columns are selected, field settings for can be defined for them. The available settings depend on data source type, field type and position of the field (row/column/first/last), and should be self explaining.
Define Field Settings
[ -0.20717456936836243, -0.3653056025505066, -0.20875748991966248, -0.09405004233121872, 0.12743213772773743, -0.17019537091255188, 0.1660815179347992, 0.07528549432754517, -0.09519889205694199, 0.3823050856590271, 0.155619814991951, 0.08851650357246399, 0.10603950172662735, 0.22759276628494...
https://pimcore.com/docs/platform//Statistics_Explorer/Usage/Using_Statistics_Explorer#define-filters
Define Filters As soon as data source is selected, filters can be defined. These are applied to the query before the statistics are calculated. Available fields and operators depend on data source type and field type and should be self explaining.
Define Filters
[ -0.2363281399011612, 0.17059648036956787, -0.15312829613685608, -0.028559939935803413, -0.12631987035274506, -0.7192475199699402, 0.12214218825101852, -0.18291211128234863, -0.23889076709747314, 0.3337517976760864, -0.1407807320356369, 0.24712613224983215, 0.24594390392303467, 0.2792397141...
https://pimcore.com/docs/platform//Statistics_Explorer/Usage/Using_Statistics_Explorer#select-visualization
Select Visualization In Statistic mode, data also can be visualized with simple charts. For the charts same data is used as shown in table. Following chart types are supported: Line Chart Bar Chart Area Chart Pie Chart
Select Visualization
[ -0.6581592559814453, -0.2329847663640976, -0.21354177594184875, -0.019281983375549316, -0.03374883532524109, -0.1258234977722168, 0.07589621841907501, 0.05216595530509949, -0.03875339403748512, 0.3286864459514618, -0.0036423616111278534, 0.40826067328453064, 0.20992936193943024, 0.43828833...
https://pimcore.com/docs/platform//Statistics_Explorer/Usage/Using_Statistics_Explorer#save-&-load-&-share
Save & Load & Share Configurations can be saved and loaded later on. They also can be shared with other users or user roles. If a user is not owner of a configuration, changes only can be saved as a new copy of the configuration (which then can be shared again). The user cannot overwrite the original configurat...
Save & Load & Share
[ -0.2488032430410385, -0.1386806070804596, -0.05611593648791313, 0.11625520884990692, -0.009503883309662342, -0.13197921216487885, 0.260698527097702, -0.4011552929878235, -0.135735884308815, 0.4279075264930725, -0.27069735527038574, 0.02717793919146061, 0.3974229097366333, 0.241377875208854...
https://pimcore.com/docs/platform//Statistics_Explorer/Usage/Using_Statistics_Loader#using-statistics-loader
Using Statistics Loader The statistics loader can be used to embed the report (table and chart) of stored configurations into your application.
Using Statistics Loader
[ -0.5893938541412354, -0.1954321563243866, -0.20538216829299927, 0.11848611384630203, 0.06657323986291885, -0.014848891645669937, 0.17133808135986328, -0.09728453308343887, 0.165256530046463, 0.39850929379463196, -0.14835451543331146, 0.3890206515789032, 0.22251717746257782, 0.3329202234745...
https://pimcore.com/docs/platform//Statistics_Explorer/Usage/Using_Statistics_Loader#steps-to-embed-into-application
Steps to Embed into Application Include boostrap style sheets: Statistics explorer is using bootstrap markup. To provide proper styling it makes sense in include bootstrap style sheets Include statistics loader style sheets: Include them via symfony webpack encore with {{ encore_entry_link_tags('loader', null, 'pimc...
Steps to Embed into Application
[ -0.3270050883293152, 0.15649008750915527, -0.03340443968772888, 0.13939352333545685, 0.1455845832824707, -0.24352827668190002, -0.13047964870929718, 0.17329590022563934, -0.3386988937854767, 0.2299531102180481, 0.022174963727593422, 0.3809092342853546, 0.35043781995773315, 0.23911087214946...
https://pimcore.com/docs/platform//Statistics_Explorer/Further_Customizing/Customizing_Results#customizing-results
Customizing Results Depending on context and use case it might be necessary to customize the result before printing it to the reports. Use cases might be Adding additional filters due to user permissions Enriching result data with additional information, e.g. nice names, links, ... Customizing table template for inclu...
Customizing Results
[ -0.16567029058933258, 0.07000620663166046, -0.16097304224967957, -0.06300432235002518, -0.29880309104919434, -0.151029571890831, 0.023863760754466057, 0.15870916843414307, -0.1593947559595108, 0.4024157226085663, 0.05816987529397011, 0.35655641555786133, 0.20756183564662933, 0.233457520604...
https://pimcore.com/docs/platform//Statistics_Explorer/Further_Customizing/Customizing_Results#event-datafiltermodificationevent
Event DataFilterModificationEvent Fires after filter condition for data request is generated and allows to modify the filter Available information Context Configuration (if it is a saved configuration) Data source name Statistics mode (statistic or list) Changeable information Filter
Event DataFilterModificationEvent
[ -0.44571617245674133, 0.050696272403001785, -0.179096058011055, -0.2560316324234009, -0.13409173488616943, -0.4230787456035614, 0.05218115821480751, -0.09880726784467697, -0.21221543848514557, 0.19190889596939087, -0.08322369307279587, 0.19999822974205017, 0.02092953957617283, 0.4618514776...
https://pimcore.com/docs/platform//Statistics_Explorer/Further_Customizing/Customizing_Results#event-dataprequeryevent
Event DataPreQueryEvent Fires just before query is sent to storage backend and allows to modify the query Available information Context Configuration (if it is a saved configuration) Data source name Statistics mode (statistic or list) Changeable information Query (elasticsearch query array, sql statement)
Event DataPreQueryEvent
[ -0.2856203615665436, -0.007281133439391851, -0.2295132726430893, -0.24085234105587006, -0.3935043513774872, -0.3573373556137085, -0.1901525855064392, -0.12339010089635849, -0.17073309421539307, 0.11847254633903503, 0.1678599715232849, 0.25079843401908875, 0.09066323935985565, 0.29891529679...
https://pimcore.com/docs/platform//Statistics_Explorer/Further_Customizing/Customizing_Results#event-dataresultevent
Event DataResultEvent Fires before statistics data result is returned to controller and allows to modify the result Available information Context Configuration (if it is a saved configuration) Data source name Statistics mode (statistic or list) Changeable information StatisticsResult
Event DataResultEvent
[ -0.5490111708641052, -0.03520289808511734, -0.11678135395050049, -0.045357514172792435, -0.0702366828918457, -0.3856380879878998, -0.13508902490139008, 0.015419896692037582, -0.3444072902202606, 0.19171223044395447, 0.09683690220117569, 0.28213638067245483, 0.08353233337402344, 0.200936406...
https://pimcore.com/docs/platform//Statistics_Explorer/Further_Customizing/Customizing_Results#event-tablerenderevent
Event TableRenderEvent Fires before table template is rendered and allows to modify template name and its parameters Available information Context Configuration (if it is a saved configuration) Data source name Statistics mode (statistic or list) Changeable information template parameters
Event TableRenderEvent
[ -0.4271408021450043, -0.3364447355270386, -0.08813733607530594, -0.052870284765958786, -0.1517249047756195, -0.24518947303295135, -0.0015179128386080265, 0.1798238307237625, -0.3570159375667572, 0.3208712041378021, -0.048181790858507156, 0.48333364725112915, 0.13874375820159912, 0.09178681...
https://pimcore.com/docs/platform//Statistics_Explorer/Further_Customizing/Providing_Predefined_Statistic_Configuration#provide-predefined-statistic-configuration
Provide Predefined Statistic Configuration There are two options to provide predefined statistic configurations that are globally visible to every user in a certain context.
Provide Predefined Statistic Configuration
[ -0.5432627201080322, -0.239743173122406, -0.13582183420658112, -0.3362077474594116, 0.14468638598918915, -0.3753935992717743, 0.3524203598499298, -0.15771418809890747, -0.08921413868665695, 0.5988351702690125, 0.06546034663915634, 0.27641499042510986, 0.3059059679508209, 0.1851472854614257...
https://pimcore.com/docs/platform//Statistics_Explorer/Further_Customizing/Providing_Predefined_Statistic_Configuration#global-configurations-via-symfony-configuration-tree
Global Configurations via Symfony Configuration Tree These predefined configurations can be defined on application level or by any bundle and are configured in symfony configuration tree with the pimcore_statistics_explorer.global_configurations configuration. Following information is necessary: name: The unique name ...
Global Configurations via Symfony Configuration Tree
[ -0.3902062475681305, -0.1735079288482666, -0.0006489100051112473, 0.1820746511220932, 0.08306614309549332, -0.34418854117393494, -0.10129307955503464, -0.10259515792131424, -0.20537464320659637, 0.37649258971214294, -0.08534075319766998, 0.3219766914844513, 0.25452446937561035, 0.112462282...
https://pimcore.com/docs/platform//Statistics_Explorer/Further_Customizing/Providing_Predefined_Statistic_Configuration#sample-configuration
Sample Configuration pimcore_statistics_explorer: global_configurations: Global Sample 1: context: 'portal' configuration: '{"showTable":true,"showChart":false,"chartType":null,"selectedDataSource":{"value":"tracking_test",&...
Sample Configuration
[ -0.514622688293457, -0.1632745862007141, -0.23230361938476562, 0.07540400326251984, 0.10205285996198654, -0.19312237203121185, -0.03243706002831459, 0.22487007081508636, -0.24757958948612213, 0.21340063214302063, -0.037080954760313034, 0.36283913254737854, 0.3096027076244354, 0.44875887036...
https://pimcore.com/docs/platform//Statistics_Explorer/Further_Customizing/Providing_Predefined_Statistic_Configuration#inject-dynamic-configurations-via-event
Inject dynamic Configurations via Event
Inject dynamic Configurations via Event
[ -0.4953356087207794, -0.5732545256614685, -0.06933007389307022, 0.25426870584487915, 0.1697826236486435, -0.324776828289032, -0.14648938179016113, -0.03411800414323807, -0.130029559135437, 0.5711755156517029, 0.06989582628011703, 0.3662034273147583, -0.30549269914627075, 0.5144391655921936...
https://pimcore.com/docs/platform//Statistics_Explorer/Further_Customizing/Providing_Predefined_Statistic_Configuration#event-loadconfigurationevent
Event LoadConfigurationEvent Fires before a configuration with given id and context is loaded from default sources (global configurations, database). If configuration is set to event, this one is used and further configuration loading is skipped. Available information Id Context Changeable information Configuratio...
Event LoadConfigurationEvent
[ -0.43143898248672485, -0.32711076736450195, -0.04983265697956085, 0.24282485246658325, -0.1676514595746994, -0.23587960004806519, 0.20245802402496338, -0.17456960678100586, 0.09567251801490784, 0.19028405845165253, 0.07714252918958664, 0.28070923686027527, 0.2402244508266449, 0.24632349610...
https://pimcore.com/docs/platform//Statistics_Explorer/Further_Customizing/Adding_Data_Sources_during_Runtime#adding-data-sources-during-runtime
Adding Data Sources during Runtime It is possible to add additional data sources during runtime by listening to following event. This event fires once per process when the StatisticsService is initialized.
Adding Data Sources during Runtime
[ -0.5146715641021729, 0.25364595651626587, -0.11880853027105331, -0.030280349776148796, 0.022079652175307274, -0.21861755847930908, 0.27292269468307495, -0.3224968910217285, -0.24432580173015594, 0.39594393968582153, 0.0033438510727137327, 0.3234151303768158, 0.17268496751785278, 0.28215101...
https://pimcore.com/docs/platform//Statistics_Explorer/Further_Customizing/Adding_Data_Sources_during_Runtime#event-statisticsserviceinitevent
Event StatisticsServiceInitEvent Fires when StatisticsService is initialized Available information StatisticsService Changeable information call all methods of StatisticsService, most likely addDataSourceAdapter for adding additional data sources.
Event StatisticsServiceInitEvent
[ -0.5216259360313416, -0.05083969980478287, -0.07575051486492157, 0.14865627884864807, -0.001961846835911274, -0.25659680366516113, -0.12514172494411469, -0.2601083815097809, -0.19575385749340057, 0.2550981044769287, 0.24630911648273468, 0.22357812523841858, 0.03503881022334099, 0.107594236...
https://pimcore.com/docs/platform//Statistics_Explorer/Tracking_Events#tracking-events
Tracking Events The bundle also ships with basis to easily implement a tracker that tracks events to an elasticsearch index. Supports elasticsearch versions 8.
Tracking Events
[ -0.4363462030887604, -0.0871620699763298, -0.269746333360672, -0.007119339425116777, -0.263094425201416, 0.10010293126106262, 0.1387200504541397, 0.2395920604467392, 0.13890410959720612, 0.06089641526341438, 0.045289624482393265, 0.3115258514881134, -0.5262250304222107, 0.3724033236503601,...
https://pimcore.com/docs/platform//Statistics_Explorer/Tracking_Events#implement-tracker
Implement Tracker To implement a tracker, extend the AbstractElasticsearchTracker and implement all abstract methods: getIndexName: Define the name of index. buildMappingArray: Define elasticsearch mapping for index as array. trackEvent: Method for actual event tracking that is called by outside world. It takes a p...
Implement Tracker
[ -0.03467584773898125, -0.15399734675884247, -0.10705878585577011, -0.05653828755021095, -0.28211167454719543, -0.1630735844373703, 0.014916004613041878, 0.2876908779144287, 0.07188934087753296, 0.2687873840332031, 0.17226937413215637, 0.06356407701969147, -0.4893217980861664, 0.17642670869...
https://pimcore.com/docs/platform//Statistics_Explorer/Tracking_Events#tracking-events
Tracking Events For each event type, a tracker needs to be implemented. The tracker implementations then need to be registered as services and then can be injected to any service or controller. By calling $tracker->trackEvent($parameters) the events get tracked.
Tracking Events
[ -0.2995908558368683, -0.13739052414894104, -0.08432848006486893, 0.33954399824142456, -0.052608296275138855, -0.3230689764022827, 0.19871491193771362, 0.040402449667453766, 0.10852470993995667, 0.27916988730430603, -0.005710448604077101, 0.13182808458805084, -0.31040477752685547, 0.3882595...
https://pimcore.com/docs/platform//Statistics_Explorer/Tracking_Events#elasticsearch-index-structure
Elasticsearch Index Structure For performance and data housekeeping reasons, the tracker implements some kind of index rotating. This means data is tracked to an index named <INDEX_NAME>__<YEAR>_<MONTH> which always corresponds to the current month. If the index doesn't exist, it is created automatica...
Elasticsearch Index Structure
[ 0.11859513819217682, 0.1119682639837265, -0.07274101674556732, 0.08231265097856522, -0.3191514313220978, 0.0580587238073349, -0.057248372584581375, 0.021708602085709572, -0.09270131587982178, 0.34745875000953674, 0.26439881324768066, -0.02242927998304367, 0.026485150679945946, 0.1312040537...
https://pimcore.com/docs/platform//Statistics_Explorer/Contribution_Guide#contribution-guide
Contribution Guide
Contribution Guide
[ 0.03406747803092003, -0.055441051721572876, -0.2739652097225189, -0.2270107865333557, 0.06505011022090912, -0.1628766804933548, 0.4237610995769501, 0.08756353706121445, -0.3221018314361572, 0.2211957722902298, -0.051169462502002716, 0.22103947401046753, 0.2339913249015808, 0.16743408143520...
https://pimcore.com/docs/platform//Statistics_Explorer/Contribution_Guide#frontend-builds
Frontend Builds All frontend assets are build with webpack encore. The most recent production build is added to the repository in src/Resources/public/build folder. To build frontend assets install webpack encore to your project add following content to your package.json { "name": "demo-project&qu...
Frontend Builds
[ -0.4992799758911133, -0.16389718651771545, -0.20964975655078888, -0.02896464243531227, 0.15206289291381836, -0.22910143435001373, -0.022298045456409454, 0.25661295652389526, -0.09073753654956818, 0.1713223159313202, 0.009084781631827354, 0.3629114627838135, 0.38832613825798035, 0.465531289...
https://pimcore.com/docs/platform//Statistics_Explorer#statistics_explorer
Statistics_Explorer
Statistics_Explorer
[ -0.29310521483421326, -0.0030877406243234873, -0.20835384726524353, 0.1389802247285843, 0.10488497465848923, -0.23766857385635376, -0.0979883223772049, 0.01570088230073452, -0.3236234188079834, 0.472007155418396, 0.13638335466384888, 0.15198327600955963, -0.049319226294755936, 0.1557674109...
https://pimcore.com/docs/platform//Statistics_Explorer#title:-statistics-explorer
title: Statistics Explorer
title: Statistics Explorer
[ -0.0920950174331665, 0.22817635536193848, -0.24403546750545502, -0.08185277134180069, 0.13262832164764404, 0.021492503583431244, -0.012357121333479881, -0.012381480075418949, -0.1870678812265396, 0.45155131816864014, 0.19775234162807465, 0.05626896396279335, -0.20492783188819885, 0.1744942...
https://pimcore.com/docs/platform//Statistics_Explorer#pimcore-statistics-explorer
Pimcore Statistics Explorer Pimcore Statistics Explorer provides a simple statistics tool that can be integrated into your application allowing users to dig into data and create statistic reports. Sample interface for Pimcore Statistics Explorer
Pimcore Statistics Explorer
[ -0.56699138879776, -0.12538237869739532, -0.15569664537906647, -0.09423106163740158, 0.019225390627980232, -0.14599213004112244, -0.11866241693496704, -0.0868879035115242, -0.33288320899009705, 0.22799047827720642, 0.03630285710096359, 0.36712995171546936, 0.11427856981754303, 0.1799008399...
https://pimcore.com/docs/platform//Statistics_Explorer#features-in-a-nutshell
Features in a Nutshell Statistics Explorer to dig into data and create reports. Two statistic modes: Simple listings. Statistics with calculating metrics and pivot tables. Different chart types for visualization of report data. Supported data backends: Elasticsearch index. MySQL table. Saving and sharing of repo...
Features in a Nutshell
[ -0.44209620356559753, -0.3209425210952759, -0.2517847716808319, 0.017140088602900505, -0.248284712433815, 0.12256445735692978, -0.16712646186351776, 0.09356491267681122, -0.05322554334998131, 0.13046382367610931, -0.02239311672747135, 0.3307967782020569, -0.0813710168004036, 0.561869621276...
https://pimcore.com/docs/platform//Statistics_Explorer#documentation-overview
Documentation Overview Installation & Configuration Using Statistics Explorer Using Statistics Loader Customizing Results Providing Predefined Statistic Configurations Tracking Events
Documentation Overview
[ -0.5087010264396667, 0.0741894468665123, -0.17274825274944305, 0.013187147676944733, -0.1787215918302536, -0.10539615899324417, -0.006483099423348904, -0.08345218747854233, -0.11388622224330902, 0.37459391355514526, -0.02624068781733513, 0.2525373101234436, 0.16592565178871155, 0.421473115...
https://pimcore.com/docs/platform//Statistics_Explorer#development-and-contribution
Development and Contribution Contribution Guide
Development and Contribution
[ -0.14475519955158234, 0.16093102097511292, -0.3581737279891968, -0.25206685066223145, 0.17707616090774536, -0.4395926594734192, 0.3983860909938812, -0.007595349568873644, -0.34642112255096436, 0.23225843906402588, -0.027636408805847168, 0.08764635026454926, 0.27294138073921204, 0.338959217...
https://pimcore.com/docs/platform//Ecommerce_Framework/Architecture_Overview#architecture-overview
Architecture Overview The following architecture overview shows available framework components. The component configuration takes place in the pimcore_ecommerce_framework configuration node and a factory is responsible for resolving of the implementations. For each component a custom implementation can be configured an...
Architecture Overview
[ -0.23690520226955414, -0.37147653102874756, -0.21125270426273346, 0.17190542817115784, 0.00872470811009407, -0.2773961126804352, 0.06626323610544205, -0.3330935537815094, -0.33784180879592896, 0.057034168392419815, -0.2899683117866516, 0.4148869216442108, 0.4051145315170288, 0.415081381797...
https://pimcore.com/docs/platform//Ecommerce_Framework/Architecture_Overview#separation-of-concerns
Separation of Concerns We try to separate different functionality and encapsulate them as good as possible in the different components. Following list should state the basic ideas and represent a guideline for future extensions:
Separation of Concerns
[ 0.03120148368179798, -0.2850306034088135, -0.2872856855392456, 0.03962152823805809, 0.09460340440273285, -0.12056176364421844, 0.2779393792152405, 0.025987738743424416, -0.1229010596871376, 0.19735954701900482, -0.0018869685009121895, -0.011268699541687965, 0.20936435461044312, 0.073286503...
https://pimcore.com/docs/platform//Ecommerce_Framework/Architecture_Overview#index-service
Index Service The Index Service is responsible for all aspects concerning indexing products and providing an API to access product data from the index. These aspects contain among other things: Defining which attributes should be indexed. Implementations for different search backends (e.g. mysql, elasticsearch, fact f...
Index Service
[ 0.26576918363571167, -0.31571632623672485, -0.28047388792037964, -0.05574683099985123, -0.3223492503166199, 0.07479853928089142, 0.21895234286785126, -0.07819581031799316, 0.6051191091537476, -0.24869036674499512, -0.0026076966896653175, 0.21525365114212036, -0.08026393502950668, 0.2714560...
https://pimcore.com/docs/platform//Ecommerce_Framework/Architecture_Overview#filter-service
Filter Service The Filter Service is responsible for all aspects concerning filtering products and setting up a filtered navigation. It is tightly coupled with the Product Lists of the Index Service, provides the developer a simple API for building a layered navigation and takes care of query generation, counting resul...
Filter Service
[ 0.31055498123168945, -0.33930155634880066, -0.273981511592865, -0.4273938834667206, -0.366324245929718, -0.0789279192686081, 0.158005490899086, -0.1856943666934967, 0.34836483001708984, -0.35776016116142273, -0.18412409722805023, 0.24707917869091034, 0.0019062729552388191, 0.55461782217025...
https://pimcore.com/docs/platform//Ecommerce_Framework/Architecture_Overview#availability-system
Availability System The Availability System is responsible for all aspects concerning product availability. Here the logic for calculating availabilities, calling external availability services, etc. is encapsulated. Each product has an Availability System assigned and when it comes to getting the availability of a pro...
Availability System
[ 0.19282163679599762, -0.5712912082672119, -0.2418612837791443, -0.30725905299186707, -0.06409137696027756, -0.22145405411720276, 0.2938702404499054, -0.4599626362323761, -0.1467355489730835, -0.011128537356853485, 0.09691562503576279, 0.04069354012608528, 0.2159913182258606, 0.015205598436...
https://pimcore.com/docs/platform//Ecommerce_Framework/Architecture_Overview#price-system-and-taxes
Price System and Taxes Like Availability Systems, there are Price Systems which are responsible for all aspects of getting product prices. Here the logic of calculating the product prices should be encapsulated. Each product has a Price System and when it comes to getting the price of a product, this should be delegate...
Price System and Taxes
[ 0.1642327904701233, -0.10409234464168549, -0.09404879808425903, 0.3290627896785736, -0.027739273384213448, -0.3968425393104553, 0.4169752299785614, -0.15019774436950684, -0.18608178198337555, 0.08009792119264603, -0.04693566635251045, 0.22172218561172485, 0.49307504296302795, 0.36106646060...
https://pimcore.com/docs/platform//Ecommerce_Framework/Architecture_Overview#pricing-manager
Pricing Manager In addition to the Price System, there is the Pricing Manager which is responsible for all aspects concerning modification of prices for marketing purposes. Therefore pricing rules (e.g. certain products, certain time frames, ...) build conditions which need to be valid that certain pricing actions (e.g...
Pricing Manager
[ 0.2299441248178482, -0.2669532001018524, -0.11273866891860962, 0.04441908374428749, 0.039525117725133896, 0.2590882182121277, 0.19118072092533112, -0.314035028219223, -0.37698453664779663, 0.10318722575902939, 0.14027488231658936, 0.248257577419281, 0.03987658768892288, 0.2064315378665924,...
https://pimcore.com/docs/platform//Ecommerce_Framework/Architecture_Overview#voucher-system
Voucher System The Voucher System is responsible for all aspects concerning vouchers for customers. These aspects contain among other things: Voucher Services Voucher Tokens Voucher Statistics Modification of product prices based on vouchers which is done with the help of the Pricing Manager.
Voucher System
[ 0.17169740796089172, -0.14048327505588531, -0.16699104011058807, 0.22216100990772247, -0.002927686320617795, 0.25955188274383545, 0.16571539640426636, -0.32764187455177307, -0.2839764654636383, -0.3456023931503296, -0.1030944362282753, 0.27984821796417236, 0.12059414386749268, -0.013016194...
https://pimcore.com/docs/platform//Ecommerce_Framework/Architecture_Overview#cart-manager
Cart Manager The Cart Manager is responsible for all aspects concerning carts. These aspects contain among other things: Different cart implementations CRUD-Operations on carts Price calculations for carts Price modifications for carts (like shipping costs, etc.)
Cart Manager
[ 0.1359895020723343, -0.1799430549144745, -0.17314177751541138, 0.08844146877527237, 0.1857941746711731, 0.28053098917007446, 0.3557286858558655, -0.27042916417121887, -0.02723241224884987, 0.16365689039230347, 0.15078535676002502, 0.5668136477470398, -0.015145109966397285, -0.2412475049495...
https://pimcore.com/docs/platform//Ecommerce_Framework/Architecture_Overview#checkout-manager
Checkout Manager The Checkout Manager is responsible for all aspects concerning checkout process and an one-stop API for getting through the checkout process. The Checkout Manager always works with a cart and at certain points in the checkout process it delegates to other components to convert the cart to an order obje...
Checkout Manager
[ 0.2888805866241455, -0.35143405199050903, -0.11710898578166962, -0.14325957000255585, 0.14167962968349457, 0.10517903417348862, 0.11041038483381271, -0.19418542087078094, 0.06938167661428452, 0.17689621448516846, 0.14594519138336182, 0.3362748324871063, 0.22241471707820892, 0.1410466283559...
https://pimcore.com/docs/platform//Ecommerce_Framework/Architecture_Overview#commit-order-processor
Commit Order Processor The Commit Order Processor is part of the Checkout Manager namespace and is responsible for all aspects concerning committing and order. These aspects contain among other things: Handle payment response commit order payment commit order and send order to other backend systems (e.g. erp system) ...
Commit Order Processor
[ 0.26942282915115356, 0.008687612600624561, -0.032205551862716675, -0.02789907157421112, 0.02679041214287281, 0.06962194293737411, -0.20643259584903717, -0.096253901720047, 0.18544377386569977, 0.32366132736206055, 0.19045254588127136, 0.0502287857234478, 0.21884620189666748, 0.378607153892...
https://pimcore.com/docs/platform//Ecommerce_Framework/Architecture_Overview#payment-manager
Payment Manager The Payment Manager is responsible for all aspects concerning payment. The main aspect is the implementation of different Payment Providers to integrate them into the framework.
Payment Manager
[ 0.3013116717338562, -0.06786991655826569, -0.21164575219154358, 0.09285760670900345, 0.27676641941070557, 0.31961098313331604, 0.0040877629071474075, -0.20944912731647491, -0.2541517913341522, 0.18605561554431915, 0.09197895228862762, 0.34729471802711487, 0.23210695385932922, 0.02202869020...
https://pimcore.com/docs/platform//Ecommerce_Framework/Architecture_Overview#order-manager
Order Manager The Order Manager is responsible for all aspects of working with orders except committing them (which is the responsibility of the Commit Order Processor). These aspects contain among other things: Creating orders based on carts Order Storage Loading orders Loading order lists and filter them (Order List...
Order Manager
[ 0.40931302309036255, 0.022082027047872543, -0.17308826744556427, -0.060509443283081055, 0.044123586267232895, 0.22217196226119995, 0.17934288084506989, -0.3585747480392456, 0.03650830313563347, 0.1898643523454666, 0.08900540322065353, 0.06126704812049866, 0.008442074991762638, 0.0245347749...
https://pimcore.com/docs/platform//Ecommerce_Framework/Installation#installation-and-first-configuration
Installation and First Configuration This section describes the installation of the E-Commerce Framework and the first steps of configuration.
Installation and First Configuration
[ 0.12691457569599152, -0.2904491424560547, -0.2794826626777649, 0.14142899215221405, 0.12060967832803726, 0.005866857245564461, 0.05311492830514908, -0.3191276490688324, -0.16806325316429138, -0.02896939031779766, -0.020050974562764168, -0.05430830270051956, 0.3685857057571411, 0.2842771112...
https://pimcore.com/docs/platform//Ecommerce_Framework/Installation#installation
Installation
Installation
[ -0.06728437542915344, -0.4834894835948944, -0.3417288661003113, 0.20734061300754547, 0.06259846687316895, 0.09173910319805145, -0.07573223114013672, -0.07214274257421494, 0.15155638754367828, 0.1816904991865158, -0.07461769878864288, 0.14365136623382568, 0.041423697024583817, 0.05546558648...
https://pimcore.com/docs/platform//Ecommerce_Framework/Installation#minimum-requirements
Minimum Requirements Pimcore >= 11.0
Minimum Requirements
[ -0.5381379127502441, -0.5530741810798645, -0.20082436501979828, 0.06452324986457825, 0.0002153780369553715, -0.1548311561346054, -0.13464324176311493, 0.11669043451547623, -0.22433604300022125, 0.3071454167366028, 0.08415747433900833, 0.23456713557243347, -0.1346186101436615, 0.29944258928...
https://pimcore.com/docs/platform//Ecommerce_Framework/Installation#install
Install Install bundle via composer: composer require pimcore/ecommerce-framework-bundle Enable bundle via console or extensions manager: php bin/console pimcore:bundle:install PimcoreEcommerceFrameworkBundle Check if the bundle has been installed: php bin/console pimcore:bundle:list +--------------------------------...
Install
[ -0.184309184551239, -0.13790959119796753, -0.2266254425048828, 0.17674517631530762, 0.07543638348579407, -0.04999329522252083, 0.07607285678386688, 0.06509429961442947, -0.32632333040237427, 0.09337006509304047, -0.06833231449127197, 0.5532243251800537, -0.13382461667060852, 0.336883217096...
https://pimcore.com/docs/platform//Ecommerce_Framework/Installation#configure-product-and-product-category-class
Configure Product and Product Category Class The E-Commerce Framework installation does not create classes for products and product categories. That is because the framework does not limit you on specific classes or class structures. Literally every class can act as a product or product category class and it is also po...
Configure Product and Product Category Class
[ 0.14911338686943054, -0.2518024444580078, -0.24116404354572296, 0.2996522784233093, 0.3033171594142914, -0.06174752116203308, 0.15257145464420319, -0.09805802255868912, -0.05946025997400284, -0.06246121972799301, -0.03859752416610718, 0.009432241320610046, 0.039726074784994125, 0.319720834...
https://pimcore.com/docs/platform//Ecommerce_Framework/Installation#product
Product There are two ways of preparing a Pimcore class for product-usage in the E-Commerce Framework The Pimcore class needs to extend the abstract class \Pimcore\Bundle\EcommerceFrameworkBundle\Model\AbstractProduct This is useful, when both product index and checkout functionality are based on the E-Commerce Fram...
Product
[ -0.016818817704916, -0.4141501486301422, -0.11547573655843735, 0.045933764427900314, 0.06851159036159515, -0.30371156334877014, 0.3609358072280884, -0.004153536166995764, -0.04978542774915695, 0.03468947857618332, -0.05481570586562157, 0.6190176010131836, 0.11927894502878189, 0.69535005092...
https://pimcore.com/docs/platform//Ecommerce_Framework/Installation#product-category
Product Category When a product category class is used, this class needs to extend the abstract class \Pimcore\Bundle\EcommerceFrameworkBundle\Model\AbstractCategory. For product categories only one Pimcore class should be used. For products, several Pimcore classes can be used. Possibly the index update scripts need ...
Product Category
[ -0.04960107430815697, -0.05019548907876015, -0.15430611371994019, 0.17528846859931946, 0.12319061905145645, -0.12372522801160812, 0.3080909252166748, 0.1981760412454605, -0.19323912262916565, 0.023408493027091026, -0.021761761978268623, 0.3734996020793915, -0.03483358025550842, 0.356131345...
https://pimcore.com/docs/platform//Ecommerce_Framework/Installation#configuring-pimcore-ecommerce-framework
Configuring Pimcore Ecommerce Framework The E-Commerce Framework is split up into multiple components which can be configured individually. For further reading please see: Configuration describes configuration features valid for the whole framework configuration PimcoreEcommerceFrameworkBundle Configuration Referenc...
Configuring Pimcore Ecommerce Framework
[ -0.19479233026504517, -0.4322689175605774, -0.23794464766979218, 0.1636848896741867, 0.19850286841392517, -0.07619691640138626, 0.07575726509094238, -0.33480358123779297, -0.2350248396396637, 0.14616239070892334, -0.18978863954544067, 0.3455817401409149, 0.4489451050758362, 0.4457470774650...
https://pimcore.com/docs/platform//Ecommerce_Framework/Configuration/PimcoreEcommerceFrameworkBundle_Configuration_Reference#pimcoreecommerceframeworkbundle-configuration-reference
PimcoreEcommerceFrameworkBundle Configuration Reference The following is the generated reference for the pimcore_ecommerce_framework configuration tree. This reference can be generated by issuing the following command: $ bin/console config:dump-reference pimcore_ecommerce_framework IMPORTANT This is just a reference ...
PimcoreEcommerceFrameworkBundle Configuration Reference
[ -0.2972327172756195, -0.04520249739289284, -0.1977008730173111, 0.1178172305226326, 0.1967163383960724, -0.17142847180366516, 0.19054248929023743, -0.006859102752059698, -0.2800068259239197, 0.13902705907821655, -0.06852903962135315, 0.5965362787246704, 0.1779429316520691, 0.35647985339164...
https://pimcore.com/docs/platform//Ecommerce_Framework/Configuration#configuration
Configuration The E-Commerce Framework is implemented as semantic bundle configuration which means that you can configure the framework in any of the loaded config files (e.g. /config/config.yaml or *Bundle/Resources/config/pimcore/config.yaml) by adding configuration to the pimcore_ecommerce_framework node. The config...
Configuration
[ -0.2378663867712021, -0.45464566349983215, -0.15928247570991516, 0.13949759304523468, 0.053082168102264404, -0.25228163599967957, 0.03846141695976257, -0.3163648843765259, -0.2683737874031067, 0.035820282995700836, -0.22134706377983093, 0.4014531672000885, 0.1254786252975464, 0.42914456129...
https://pimcore.com/docs/platform//Ecommerce_Framework/Configuration#tenant-support-and-_defaults-sections
Tenant support and _defaults sections As certain components of the E-Commerce Framework support different tenants, Pimcore adds a way to specify settings which are common to all tenants in a special tenant named _defaults. If such a tenant exists, its values will be merged into all other tenants and the _defaults tenan...
Tenant support and _defaults sections
[ -0.43851223587989807, -0.327438622713089, -0.06143463775515556, 0.12626323103904724, 0.27690955996513367, -0.10519682615995407, 0.1993526667356491, -0.13067762553691864, -0.1466616690158844, 0.29298272728919983, -0.2191460281610489, 0.5323206782341003, 0.15165840089321136, 0.08896411210298...
https://pimcore.com/docs/platform//Ecommerce_Framework/Configuration#service-ids-and-tenant-specifics
Service IDs and tenant specifics When configuring tenant specific services, there are multiple configuration entries demanding a service ID as configuration value. This means, the system expects the configured value to be available as service definition on the container. You can read through the service definitions def...
Service IDs and tenant specifics
[ -0.23094947636127472, -0.3088842034339905, -0.055669721215963364, 0.13473637402057648, 0.13572053611278534, -0.3702165484428406, 0.431750625371933, -0.4109499156475067, -0.0737152025103569, 0.18318332731723785, -0.1390237957239151, 0.5128394961357117, 0.31580379605293274, 0.326411992311477...
https://pimcore.com/docs/platform//Ecommerce_Framework/Configuration#service-ids-in-tenant-context
Service IDs in tenant context Now let's take a look at another example handling tenants: pimcore_ecommerce_framework: order_manager: tenants: default: order_manager_id: Pimcore\Bundle\EcommerceFrameworkBundle\OrderManager\OrderManager options: ...
Service IDs in tenant context
[ -0.003332416759803891, -0.02928788959980011, -0.059481680393218994, 0.2733992040157318, 0.13529807329177856, -0.36854836344718933, 0.612507164478302, -0.24193018674850464, -0.12441929429769516, 0.15421529114246368, -0.3183199465274811, 0.29373276233673096, 0.12381602078676224, -0.104514010...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Assortment_Tenant_Configuration#assortment-tenant-configuration
Assortment Tenant Configuration The E-Commerce Framework provides a two level Assortment Tenant system for the Product Index: Assortment Tenant: The first level of tenants are heavy-weight tenants. They allow multiple shop instances within one system. The shop instances are completely independent from each other and ...
Assortment Tenant Configuration
[ 0.024722063913941383, -0.336113303899765, -0.10734255611896515, 0.3460088074207306, -0.10601974278688431, 0.08642648160457611, 0.38454172015190125, -0.43185126781463623, 0.19663852453231812, 0.26568740606307983, -0.2628704905509949, 0.0723867118358612, -0.07161961495876312, -0.026726998388...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Assortment_Tenant_Configuration#assortment-tenants
Assortment Tenants For setting up an Assortment Tenant, following steps are necessary: Implementation of a Tenant Config: The Tenant Config class is the central configuration of an assortment tenant, defines which products are available for the tenant and provides the connection to the used Product Index implementati...
Assortment Tenants
[ -0.07887960225343704, -0.11087754368782043, -0.10163988173007965, 0.08854996412992477, -0.01122612226754427, -0.05550888925790787, 0.3329288363456726, -0.21251162886619568, -0.09175240993499756, 0.21671436727046967, -0.11762218177318573, 0.41139647364616394, 0.014345111325383186, 0.1741703...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Assortment_Tenant_Configuration#setting-current-assortment-tenant-for-frontend
Setting current Assortment Tenant for Frontend The E-Commerce Framework Environment provides following methods to set the current Assortment Tenant when working with Product Lists in Code: <?php /** * sets current assortment tenant which is used for indexing and product lists * * @param string $te...
Setting current Assortment Tenant for Frontend
[ 0.0008036980871111155, -0.23602131009101868, -0.18980957567691803, 0.06269171833992004, -0.0034268891904503107, -0.13195428252220154, 0.44956114888191223, -0.18573953211307526, 0.3197506070137024, 0.09992890805006027, -0.09218090027570724, 0.1622900664806366, 0.04139525070786476, 0.0596273...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Assortment_Tenant_Configuration#example:
Example: <?php $factory = \Pimcore\Bundle\EcommerceFrameworkBundle\Factory::getInstance(); //setting assortment tenant $environment = $factory->getEnvironment(); $environment->setCurrentAssortmentTenant("elasticsearch"); //getting suitable product list $productlist = $factory-&gt...
Example:
[ -0.39623767137527466, -0.25103721022605896, -0.332038938999176, 0.10614696145057678, -0.1744306981563568, -0.22100350260734558, 0.18652518093585968, 0.10361390560865402, -0.0007326518534682691, 0.2587028443813324, 0.06809849292039871, 0.4700227379798889, -0.07631560415029526, 0.01234822906...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Assortment_Tenant_Configuration#assortment-subtenants
Assortment Subtenants Subtenants are light-weight tenants, which share the same Product Index with the same attributes as their parent assortment tenant.
Assortment Subtenants
[ -0.0072145420126616955, -0.23727242648601532, -0.16590800881385803, 0.24540849030017853, 0.04307826608419418, 0.40864208340644836, 0.5243653059005737, -0.07051791250705719, 0.12362629175186157, 0.240526020526886, -0.31928539276123047, 0.1834120899438858, -0.21291197836399078, -0.3588247895...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Assortment_Tenant_Configuration#implementing-an-assortment-subtenant-for-mysql
Implementing an Assortment Subtenant for MySQL The mapping which product is assigned to with subtenant is done with an additional mapping table. The necessary joins and conditions are implemented within additional methods within Pimcore\Bundle\EcommerceFrameworkBundle\IndexService\Config\MysqlConfigInterface: /** ...
Implementing an Assortment Subtenant for MySQL
[ -0.13414540886878967, -0.255340039730072, -0.14183779060840607, 0.36423325538635254, -0.34041720628738403, -0.1364898979663849, 0.11273442208766937, -0.09791732579469681, -0.027255546301603317, 0.06809265911579132, -0.4102407991886139, 0.4163626432418823, 0.07137101888656616, 0.02462931163...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Assortment_Tenant_Configuration#implementing-an-assortment-subtenant-for-elasticsearch
Implementing an Assortment Subtenant for Elasticsearch In order to populate the additional mapping data, the following method has to be implemented: /** * in case of subtenants returns a data structure containing all sub tenants * * @param IndexableInterface $object * @param int|null $subObjectI...
Implementing an Assortment Subtenant for Elasticsearch
[ -0.12531504034996033, -0.10366012156009674, -0.1945004165172577, 0.1189446821808815, -0.2598165273666382, -0.0346483513712883, 0.09845392405986786, 0.10473181307315826, 0.2255433052778244, 0.32215389609336853, -0.22384120523929596, 0.269519180059433, -0.12197676301002502, -0.13541658222675...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Data_Architecture_and_Indexing_Process#data-architecture-and-indexing-process
Data Architecture and Indexing Process Depending on the Product Index implementation, there are two different Product Index data architectures and ways for indexing: Simple Mysql Architecture and Optimized Architecture. For indexing itself the provided Pimcore console commands can be used.
Data Architecture and Indexing Process
[ -0.10072547197341919, -0.21969592571258545, -0.2678316831588745, 0.19484488666057587, -0.19397468864917755, -0.27151039242744446, 0.11924327164888382, -0.09528744220733643, -0.1224399283528328, 0.16526742279529572, -0.4563937783241272, 0.33352139592170715, -0.011011794209480286, 0.47947230...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Data_Architecture_and_Indexing_Process#simple-mysql-architecture
Simple Mysql Architecture Pimcore object data is transferred directly to the Product Index. After every update of a Pimcore object, the changes are directly written into the Product Index. Only used for \Pimcore\Bundle\EcommerceFrameworkBundle\IndexService\Config\DefaultMysql Updates of dependent objects (like chil...
Simple Mysql Architecture
[ -0.010695590637624264, -0.08597543090581894, -0.12030082195997238, 0.35497763752937317, -0.24587751924991608, -0.18389366567134857, 0.08780838549137115, -0.14145730435848236, -0.1463974416255951, 0.08367618173360825, -0.18637125194072723, 0.484717458486557, 0.1373457908630371, 0.2329479753...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Data_Architecture_and_Indexing_Process#console-commands-for-simple-mysql-architecture
Console Commands for Simple Mysql Architecture For manually updating the whole index use following command: php bin/console ecommerce:indexservice:bootstrap --update-index If you need to create or update the index structures you can use: php bin/console ecommerce:indexservice:bootstrap --create-or-update-index-str...
Console Commands for Simple Mysql Architecture
[ -0.31864210963249207, 0.023965084925293922, -0.18333576619625092, -0.058493759483098984, -0.14737240970134735, 0.24461397528648376, 0.02170691452920437, 0.16430431604385376, -0.22530589997768402, 0.2053990662097931, -0.2747386395931244, 0.41864144802093506, 0.13441304862499237, 0.317806839...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Data_Architecture_and_Indexing_Process#optimized-architecture
Optimized Architecture In the optimized architecture, object data is transferred not directly to the Product Index. In this case a so called store table is between the Pimcore objects and the Product Index. This store table enables to ... ... update the Product Index only if index relevant data has changed. Theref...
Optimized Architecture
[ -0.11351625621318817, -0.33319881558418274, -0.25107237696647644, -0.06318406015634537, -0.20182906091213226, -0.18801407516002655, -0.03426984325051308, 0.13131020963191986, -0.2243186980485916, 0.237928569316864, -0.18184494972229004, 0.4686765670776367, 0.03276600316166878, 0.2065774351...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Data_Architecture_and_Indexing_Process#console-commands-for-optimized-architecture
Console Commands for Optimized Architecture For updating data in index following commands are available. For process the preparation queue and update Pimcore objects to the index store table, use following command. This command should be executed periodically (e.g. all 10 minutes). php bin/console ecommerce:indexser...
Console Commands for Optimized Architecture
[ -0.3166200518608093, -0.03045107237994671, -0.22339871525764465, 0.019673701375722885, -0.05908289924263954, -0.01647859998047352, 0.023017913103103638, 0.20226652920246124, -0.2013138085603714, 0.2492053359746933, -0.0564156211912632, 0.4038180112838745, 0.25185900926589966, 0.33476623892...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Data_Architecture_and_Indexing_Process#paralelization-of-indexing
Paralelization of Indexing All indexing commands include the parallelization trait of webmozart. Thus indexing can be parallelized very easily by adding the --processes=X option to the command. Be aware that depending on the command too many parallel processes might cause deadlocks on database.
Paralelization of Indexing
[ -0.2922708988189697, -0.2902553081512451, -0.27462297677993774, -0.00883408635854721, -0.22639556229114532, 0.24589687585830688, 0.03941420465707779, 0.5016093850135803, 0.1021852120757103, 0.14904199540615082, -0.3572554588317871, 0.08001325279474258, 0.0026693742256611586, -0.22492726147...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search/Configuration_Details#configuration-configuration
Configuration Configuration Following aspects need to be considered in index configuration:
Configuration Configuration
[ -0.1483539491891861, -0.28390398621559143, -0.24861378967761993, 0.17246152460575104, 0.02317158132791519, 0.0895666554570198, 0.27301570773124695, 0.07624936103820801, 0.17494143545627594, 0.13352476060390472, -0.23353731632232666, 0.10672726482152939, 0.27107948064804077, 0.1838427931070...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search/Configuration_Details#general-configuration-options
General Configuration Options In the config_options area general elasticsearch settings can be made - like hosts, index settings, etc.
General Configuration Options
[ -0.20626777410507202, -0.20669272541999817, -0.31960824131965637, -0.427655965089798, -0.048935383558273315, -0.14960843324661255, 0.10840102285146713, 0.11011241376399994, 0.13216568529605865, 0.23510070145130157, -0.1524660587310791, 0.08172735571861267, -0.019922399893403053, 0.05100910...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search/Configuration_Details#client_config
client_config logging: (deprecated, for Elasticsearch 7 only) true/false to activate logging of elasticsearch client indexName: index name to be used, if not provided tenant name is used as index name
client_config
[ 0.07191558927297592, -0.13875755667686462, -0.11354397237300873, -0.3800816237926483, -0.08681575208902359, -0.101664237678051, 0.23121803998947144, 0.02025187760591507, 0.050322916358709335, 0.09952042996883392, 0.22250378131866455, 0.23270751535892487, -0.27791619300842285, 0.00223044375...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search/Configuration_Details#index_settings
index_settings Index settings that are used when creating a new index. They are passed 1:1 as settings param to the body of the create index command. Details see also elasticsearch Docs.
index_settings
[ 0.004894281271845102, -0.6405298709869385, -0.23313985764980316, -0.28684791922569275, -0.04575517401099205, 0.12933064997196198, -0.04873847961425781, 0.02255900204181671, 0.007560233119875193, 0.4255332350730896, 0.11379434913396835, 0.03789840266108513, 0.12807263433933258, -0.075162492...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search/Configuration_Details#es_client_name-(for-elasticsearch-8-only)
es_client_name (for Elasticsearch 8 only) Elasticsearch 8 client configuration takes place via Pimcore Elasticsearch Client Bundle and has two parts. Configuring an elasticsearch client in separate configuration # Configure an elasticsearch client pimcore_elasticsearch_client: es_clients: default: ...
es_client_name (for Elasticsearch 8 only)
[ -0.0277169831097126, -0.14116209745407104, -0.15693379938602448, -0.36326682567596436, 0.027457566931843758, -0.2126358449459076, 0.35590407252311707, -0.07647169381380081, 0.03558441624045372, 0.26055920124053955, -0.17800156772136688, 0.2961004376411438, 0.0708671435713768, -0.1505327224...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search/Configuration_Details#synonym_providers
synonym_providers Specify synonym providers for synonym filters defined in filter section of index settings. For details see Synonyms.
synonym_providers
[ -0.01997450180351734, -0.18928878009319305, -0.1624072641134262, -0.12699373066425323, -0.04374933987855911, -0.2499554306268692, 0.17214420437812805, 0.09667730331420898, 0.006676692981272936, 0.3285125494003296, -0.22364136576652527, 0.06034085899591446, 0.2623078525066376, -0.0269352141...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search/Configuration_Details#sample-config
Sample Config pimcore_ecommerce_framework: index_service: tenants: MyEsTenant: worker_id: Pimcore\Bundle\EcommerceFrameworkBundle\IndexService\Worker\ElasticSearch\DefaultElasticSearch8 config_id: Pimcore\Bundle\EcommerceFrameworkBundle\IndexService\Config\Elastic...
Sample Config
[ -0.3241058588027954, -0.07571566104888916, -0.2589651942253113, -0.26222023367881775, 0.003207694971933961, -0.09537323564291, 0.3029315769672394, 0.24743641912937164, 0.029094982892274857, 0.126132532954216, -0.21902233362197876, 0.31901663541793823, 0.006591080687940121, 0.08754429966211...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search/Configuration_Details#data-types-for-attributes
Data Types for attributes The type of the data attributes needs to be set to elasticsearch data types.. pimcore_ecommerce_framework: index_service: tenants: MyEsTenant: attributes: name: locale: '%%locale%%' type...
Data Types for attributes
[ -0.1046789139509201, -0.23336495459079742, -0.1452665776014328, 0.07810923457145691, 0.30181702971458435, -0.15615946054458618, 0.11711196601390839, 0.0849822610616684, 0.07973182946443558, 0.1849852055311203, -0.13971751928329468, 0.40206673741340637, 0.13160313665866852, 0.27893006801605...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search/Synonyms#synonyms
Synonyms With elasticsearch so called synonym filters can be configured to further optimize search behavior. For details see Synonym Token Filter and following pages at elasticsearch documentation. Pimcore provides an out-of-the box integration to provide synonyms for the synonym filters of elasticsearch.
Synonyms
[ -0.07474331557750702, -0.2629656195640564, -0.2952900230884552, -0.34454694390296936, -0.2813798189163208, -0.40243110060691833, -0.21538206934928894, 0.14151448011398315, -0.24062728881835938, 0.163555309176445, -0.20764325559139252, 0.23156104981899261, 0.11647575348615646, 0.00443528406...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search/Synonyms#synonym-providers
Synonym Providers Synonym providers are symfony services that implement the SynonymProviderInterface, load synonyms from a specific source and provide it for using them in elasticsearch synonym filters. Sources can be simple files, Pimcore assets, Pimcore data objects, database tables or what ever source is needed. Pim...
Synonym Providers
[ 0.028657548129558563, 0.12003100663423538, -0.03780405968427658, -0.1424953192472458, -0.35887640714645386, -0.3300241231918335, -0.04004688560962677, -0.07859048992395401, -0.2572093605995178, 0.10742802917957306, -0.11731076240539551, 0.2360193133354187, 0.25060054659843445, -0.244847699...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search/Synonyms#matching-synonym-providers-to-synonym-filters
Matching Synonym Providers to Synonym Filters Matching between synonym providers and synonym filters in index settings takes place via name. In the sample below there the synonym provider app_synonym_filter provides the synonyms for the filter app_synonym_filter. The filter definition in the index settings can hold jus...
Matching Synonym Providers to Synonym Filters
[ 0.039715223014354706, -0.07763417810201645, -0.13978628814220428, -0.17640788853168488, -0.23081450164318085, -0.3747863173484802, -0.13081540167331696, -0.0007760617299936712, -0.04135908931493759, 0.04145895317196846, -0.14044612646102905, 0.2654889225959778, 0.19384458661079407, 0.06062...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search/Synonyms#updating-synonyms
Updating Synonyms There are three ways of updating the synonyms in the elasticsearch index. For all applies that the synonyms are loaded from synonyms provider and injected to the synonyms array of the corresponding synonyms filter by Pimcore.
Updating Synonyms
[ 0.40618202090263367, 0.008706395514309406, -0.19137583673000336, -0.22364872694015503, -0.5279276967048645, -0.2492256462574005, -0.2788674533367157, -0.1099725291132927, -0.13584180176258087, 0.084189273416996, -0.20474785566329956, 0.18039149045944214, 0.4024566113948822, -0.244994848966...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search/Synonyms#index-creation
Index Creation During index creation the synonyms are loaded from synonym providers and applied to index.
Index Creation
[ 0.2938013970851898, -0.25267738103866577, -0.1297723650932312, 0.2716834545135498, -0.08305106312036514, -0.12900134921073914, 0.3087327480316162, -0.05197090655565262, 0.12543195486068726, 0.2643115520477295, -0.13502411544322968, -0.0368444062769413, 0.28662779927253723, -0.0572993196547...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search/Synonyms#reindex
Reindex During reindex the synonyms are loaded from synonym providers and applied to index when new index is created. This is the recommended way to update synonyms during runtime at a production system as there is no service downtime.
Reindex
[ 0.21325327455997467, -0.020182818174362183, -0.15614533424377441, -0.19020110368728638, -0.1668281853199005, -0.1293482482433319, 0.09726610034704208, -0.07584300637245178, 0.034585773944854736, -0.027486396953463554, -0.2719014883041382, 0.20864443480968475, 0.3538181185722351, -0.0536299...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search/Synonyms#elasticsearch-sync-command
Elasticsearch sync command With the command bin/console ecommerce:indexservice:elasticsearch-sync update-synonyms synonyms can be updated in the current index. For that, the index has to be closed and reopened which means a short downtime of the index.
Elasticsearch sync command
[ -0.18034715950489044, -0.05247960612177849, -0.3071752190589905, -0.3742154538631439, -0.33541062474250793, -0.09871765971183777, -0.09195675700902939, 0.18034526705741882, 0.16979365050792694, 0.28246524930000305, -0.09529685974121094, 0.2220967710018158, 0.10397669672966003, -0.106860645...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search#special-aspects-for-elasticsearch
Special Aspects for Elasticsearch Basically Elasticsearch worker works as described in the optimized architecture. Currently, Elasticsearch 8 is supported.
Special Aspects for Elasticsearch
[ -0.28374502062797546, -0.3861934244632721, -0.31853434443473816, -0.24229244887828827, -0.23875507712364197, -0.15954968333244324, -0.04757380858063698, 0.21319139003753662, 0.09880639612674713, 0.1360083818435669, -0.22156397998332977, 0.19586072862148285, -0.31239375472068787, 0.06974019...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search#installation
Installation
Installation
[ -0.06728437542915344, -0.4834894835948944, -0.3417288661003113, 0.20734061300754547, 0.06259846687316895, 0.09173910319805145, -0.07573223114013672, -0.07214274257421494, 0.15155638754367828, 0.1816904991865158, -0.07461769878864288, 0.14365136623382568, 0.041423697024583817, 0.05546558648...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search#elasticsearch-8
Elasticsearch 8 To work properly Pimcore requires the Elasticsearch client, install them with: composer require pimcore/elasticsearch-client.
Elasticsearch 8
[ -0.3586961328983307, 0.07423550635576248, -0.2401430606842041, -0.14725613594055176, -0.04421903192996979, -0.2904757559299469, 0.19268280267715454, 0.14377257227897644, -0.09506476670503616, 0.2032487690448761, -0.2918405532836914, 0.37426871061325073, -0.17436003684997559, -0.06936584413...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search#index-configuration
Index Configuration Elasticsearch provides a couple of additional configuration options for the index to utilize elasticsearch features. See Configuration Details for more information.
Index Configuration
[ -0.016304032877087593, -0.30242297053337097, -0.3129129111766815, -0.2318815290927887, -0.10245494544506073, 0.008979998528957367, 0.19032683968544006, 0.03249048441648483, 0.21941305696964264, 0.2580536901950836, -0.13000136613845825, 0.11265427619218826, 0.03856317326426506, 0.0125217866...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search#reindexing-mode
Reindexing Mode It is possible that elasticsearch cannot update the mapping, e.g. if data types of attributes change on the fly. For this case, a reindex is necessary. If it is necessary, a native ES reindex is executed automatically during bin/console ecommerce:indexservice:bootstrap --create-or-update-index-structure...
Reindexing Mode
[ 0.07965990155935287, -0.1959690898656845, -0.14969076216220856, -0.08023606240749359, -0.13219821453094482, 0.013210633769631386, -0.0041028158739209175, 0.2532196342945099, 0.2088489681482315, 0.07311458885669708, -0.20565913617610931, 0.3615013360977173, 0.1412663608789444, 0.05673002451...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search#indexing-of-classification-store-attributes
Indexing of Classification Store Attributes With elasticsearch it is possible to index all attributes of Classification Store data without defining an attribute for each single classification store key. For details see Filter Classification Store in Filter Service documentation.
Indexing of Classification Store Attributes
[ 0.028367331251502037, -0.08350338786840439, -0.23910675942897797, -0.013969759456813335, 0.10454066842794418, 0.061154793947935104, 0.2544834315776825, 0.1510014683008194, 0.28951552510261536, 0.09148913621902466, -0.20972993969917297, 0.18012748658657074, -0.06963378936052322, 0.220593944...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Elastic_Search#synonyms
Synonyms Pimcore provides an out-of-the box integration for synonyms in elasticsearch. See Synonyms for details.
Synonyms
[ -0.1038968414068222, -0.15784308314323425, -0.32790929079055786, -0.4370593726634979, -0.33293211460113525, -0.27153101563453674, -0.2178887277841568, 0.1583014577627182, -0.18699754774570465, 0.1345146894454956, -0.1796446442604065, 0.3100615441799164, -0.07582637667655945, 0.072914354503...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration/Findologic#special-aspects-for-findologic-exporter
Special Aspects for Findologic Exporter Basically findologic worker works as described in the optimized architecture. But there is an additional speciality with the export: Executing php bin/console ecommerce:indexservice:process-update-queue does not write the data directly to Findologic, but into an extra table \Pimc...
Special Aspects for Findologic Exporter
[ -0.31207793951034546, 0.12163365632295609, -0.2013634741306305, 0.08499722182750702, -0.13817927241325378, -0.3256141245365143, 0.05176635831594467, 0.29980704188346863, -0.04344185069203377, -0.03809583559632301, -0.36510607600212097, 0.5967962145805359, -0.04897976666688919, 0.2455451041...
https://pimcore.com/docs/platform//Ecommerce_Framework/Index_Service/Product_Index_Configuration#product-index-configuration
Product Index Configuration The configuration of the Product Index defines the content of the Product Index (which attributes are extracted how and stored where) and takes place in the pimcore_ecommerce_framework configuration within the section index_service. The product index can define multiple tenants (see Assortme...
Product Index Configuration
[ 0.022089531645178795, -0.2268742471933365, -0.17446434497833252, 0.039810892194509506, 0.0017992376815527678, -0.1906328797340393, 0.3195817768573761, -0.12189636379480362, -0.024163072928786278, 0.26191338896751404, -0.24580244719982147, 0.417635053396225, 0.07352828979492188, 0.273700386...