ores.reporting.engine_settings
Table of Contents
The central row of a named engine settings configuration. A report definition binds the configuration through
report_configuration, in the slot of configuration type engine_settings, as it binds its pricing engines. The row holds
only the identity. The settings live in three parts, each its own table keyed by this row: engine_settings_fixings,
engine_settings_building and engine_settings_execution. A part that has no row means the engine default for every
setting in it. A write to any part bumps the version of this row in the same transaction.
1. Flags
2. Columns
2.1. id
UUID uniquely identifying this configuration.
ctx.generate_uuid()
2.2. party_id
The party that owns this configuration. Set from the session that writes it, and enforced by row level security, so a party sees only its own configurations.
ctx.generate_uuid()
2.3. name
Human-readable name of this configuration, unique per party. It is also the name of the reporting configuration this row is registered as, which is how a report definition binds it.
std::string("Standard engine settings")
2.4. description
What the settings are for and which reports share them.
std::string("Engine settings")
2.5. configuration_id
The reporting configuration this row is registered as. A report definition binds that configuration, and so reaches these settings.
ctx.generate_uuid()
3. SQL
3.1. Flags
4. Foreign keys
4.1. configuration_id
5. Insert trigger
5.1. Validations
| column | validation_function |
6. C++
6.1. Flags
6.2. Repository
6.3. Domain includes
#include <boost/uuid/uuid.hpp> #include <string>
6.4. Entity includes
#include <optional> #include <ostream> #include <string> #include <boost/uuid/uuid.hpp>
6.5. Conventions
6.6. Table display
| column | header |
|---|---|
| name | Name |
| description | Description |
| modified_by | Modified By |
| version | Version |
6.7. Presentation
6.7.1. Detail fields
| field | label | widget | type | is_key | is_required | placeholder |
|---|---|---|---|---|---|---|
| id | Id | idEdit | line_edit | true | true | |
| name | Name | nameEdit | line_edit | true | ||
| description | Description | descriptionEdit | line_edit |
6.7.2. Columns
| enum_name | field | header | type | width |
|---|---|---|---|---|
| Name | name | Name | string | 120 |
| Description | description | Description | string | 120 |
| Version | version | Version | int | 80 |
| ModifiedBy | modified_by | Modified By | string | 120 |
| RecordedAt | recorded_at | Recorded At | timestamp | 150 |
6.8. Custom repository methods
7. See also
- ores.reporting — component group overview.
- ores.reporting.risk_report_config — the run settings this row's engine settings leave.