Skip to content

Commit

Permalink
Update configuration.md
Browse files Browse the repository at this point in the history
  • Loading branch information
keharper authored Dec 16, 2024
1 parent b8716e9 commit a12db65
Showing 1 changed file with 7 additions and 17 deletions.
24 changes: 7 additions & 17 deletions src/pages/admin-ui-sdk/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,23 @@ Navigate to **Stores** > Settings > **Configuration** > **Adobe Services** > **A

## General configuration

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

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

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`.
The Admin UI SDK is disabled by default. To enable it, set the **Enable Admin UI SDK** field to **Yes**.

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.

## Database logging configuration

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.
The **Database logging configuration** section allows you to save Admin UI SDK log entries for the specified retention period.

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

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

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`.
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**.

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.

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

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

1. Set the **Testing mode** to `Staging`.
1. Set the **Testing mode** to **Staging**.

1. Select all app status to load in the Admin Panel.

### Prerequisites

* Adobe Commerce on cloud infrastructure or on premises: 2.4.5+
* PHP 8.1+
* [Adobe Identity Management Service (IMS) for Adobe Commerce](https://experienceleague.adobe.com/docs/commerce-admin/start/admin/ims/adobe-ims-integration-overview.html)
1. Select all app statuses to load.

## Local testing

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

1. Save your configuration.

### Prerequisites

- An Adobe Commerce instance installed on the local machine.

### Configuration

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.
Expand Down

0 comments on commit a12db65

Please sign in to comment.