ores.reporting.configuration_analytic_parameter
Table of Contents
One Parameter element inside one Analytic of the run document that a configuration describes: the value, and the definition that says what it means. A row is keyed to a definition in ore_parameter whose scope is the analytic and whose subtype is the analytic type code, so adding a parameter is a lookup row and never a column.
1. Flags
2. Columns
2.1. id
UUID uniquely identifying this parameter.
2.2. party_id
The party that owns the document this row belongs to. Set from the session that writes the document, and enforced by row level security, so a party sees only its own configuration.
ctx.generate_uuid()
2.3. configuration_analytic_id
The analytic of the configuration that this parameter belongs to.
2.4. ore_parameter_id
The definition that says what this value means.
2.5. value
The value, whose type comes from the definition's value domain.
2.6. position
The order the document wrote the parameter in.
3. SQL
3.1. Flags
4. Artefact columns
The definition of a parameter has an id that differs between databases, so a dataset cannot stage it. A staged parameter names the parameter instead, and the analytic type comes from the staged analytic that the row points at. ores_dq_publish_configuration_document_fn resolves the pair to the definition of the target database.
4.1. id
4.2. version
4.3. party_id
4.4. configuration_analytic_id
4.5. parameter_name
4.6. value
4.7. position
5. Foreign keys
5.1. configuration_analytic_id
5.2. ore_parameter_id
The insert checks the parameter under the system tenant, and the database build publishes no parameter. The eventing integration test writes five parameters of its own into the system tenant, and a value domain for them, and names the first. The test does not read the real parameters.
#include "ores.testing/ore_parameter_fixture.hpp"
v.ore_parameter_id =
ores::testing::write_system_parameters(party_ctx, h.db_user(), ctx).front();
6. Insert trigger
6.1. Validations
| column | validation_function |
7. C++
7.1. Flags
7.2. Repository
7.3. Domain includes
#include <string>
7.4. Entity includes
#include <string>
7.5. Conventions
7.6. Table display
| column | header |
|---|---|
| value | Value |
| position | Position |
| modified_by | Modified By |
| version | Version |
7.7. Presentation
7.7.1. Detail fields
| field | label | type | is_key | is_required | placeholder |
|---|---|---|---|---|---|
| value | Value | line_edit | true | Enter value | |
| position | Position | spin_edit | true | Enter position |
7.7.2. Columns
| enum_name | field | header | type | width |
|---|---|---|---|---|
| Value | value | Value | string | 260 |
| Position | position | Position | int | 80 |
| Version | version | Version | int | 80 |
| ModifiedBy | modified_by | Modified By | string | 120 |
7.8. Custom repository methods
8. See also
- ores.reporting — component group overview.