Skip to content

Commit a9bc4d5

Browse files
clemzarchclemzarch
authored
Merge pull request #51 from php-etl/feature/update-akeneo-plugin
Updated Akeneo Plugin's documentation
2 parents e7e309a + 2fb8e2b commit a9bc4d5

File tree

1 file changed

+62
-39
lines changed

1 file changed

+62
-39
lines changed

‎content/connectivity/akeneo/plugin.en.md‎

Lines changed: 62 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -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,36 +59,29 @@ To retrieve these identifiers, you need to add a
5959
6060
Warning: 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

8767
For each resource, the following 3 methods are available :
8868
- `all` : retrieves all data from a table
8969
- `get` : retrieve a row from a table
9070
- `listPerPage` : retrieves a set number of data from a table
9171

72+
Depending on the resource and the method used, different options are available in the YAML configuration :
73+
74+
| Resource | Method | Option(s) required |
75+
|--------------------------------------|-------------|-------------------------------|
76+
| **All resources** | all | _No options required_ |
77+
| **All resources** | get | identifier |
78+
| **All resources** | listPerPage | _No options required_ |
79+
| **attributeOption** | all | attribute_code |
80+
| **attributeOption** | get | attribute_code, code |
81+
| **assetManager** | all | asset_family_code |
82+
| **assetManager** | get | asset_family_code, asset_code |
83+
| **productMediaFile, assetMediaFile** | get | file |
84+
9285
```yaml
9386
akeneo:
9487
extractor:
@@ -110,7 +103,8 @@ this is called a lookup.
110103
In the configuration of your lookup, you must specify the `type` of resource you will be working on
111104
and which `method` you want to use to retrieve your data.
112105

113-
The list of available resources is quite long and depends on the edition of your Akeneo (Enterprise, Growth or Community).
106+
You can retrieve the list of available resources [here](#available-resources).
107+
114108
The options available are the same as for the [loader](#building-a-loader).
115109

116110
The `merge` option allows you to add data to your dataset, in a sense merging your actual dataset with your new data.
@@ -171,19 +165,8 @@ akeneo:
171165

172166
### Building a loader
173167

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`.
168+
In the configuration of your loader, you must specify the `type` of resource (see [available-resources](#available-resources))
169+
you are going to write and which `method` you want to use to insert your data.
187170

188171
For each resource, the following 4 methods are available :
189172

@@ -192,13 +175,24 @@ For each resource, the following 4 methods are available :
192175
- `upsertList`: will try to update a resources list, otherwise the resources will be created
193176
- `delete`: delete a resource from the table
194177

178+
Depending on the resource and the method used, different options are available in the YAML configuration :
179+
180+
| Resource | Method | Option(s) required |
181+
|------------------------------------|------------|----------------------------------------------------|
182+
| **All resources** | upsert | code |
183+
| **All resources** | upsertList | _No options required_ |
184+
| **referenceEntityRecord** | upsert | reference_entity, code |
185+
| **referenceEntityRecord** | upsertList | reference_entity |
186+
| **referenceEntityAttributeOption** | upsert | reference_entity, reference_entity_attribute, code |
187+
| **referenceEntityAttributeOption** | upsertList | reference_entity, reference_entity_attribute |
188+
| **attributeOption** | upsert | attribute_code, code |
189+
| **attributeOption** | upsertList | attribute_code |
190+
195191
```yaml
196192
akeneo:
197193
loader:
198194
type: products
199195
method: create
200-
logger:
201-
type: stderr
202196
client:
203197
api_url: 'http://demo.akeneo.com/'
204198
client_id: '414yc7d9mnk044ko4wswgw80o8ssw80gssos488kk8ogss40ko'
@@ -248,3 +242,32 @@ akeneo:
248242
- 'Kiboko\Component\ExpressionLanguage\Akeneo\AkeneoFilterProvider'
249243
# ...
250244
```
245+
246+
## Available resources
247+
248+
| Resources | Akeneo's Edition(s) |
249+
|------------------------------------|-------------------------------|
250+
| **product** | Community, Growth, Enterprise |
251+
| **category** | Community, Growth, Enterprise |
252+
| **attribute** | Community, Growth, Enterprise |
253+
| **attributeOption** | Community, Growth, Enterprise |
254+
| **attributeGroup** | Community, Growth, Enterprise |
255+
| **family** | Community, Growth, Enterprise |
256+
| **productMediaFile** | Community, Growth, Enterprise |
257+
| **locale** | Community, Growth, Enterprise |
258+
| **channel** | Community, Growth, Enterprise |
259+
| **currency** | Community, Growth, Enterprise |
260+
| **measureFamily** | Community, Growth, Enterprise |
261+
| **associationType** | Community, Growth, Enterprise |
262+
| **familyVariant** | Community, Growth, Enterprise |
263+
| **productModel** | Community, Growth, Enterprise |
264+
| **publishedProduct** | Enterprise |
265+
| **productModelDraft** | Enterprise |
266+
| **productDraft** | Enterprise |
267+
| **asset** | Enterprise |
268+
| **assetCategory** | Enterprise |
269+
| **assetTag** | Enterprise |
270+
| **referenceEntityRecord** | Enterprise |
271+
| **referenceEntityAttribute** | Enterprise |
272+
| **referenceEntityAttributeOption** | Enterprise |
273+
| **referenceEntity** | Enterprise |

0 commit comments

Comments
 (0)