ores.reporting.report_instance

Table of Contents

A single execution of a report_definition. Created automatically when the scheduler fires a trigger for an active definition.

Lifecycle is managed through the report_instance_lifecycle FSM machine. fsm_state_id points to the current state in ores_dq_fsm_states_tbl.

started_at is NULL when the instance is cancelled or skipped before execution begins. completed_at is NULL while running or in a terminal-before-start state.

Flags

Primary key

UUID uniquely identifying this report instance.

Natural keys

name

Human-readable name copied from the report definition at creation time. 

std::string(faker::word::noun()) + "_instance"

Columns

description

Description copied from the report definition at creation time. 

std::string(faker::lorem::sentence())

party_id

Party that owns this report instance (inherited from the definition). 

boost::uuids::random_generator()()

definition_id

The report definition that produced this instance. 

boost::uuids::random_generator()()

fsm_state_id

Current FSM state (FK to ores_dq_fsm_states_tbl). 

std::nullopt

trigger_run_id

Scheduler trigger run ID that caused this instance to be created. 

faker::number::integer<std::int64_t>(1, 1000000)

output_message

Execution log or error message. 

std::string()

started_at

When execution began. NULL if cancelled before starting. 

std::nullopt

completed_at

When execution completed. NULL while running or before start. 

std::nullopt

SQL

Flags

C++

Flags

Repository

Domain includes

#include <chrono>
#include <cstdint>
#include <optional>
#include <string>
#include <boost/uuid/uuid.hpp>

Entity includes

#include <cstdint>
#include <optional>
#include <string>
#include "sqlgen/Timestamp.hpp"
#include <boost/uuid/uuid.hpp>

Conventions

Qt

Detail fields

field label widget type is_key is_required placeholder
name Name nameEdit line_edit true true Report instance name
description Description descriptionEdit text_edit     Description
output_message Output outputEdit text_edit     Execution log or error message

Columns (Qt model)

enum_name field header type width
Name name Name string 200
DefinitionId definition_id Definition uuid 200
TriggerRunId trigger_run_id Trigger Run int 100
OutputMessage output_message Output string 250
StartedAt started_at Started At timestamp 150
CompletedAt completed_at Completed timestamp 150
Version version Version int 60
ModifiedBy modified_by Modified By string 120

Custom repository methods

See also

Emacs 29.1 (Org mode 9.6.6)