@@ -32,7 +32,6 @@ This document provides detailed information about all features available in the
3232 - [ Akeneo Manager] ( #akeneo-manager )
3333- [ Notification Features] ( #notification-features )
3434 - [ Slack Notifications] ( #slack-notifications )
35- - [ CLI Commands] ( #cli-commands )
3635- [ Event System] ( #event-system )
3736 - [ Import Finished Events] ( #import-finished-events )
3837
@@ -41,17 +40,26 @@ This document provides detailed information about all features available in the
4140## Configuration Guide
4241<a id =" configuration-guide " ></a >
4342
44- All features are configured via the Magento Admin Panel:
43+ All features are configured via the Magento Admin Panel under :
4544
46- ** Main Path: ** ` Stores > Configuration > Catalog > Akeneo Connector > JustBetter Akeneo `
45+ ** ` Stores > Configuration > Catalog > Akeneo Connector > JustBetter Akeneo ` **
4746
48- Most features are toggled and configured in this main section. Some features use additional configuration sections:
49- - Grid configurations for tier prices, tax mapping, and required attributes under ` Products `
50- - Family exclusion filter under ` Products Filters `
47+ ### Configuration Sections
5148
52- See each feature below for specific configuration paths and options.
49+ #### Main Configuration
50+ ** Path:** ` Stores > Configuration > Catalog > Akeneo Connector > JustBetter Akeneo `
5351
54- ** [ ⬆ Back to top] ( #features-documentation ) **
52+ #### Products Configuration
53+ ** Path:** ` Stores > Configuration > Catalog > Akeneo Connector > Products `
54+
55+ - ** Customer Group Pricing:** Grid mapping Akeneo attribute codes to Magento customer groups
56+ - ** Tax Class Mapping:** Grid mapping Akeneo tax codes to Magento tax class IDs
57+ - ** Required Attribute Mapping:** Grid defining required attributes per website
58+
59+ #### Products Filters
60+ ** Path:** ` Stores > Configuration > Catalog > Akeneo Connector > Products Filters `
61+
62+ - ** Excluded Families:** Multiselect of families to exclude from import
5563
5664---
5765
@@ -64,8 +72,6 @@ Select attributes that should always be imported and added to product temporary
6472
6573** Configuration:** ` Stores > Configuration > Catalog > Akeneo Connector > JustBetter Akeneo > Important Attributes `
6674
67- ** [ ⬆ Back to top] ( #features-documentation ) **
68-
6975---
7076
7177### Tier Prices
@@ -76,8 +82,6 @@ Maps Akeneo attribute codes to Magento customer groups, enabling customer group-
7682** Configuration:** ` Stores > Configuration > Catalog > Akeneo Connector > Products > Customer Group Pricing `
7783** Mapping:** Define Akeneo Attribute → Magento Customer Group pairs in grid configuration.
7884
79- ** [ ⬆ Back to top] ( #features-documentation ) **
80-
8185---
8286
8387### Default Store Values for Required Attributes
@@ -89,8 +93,6 @@ Automatically sets default language values for required product attributes when
8993- Enable: ` Stores > Configuration > Catalog > Akeneo Connector > JustBetter Akeneo > Default Store Values `
9094- Fallback Language: ` Stores > Configuration > Catalog > Akeneo Connector > JustBetter Akeneo > Default Language ` (e.g., ` nl_NL ` )
9195
92- ** [ ⬆ Back to top] ( #features-documentation ) **
93-
9496---
9597
9698### Exclude Families from Import
@@ -102,8 +104,6 @@ Prevents specific product families from being imported. Products belonging to ex
102104
103105** Note:** This feature works in combination with the "Family Attribute as Filter" configuration.
104106
105- ** [ ⬆ Back to top] ( #features-documentation ) **
106-
107107---
108108
109109### Insert New Products
@@ -113,8 +113,6 @@ Control whether new products from Akeneo are inserted into Magento. When disable
113113
114114** Configuration:** ` Stores > Configuration > Catalog > Akeneo Connector > JustBetter Akeneo > Insert New Products ` (Default: Yes)
115115
116- ** [ ⬆ Back to top] ( #features-documentation ) **
117-
118116---
119117
120118### Set Products Active
@@ -124,8 +122,6 @@ Automatically enables all products imported from Akeneo by setting their status
124122
125123** Configuration:** ` Stores > Configuration > Catalog > Akeneo Connector > JustBetter Akeneo > Set Products Active `
126124
127- ** [ ⬆ Back to top] ( #features-documentation ) **
128-
129125---
130126
131127### Enable Manage Stock by Default
@@ -135,8 +131,6 @@ Sets "Manage Stock" to "Yes" for all imported products by default.
135131
136132** Configuration:** ` Stores > Configuration > Catalog > Akeneo Connector > JustBetter Akeneo > Enable Manage Stock `
137133
138- ** [ ⬆ Back to top] ( #features-documentation ) **
139-
140134---
141135
142136### Set Stock Status
@@ -146,8 +140,6 @@ Automatically sets imported products' stock status to "In Stock" when they are b
146140
147141** Configuration:** ` Stores > Configuration > Catalog > Akeneo Connector > JustBetter Akeneo > Set Stock Status `
148142
149- ** [ ⬆ Back to top] ( #features-documentation ) **
150-
151143---
152144
153145### Remove Redundant EAV Attributes
@@ -159,8 +151,6 @@ Automatically cleans up orphaned EAV values when a product's family changes in A
159151
160152** Example:** Product changes from Family A (attributes: name, price, color) to Family B (attributes: name, price, weight). The "color" EAV values are automatically deleted.
161153
162- ** [ ⬆ Back to top] ( #features-documentation ) **
163-
164154---
165155
166156## Category Features
@@ -172,8 +162,6 @@ When enabled, preserves existing category URL keys instead of regenerating them
172162
173163** Configuration:** ` Stores > Configuration > Catalog > Akeneo Connector > JustBetter Akeneo > Category Exist `
174164
175- ** [ ⬆ Back to top] ( #features-documentation ) **
176-
177165---
178166
179167## Tax & Pricing Features
@@ -189,8 +177,6 @@ Maps Akeneo tax class attribute values to Magento tax class IDs. Supports both n
189177
190178** Requirements:** Map the Akeneo tax attribute in the Attribute Types configuration with type "tax".
191179
192- ** [ ⬆ Back to top] ( #features-documentation ) **
193-
194180---
195181
196182## Attribute Features
@@ -208,8 +194,6 @@ Imports Akeneo metric attribute units into Magento's `eav_attribute.unit` field.
208194- Automatically runs after attribute import
209195- Manual execution: ` bin/magento metric:import `
210196
211- ** [ ⬆ Back to top] ( #features-documentation ) **
212-
213197---
214198
215199### Format Media Name (SEO Friendly)
@@ -221,8 +205,6 @@ Replaces underscores with hyphens in media file names for SEO-friendly URLs.
221205
222206** Example:** ` product_image_2024.jpg ` → ` product-image-2024.jpg `
223207
224- ** [ ⬆ Back to top] ( #features-documentation ) **
225-
226208---
227209
228210## Visibility Features
@@ -238,8 +220,6 @@ Automatically sets visibility to "Not Visible Individually" for all products bel
238220- Automatically runs after product import
239221- Manual execution: ` bin/magento akeneo:setfamilynotvisible `
240222
241- ** [ ⬆ Back to top] ( #features-documentation ) **
242-
243223---
244224
245225## Website Association Features
@@ -258,8 +238,6 @@ Validates that required product attributes contain values before assigning websi
258238
259239** Example:** Product mapped to US website requires "description". If "description-en_US-ecommerce" is empty, US website association is removed.
260240
261- ** [ ⬆ Back to top] ( #features-documentation ) **
262-
263241---
264242
265243## Management & Administration
@@ -274,8 +252,6 @@ Manual mapping interface for adjusting Akeneo codes versus Magento entity IDs in
274252
275253** Features:** Create, edit, and delete mappings for families, categories, attributes, and other entities synced between Akeneo and Magento.
276254
277- ** [ ⬆ Back to top] ( #features-documentation ) **
278-
279255---
280256
281257## Notification Features
@@ -302,41 +278,6 @@ Sends daily import status notifications to Slack at 8:00 AM. Reports successful
302278
303279** Usage:** Manual execution: ` bin/magento slack:notification `
304280
305- ** [ ⬆ Back to top] ( #features-documentation ) **
306-
307- ---
308-
309- ## CLI Commands
310- <a id =" cli-commands " ></a >
311-
312- Some features provide CLI commands for manual execution or testing purposes.
313-
314- ### Import Metric Units
315- ``` bash
316- bin/magento metric:import
317- ```
318- Imports metric unit information from Akeneo into Magento's ` eav_attribute.unit ` field. This command runs automatically after attribute import but can be executed manually when needed.
319-
320- ** Related feature:** [ Metric Units Import] ( #metric-units )
321-
322- ### Set Family Visibility
323- ``` bash
324- bin/magento akeneo:setfamilynotvisible
325- ```
326- Sets products in configured families to "Not Visible Individually". This command runs automatically after product import but can be executed manually to update visibility for existing products.
327-
328- ** Related feature:** [ Set Families Not Visible] ( #not-visible-individually )
329-
330- ### Send Slack Notification
331- ``` bash
332- bin/magento slack:notification
333- ```
334- Manually triggers Slack import status notification. Useful for testing Slack integration or sending on-demand status reports.
335-
336- ** Related feature:** [ Slack Notifications] ( #slack-notifications )
337-
338- ** [ ⬆ Back to top] ( #features-documentation ) **
339-
340281---
341282
342283## Event System
@@ -359,60 +300,8 @@ akeneo_connector_import_finish_product
359300
360301** Important:** Product import runs per family (since Akeneo Connector 102.1.1), so ` akeneo_connector_import_finish_product ` fires multiple times if importing multiple families.
361302
362- ** Use Cases:**
363- - Custom indexing after product import
364- - Third-party system synchronization
365- - Custom cache warming
366- - Email notifications
367- - Data validation and reporting
368-
369- ### Event Implementation Example
370-
371- ** Create an observer in your custom module:**
372-
373- 1 . ** Register the observer in ` etc/events.xml ` :**
374- ``` xml
375- <?xml version =" 1.0" ?>
376- <config xmlns : xsi =" http://www.w3.org/2001/XMLSchema-instance"
377- xsi : noNamespaceSchemaLocation =" urn:magento:framework:Event/etc/events.xsd" >
378- <event name =" akeneo_connector_import_finish_product" >
379- <observer name =" your_module_custom_processing"
380- instance =" YourVendor\YourModule\Observer\CustomProductProcessing" />
381- </event >
382- </config >
383- ```
384-
385- 2 . ** Create the observer class:**
386- ``` php
387- <?php
388- declare(strict_types=1);
389-
390- namespace YourVendor\YourModule\Observer;
391-
392- use Magento\Framework\Event\Observer;
393- use Magento\Framework\Event\ObserverInterface;
394-
395- class CustomProductProcessing implements ObserverInterface
396- {
397- public function execute(Observer $observer): void
398- {
399- /** @var \Akeneo\Connector\Job\Import $import */
400- $import = $observer->getData('import');
401-
402- // Get import details
403- $importCode = $import->getCode(); // e.g., 'product'
404- $family = $import->getFamily(); // Current family being imported
405-
406- // Your custom logic here
407- // Example: Trigger reindexing, send notifications, etc.
408- }
409- }
410- ```
411-
412303** Note:** The ` akeneo_connector_import_finish_product ` event fires multiple times (once per family) since Akeneo Connector 102.1.1. Use ` $import->getFamily() ` to process specific families only.
413304
414- ** [ ⬆ Back to top] ( #features-documentation ) **
415-
416305---
417306
418307** [ ← Back to README] ( README.md ) **
0 commit comments