Skip to content

Commit 1a1a4a2

Browse files
Move config key explinations to a table
1 parent 90235cb commit 1a1a4a2

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

15/umbraco-commerce/how-to-guides/configuring-cart-cleanup.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,11 @@ This service can be enabled and configured in the `appSettings.json`
2020
"CartCleanupPolicy": {
2121
"EnableCleanup": true,
2222
"KeepCartsForDays": 800,
23-
// Below settings are optional
24-
"FirstRunTime": string; the time to first run the scheduled cleanup task, in crontab format
25-
"Period": string; how often to run the task, in timespan format
26-
// Configure diffrent policies per store
23+
// Optional settings
24+
"FirstRunTime": "* 4 * * *",
25+
"Period": "1.00:00:00",
2726
"PerStorePolicies": {
28-
"StoreAlias": {
27+
"{STORE_ALIAS}": {
2928
"KeepCartsForDays": 800,
3029
}
3130
}
@@ -35,6 +34,17 @@ This service can be enabled and configured in the `appSettings.json`
3534
}
3635
```
3736

37+
The configuration supports the followin keys.
38+
39+
| Key | Description |
40+
| -- | -- |
41+
| `EnableCleanup` | Enables or disabled the cart cleanup service. `false` by default. |
42+
| `KeepCartsForDays` | The number of days to keep carts after the carts last modification date. |
43+
| `FirstRunTime` | The time to first run the scheduled cleanup task, in crontab format. If empty, runs imediately on app startup. |
44+
| `Period` | How often to run the task, in timespan format. Defaults to every 24 hours. |
45+
| `PerStorePolicies` | Define store specific policies. |
46+
| `PerStorePolicies.{STORE_ALAIS}.KeepCartsForDays` | The number of days to keep carts after the carts last modification date for the given store. |
47+
3848
## Cart Conversion Rates Widget
3949

4050
When enabling the cart cleanup service, it's important to know that this can affect the cart conversion rates widget in the analytics section. If the widget is configured to show a time period that exceeds the cleanup policies time frame then a warning will be displayed.

0 commit comments

Comments
 (0)