Skip to content

Commit 3f3446a

Browse files
committed
add productSelection ext doc + reorganize position & faq
1 parent ca1d91f commit 3f3446a

15 files changed

+113
-81
lines changed

content/extensions/faq.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## FAQ
2+
### Who is responsible for UI extensions?
3+
Akeneo is responsible for the UI extensions framework itself, including the APIs and administrative interface. We provide support for these components. Your organization or your integrator is responsible for any custom code, iframes, or other custom development built within the UI extensions. Support for this custom code falls to your organization or integrator, not Akeneo.
4+
5+
### How can I add a new UI extension to my PIM?
6+
Adding a new extension to your organization is easy! Just follow the steps in [this guide](https://api.akeneo.com/extensions/ui-extensions.html#getting-started).
7+
8+
### The UI extensions entry isn't showing up in my PIM. Could you help me understand why?
9+
If you don't see the UI extensions entry in your PIM, it's likely due to permission settings. [This guide](https://api.akeneo.com/extensions/ui-extensions.html#authorization) will help you check and activate the necessary permissions.
10+
11+
### I'd like to see my extension in a position that isn't currently available. What can I do?
12+
Currently, UI extension placements are limited to those defined by Akeneo. However, we highly value your feedback! Please contact your Customer Success Manager or our Support team to share your specific placement needs. This will help us understand your use case and consider it for future development.

content/extensions/positions.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Positions
2+
3+
**Extension Positions**
4+
5+
Extension position determines where your extension appears within the Akeneo PIM interface. You can select from a variety of available positions, which vary depending on the specific extension type.
6+
7+
**Key Concepts:**
8+
9+
* **Position Options:** Each extension type offers a set of predefined positions. These positions control the location of your extension's interface elements.
10+
* **Contextual Relevance:** Position options are designed to align with the functionality of each extension type, ensuring a seamless user experience.
11+
12+
**Best Practices:**
13+
14+
* Choose a position that aligns with the extension's intended functionality and user workflow.
15+
* Review the available position options for each extension type to ensure optimal integration.
16+
* Consider the impact of the position on the overall user experience within the PIM.
17+
18+
19+
## Available positions for UI extensions
20+
21+
22+
| Positions | Action | Iframe | Link |
23+
|------------------------------|--------|--------|-------|
24+
| pim.product.header | ✔️ || ✔️ |
25+
| pim.product-model.header | ✔️ || ✔️ |
26+
| pim.sub-product-model.header | ✔️ || ✔️ |
27+
| pim.product.tab || ✔️ ||
28+
| pim.product-model.tab || ✔️ ||
29+
| pim.sub-product-model.tab || ✔️ ||
30+
| pim.category.tab || ✔️ ||
31+
| pim.product-grid.action-bar | ✔️ | ✔️ ||
32+
| pim.activity.navigation.tab || ✔️ ||
33+
34+
35+
### Positions list
36+
37+
#### pim.product.header
38+
[![pim-product-header.png](../img/extensions/ui-extensions/positions/pim-product-header.png)](../img/extensions/ui-extensions/positions/pim-product-header.png)
39+
40+
This position refers to the header of a simple product or a variant edit page.
41+
42+
#### pim.product-model.header
43+
[![pim-product-model-header.png](../img/extensions/ui-extensions/positions/pim-product-model-header.png)](../img/extensions/ui-extensions/positions/pim-product-model-header.png)
44+
45+
This position refers to the header of a root model edit page.
46+
47+
#### pim.sub-product-model.header
48+
[![pim-sub-product-model-header.png](../img/extensions/ui-extensions/positions/pim-sub-product-model-header.png)](../img/extensions/ui-extensions/positions/pim-sub-product-model-header.png)
49+
50+
This position refers to the header of a sub product model edit page.
51+
52+
#### pim.product.tab
53+
[![pim-product-tab.png](../img/extensions/ui-extensions/positions/pim-product-tab.png)](../img/extensions/ui-extensions/positions/pim-product-tab.png)
54+
55+
This position refers to the tab of a simple product or a variant edit page.
56+
57+
#### pim.product-model.tab
58+
[![pim-product-model-tab.png](../img/extensions/ui-extensions/positions/pim-product-model-tab.png)](../img/extensions/ui-extensions/positions/pim-product-model-tab.png)
59+
60+
This position refers to the tab of a root model edit page.
61+
62+
#### pim.sub-product-model.tab
63+
[![pim-product-model-tab.png](../img/extensions/ui-extensions/positions/pim-product-model-tab.png)](../img/extensions/ui-extensions/positions/pim-product-model-tab.png)
64+
65+
This position refers to the tab of a sub product model edit page.
66+
67+
#### pim.category.tab
68+
[![pim-category-tab.png](../img/extensions/ui-extensions/positions/pim-category-tab.png)](../img/extensions/ui-extensions/positions/pim-category-tab.png)
69+
70+
This position refers to the tab of a category edit page.
71+
72+
#### pim.product-grid.action-bar
73+
[![pim-product-grid-action-bar.png](../img/extensions/ui-extensions/positions/pim-product-grid-action-bar.png)](../img/extensions/ui-extensions/positions/pim-product-grid-action-bar.png)
74+
75+
This position refers to the action bar of the product grid. It is used to add actions that can be applied to multiple products at once.
76+
77+
::: warning
78+
For the moment, you can't use UI extensions with more than **500** selected products & product models.
79+
:::
80+
81+
#### pim.activity.navigation.tab
82+
[![pim-activity-navigation-tab.png](../img/extensions/ui-extensions/positions/pim-activity-navigation-tab.png)](../img/extensions/ui-extensions/positions/pim-activity-navigation-tab.png)
83+
84+
This position refers to the tab of the activity navigation. It is used to add custom tabs in the activity navigation of the PIM.
85+
86+
::: panel-link FAQ [Next](/extensions/faq.html)
87+
:::

content/extensions/ui-extensions.md

Lines changed: 7 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -494,75 +494,6 @@ Examples :
494494
}
495495
```
496496

497-
## Positions
498-
499-
**Extension Positions**
500-
501-
Extension position determines where your extension appears within the Akeneo PIM interface. You can select from a variety of available positions, which vary depending on the specific extension type.
502-
503-
**Key Concepts:**
504-
505-
* **Position Options:** Each extension type offers a set of predefined positions. These positions control the location of your extension's interface elements.
506-
* **Contextual Relevance:** Position options are designed to align with the functionality of each extension type, ensuring a seamless user experience.
507-
508-
**Best Practices:**
509-
510-
* Choose a position that aligns with the extension's intended functionality and user workflow.
511-
* Review the available position options for each extension type to ensure optimal integration.
512-
* Consider the impact of the position on the overall user experience within the PIM.
513-
514-
515-
### Positions list
516-
517-
![PIM Header.png](../img/extensions/ui-extensions/pim-header-with-extension.png)
518-
#### pim.product.header
519-
This position refers to the header of a simple product or a variant edit page.
520-
521-
#### pim.product-model.header
522-
This position refers to the header of a root model edit page.
523-
524-
#### pim.sub-product-model.header
525-
This position refers to the header of a sub model edit page.
526-
527-
![PIM Tab.png](../img/extensions/ui-extensions/pim-product-with-tab-extension.png)
528-
#### pim.product.tab
529-
This position refers to the left panel of a simple product or a variant edit page.
530-
531-
#### pim.product-model.tab
532-
This position refers to the left panel of a root model edit page.
533-
534-
#### pim.sub-product-model.tab
535-
This position refers to the left panel of a sub model edit page.
536-
537-
#### pim.category.tab
538-
This position refers to the horizontal list of tabs on a category edit page.
539-
540-
![PIM Product Grid.png](../img/extensions/ui-extensions/pim-product-grid-with-bulk-trigger-action.png)
541-
#### pim.product-grid.action-bar
542-
This position refers to the list of commands availables after selecting some products on the product grid.
543-
544-
::: warning
545-
For the moment, you can't use UI extensions with more than **500** selected products & product models.
546-
:::
547-
548-
#### pim.activity.navigation.tab
549-
This position refers to the activity PIM menu, adding UI extensions in this position will create a new section in the activity sub-navigation.
550-
551-
### Available types by position
552-
Each position supports a specific subset of available types. The table below outlines the compatible types for all positions.
553-
554-
| Positions | Action | Iframe | Link |
555-
|------------------------------|--------|--------|-------|
556-
| pim.product.header | ✔️ || ✔️ |
557-
| pim.product-model.header | ✔️ || ✔️ |
558-
| pim.sub-product-model.header | ✔️ || ✔️ |
559-
| pim.product.tab || ✔️ ||
560-
| pim.product-model.tab || ✔️ ||
561-
| pim.sub-product-model.tab || ✔️ ||
562-
| pim.category.tab || ✔️ ||
563-
| pim.product-grid.action-bar | ✔️ | ✔️ ||
564-
| pim.activity.navigation.tab || ✔️ ||
565-
566497
## Administration of UI extensions
567498
For a functional overview of the administration panel and permissions, see our [Help Center](https://help.akeneo.com/extensions/ui-extentions).
568499

@@ -586,21 +517,16 @@ To manage one or more UI extensions from the list, you just have to select them
586517

587518
You can filter the user groups allowed to see and execute an UI extension by using the permissions tab on the UI extensions creation/edition form.
588519

520+
### Filter UI extension by product selection
521+
You can filter the products that can be selected by an UI extension by using the product selection tab on the UI extensions creation/edition form.
522+
523+
[![ui-extension-product-selection.png](../img/extensions/ui-extensions/ui-extension-product-selection.png)](../img/extensions/ui-extensions/ui-extension-product-selection.png)
524+
589525
## API reference
590526
Several choices are offered to deep dive into our API, to discover all the endpoints, and their request/response schema:
591527

592528
- You can <a href="https://api.akeneo.com/api-reference-index.html#UIExtensions" target="_blank">consult this static documentation</a>
593529
- Discover it thanks to <a href="https://api.akeneo.com/files/Akeneo%20PIM%20API.postman_collection.json" target="_blank">the postman collection</a> (see the [Postman section](https://api.akeneo.com/extensions/ui-extensions.html#using-postman))
594530

595-
## FAQ
596-
### Who is responsible for UI extensions?
597-
Akeneo is responsible for the UI extensions framework itself, including the APIs and administrative interface. We provide support for these components. Your organization or your integrator is responsible for any custom code, iframes, or other custom development built within the UI extensions. Support for this custom code falls to your organization or integrator, not Akeneo.
598-
599-
### How can I add a new UI extension to my PIM?
600-
Adding a new extension to your organization is easy! Just follow the steps in [this guide](https://api.akeneo.com/extensions/ui-extensions.html#getting-started).
601-
602-
### The UI extensions entry isn't showing up in my PIM. Could you help me understand why?
603-
If you don't see the UI extensions entry in your PIM, it's likely due to permission settings. [This guide](https://api.akeneo.com/extensions/ui-extensions.html#authorization) will help you check and activate the necessary permissions.
604-
605-
### I'd like to see my extension in a position that isn't currently available. What can I do?
606-
Currently, UI extension placements are limited to those defined by Akeneo. However, we highly value your feedback! Please contact your Customer Success Manager or our Support team to share your specific placement needs. This will help us understand your use case and consider it for future development.
531+
::: panel-link UI extensions available positions [Next](/extensions/positions.html)
532+
:::
147 KB
Loading
215 KB
Loading
363 KB
Loading
366 KB
Loading
247 KB
Loading
247 KB
Loading
281 KB
Loading

0 commit comments

Comments
 (0)