Transactional entity editor
The Transactional entity editor is used to define and manage entities that store process-driven data.
It provides a structured interface for configuring entity properties, relationships, and behaviour. Unlike static entities, you do not add or manage rows of predefined data in this editor; transactional records are created and updated through screens and workflows.
Note
Transactional data can also be edited manually outside of screens and workflows. See Edit transactional data for more information.
Editor overview
Section titled “Editor overview”This editor consists of the following tabs:
- Base Entity
- Subsets
Base Entity
Section titled “Base Entity”The base entity tab is made up of four sections:
1. General area
Section titled “1. General area”This area allows the user to enter the transactional record’s ID type. Set:
| Property | Description | Recommended setting |
|---|---|---|
| ID Type | Defines the type of the entity identifier | Use string in most cases |
2. Properties
Section titled “2. Properties”This is where you create a list of properties that the transactional entity is made up of:
Insight
Each property represents a field in the entity and is used to store data.
- Clck on the “property” label to define a property. Set:
| Property | Value | Note |
|---|---|---|
| Property | (Property name, eg., quantity) | The internal property name |
- Click on the expand arrow on the property dropdown to expose the rest of the record’s properties.
- Set:
| Property | Description | Example |
|---|---|---|
| Type | Defines the data type | number, string, or reference |
| Default Expression | Optional default value | 1 |
| static checkbox | Optional default value | Leave unchecked |
| Seachable by default checkbox | Optional default value | Leave unchecked |
-
Save your changes before continuing.
- Click on + Add new property for each successive property you want to add and continue from the first step again.
3. Entity relationships
Section titled “3. Entity relationships”This section is used to define how the current entity is related to other entities.
Relationships link records together (for example, a header record and its associated line items).
Relationship types
Section titled “Relationship types”- Many-to-one: Multiple records reference a single record (e.g.
PurchaseRequestItem→PurchaseRequest) - One-to-many: A single record references multiple records (e.g.
PurchaseRequest→PurchaseRequestItem)
Relationship configuration
Section titled “Relationship configuration”- When adding a relationship, set:
| Property | Description | Example |
|---|---|---|
| Name | Internal relationship name | request |
| Target Entity | The entity being referenced | Purchasing.PurchaseRequest |
| Relation type | Defines the relationship direction | many-to-one or one-to-many |
| ID property name | Foreign key field name | requestId |
| Enforce DB Constraint | Ensures referential integrity | Enabled (default) |
-
Save your changes before continuing.
- Click on + Add new relationship for each successive entity relationship you want to add and continue from the first step again.
Insight
Define the relationship on the detail entity first (many-to-one), then configure the inverse relationship on the header entity.
4. Methods
Section titled “4. Methods”LEIGH TO-DO: Need information on adding methods - what, why, and how?
Save and close the editor.
Key Lesson
Transactional entities define the structure of process data. The actual records are created and managed through screens and workflows, not within the editor.