ores.reporting.ore_parameter

1. Flags
2. Columns
3. SQL
- 3.1. Flags
4. Foreign keys
- 4.1. ore_parameter_value_domain_code
5. Insert trigger
- 5.1. Validations
6. C++
7. See also

The vocabulary of ORE XML. A row documents one leaf of one ORE document: an attribute or an element that holds a value. schema_name names the XML schema of the document, for example ore.xsd, and xpath is the path to the leaf in a document of that schema. The two together say which leaf this is.

ORE writes the parameters of ore.xml as a name and a value inside a block. For them scope names the block (Setup, Markets, an analytic), subtype narrows it, and name is the parameter, so the three give the same path as xpath. position keeps the order the document wrote, because a document that is not reproducible in order is not reproducible.

165 of the 218 parameter names observed in the shipped corpus belong to exactly one analytic kind, which is why the name alone is not the key.

1. Flags

2. Columns

2.1. id

Surrogate key for the ORE parameter.

2.2. scope

The block the parameter belongs to, for example Setup or Markets.

2.3. subtype

The kind within the block that accepts the parameter, for example the analytic type. Empty when the block is the whole context.

2.4. name

The parameter name as ORE writes it.

2.5. schema_name

The XML schema the leaf belongs to, named by the file name of the schema, for example ore.xsd. A document is of this schema whatever its own file name is.

2.6. xpath

The XPath of the leaf in a document of the schema, for example /ORE/Setup/Parameter[@name='implyTodaysFixings']. The schema name and the XPath together say which leaf this is. For ore.xsd, scope, subtype and name give the same path.

2.7. position

The order the document writes the parameter in.

2.8. ore_parameter_value_domain_code

What a value of this parameter is.

2.9. is_required

Whether the document must carry the parameter.

2.10. label

The name a screen shows for the parameter, for example Imply today’s fixings.

std::string("Parameter")

2.11. help

One line a screen shows next to the control. It says what kind of value the parameter takes.

std::string("A flag.")

2.12. description

The full text a screen shows for the parameter. It says what the parameter decides, what each value does and when to change it.

std::string("What the parameter decides.")

2.13. default_text

The default as a person reads it, with what it means, for example No. Today’s fixing is loaded.

std::string("No.")

2.14. format

How a value is written in the document, for example a flag written Y or N, or a whole number from 0 to 9.

std::string("A flag.")

2.15. introduced_in

The ORE release that introduced the parameter. When the project could not measure an earlier release, the text says so, for example 1.8.0.7 or earlier.

std::string("1.8.13.0")

2.16. removed_in

The ORE release that removed the parameter. Null while the parameter still exists.

std::string("1.9.0.0")

3. SQL

3.1. Flags

4. Foreign keys

4.1. ore_parameter_value_domain_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
schema_name	Schema
xpath	XPath
scope	Scope
subtype	Subtype
name	Name
ore_parameter_value_domain_code	Value Is
modified_by	Modified By
version	Version

6.7. Presentation

6.7.1. Detail fields

field	label	type	is_key	is_required	placeholder
schema_name	Schema	line_edit	true	true	Enter schema name
xpath	XPath	line_edit	true	true	Enter XPath
scope	Scope	line_edit	true	true	Enter scope
subtype	Subtype	line_edit	true	true	Enter subtype
name	Name	line_edit	true	true	Enter parameter name
ore_parameter_value_domain_code	Value Is	line_edit		true	Enter value domain code
label	Label	line_edit		true	Enter label
help	Help	line_edit		true	Enter help
description	Description	line_edit		true	Enter description
default_text	Default	line_edit		true	Enter default
format	Format	line_edit		true	Enter format
introduced_in	Introduced in	line_edit		true	Enter release
removed_in	Removed in	line_edit			Enter release

6.7.2. Columns

enum_name	field	header	type	width
Schema	schema_name	Schema	string	120
XPath	xpath	XPath	string	360
Scope	scope	Scope	string	140
Subtype	subtype	Subtype	string	160
Name	name	Name	string	200
ValueDomain	ore_parameter_value_domain_code	Value Is	string	160
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.