FAQ
We are trying to make your experience as smooth as possible. However, there are still some issues that you may face while working with UI Extensibility.
AIO CLI does not behave as described in the documentation
Most probably you have a dated version of AIO CLI.
Solution
Ensure your CLI and all plugins are up to date.
Check the installed version of AIO CLI:
Copied to your clipboardaio -v
Compare it with the current published version:
Copied to your clipboardnpm show @adobe/aio-cli version
If your CLI is outdated, update it by running:
Copied to your clipboardnpm install -g @adobe/aio-cli
After that, you can simply run aio update to ensure all plugins are updated.
Find more details on Prepare your local environment.
My UI Extension is not loaded
Most probably you have issues with a SSL certificate. Adobe App Builder generates valid certificates for the production environment but during local development and on staging you may need manually accept the certificate.
Solution
- Open a UI Extension endpoint in your browser (e.g.
https://localhost:9080during local development). - Manually accept the certificate. For example for Google Chrome type
thisisunsafeor click onAdvancedlink and then onProceed to localhost (unsafe).
Login via aio login does not work or aio app commands show the wrong IMS organization or projects
This sometimes may happen to users who work with multiple Adobe Services and are members of multiple IMS organizations.
Solution
- Go to https://account.adobe.com and click "Sign Out".
- Open the terminal and type
aio logout. - Then try to run
aio loginagain.
What UI can be extended
You may find a list of Adobe Services that implement UI Extensibility under Extensible Services in this documentation. For each service, we provide documentation of extension points and step-by-step guides.
What is an extension point
The extension point is functionality in Adobe Service UI that allows the execution of 3rd party code. Extension point usually includes:
- Requirements for extension implementation (what API extension should implement).
- Promise to invoke extension code under defined conditions.
- API that allows the extension to access Adobe Service UI functionality.
What software tools should I have installed to get started with developing
You will need NodeJS and AIO CLI. All other tools are optional and you may replace them with your preferred one.
For more information see Set Up Local Environment.
Do I need to deploy any services locally
No! The only thing that you will run locally is your own extension. You will be able to add your extension running locally or in Adobe cloud to the production Adobe Services and see how it behaves before sharing it with anybody else.
Can I test my extension before deploying it to the cloud
Yes! It is possible to run the extension locally and embed it into production Adobe Service to check if it works as expected. For more information see Troubleshooting.
Should I write all extension code by myself
No! We provide a template that allows you to generate most of the code required to make UI Extension out of the App Builder application. You will need only implement your business logic.
But you still can write everything from scratch if you wish to.
For more information see Code Generation.
What is the simplest way to start
Our code generator supplies a demo project that you may generate and deploy for your IMS organization. Explore it and change to learn what is possible with UI Extensibility.
How I can ask for additional extension point
We are open to genuine feedback and would gladly expand UI Extensibility capability to solve your needs.
Please get in touch with us through email at uix@adobe.com for feature requests, use-case validation, assistance with extension implementation, or bug reports.
