Static Entity Editor
The static entity editor is used to define, configure, and manage reusable reference data, properties, and entry sources (manual or dynamic) within a static entity.
Editor overview
Section titled “Editor overview”This editor is made up of five main sections:
1. General section
Section titled “1. General section”| Property | Description | Recommended setting |
|---|---|---|
| Source | Defines how entries are loaded into the entity | Select Static or one of the supported dynamic source types |
| Display Column | Determines which property appears in dropdowns | Use the property users should see in the UI |
| Use "other" values | Allows free-text input in dropdowns | Leave disabled unless required |
When Use “other” values is enabled, Lowgile adds the $isOther property to the static entity. One or more entries can then be marked as the Other option by setting $isOther = true. When selected in a dropdown, the Other entry allows users to enter a custom value.
Attention
The display column should remain set to the property users should see in the dropdown, such as the static entity description (label or name). The $isOther property is a behaviour flag used to identify the Other entry and should not be used as the display column.
2. Properties section
Section titled “2. Properties section”This section defines the properties available in the static entity. By default, static entities contain the following properties:
| Column | Description | Example |
|---|---|---|
| Identifier | PascalCase internal identifier | Usd |
| ID | Unique internal identifier | usd |
| Label | Display value shown in the UI | USD |
3. Static Entries section
Section titled “3. Static Entries section”This section contains the manually maintained rows stored in the static entity and is only used when the source type is set to Static.
Each row represents a single static entity entry and stores values for the properties defined in the Properties section.
4. Caching section
Section titled “4. Caching section”When one of the dynamic source types is selected, the editor displays a Caching section.
Dynamic static entity entries may be cached on both the:
- Server side, and
- Client side.
The configured caching values determine how long dynamic entries are reused before Lowgile reloads the source data the next time the static entity is accessed.
Insight
If the source data changes before the cache expires, the static entity may continue using cached values until the next reload occurs.
To force a reload programmatically:
await This.<static-entity-name>.load(true)Passing true forces the dynamic static entity to reload its source data instead of using cached values.
5. Dynamic Entries Script section
Section titled “5. Dynamic Entries Script section”When the source type is changed from Static to one of the dynamic source types, the editor displays a Dynamic Entries Script section.
“Dynamic entity types
The script returns the list of entries used by the static entity. Dynamic entries may be loaded from:
- XLS spreadsheets,
- CSV files,
- External APIs,
- Database queries, or
- Other server-side integrations.
Naming conventions
Section titled “Naming conventions”Use the following naming conventions to maintain consistency across applications:
| Property | Convention/Format | Example |
|---|---|---|
| Identifier | PascalCase | Usd |
| ID | Unique identifier | usd |
| Label | Display value shown in the UI | USD |