You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/guides/ecommerce-connection/step4-define-your-first-scope.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,10 @@ You have to choose these versions according to:
16
16
* The number of potential users owning this version.
17
17
* The lifetime of this version. It is useless to specifically develop a version compatible with a version of your eCommerce solution if this one won't exist anymore in a couple of months.
18
18
19
+
## Follow the guide to build an App!
20
+
21
+
We have a ["complete guide"](https://api.akeneo.com/apps/introduction.html) to understand how to build an App.
22
+
19
23
## What are Akeneo's recommendations to build the first iteration of an eCommerce App release?
20
24
21
25
**Our recommendation: always listen to your customer's needs first!**
Copy file name to clipboardExpand all lines: content/guides/erp-connection/step4-how-to-build-your-app.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,9 +23,9 @@ All you need to know to interact with our PIM through our API can be found in ou
23
23
24
24
**Our recommendation: always listen to your customer's needs first.**
25
25
26
-
We are aware that it is quite difficult to develop a 100% complete connector that fits all your customer's needs immediately.
26
+
We are aware that it is quite difficult to develop a 100% complete App that fits all your customer's needs immediately.
27
27
28
-
Once you are comfortable with your customer's needs, our recommendation is to follow the steps we describe and to iterate in order not to miss any important feature. Building an ERP connector is a complex task that requires a dedicated focus every step of the way.
28
+
Once you are comfortable with your customer's needs, our recommendation is to follow the steps we describe and to iterate in order not to miss any important feature. Building an ERP App is a complex task that requires a dedicated focus every step of the way.
Copy file name to clipboardExpand all lines: content/guides/print-connection/step2-understand-akeneo-pim.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,24 +16,24 @@ Then, in order to understand our different editions and their capabilities, you
16
16
17
17
Play with our PIM!
18
18
19
-
It is crucial to understand the PIM features and data model in order to create a great print connector.
19
+
It is crucial to understand the PIM features and data model in order to create a great print App.
20
20
21
21
The best way to become an expert at Akeneo PIM is to play with it!
22
22
Here, you can access our [Akeneo PIM Community Edition demo platform](http://demo.akeneo.com) (login/password: admin / admin).
23
23
24
24
:::warning
25
-
Please note that this Akeneo PIM CE demo instance is for exploratory purposes only and will only allow you to start getting familiar with Akeneo PIM. This instance is reset frequently and is therefore not intended to be used to build a connector.
25
+
Please note that this Akeneo PIM CE demo instance is for exploratory purposes only and will only allow you to start getting familiar with Akeneo PIM. This instance is reset frequently and is therefore not intended to be used to build a App.
26
26
:::
27
27
28
-
If you need an Akeneo PIM **Enterprise Edition** instance to start developing your connector, please [contact us](https://www.akeneo.com/contact/).
28
+
If you need an Akeneo PIM **Enterprise Edition** instance to start developing your App, please [contact us](https://www.akeneo.com/contact/).
29
29
30
30
## Acquire PIM knowledge
31
31
32
32
We advise you to take a look at our [Helpcenter](https://help.akeneo.com/pim/index.html) where you'll find a lot of documentation about all our features.
33
33
34
34
If you feel that a comprehensive training program would allow you to know everything about Akeneo PIM, we got you covered as well with our [training sessions](https://www.akeneo.com/training/). Don't hesitate to register!
35
35
36
-
In the context of building a print connector, here is a selection of PIM concepts you'll need to master before developing anything:
36
+
In the context of building a print App, here is a selection of PIM concepts you'll need to master before developing anything:
37
37
- The [product](/concepts/products.html#product),
38
38
- The [product model](/concepts/products.html#product-model),
39
39
- The [family](/concepts/catalog-structure.html#family),
Copy file name to clipboardExpand all lines: content/guides/print-connection/step3-reconcile-PIM-data-with-print-features.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,17 +7,17 @@ Congratulations! Now that you have a good overview of Akeneo PIM data, you need
7
7
Next step, for each piece of PIM data, you need to ask yourself the following questions:
8
8
9
9
1. What data does my print solution need from the PIM?
10
-
2. How will the configuration UI of my connector fulfill all of my end users' needs?
11
-
3. How flexible does my connector need to be to adapt to any catalog structure created with the PIM?
10
+
2. How will the configuration UI of my App fulfill all of my end users' needs?
11
+
3. How flexible does my App need to be to adapt to any catalog structure created with the PIM?
12
12
4. Documentation: What do I need to document? (Data processing, feature limits, possible settings...)
13
13
14
-
In order to help you develop your connector features, here are some useful features you can use.
14
+
In order to help you develop your App features, here are some useful features you can use.
15
15
16
16
## API connection configuration
17
17
18
18
**What is it?**
19
19
20
-
In order for your connector to communicate with Akeneo PIM, you need to provide a setting to invite Julia to enter her PIM API credentials.
20
+
In order for your App to communicate with Akeneo PIM, you need to provide a setting to invite Julia to enter her PIM API credentials.
21
21
22
22
**What do you need to implement?**
23
23
@@ -44,7 +44,7 @@ Here are some examples of filters we believe are relevant:
44
44
* Channel: Only import product data related to the selected channel (most of the time a "print" channel).
45
45
* Locale: Only import product data related to the selected locale.
46
46
* Completeness: A PIM product can be exported if it is complete in terms of data content, translation (localizable attribute), or information specific to the channels you are going to use (attribute with a value per channel).
47
-
* Enabled/Disabled status: Each PIM product has an enable/disable status. You can set your connector to only export products that are `enabled`.
47
+
* Enabled/Disabled status: Each PIM product has an enable/disable status. You can set your App to only export products that are `enabled`.
48
48
49
49
And sometimes, your customers may also need to export a PIM product to the print solution based on the following parameters:
50
50
@@ -55,11 +55,11 @@ And sometimes, your customers may also need to export a PIM product to the print
55
55
* A category tree or a subcategory tree
56
56
* ...
57
57
58
-
**Conclusion:** each customer project has its own requirements and it is important to offer enough flexibility in your connector settings to allow each customer to import only the product information they need according to their own criteria.
58
+
**Conclusion:** each customer project has its own requirements and it is important to offer enough flexibility in your App settings to allow each customer to import only the product information they need according to their own criteria.
59
59
60
60
**What do you need to implement?**
61
61
62
-
In the features of your connector configuration page, in order to be able to cover all of your customers' needs, you can choose to have one of the two filter systems. Either a “simple” one for straightforward use cases or an “advanced” one for the most specific requirements.
62
+
In the features of your App configuration page, in order to be able to cover all of your customers' needs, you can choose to have one of the two filter systems. Either a “simple” one for straightforward use cases or an “advanced” one for the most specific requirements.
63
63
64
64
### Products with variants
65
65
@@ -109,7 +109,7 @@ Apart from taking into consideration all these PIM modeling capabilities, you al
109
109
110
110
::: warning
111
111
The number of images that a catalog can contain can be quite large and we know that images dedicated to a print catalog can be very heavy (high definition).
112
-
Make sure you have all the mechanisms in your connector to optimize the performance to manage image binaries.
112
+
Make sure you have all the mechanisms in your App to optimize the performance to manage image binaries.
113
113
:::
114
114
115
115
@@ -172,7 +172,7 @@ The introduction of [our documentation on Reference Entities](https://help.akene
172
172
173
173
As you can see, Reference Entities can be used to enrich product information or to create dedicated pages with product relationships.
174
174
175
-
Keep in mind that Julia can use "Reference Entities" for a wide variety of needs, you might have to adapt accordingly.
175
+
Keep in mind that Julia can use "Reference Entities" for a wide variety of needs, you might have to adapt accordingly.
Copy file name to clipboardExpand all lines: content/guides/print-connection/step4-define-your-first-scope.md
+16-14Lines changed: 16 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,33 +1,35 @@
1
1
# Define the scope of your first version
2
2
3
-
## A "Connection-compliant" connector
4
-
5
-
The best way to interact with Julia's PIM is to develop a "[Connection-compliant](https://help.akeneo.com/pim/serenity/articles/what-is-a-connection.html)" connector (based on our API).
6
-
7
-
:::tips
8
-
Why?
9
-
Please don't hesitate to read our ["4 reasons why you should use our API"](https://api.akeneo.com/documentation/why-the-api.html#4-reasons-why-you-should-use-our-api) page.
10
-
:::
11
-
12
-
## Follow the guide!
3
+
## Find your PIM compatibility
13
4
14
5
As [mentioned before](step2-understand-akeneo-pim.html), there are [several editions](https://www.akeneo.com/compare-editions/) and several supported versions of Akeneo PIM.
15
6
16
-
Of course, the choice of the PIM version/edition depends on your business but we strongly encourage you to develop a connector that is fully compatible with our latest **SaaS edition**.
7
+
Of course, the choice of the PIM version/edition depends on your business but we strongly encourage you to develop an App that is fully compatible with our latest **SaaS edition**.
17
8
18
9
To know more about the different PIM versions, don't hesitate to consult our blog section on our [PIM release cycle](https://www.akeneo.com/blog/akeneo-introduces-a-simpler-product-release-cycle/).
19
10
20
11
You can also consult our [release notes](https://www.akeneo.com/release-notes/) and our ["new key features released" page](https://help.akeneo.com/pim/serenity/whats-new.html) to understand more about the latest Akeneo supported **versions** and their brand new features.
21
12
22
-
Well, now you can [start here](https://api.akeneo.com/getting-started/connect-the-pim-4x/welcome.html) to connect your print solution with our API! 🚀
13
+
## Follow the guide to build an App!
14
+
15
+
We have a ["complete guide"](https://api.akeneo.com/apps/introduction.html) to understand how to build an App.
16
+
17
+
## Use our API
18
+
19
+
:::tips
20
+
Why?
21
+
Please don't hesitate to read our ["4 reasons why you should use our API"](https://api.akeneo.com/documentation/why-the-api.html#4-reasons-why-you-should-use-our-api) page.
22
+
:::
23
+
24
+
Well, now you can [start here](https://api.akeneo.com/documentation/introduction.html) to connect your print solution with our API! 🚀
23
25
24
26
## Step by step
25
27
26
28
**Our recommendation: always listen to your customer's needs first!**
27
29
28
-
We are aware that it is difficult and expensive in terms of investment to achieve a 100% complete print connector that is flexible enough to adapt to any customer project.
30
+
We are aware that it is difficult and expensive in terms of investment to achieve a 100% complete print App that is flexible enough to adapt to any customer project.
29
31
30
-
Furthermore, to build such a complex connector as a print connector in a single iteration would undoubtedly be too complex to design from scratch.
32
+
Furthermore, to build such a complex App as a print App in a single iteration would undoubtedly be too complex to design from scratch.
Copy file name to clipboardExpand all lines: content/guides/syndication-connection/step3-define-your-first-scope.md
+4-11Lines changed: 4 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,6 @@
1
1
# Define the scope of your first version
2
2
3
-
## A "Connection-compliant" App
4
-
5
-
The best way to interact with Julia's PIM is to develop a "[Connection-compliant](https://help.akeneo.com/pim/serenity/articles/what-is-a-connection.html)" App (based on our API).
6
-
7
-
:::tips
8
-
Why?
9
-
Please don't hesitate to read our ["4 reasons why you should use our API"](https://api.akeneo.com/documentation/why-the-api.html#4-reasons-why-you-should-use-our-api) page.
10
-
:::
11
-
12
-
## Follow the guide!
3
+
## Find your PIM compatibility
13
4
14
5
As [mentioned before](step2-understand-akeneo-pim.html), there are [several editions](https://www.akeneo.com/compare-editions/) and several supported version of Akeneo PIM.
15
6
@@ -19,7 +10,9 @@ To know more about the different PIM versions, don't hesitate to consult our blo
19
10
20
11
You can also consult our [release notes](https://www.akeneo.com/release-notes/) and our ["new key features released" page](https://help.akeneo.com/pim/serenity/whats-new.html) to understand more about the latest Akeneo supported **versions** and their brand new features.
21
12
22
-
Well, now you can [start here](https://api.akeneo.com/getting-started/connect-the-pim-4x/welcome.html) to connect your syndication solution with our API! 🚀
13
+
## Follow the guide to build an App!
14
+
15
+
We have a ["complete guide"](https://api.akeneo.com/apps/introduction.html) to understand how to build an App.
0 commit comments