Number Options
Configuration of number options for assigning IDs to entities.
Overview
Number option settings determine how new IDs are assigned to entities such as customers, orders, carts, etc. Each number option is associated with a specific number type. The first defined configuration for a number type will be used when creating new IDs.
For example, when a new customer is created, Omnium will search for the first available "CustomerNumberOptions" on the selected market. If none are found, it will fall back to the first "CustomerNumberOptions" defined in the generic number options section of the configuration file. If no option is defined there, the system defaults to "GuidNumberService."
Number Option Model
The table below outlines the properties of a number option:
| Property | Type | Description | Notes |
|---|---|---|---|
| NumberType | string | Specifies the number type (e.g., SupplierNumberOptions, CustomerNumberOptions). | Required |
| Key | string | Unique key for the incrementing value (e.g., OrderNumber, CustomerNumber). | Required |
| StartSequence | int | The starting point for the new number series. | Optional |
| Prefix | string | A prefix to be added to the number (e.g., "C-" for "C-1", "C-2"). | Optional |
| Service | string | The number service used (e.g., "SequentialNumberService", "GuidNumberService"). | Required |
| TranslateKey | string | Key for translating the number option name. | Optional |
| ValidationRegex | string | Regex pattern for validating the ID. | Optional |
| IsReadOnly | bool | If true, the number is non-editable in the GUI. | Optional |
| IsAutoCreateDisabled | bool | If true, automatic number assignment is disabled in the GUI (allowing manual entry). | Optional |
Number Types
Number types are used to distinguish between different entity types. Below are the most common number types: