ores.reporting.report_instance_kind

1. Flags
2. Columns
3. SQL
- 3.1. Flags
4. C++
5. See also

Reference data naming the kinds of report instance. A report instance is one execution of a report definition, and its kind says what that execution does:

production prepares the engine's input, computes it on the grid and records the results. It is the kind of every instance the scheduler creates.
package prepares the engine's input and stops. It produces the packages that the compute grid would receive for the report and computes nothing, so a developer can inspect a report's packages and run them in ORE on their own machine.

The kind is a property of the run and not of the definition: one definition has instances of both kinds. A package instance is a real instance, with its own run token scope, storage keys and lifecycle, so the steps that prepare the input work for it unchanged. The concurrency policy of a definition counts production instances only.

1. Flags

2. Columns

2.1. code

The stable code of the kind: production or package.

2.2. name

The human-readable name of the kind.

2.3. description

What a report instance of this kind does, in one line.

2.4. display_order

The order the kind appears in a list.

3. SQL

3.1. Flags

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
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 kind 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

ores.reporting — component group overview.