ores.reporting.configuration_analytic
Table of Contents
One row per Analytic element in the run document that a configuration describes: which analytic to run, in what order, and whether it is on. A report definition binds a shared configuration, and the configuration owns its analytics, so reports that run the same analytics share one set of rows. The parameters of an analytic are rows of configuration_analytic_parameter.
1. Flags
2. Columns
2.1. id
UUID uniquely identifying this analytic.
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_id
The configuration whose run this analytic belongs to. It is the reporting configuration that the risk report configuration is registered as.
2.4. analytic_type_code
The analytic to run, as the value ORE writes in its type attribute.
2.5. display_order
The position the analytic holds in the document's list, counting from one. ORE runs the analytics in the order they appear.
2.6. active
Whether the analytic is on, as ORE spells it: Y or N. ORE writes the flag as a parameter of every analytic, so the row carries it rather than inferring it.
3. SQL
3.1. Flags
4. Foreign keys
4.1. configuration_id
4.2. analytic_type_code
5. Insert trigger
5.1. Validations
| column | validation_function |
6. C++
6.1. Flags
6.2. Repository
6.3. Domain includes
#include <string>
6.4. Entity includes
#include <string>
6.5. Conventions
6.6. Table display
| column | header |
|---|---|
| analytic_type_code | Analytic |
| display_order | Order |
| active | Active |
| modified_by | Modified By |
| version | Version |
6.7. Presentation
6.7.1. Detail fields
| field | label | type | is_key | is_required | placeholder |
|---|---|---|---|---|---|
| analytic_type_code | Analytic | line_edit | true | e.g. npv | |
| display_order | Order | spin_edit | true | Enter order | |
| active | Active | line_edit | true | Y or N |
6.7.2. Columns
| enum_name | field | header | type | width |
|---|---|---|---|---|
| AnalyticTypeCode | analytic_type_code | Analytic | string | 180 |
| DisplayOrder | display_order | Order | int | 80 |
| Active | active | Active | string | 80 |
| Version | version | Version | int | 80 |
| ModifiedBy | modified_by | Modified By | string | 120 |
6.8. Custom repository methods
7. See also
- ores.reporting — component group overview.