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
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/getting-started.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/getting-started.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.
You may want to create UI extensions that are only available to certain user groups or for specific products. This can be achieved by filtering UI extensions based on user groups and product selection.
4
+
5
+
### Filter UI extension by user groups
6
+
7
+
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.
Copy file name to clipboardExpand all lines: content/extensions/getting-started.md
+4-88Lines changed: 4 additions & 88 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,9 @@
1
-
# UI extensions
1
+
# Getting Started
2
2
The UI extension feature enables you to extend your PIM by integrating custom views and actions from external systems. This framework provides the flexibility to modify and adapt your PIM experience to meet specific business requirements.
3
3
By leveraging this functionality, you can integrate custom solutions while maintaining the reliability and ease the use of our SaaS platform, offering a balance between flexibility and stability.
4
4
5
5
The extension framework is designed to help you customize the standard behavior of your PIM system by integrating with externally hosted solutions. This documentation provides an overview of the framework's capabilities and the various customization options available, enabling you to extend and tailor your PIM to meet your specific business needs.
6
6
7
-
## Getting Started
8
7
This guide provides a step-by-step walkthrough for setting up and managing UI extensions.
9
8
10
9
### Prerequisites
@@ -494,75 +493,6 @@ Examples :
494
493
}
495
494
```
496
495
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.
For a functional overview of the administration panel and permissions, see our [Help Center](https://help.akeneo.com/extensions/ui-extentions).
568
498
@@ -582,25 +512,11 @@ On the new page, you can see all extensions registered in your PIM.
582
512
583
513
To manage one or more UI extensions from the list, you just have to select them thanks to the checkboxes present on the left of each line, and then use one of the two commands available at the bottom of the screen.
584
514
585
-
### Filter UI extension by user groups
586
-
587
-
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.
588
-
589
515
## API reference
590
516
Several choices are offered to deep dive into our API, to discover all the endpoints, and their request/response schema:
591
517
592
518
- You can <ahref="https://api.akeneo.com/api-reference-index.html#UIExtensions"target="_blank">consult this static documentation</a>
593
-
- Discover it thanks to <ahref="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))
594
-
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.
519
+
- Discover it thanks to <ahref="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/getting-started.html#using-postman))
598
520
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.
521
+
::: panel-link UI extensions available positions [Next](/extensions/positions.html)
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.
4
+
5
+
**Key Concepts:**
6
+
7
+
***Position Options:** Each extension type offers a set of predefined positions. These positions control the location of your extension's interface elements.
8
+
***Contextual Relevance:** Position options are designed to align with the functionality of each extension type, ensuring a seamless user experience.
9
+
10
+
**Best Practices:**
11
+
12
+
* Choose a position that aligns with the extension's intended functionality and user workflow.
13
+
* Review the available position options for each extension type to ensure optimal integration.
14
+
* Consider the impact of the position on the overall user experience within the PIM.
0 commit comments