@@ -14,14 +14,14 @@ weight: 1
1414- [ Installation] ( #installation )
1515- [ Usage] ( #usage )
1616 - [ Connecting to Akeneo] ( #connecting-to-akeneo )
17- - [ Using the enterprise version] ( #using-the-enterprise-version )
1817 - [ Building an extractor] ( #building-an-extractor )
1918 - [ Building a lookup] ( #building-a-lookup )
2019 - [ Building a conditional lookup] ( #building-a-conditional-lookup )
2120 - [ Building a loader] ( #building-a-loader )
2221- [ Advanced Usage] ( #advanced-usage )
2322 - [ Filtering your search] ( #filtering-your-search )
2423 - [ Using ExpressionLanguage] ( #using-expressionlanguage )
24+ - [ Available resources] ( #available-resources )
2525---
2626## What is it ?
2727
@@ -59,30 +59,10 @@ To retrieve these identifiers, you need to add a
5959
6060Warning: For the ` api_url` option, you must remove the `/` at the end of your URL if there is one.
6161
62- # ## Using the enterprise edition
63-
64- The `enterprise` option allows you to use the enterprise features in Akeneo and uses the Enterprise client accordingly. By default, it's set to `false`.
65-
66- ` ` ` yaml
67- akeneo:
68- enterprise: true
69- # ...
70- ` ` `
71-
7262# ## Building an extractor
7363
74- In the configuration of your extractor, you must specify the `type` of resource you will be working on
75- and which `method you want to use to retrieve your data.
76-
77- The list of available resources is quite long depend on the edition of your Akeneo (Enterprise, Growth or Community).
78-
79- For a Community Edition or Growth Edition, you can choose between this types of resources : ` product` , `category`, `attribute`,
80- ` attributeOption` , `attributeGroup`, `family`, `productMediaFile`, `locale`, `channel`, `currency`, `measureFamily`,
81- ` associationType` , `familyVariant`, `productModel`.
82-
83- For an Enterprise Edition, you will be able to use in addition to the resources present in the Community Edition :
84- ` publishedProduct` , `productModelDraft`, `productDraft`, `asset`, `assetCategory`, `assetTag`, `referenceEntityRecord`,
85- ` referenceEntityAttribute` , `referenceEntityAttributeOption`, `referenceEntity`.
64+ In the configuration of your extractor, you must specify the `type` of resource (see [available-resources](#available-resources))
65+ you will be working on and which method you want to use to retrieve your data.
8666
8767For each resource, the following 3 methods are available :
8868- `all` : retrieves all data from a table
@@ -110,7 +90,8 @@ this is called a lookup.
11090In the configuration of your lookup, you must specify the `type` of resource you will be working on
11191and which `method` you want to use to retrieve your data.
11292
113- The list of available resources is quite long and depends on the edition of your Akeneo (Enterprise, Growth or Community).
93+ You can retrieve the list of available resources [here](#available-resources).
94+
11495The options available are the same as for the [loader](#building-a-loader).
11596
11697The `merge` option allows you to add data to your dataset, in a sense merging your actual dataset with your new data.
@@ -171,19 +152,8 @@ akeneo:
171152
172153# ## Building a loader
173154
174- In the configuration of your loader, you must specify the `type` of resource you are going to write
175- and which `method` you want to use to insert your data.
176-
177- The list of available resources is quite long and dépends on your Akeneo edition (Enterprise, Growth or Community).
178-
179- For a Community Edition or Growth Edition, you can choose between these types of resources : ` product` , `category`, `attribute`,
180- ` attributeOption` , `attributeGroup`, `family`, `productMediaFile`, `locale`, `channel`, `currency`, `measureFamily`,
181- ` associationType` , `familyVariant`, `productModel`.
182-
183- For an Enterprise Edition, you will be able to use in addition to the resources present in the Community Edition :
184- ` publishedProduct` ,
185- ` productModelDraft` , `productDraft`, `asset`, `assetCategory`, `assetTag`, `referenceEntityRecord`, `referenceEntityAttribute`,
186- ` referenceEntityAttributeOption` , `referenceEntity`.
155+ In the configuration of your loader, you must specify the `type` of resource (see [available-resources](#available-resources))
156+ you are going to write and which `method` you want to use to insert your data.
187157
188158For each resource, the following 4 methods are available :
189159
@@ -192,6 +162,19 @@ For each resource, the following 4 methods are available :
192162- `upsertList` : will try to update a resources list, otherwise the resources will be created
193163- `delete` : delete a resource from the table
194164
165+ Depending on the resource and the method used, different options are available :
166+
167+ | Resource | Method | Option(s) required |
168+ |------------------------------------|------------|----------------------------------------------------|
169+ | **All resources** | upsert | code |
170+ | **All resources** | upsertList | _No parameters required_ |
171+ | **referenceEntityRecord** | upsert | reference_entity, code |
172+ | **referenceEntityRecord** | upsertList | reference_entity |
173+ | **referenceEntityAttributeOption** | upsert | reference_entity, reference_entity_attribute, code |
174+ | **referenceEntityAttributeOption** | upsertList | reference_entity, reference_entity_attribute |
175+ | **attributeOption** | upsert | attribute_code, code |
176+ | **attributeOption** | upsertList | attribute_code |
177+
195178` ` ` yaml
196179akeneo:
197180 loader:
@@ -248,3 +231,32 @@ akeneo:
248231 - 'Kiboko\C omponent\E xpressionLanguage\A keneo\A keneoFilterProvider'
249232 # ...
250233` ` `
234+
235+ # # Available resources
236+
237+ | Resources | Akeneo's Edition(s) |
238+ |------------------------------------|-------------------------------|
239+ | **product** | Community, Growth, Enterprise |
240+ | **category** | Community, Growth, Enterprise |
241+ | **attribute** | Community, Growth, Enterprise |
242+ | **attributeOption** | Community, Growth, Enterprise |
243+ | **attributeGroup** | Community, Growth, Enterprise |
244+ | **family** | Community, Growth, Enterprise |
245+ | **productMediaFile** | Community, Growth, Enterprise |
246+ | **locale** | Community, Growth, Enterprise |
247+ | **channel** | Community, Growth, Enterprise |
248+ | **currency** | Community, Growth, Enterprise |
249+ | **measureFamily** | Community, Growth, Enterprise |
250+ | **associationType** | Community, Growth, Enterprise |
251+ | **familyVariant** | Community, Growth, Enterprise |
252+ | **productModel** | Community, Growth, Enterprise |
253+ | **publishedProduct** | Enterprise |
254+ | **productModelDraft** | Enterprise |
255+ | **productDraft** | Enterprise |
256+ | **asset** | Enterprise |
257+ | **assetCategory** | Enterprise |
258+ | **assetTag** | Enterprise |
259+ | **referenceEntityRecord** | Enterprise |
260+ | **referenceEntityAttribute** | Enterprise |
261+ | **referenceEntityAttributeOption** | Enterprise |
262+ | **referenceEntity** | Enterprise |
0 commit comments