Skip to content

Commit 77ccbc6

Browse files
committed
Merge branch 'admin-ui-sdk-2.1' of https://github.com/asalloum5/commerce-extensibility into pr/301
2 parents 13dae46 + 252cd38 commit 77ccbc6

File tree

5 files changed

+29
-47
lines changed

5 files changed

+29
-47
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ This file now declares extensions and redirects to an `ext.config.yaml` file.
141141

142142
## Add or update the `ext.config.yaml`
143143

144-
Add or update the `ext.config.yaml` under `src/commerce-backend-ui-1`. This directory will contain the `actions` and `web-src` code.
144+
Add or update the `src/commerce-backend-ui-1/ext.config.yaml` file. The `commerce-backend-ui-1` directory contains the `actions` and `web-src` code.
145145

146146
Your extension configuration file should look like this:
147147

@@ -168,8 +168,8 @@ runtimeManifest:
168168
final: true
169169
```
170170

171-
The package should be called `admin-ui-sdk` and the action called `registration`. The function can point to any route that returns the registration in the correct expected format.
171+
The package name must be `admin-ui-sdk`, and the action must be `registration`. The `function` can point to any route that returns the registration in the correct expected format.
172172

173-
It is recommended to secure the registration runtime action by setting `require-adobe-auth` to `true`. The Adobe Commerce instance will correctly load registrations securely based on the IMS credentials provided.
173+
We recommend securing the registration runtime action by setting `require-adobe-auth` to `true`. The Adobe Commerce instance will correctly load registrations securely based on the provided IMS credentials.
174174

175175
Complete this file with the actions from your app.

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

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,23 @@ Navigate to **Stores** > Settings > **Configuration** > **Adobe Services** > **A
1414

1515
## General configuration
1616

17-
The general configuration section allows to enable the Admin UI SDK and refresh registrations when changes are made.
17+
The **General configuration** section enables the Admin UI SDK and refreshes registrations when changes are made.
1818

1919
![Admin UI SDK general configuration](../_images/admin-ui-sdk-general-config.png)
2020

21-
The Admin UI SDK is disabled by default. To enable it, set the `Enable Admin UI SDK` field to `Yes`. To disable it, change this field to `No`.
21+
The Admin UI SDK is disabled by default. To enable it, set the **Enable Admin UI SDK** field to **Yes**.
2222

23-
The `Refresh registrations` button reloads all registrations from the registries. It is typically used when changes are made to the registration on the app builder application side or when a new app is added and published, to reflect these changes in the Admin Panel.
23+
The `Refresh registrations` button reloads all registrations from the registries. It is typically used when changes are made to the registration on the app builder application side or when a new app is added and published, to reflect these changes in the Admin.
2424

2525
## Database logging configuration
2626

27-
The database logging configuration enables saving logs generated by the Admin UI SDK in the database with a specified retention period. These logs can be accessed directly in the Admin Panel by navigating to **System** > Admin UI SDK > **Admin UI SDK Logs** screen.
27+
The **Database logging configuration** section allows you to save Admin UI SDK log entries for the specified retention period.
2828

2929
![Admin UI SDK database logging configuration](../_images/admin-ui-sdk-db-log-config.png)
3030

31-
To save logs, set the `Enable Logs` field to `Yes`. By default, this field is set to `No`.
31+
To save logs, set the **Enable Logs** field to **Yes**. By default, this field is set to **No**.
3232

33-
Set the minimum log level to save. Any logs at this level or higher will be stored. By default, the minimum level is set to `Warning`.
33+
Set the minimum log level to save. Any logs at this level or higher will be stored. By default, the minimum level is set to **Warning**.
3434

3535
Set the retention period for logs to be cleaned from the database. This field specifies the number of days. By default, the retention period is set to 1 day.
3636

@@ -42,15 +42,9 @@ The staging testing option provides a sandbox environment to test your applicati
4242

4343
1. Select **Yes** from the **Enable testing** menu.
4444

45-
1. Set the **Testing mode** to `Staging`.
45+
1. Set the **Testing mode** to **Staging**.
4646

47-
1. Select all app status to load in the Admin Panel.
48-
49-
### Prerequisites
50-
51-
* Adobe Commerce on cloud infrastructure or on premises: 2.4.5+
52-
* PHP 8.1+
53-
* [Adobe Identity Management Service (IMS) for Adobe Commerce](https://experienceleague.adobe.com/docs/commerce-admin/start/admin/ims/adobe-ims-integration-overview.html)
47+
1. Select all app statuses to load.
5448

5549
## Local testing
5650

@@ -72,10 +66,6 @@ When you enable the local service, all calls are automatically redirected to the
7266

7367
1. Save your configuration.
7468

75-
### Prerequisites
76-
77-
- An Adobe Commerce instance installed on the local machine.
78-
7969
### Configuration
8070

8171
You can download a sample app from the [Adobe Commerce Samples repository](https://github.com/adobe/adobe-commerce-samples/tree/main/admin-ui-sdk/menu/custom-menu) to gain insight on how the Admin SDK injects menus and pages into the Admin.

src/pages/admin-ui-sdk/extension-points/customer/grid-columns.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@ It leverages API Mesh [JSON Schemas handler](https://developer.adobe.com/graphql
7777

7878
### Sample runtime action to retrieve data
7979

80-
This sample `get-customers` runtime action is referenced in the mesh configuration file. It defines the path to the runtime action to retrieve the data of custom columns.
80+
The `get-customers` sample runtime action is referenced in the mesh configuration file. It defines the path to the runtime action that retrieves the data of custom columns.
8181

82-
It is important to add the `ids={args.ids}` as part of the query and handle this filtering in the runtime action. This will allow Admin UI SDK to load only necessary data needed to display in the grid columns in the Admin Panel of the Adobe Commerce instance.
82+
It is important to add the `ids={args.ids}` as part of the query and handle this filtering in the runtime action. This allows Admin UI SDK to load only the necessary data needed to display in the grid columns in the Admin.
8383

8484
```javascript
8585
export async function main(props) {
@@ -125,7 +125,7 @@ export async function main(props) {
125125

126126
### Sample schema file
127127

128-
This sample `schema.json` file is referenced in the mesh configuration file. It defines the response of the external `customerGridColumns` query that fetches column data.
128+
The `schema.json` sample file, which is also referenced in the mesh configuration file, defines the response of the external `customerGridColumns` query that fetches column data.
129129

130130
```json
131131
{
@@ -155,9 +155,9 @@ This sample `schema.json` file is referenced in the mesh configuration file. It
155155
}
156156
```
157157

158-
### Create or Update your mesh
158+
### Create or update your mesh
159159

160-
Make sure to create or update your mesh, and to keep the mesh id provided.
160+
Use one of the following commands to create or update your mesh. Be sure to store the mesh ID provided.
161161

162162
```bash
163163
aio api-mesh:create mesh.json
@@ -169,17 +169,13 @@ aio api-mesh:update mesh.json
169169

170170
### Customer data matching
171171

172-
#### Id matching
172+
The Admin UI SDK expects the customer ID in Adobe Commerce to correctly match the customer to the data and fill the correct cell.
173173

174-
The Admin UI SDK expects the customer id in Adobe Commerce to correctly match the customer to the data and fill the correct cell.
174+
A default value can be provided to be added to unmatched IDs, or in case data doesn't match, the expected type of the column. If a value is not provided, the cell is left empty.
175175

176-
#### Default value
176+
In case of error, check the Adobe Commerce logs.
177177

178-
A default value can be provided to be added to unmatched ids, or in case data doesn't match the expected type of the column. If not provided, the cell is left empty.
179-
180-
In case of error, more info can be found in the Adobe Commerce logs.
181-
182-
##### Example of default value
178+
The following example provides a default value.
183179

184180
```javascript
185181
"*": {

src/pages/admin-ui-sdk/extension-points/order/grid-columns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ It leverages API Mesh [JSON Schemas handler](https://developer.adobe.com/graphql
8585

8686
This sample `get-orders` runtime action is referenced in the mesh configuration file. It defines the path to the runtime action to retrieve the data of custom columns.
8787

88-
It is important to add the `ids={args.ids}` as part of the query and handle this filtering in the runtime action. This will allow Admin UI SDK to load only necessary data needed to display in the grid columns in the Admin Panel of the Adobe Commerce instance.
88+
It is important to add `ids={args.ids}` to the query and handle this filtering in the runtime action. As a result, the Admin UI SDK loads only the data necessary to display in the grid columns of the Admin.
8989

9090
```javascript
9191
export async function main(props) {

src/pages/admin-ui-sdk/extension-points/product/grid-columns.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ product: {
3636

3737
### Sample runtime action to retrieve data
3838

39-
This sample `get-products` runtime action is referenced in the mesh configuration file. It defines the path to the runtime action to retrieve the data of custom columns.
39+
The mesh configuration fule references the `get-products` sample runtime action. It defines the path to the runtime action to retrieve the data of custom columns.
4040

41-
It is important to add the `ids={args.ids}` as part of the query and handle this filtering in the runtime action. This will allow Admin UI SDK to load only necessary data needed to display in the grid columns in the Admin Panel of the Adobe Commerce instance.
41+
It is important to add `ids={args.ids}` to the query and handle this filtering in the runtime action. As a result, the Admin UI SDK loads only the data necessary to display in the grid columns of the Adobe Commerce instance.
4242

4343
```javascript
4444
export async function main(props) {
@@ -149,9 +149,9 @@ This sample `schema.json` file is referenced in the mesh configuration file. It
149149
}
150150
```
151151

152-
### Create or Update your mesh
152+
### Create or update your mesh
153153

154-
Make sure to create or update your mesh, and to keep the mesh id provided.
154+
Use one of the following commands to create or update your mesh. Be sure to store the mesh ID provided.
155155

156156
```bash
157157
aio api-mesh:create mesh.json
@@ -163,17 +163,13 @@ aio api-mesh:update mesh.json
163163

164164
### Products data matching
165165

166-
#### Id matching
166+
The Admin UI SDK expects the product SKU in Adobe Commerce to correctly match the product to the data and to fill the correct cell.
167167

168-
The Admin UI SDK expects the product sku in Adobe Commerce to correctly match the product to the data and fill the correct cell.
168+
A default value can be provided to be added to unmatched IDs, or in case data doesn't match, the expected type of the column. If a value is not provided, the cell is left empty.
169169

170-
#### Default value
170+
In case of error, check the Adobe Commerce logs.
171171

172-
A default value can be provided to be added to unmatched ids, or in case data doesn't match the expected type of the column. If not provided, the cell is left empty.
173-
174-
In case of error, more info can be found in the Adobe Commerce logs.
175-
176-
##### Example of default value
172+
The following example provides a default value.
177173

178174
```javascript
179175
"*": {

0 commit comments

Comments
 (0)