Database Field Nodes


label
derivation_method
log_field
session_field
source_database_field
suppress_top
suppress_bottom
category
aggregation_method
sql_field_length
integer_bits
index
integer_bits
always_include_bottom_level_items
itemnums_hash_function


label
Type: string
Values:Unique database field label.
Default value:-
Relevant:always
Notes:


derivation_method
Type: string
Values: log_field
database_filter
Default value: log_field
Relevant: always
Notes: The derivation method in database fields determines if a database field is based on a log field or on a database filter.


log_field
Type: string
Values: The node name of an existing log field.
Default value: -
Relevant: Only relevant if derivation_method is "log_field".
Notes: Two or more database fields can refer to the same log field.


session_field
Type: string
Values: sessions
session_events
session_user
session_date_time
session_begin
session_end
session_duration
session_id
session_page
session_entrances
session_exits
Default value: -
Relevant: Only relevant if derivation_method is "session_field".
Notes:


source_database_field
Type: string
Values: The node name of an existing database field where derivation_method is not log_field and not sessions, session_begin or session_end.
Default value: -
Relevant: Only relevant if derivation_method is session_field and if the session field is:
sessions
session_begin
session_end
Notes:This node is only used for some session database fields!
Session database fields which are actually based on another field point to it with "source_database_field".
The C++ uses this to determine what field of the main table to use for the values of the field.
If "source_database_field" is absent, the C++ assumes that the database field is its own source field.


type
Type: string
Values: string
int
float
Default value: string
Relevant: always
Notes:Any database field type is valid for any log field type, no particular constraints are applied. The type "unique" is not valid any more in version 8, "unique" is now defined as aggregation_method.


suppress_top
Type: integer
Values: > = 0 AND < = suppress_bottom
Default value: 0
Relevant: Suppress_top is relevant for all database fields of type "string".
Notes:If this value is not specified, it is as though it were specified as 0.


suppress_bottom
Type: integer
Values: > = suppress_top
Default value: 2
Relevant: Suppress_bottom is relevant for all database fields of type "string".
Notes:If this value is not specified, it is as though it were specified as 2.


category
Type: string
Values: "" (empty)
date_time
day_of_week
hour_of_day
day_of_year
week_of_year
...
Categories are defined in LogAnalysisInfo/field_categories.cfg.
Default value: -
Relevant: always
Notes:The database field category can be overriden by a report field category.
The category is used for RBAC control (permit/prohibit table columns) and to determine graph display, we recognize i.e. a chronological graph by the category "date_time".


aggregation_method
Type: string
Values: none
sum
count
min
max
unique
Default value: -
Relevant: always
Notes:The aggregation_method "average" is not valid since version 8.
Average field calculation is now done by a report field expression, respectively the average denominator field is defined in a report field.


sql_field_length
Type: integer
Values: >= 1
Default value: 200
Relevant: Only relevant if type is equal string and database is not internal database.
Notes:


integer_bits
Type: integer
Values: 0,8,16,32,64
Default value: 0
Relevant: Only relevant if type is not equal float.
Notes:This determines the number of bits used in the database to represent the integer values in a database field (including intemnum fields).
Setting integer bits to 0 (Auto) means that it will use the maximum efficient machine word size, e.g., 32 bits on a 32-bit system, or 64 bits on a 64-bit system.
integer_bits is used for all fields that are represented by integers in the database, which is anything that isn't a floating point number.


index
Type: boolean
Values: -
Default value: true
Relevant: always
Notes:


always_include_bottom_level_items
Type: boolean
Values: -
Default value: false
Relevant: Only relevant for hierarchical fields.
Notes:


itemnums_hash_function
Type: string
Values: -
Default value: -
Relevant: Only relevant if the node exists.
Notes:The node should not be editable from the GUI.
If the node exists then keep it invisible but re-save it.