ores.reporting.report_error_scope

Table of Contents

The vocabulary a report error's scope is drawn from. The engine that computes a report states the scope of every error it emits, in its structured log, as a group. The codes here are those group names verbatim, so the model adds no classification of its own: the engine says Trade and the row says Trade.

Code Where an error of this scope appears
Trade On the one trade the error names. A trade that would not build is one of these, and a run that reports sixteen of them reported sixteen trades that would not build.
Analytics On the one analytic the error names, or on the trade the analytic could not build. Which of the two is stated by the error row's subject, not by the scope.
Curve On the one curve the error names, a curve that would not build while the market was assembled.
Configuration On the input the error names, which belongs to no one trade.
Report Nowhere below the run: the error is about the run itself. This is the one code the engine does not emit. It is here because a run can also fail for a reason no engine saw, such as a workflow step that never reached it, and a reader wants one table.

Report is the only code this model states rather than copies. Every other code is a string the engine writes, and a code the engine writes that is not a row here is a vocabulary the engine has grown: the row is refused, loudly, rather than stored with a scope no reader can place.

1. Flags

2. Columns

2.1. code

The engine's own group name, verbatim: Trade, Analytics, Curve, Configuration, or Report for an error about the run itself.

2.2. name

The human-readable name of the scope.

2.3. description

What an error of this scope is about, in one line.

2.4. display_order

The order the scope appears in a list, narrowest subject first.

3. SQL

3.1. Flags

The table's row-level security is stated by hand in reporting_rls_policies_create.sql rather than generated, because the scope vocabulary is seeded for the system tenant and has to be readable by every tenant that reads a report. A generated tenant-only policy shows a tenant its own rows and nothing else, so every tenant would find the vocabulary empty.

4. C++

4.1. Flags

4.2. Repository

4.3. Domain includes

#include <string>

4.4. Entity includes

#include <string>

4.5. Conventions

4.6. Table display

column header
code Code
name Name
description Description
display_order Order
modified_by Modified By
version Version

4.7. Presentation

4.7.1. Detail fields

field label type is_key is_required placeholder
code Code line_edit true true Enter scope code
name Name line_edit   true Enter display name
description Description line_edit   true Enter description
display_order Order spin_edit   true Enter order

4.7.2. Columns

enum_name field header type width
Code code Code string 160
Name name Name string 200
Description description Description string 320
DisplayOrder display_order Order int 80
Version version Version int 80
ModifiedBy modified_by Modified By string 120

4.8. Custom repository methods

5. See also

Emacs 29.3 (Org mode 9.6.15)