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
Copy file name to clipboardExpand all lines: src/pages/admin-ui-sdk/app-registration.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -141,7 +141,7 @@ This file now declares extensions and redirects to an `ext.config.yaml` file.
141
141
142
142
## Add or update the `ext.config.yaml`
143
143
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.
145
145
146
146
Your extension configuration file should look like this:
147
147
@@ -168,8 +168,8 @@ runtimeManifest:
168
168
final: true
169
169
```
170
170
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.
172
172
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.
174
174
175
175
Complete this file with the actions from your app.
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.
18
18
19
19

20
20
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**.
22
22
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.
24
24
25
25
## Database logging configuration
26
26
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.
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**.
32
32
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**.
34
34
35
35
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.
36
36
@@ -42,15 +42,9 @@ The staging testing option provides a sandbox environment to test your applicati
42
42
43
43
1. Select **Yes** from the **Enable testing** menu.
44
44
45
-
1. Set the **Testing mode** to `Staging`.
45
+
1. Set the **Testing mode** to **Staging**.
46
46
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.
54
48
55
49
## Local testing
56
50
@@ -72,10 +66,6 @@ When you enable the local service, all calls are automatically redirected to the
72
66
73
67
1. Save your configuration.
74
68
75
-
### Prerequisites
76
-
77
-
- An Adobe Commerce instance installed on the local machine.
78
-
79
69
### Configuration
80
70
81
71
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.
Copy file name to clipboardExpand all lines: src/pages/admin-ui-sdk/extension-points/customer/grid-columns.md
+9-13Lines changed: 9 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -77,9 +77,9 @@ It leverages API Mesh [JSON Schemas handler](https://developer.adobe.com/graphql
77
77
78
78
### Sample runtime action to retrieve data
79
79
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.
81
81
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.
83
83
84
84
```javascript
85
85
exportasyncfunctionmain(props) {
@@ -125,7 +125,7 @@ export async function main(props) {
125
125
126
126
### Sample schema file
127
127
128
-
This sample`schema.json` fileis 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.
129
129
130
130
```json
131
131
{
@@ -155,9 +155,9 @@ This sample `schema.json` file is referenced in the mesh configuration file. It
155
155
}
156
156
```
157
157
158
-
### Create or Update your mesh
158
+
### Create or update your mesh
159
159
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.
The Admin UI SDK expects the customer ID in Adobe Commerce to correctly match the customer to the data and fill the correct cell.
173
173
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.
175
175
176
-
#### Default value
176
+
In case of error, check the Adobe Commerce logs.
177
177
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.
Copy file name to clipboardExpand all lines: src/pages/admin-ui-sdk/extension-points/order/grid-columns.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -85,7 +85,7 @@ It leverages API Mesh [JSON Schemas handler](https://developer.adobe.com/graphql
85
85
86
86
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.
87
87
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.
Copy file name to clipboardExpand all lines: src/pages/admin-ui-sdk/extension-points/product/grid-columns.md
+8-12Lines changed: 8 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -36,9 +36,9 @@ product: {
36
36
37
37
### Sample runtime action to retrieve data
38
38
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.
40
40
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.
42
42
43
43
```javascript
44
44
exportasyncfunctionmain(props) {
@@ -149,9 +149,9 @@ This sample `schema.json` file is referenced in the mesh configuration file. It
149
149
}
150
150
```
151
151
152
-
### Create or Update your mesh
152
+
### Create or update your mesh
153
153
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.
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.
167
167
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.
169
169
170
-
#### Default value
170
+
In case of error, check the Adobe Commerce logs.
171
171
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.
0 commit comments