OMS settings
Browse OMS setting groups, edit values by type, view change history, and define new settings.
The OMS settings screen is where you browse settings grouped by the order management system's behavior, change their values, review change history, and define new settings if needed. Many order management behaviors are read from these settings; changes take effect immediately in production. This screen is typically used by system administrators responsible for order management setup.
Accessing the screen
Follow the menu path Settings & Permissions › System › OMS settings. If you do not see it in the menu, your account does not have permission for this screen.
If you have view permission but not edit permission, you can see settings and their histories; the Add button is hidden and edit icons are disabled.
Screen sections
- Header — The root setting group's name (if no group name, OMS settings) and the description Browse setting groups, view values and change history. On the right, there is a Search field and, if you have permission, an Add button.
- Root group settings table — Settings directly linked to the top-level group.
- Subgroup tabs — Groups under the root group are listed as tabs. Each tab shows that group's settings table and, if any, nested tabs of its own subgroups. The number next to each tab name indicates the count of settings in that group and all its subgroups.
If you arrive directly at a specific group via a link, a Root button also appears in the header; clicking it reloads the screen from the top-level group.
Filtering and searching
| Field | Purpose | Tip |
|---|---|---|
| Search | Filters settings by text contained in Name, display name or description. | Applies instantly while typing; case-insensitive. Your search is also written to the address bar, so sharing the link opens the same search. |
Search works across all groups simultaneously. During search, the number next to tab names shows only matches within that tab's own settings, helping you locate matches by checking tabs. Groups without matches display No settings match the search.
List
Each group's settings table contains these columns:
| Column | Meaning |
|---|---|
| Display name | The understandable name of the setting; below it, the technical name (key) is shown. If no display name, the technical name is shown. |
| Value | The current value of the setting. Long values are truncated; hovering shows the full value as a tooltip. Settings carrying passwords or keys have masked values and a Secret badge. Empty values appear as —. |
| Value type | The type defined in the record, shown as is (e.g. Text, Integer, Long, Decimal, Datetime, Json, Bool). If no type, — is shown. |
| Description | Explanation of the setting's purpose (if any). |
| (action icons) | Pencil icon (Edit) edits the value; clock icon (Change history) opens the history. |
If the root group has no directly linked settings, the table shows This group has no settings.; if subgroups have no settings, the table is not shown, only that group's subtabs appear.
Actions
Editing a value
Use to change a setting's value.
- Click the pencil icon (Edit) on the relevant row.
- The Edit value window opens; the setting's display name appears under the title. The top warning states: This setting takes effect immediately in production.
- The First name field is read-only. If the setting has a description, it appears below.
- Change the Value field. The field appearance varies by the setting's type (see table below).
- Click the Save button. If the value does not match the type, the button is disabled; while saving, the button shows Saving….
Result: A Setting updated notification appears, the window closes, and the table and change history refresh. If the server rejects the change, a The server rejected the operation. notification appears and the window remains open. No confirmation is asked; the saved value takes effect immediately. To revert to the old value, re-save the previous value from Change history the same way.
Value field behavior by type:
| Value type | Edit field | Rule and warning |
|---|---|---|
Bool |
Checkbox; labeled Yes or No. | Checked = true, unchecked = false when saved. |
Integer, Long |
Single-line field, with Integer below. | Negative integers accepted. If invalid, shows Enter an integer. |
Decimal |
Single-line field, with Decimal below. | If invalid, shows Enter a decimal number (e.g. 12.5). Comma can be used as decimal separator; saved as dot. |
Datetime |
Single-line field, with Date/time (e.g. 2026-09-25 or 2026-09-25T10:00) below. | If invalid, shows Enter a valid date. |
Json |
Large text area; current value opens pretty-printed. Tip: Must be valid JSON; saved minified. | If invalid, shows Not valid JSON. |
Text and others |
Multi-line text area. | If value is stored as quoted text, tip Value is stored as text (JSON string); quotes are added automatically. appears; no need to type quotes. |
Type mismatch warning
If a record's defined type does not match its actual value (e.g. a Bool type setting containing an address), the value opens as plain text or JSON without forcing the type, and this warning appears: This record is defined as type {type} but the value does not match this type. The value is edited as is ({format}); it is not forced to the type. Check the value before saving. Edit preserving the actual format used.
If edit icon is disabled
Hovering shows the reason:
- You are not allowed to do this — Your account lacks edit permission on this screen.
- This setting is defined as not editable — The setting is defined as uneditable.
- This field carries a password or key; the value is never sent to the console. — Secret settings cannot be edited from the console.
Viewing change history
Use to see when, by whom, and to what value a setting was changed. Anyone who can see this screen can use this; edit permission is not required.
- Click the clock icon (Change history) on the relevant row.
- The window lists the setting's technical name and history records:
| Column | Meaning |
|---|---|
| Value | The value written in that change. |
| Date | Date and time of the change. |
| Changed by | Identity of the user who made the change. |
Records are sorted newest first. For secret settings, past values are also masked. If no records, shows No change history for this setting. Close the window with the top-right close icon.
Adding a new setting
Use to define a setting not yet present in the order management system. To change an existing setting's value, use Edit value instead.
- Click the Add button in the header.
- Read the warning in the New OMS setting window: New setting definition and value are entered. If a setting with the same name exists, addition is rejected; edit the existing setting from the list.
- Fill in the fields:
| Field | Required | Explanation / rule |
|---|---|---|
| First name | Yes | The setting's technical name (key); max 200 characters. Case-insensitive; cannot duplicate an existing setting's name. |
| Display name | Yes | Understandable name shown in the table; max 200 characters. |
| Value type | Yes | Text (default), Integer, Long, Decimal, Datetime, Json, Bool. |
| Group | Yes | Group to add the setting to. The list shows groups indented; default is the top group currently open on screen. |
| Value | No | Multi-line text area for all types (no checkbox). Validated according to selected type (rules same as above). If Bool is selected, tip Write true or false. appears; if invalid, warning Must be true or false. appears. |
| Description | No | Purpose of the setting; max 500 characters. |
- Click Save. The button is disabled if First name or Display name is empty or the value does not match the type.
Result: A Saved notification appears, the window closes, and the setting appears in the selected group's table. If a setting with the same name already exists, a The server rejected the operation. notification appears with the explanation A setting with this name already exists; edit the existing setting from the list.
Common situations
- The screen shows "Service not configured". The service address linked to this screen is not defined in this setup. OMS settings cannot be managed from the console in this setup; contact your system administrator.
- Instead of the screen, a "Something went wrong" box appears. Settings could not be read. Click Retry; if it persists, send the Technical detail text to your system administrator.
- I cannot find the setting I am looking for. The setting may be in a subgroup. Type part of the name in the Search field and check tabs with a count greater than zero; proceed similarly in nested groups.
- The pencil icon is disabled. Hover to read the reason: lack of permission, uneditable definition, or secret setting.
- The Save button does not activate. The value does not match the setting's type; correct according to the warning below the field.
- I received "The server rejected the operation." when saving. The change was not applied. Read the explanation: if it says Secret setting cannot be edited from the console., the setting is secret and cannot be changed here; if it says A setting with this name already exists; edit the existing setting from the list., edit the existing setting instead of adding a new one. For other explanations, contact your system administrator.
Related screens
- Platform settings — For store platform, rescheduling, order (return), and CMS settings.
- Store settings — For store storefront settings.
- Cache — For cache operations after setting changes.
- Overview — General introduction to the OMS – Order Management product.