{=
  include("docs.util");
  start_docs_page(docs.technical_manual.page_titles.reportfieldsnodes);
=}
<h4>Subnodes of the profile node statistics.report_fields described report fields. Each subnode describes one report field. The layout of report field nodes is described here.
</h4>
<a href="#label">label</a><br/>
<a href="#column_label">column_label</a><br/>
<a href="#column_info">column_info</a><br/>
<a href="#database_field">database_field</a><br/>
<a href="#average_denominator_field">average_denominator_field</a><br/>
<a href="#expression">expression</a><br/>
<a href="#type">type</a><br/>
<a href="#sort_type">sort_type</a><br/>
<a href="#category">category</a><br/>
<a href="#display_format_type">display_format_type</a><br/>
<a href="#custom_display_format_type">custom_display_format_type</a><br/>
<a href="#column_alignment">column_alignment</a><br/>
<a href="#subitems_level">subitems_level</a><br/>
<a href="#show_remainder_value">show_remainder_value</a><br/>
<a href="#show_average_value">show_average_value</a><br/>
<a href="#show_min_value">show_min_value</a><br/>
<a href="#show_max_value">show_max_value</a><br/>
<a href="#show_total_value">show_total_value</a><br/>
<a href="#percent_calculation">percent_calculation</a><br/>
<a href="#sort_by_before_expression_evaluation">sort_by_before_expression_evaluation</a><br/>
<a href="#sort_direction_before_expression_evaluation">sort_direction_before_expression_evaluation</a><br/>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="label"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">label</TH></TR>
<TR><TD>Type:</TD> <TD>string</TD></TR>
<TR><TD>Values:</TD><TD>Unique report field label.</TD></TR>
<tr><td>Default value:</td><td>-</td></tr>
<tr><td>Relevant:</td><td>always</td></tr>
<tr><td>Notes: </td><td>-</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="column_label"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">column_label</TH></TR>
<TR><TD>Type:</TD> <TD>string</TD></TR>
<TR><TD>Values:</TD><TD>-</TD></TR>
<tr><td>Default value:</td><td></td></tr>
<tr><td>Relevant:</td><td>Only if the column label should be overriden.</td></tr>
<tr><td>Notes: </td><td>The column_label is used if the table column should have a different label than the report_field label. I.e. the report field "Session pages" should be "Pages" in the table column_header, so we define:<br/> label = "Session Pages"<br/>column_label = "Pages"</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="column_info"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">column_info</TH></TR>
<TR><TD>Type:</TD> <TD>string</TD></TR>
<TR><TD>Values:</TD><TD>-</TD></TR>
<tr><td>Default value:</td><td>-</td></tr>
<tr><td>Relevant:</td><td>Only if the column info should be provided.</td></tr>
<tr><td>Notes: </td><td>This node contains the text which is shown when the user clicks on the table column info icon.</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="database_field"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">database_field</TH></TR>
<TR><TD>Type:</TD> <TD>string</TD></TR>
<TR><TD>Values:</TD><TD>Node name of an existing database field.</TD></TR>
<tr><td>Default value:</td><td>-</td></tr>
<tr><td>Relevant:</td><td>Only relevant if the report field is based on a database field.</td></tr>
<tr><td>Notes: </td><td>-</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="average_denominator_field"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">average_denominator_field</TH></TR>
<TR><TD>Type:</TD> <TD>string</TD></TR>
<TR><TD>Values:</TD><TD>""(empty) or the node name of another aggregating report field.</TD></TR>
<tr><td>Default value:</td><td>-</td></tr>
<tr><td>Relevant:</td><td>Only relevant if the report field is based on a database field.</td></tr>
<tr><td>Notes: </td><td>A report field which has an average_denominator_field defined becomes automatically a report field upon query fields creation.</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="expression"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">expression</TH></TR>
<TR><TD>Type:</TD> <TD>string</TD></TR>
<TR><TD>Values:</TD><TD>-</TD></TR>
<tr><td>Default value:</td><td>-</td></tr>
<tr><td>Relevant:</td><td>Only relevant if the report field is based on an expression and not on a database field.</td></tr>
<tr><td>Notes: </td><td>A report field expression can only be calculated from other report fields which are based on a database field!</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="type"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">type</TH></TR>
<TR><TD>Type:</TD> <TD>string</TD></TR>
<TR><TD>Values:</TD><TD>string<br/>int<br/>float<br/></TD></TR>
<tr><td>Default value:</td><td>int</td></tr>
<tr><td>Relevant:</td><td>Only relevant if the report field is based on an expression and not on a database field.</td></tr>
<tr><td>Notes: </td><td>The type defines the type in the ssql table for any report field which is not based on a database field.</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="sort_type"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">sort_type</TH></TR>
<TR><TD>Type:</TD> <TD>string</TD></TR>
<TR><TD>Values:</TD><TD>""(empty)<br/>alphabetical<br/>numerical<br/>chronological</TD></TR>
<tr><td>Default value:</td><td>""(empty)</td></tr>
<tr><td>Relevant:</td><td>always</td></tr>
<tr><td>Notes: </td><td>sort_type allows to override the default sorting of a ssql table report_field.<br/>The default sort type is evaluated automatically by the C++ depending on other report field parameters.<br/>If sort_type is not empty then the C++ will sort according to the specified value.</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="category"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">category</TH></TR>
<TR><TD>Type:</TD> <TD>string</TD></TR>
<TR><TD>Values:</TD><TD>""(empty)<br/>date_time<br/>day_of_week<br/>hour_of_day<br/>day_of_year<br/>week_of_year<br/>...<br/>Categories are defined in LogAnalysisInfo/field_categories.cfg.</TD></TR>
<tr><td>Default value:</td><td>""(empty)</td></tr>
<tr><td>Relevant:</td><td>Only if the report field is based on an expression or if it overrides the database field category.<br/>If a report field is baed on a database field and the category node exists, then it overrides the database field category, also in case that the value is empty. I.e.,category="" will set the category to "", regardless of which category is defined in the source database field.</td></tr>
<tr><td>Notes: </td><td>The report field category overrides any database field category.<br/>A category is usually given in the database field, though a report field with an expression is not based on a database field, hence we allow the definition of a category in report fields as well.</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="display_format_type"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">display_format_type</TH></TR>
<TR><TD>Type:</TD> <TD>string</TD></TR>
<TR><TD>Values:</TD><TD>string<br/>bandwidth<br/>date_time<br/>day_of_week<br/>hour_of_day<br/>page<br/>hostname<br/>integer<br/>duration --> show in list as "duration"(fully written out)"<br/>duration_compact -->show in list as "duration as seconds (e.g., 1y23d 12:34:56)"<br/>duration_milliseconds -->show in list as "duration as milliseconds (e.g., 1 y23d 12:34:56.789)"<br/>duration_microseconds -->duration as microseconds (e.g., 1y23d 12:34:56.789012)"<br/>duration_hhmmss<br/>custom --> Defines that we use the value of custom_display_format_type for formatting.</TD></TR>
<tr><td>Default value:</td><td>string</td></tr>
<tr><td>Relevant:</td><td>always</td></tr>
<tr><td>Notes: </td><td>If custom is defined we show a separate custom_display_format_type input field.<br/>The string "custom" itself is never used in format(), it is only used to determine from where we get the final display format type which is then set in query_fields.<br/>We do not constraint the user on selecting the display_format_type depending on type or any othe property.<br/>Any display format type is allowed, regardless of the selected report field type.</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="custom_display_format_type"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">custom_display_format_type</TH></TR>
<TR><TD>Type:</TD> <TD>string</TD></TR>
<TR><TD>Values:</TD><TD>-</TD></TR>
<tr><td>Default value:</td><td>-</td></tr>
<tr><td>Relevant:</td><td>Only relevant if display_format_type is "custom".</td></tr>
<tr><td>Notes: </td><td>Custom display format types are useful to format i.e. a numerical value as string with a currency symbol like "$30.22". format () supports printf-style formatting, so a custom_display_format_type must be in the printf-style format, i.e.:<br/>custom_display_format_type = "<br/>$ %0.4f"(Formats '2.345678' as '$ 2.3456')<br/>custom_display_format_type = "%0.2f" (Formats '2.345678 as '2.34')<br/><br/>
Formatting a value so that it displays a dash which we require in RBAC (we simply use the display format type for hidden fields, value is only set in the query fields display format type!)<br/>
display_format_type = "<strike>%</strike>" (Formats 'abc' as '-')<br/>
Format values as dash: That takes advantage of the fact that $PRODUCT_NAME uses printf formatting when there is a % in the string. But %- is an invalid printf format string, so it renders as ""; that makes the whole thing "-".</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="column_alignment"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">column_alignment</TH></TR>
<TR><TD>Type:</TD> <TD>string</TD></TR>
<TR><TD>Values:</TD><TD>"" (empty, is equal auto alignment)<br/>left<br/>right</TD></TR>
<tr><td>Default value:</td><td>"" (empty)</td></tr>
<tr><td>Relevant:</td><td>always</td></tr>
<tr><td>Notes: </td><td>column_alignment defines the alignment in html table columns.<br/> If column_alignment is empty (auto) we align non-aggregating fields left and aggregating fields right.<br/>If left or right is specified then we align accordingly regardless of non-aggregating/aggregating type.</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="subitems_level"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">subitems_level</TH></TR>
<TR><TD>Type:</TD> <TD>int</TD></TR>
<TR><TD>Values:</TD><TD>>= -2</TD></TR>
<tr><td>Default value:</td><td>-1</td></tr>
<tr><td>Relevant:</td><td>Only relevant for report fields which are based on a database field and where the log field on which the database field is based on is not of type "flat" and not of type "agent".</td></tr>
<tr><td>Notes: </td><td>-2 --> source item field (date_time timestamp in case for date_time database field in log_detail report)<br/>-1 --> bottom_level field<br/>0 --> hierarchical field<br/>>= 1 --> specific subitems level</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="show_remainder_value"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">show_remainder_value</TH></TR>
<TR><TD>Type:</TD> <TD>boo|</TD></TR>
<TR><TD>Values:</TD><TD>-</TD></TR>
<tr><td>Default value:</td><td>true</td></tr>
<tr><td>Relevant:</td><td>Only relevant for aggregating report fields.</td></tr>
<tr><td>Notes: </td><td>If set to true, it will show the calculated remainder value in the remainder row cell.<br/>If set to false, it will show a "-" dash in the remainder row cell.</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="show_average_value"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">show_average_value</TH></TR>
<TR><TD>Type:</TD> <TD>boo|</TD></TR>
<TR><TD>Values:</TD><TD>-</TD></TR>
<tr><td>Default value:</td><td>true</td></tr>
<tr><td>Relevant:</td><td>Only relevant for aggregating report fields.</td></tr>
<tr><td>Notes: </td><td>If set to true, it will show the calculated average value in the average row cell.<br/>If set to false, it will show a "-" dash in the average row cell.</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="show_min_value"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">show_min_value</TH></TR>
<TR><TD>Type:</TD> <TD>boo|</TD></TR>
<TR><TD>Values:</TD><TD>-</TD></TR>
<tr><td>Default value:</td><td>true</td></tr>
<tr><td>Relevant:</td><td>Only relevant for aggregating report fields.</td></tr>
<tr><td>Notes: </td><td>If set to true, it will show the calculated min value in the min row cell.<br/>If set to false, it will show a "-" dash in the min row cell.</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="show_max_value"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">show_max_value</TH></TR>
<TR><TD>Type:</TD> <TD>boo|</TD></TR>
<TR><TD>Values:</TD><TD>-</TD></TR>
<tr><td>Default value:</td><td>true</td></tr>
<tr><td>Relevant:</td><td>Only relevant for aggregating report fields.</td></tr>
<tr><td>Notes: </td><td>If set to true, it will show the calculated max value in the max row cell.<br/>If set to false, it will show a "-" dash in the max row cell.</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="show_total_value"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">show_total_value</TH></TR>
<TR><TD>Type:</TD> <TD>boo|</TD></TR>
<TR><TD>Values:</TD><TD>-</TD></TR>
<tr><td>Default value:</td><td>true</td></tr>
<tr><td>Relevant:</td><td>Only relevant for aggregating report fields.</td></tr>
<tr><td>Notes: </td><td>If set to true, it will show the calculated total value in the totals row cell.<br/>If set to false, it will show a "-" dash in the totals row cell.</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="percent_calculation"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">percent_calculation</TH></TR>
<TR><TD>Type:</TD> <TD>string</TD></TR>
<TR><TD>Values:</TD><TD>sum<br/>sum_or_subsum<br/>none (column value is already a percent value) - Not implemented, planned for later.<br/>column_value (Get base value from another aggregating report field) - Not implemented, planned for later.</TD></TR>
<tr><td>Default value:</td><td>sum</td></tr>
<tr><td>Relevant:</td><td>Only relevant for aggregating report fields.</td></tr>
<tr><td>Notes: </td><td>sum and subsum basically defines the base value for percentage calculation for the inner rows (sub-table) of a pivot table. If sum, we calculate all percentages from the sum of the outer rows (main-table).<br/>If sum_or_subsum then teh sub-sum of the inner rows is equal 100%, so the base value for the inner rows percentage calculation is the sub-sum value and not the sum value.</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="sort_by_before_expression_evaluation"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">sort_by_before_expression_evaluation</TH></TR>
<TR><TD>Type:</TD> <TD>string</TD></TR>
<TR><TD>Values:</TD><TD>"" (empty) or node name of an existing report field.</TD></TR>
<tr><td>Default value:</td><td>-</td></tr>
<tr><td>Relevant:</td><td>Only relevant for report fields which are based on an expression.</td></tr>
<tr><td>Notes: </td><td>If a report field is specified then it sorts the ssql table before expressions are evaluated.</td></tr>
</table>
<br>
<br />
<TABLE BORDER CELLPADDING=10 Rules=all frame=box>
<a name="sort_direction_before_expression_evaluation"></a>
<TR><TH COLSPAN=2 bgcolor="#CCCC99">sort_direction_before_expression_evaluation</TH></TR>
<TR><TD>Type:</TD> <TD>string</TD></TR>
<TR><TD>Values:</TD><TD>ascending<br/>descending</TD></TR>
<tr><td>Default value:</td><td>descending</td></tr>
<tr><td>Relevant:</td><td>Only relevant if sort_by_before_expression_evaluatin is defined.</td></tr>
<tr><td>Notes:</td><td>This defines the sort direction for sort_by_before_expression_evaluation.</td></tr>
</table>
{= end_docs_page() =}