Skip to content

Commit b33b37d

Browse files
committed
Add troubleshooting tip and feedback
1 parent a069d64 commit b33b37d

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

src/pages/admin-ui-sdk/app-registration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn about registering your app in the App Registry
55

66
# App registration
77

8-
When the application on App Builder is ready to be published, a registration to the Adobe Registry is required to add a menu in the Admin Panel.
8+
Your app must be correctly configured with Adobe App Registry to use the Admin UI SDK to create a custom UI in Commerce. You must perform the following steps before submitting your app to be published.
99

1010
## Add or update the `install.yml` file
1111

src/pages/admin-ui-sdk/troubleshooting.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,23 @@ It's common to have the App menu missing from the Commerce Admin Panel menu when
1313

1414
* **The app is not correctly published in App Builder.** Go to the App project in the developer console and check that the Production workspace has a status of Published. If this is not the case, request an approval to publish and test again once the application in Approved.
1515

16-
*. **The latest changes are not correctly deployed and published.** Make sure to deploy the latest changes using `aio app deploy` in the correct `org/project/workspace`.
16+
* **The latest changes are not correctly deployed and published.** Make sure to deploy the latest changes using `aio app deploy` in the correct `org/project/workspace`.
17+
18+
* **The `Magento_AdminAdobeIms`module has not been enabled.** Run the following command from the Adobe Commerce command line to check the status of this module.
19+
20+
`bin/magento module:status Magento_AdminAdobeIms`
21+
22+
If the response indicates the module has not been enabled, run the following command:
23+
24+
`bin/magento module:enable Magento_AdminAdobeIms`
1725

1826
* **The registration of the menu is not correct.** Make sure that you defined the correct `menu` method with a `getItems` function that returns an array of the menus to register.
1927

2028
* To make sure your registration is correctly deployed, navigate in your browser to `<appURL>/index.html`. You can find your application URL in your project workspace in the Adobe developer console.
2129

2230
* Check the elements in your browser developer tools and look for the script `src` in the body. It usually has the format `index.<random>.js`.
2331

24-
Replace in the URL the `index.html` with this javascript to access its content. Search for `getItems` for example and make sure the registration defined in your app is the same one you see deployed.
32+
Replace in the URL the `index.html` with this javascript to access its content. Search for `getItems` for example and make sure the registration defined in your app is the same one you see deployed.
2533

2634
## App page is not displayed when accessing the menu
2735

@@ -32,7 +40,7 @@ An app page is not displayed when the `extensionId` specified doesn't match with
3240
* `extension:getId` method that returns a string with the `extensionId`.
3341
* `page:getTitle` method that returns a string with the page title.
3442

35-
*. Check the `extensionId` is the same used in the registration to identify correctly the application with a unique name.
43+
* Check the `extensionId` is the same used in the registration to identify correctly the application with a unique name.
3644

3745
## Timout error
3846

0 commit comments

Comments
 (0)