report_instance Struct Reference

A single execution of a report definition. More...

#include <report_instance.hpp>

Collaboration diagram for report_instance:

Public Attributes
int	version = 0
	Version number for optimistic locking and change tracking.
utility::uuid::tenant_id	tenant_id = utility::uuid::tenant_id::system()
	Tenant identifier for multi-tenancy isolation.
boost::uuids::uuid	id
	UUID uniquely identifying this report instance.
std::string	name
	Human-readable name copied from the report definition at creation time.
std::string	description
	Description copied from the report definition at creation time.
boost::uuids::uuid	party_id
	Party that owns this report instance (inherited from the definition).
boost::uuids::uuid	definition_id
	The report definition that produced this instance.
std::optional< boost::uuids::uuid >	fsm_state_id
	Current FSM state (FK to ores_dq_fsm_states_tbl).
std::int64_t	trigger_run_id
	Scheduler trigger run ID that caused this instance to be created.
std::string	output_message
	Execution log or error message.
std::optional< std::chrono::system_clock::time_point >	started_at
	When execution began. NULL if cancelled before starting.
std::optional< std::chrono::system_clock::time_point >	completed_at
	When execution completed. NULL while running or before start.
std::string	modified_by
	Username of the person who last modified this report instance.
std::string	performed_by
	Username of the account that performed this action.
std::string	change_reason_code
	Code identifying the reason for the change.
std::string	change_commentary
	Free-text commentary explaining the change.
std::chrono::system_clock::time_point	recorded_at
	Timestamp when this version of the record was recorded.

Detailed Description

A single execution of a report definition.

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.

Member Data Documentation

change_reason_code

std::string change_reason_code

Code identifying the reason for the change.

References change_reasons table (soft FK).