Config File XML Reference (All Nodes but General)

This reference guide describes the structure of the config file XML elements. Use this guide if you build or edit the config XML directly, without using the Admin Console.

For the settings nodes within <general></general>, see Config File XML & API Setting Reference (General Nodes).

The config file’s outer nodes are as follows:

<?xml version="1.0" standalone="yes"?>
<webreports>
</webreports>

All following nodes are within the <webreports> element. They are organized below in alphabetical order, not necessarily the order they appear in the configuration file.

How to Use This Document

XML objects are represented in tables with the following format:

Node is the XML node name. Nodes in bold font are objects, which are represented below the table.

Description is the name of the field as it appears in the Admin Console. If there is no mapped field, or the field is implicit, the description is in italic font.

Type is the value type. If the type is a constant or enum, the possible values are listed below the table. Constants are case sensitive.

Required indicates whether the node requires a value. (1+) indicates that there can be multiple nodes.

Action Events

The Introduction to Action Events topic includes detailed descriptions of each of these settings.

Outer node: <actionevent></actionevent>

Possible values for event_type: None, or see Global Action Events

Possible values for user_action: None, Load, Click

Possible values for language: CSharp, JavaScript, VB

uiaction

Possible values for element_id: See Actionable UI Elements

reference

namespace

Example

<actionevent>
  <name>DoubleClick</name>
  <id>0</id>
  <event_type>OnDoubleClickReport</event_type>
  <user_action>Click</user_action>
  <language>CSharp</language>
  <program_code>return Extensions.ActionEvents.DoubleClick(sessionInfo);</program_code>
  <uiaction>
    <element_id>RunReportBtn</element_id>
  </uiaction>
  <reference>
    <name>Extensions.dll</name>
  </reference>
</actionevent>

Custom Options

The Custom Options topic includes detailed descriptions of each of these settings.

Outer node: <customoption></customoption>

Possible values for option_type: Int, Decimal, Bool, Text, List

option_list_item

Example

<customoption>
  <option_id>Hello</option_id>
  <option_type>List</option_type>
  <option_list_item>
    <option_list_item_id>World</option_list_item>
  </option_list_item>
</customoption>

Data Sources

The Data Sources topic includes detailed descriptions of each of these settings.

Outer node: <datasource></datasource>

Possible values for dbtype: mssql, oracle, msolap, odbc, websvc, assembly, mysql, file, postgres, db2, informix, cdata

Important:

As of v2024.1.2, CData drivers are no longer available for use in Exago BI products. See CData Drivers.

Example

<datasource>
  <id>0</id>
  <name>Northwind</name>
  <dbtype>odbc</dbtype>
  <schema>dbo</dbtype>
  <dataconnstr>DRIVER=SQLite3 ODBC Driver;Database=C:Northwind.sqlite;</dataconnstr>
  <odbcdelim>`</odbcdelim>
</datasource>

Data Objects

The Data Objects topic includes detailed descriptions of each of these settings.

When a Data Object is a clone of another only the id, entity_name, cloned_from, inherit_category and inherit_description, category, object_description and db_name apply.

Outer node: <entity></entity>

Possible values for object_type: table, view, procedure, function, assembly, sqlstmt, websvc, file

Possible values for schema_access_type: Metadata, Datasource

Possible values for affinity: Global, Report

key

param

tenant

filter_dropdown

Possible values for object_type: table, view, procedure, function, assembly, sqlstmt, websvc, file

column_metadata

Possible values for col_source: ExagoFormula

Possible values for col_type: string, date, datetime, time, int, decimal, image, float, Boolean, guid, currency

Possible values for filterable: All, Dynamic, Static, None

transform

non_transform_col

Possible values for data_type: 0: string, 1: date, 2: datetime, 3: time, 4: integer, 5: decimal, 6: float, 7: bit, 8: guid, 9: image, 10: currency

Example

<entity>
  <id>ODE</id>
  <entity_name>OrderDetails</entity_name>
  <db_name>OrderDetail</db_name>
  <sql_stmt>SELECT *</sql_stmt>
  <category>Order Information</category>
  <datasource_id>1</datasource_id>
  <object_type>table</object_type>
  <key>
    <col_name>OrderId</col_name>
  </key>
  <key>
    <col_name>ProductId</col_name>
  </key>
  <param>
    <id>count</id>
  </param>
  <tenant>
    <col_name>CategoryName</col_name>
    <parameter_id>count</parameter_id>
  </tenant>
  <filter_dropdown>
    <db_name>Category</db_name>
    <sql_stmt>SELECT *</sql_stmt>
    <datasource_id>-1</datasource_id>
    <object_type>table</object_type>
  </filter_dropdown>
  <column_metadata>
    <col_source>ExagoFormula</col_source>
    <col_name>Total</col_name>
    <col_type>currency</col_type>
    <col_alias>Total</col_alias>
    <filterable>false</filterable>
    <col_value>{ODE.Quantity}*({ODE.UnitPrice}-{ODE.Discount})</col_value>
  </column_metadata>
  <column_metadata>
    <col_name>UnitPrice</col_name>
    <col_type>currency</col_type>
  </column_metadata>
</entity>

Functions

The following topics include detailed descriptions of each of these settings

• Custom Functions
• Custom Filter Functions
• Custom Aggregate Functions

Outer node: <function><function>

Functions and Filter Functions use the same XML syntax. Filter functions have weight > 0 (which indicates its order in the filter list).

Possible values for category: Aggregate, Operators, Logical, Date, Financial, Database, Arithmetic, String, Formatting, Other

Possible values for available_in:

0. Unavailable
1. Formula
2. Filter
3. Aggregate

Possible values for filter_return_type: date, string, integer, decimal

Possible values for language: CSharp, JavaScript, VB

reference

namespace

<function>
  <name>IncrementBy</name>
  <description>Count up by value steps.</description>
  <category>Other</category>
  <arguments_json>[{"Name":"counter","Required":false,"Description":"Number to increment by. Default: 1."}]</arguments_json>
  <variable_arguments>false</variable_arguments>
  <available_in>1</available_in>
  <filter_return_type>String</filter_return_type>
  <weight>0</weight>
  <language>CSharp</language>
  <program_code>return Extensions.CustomFunctions.IncrementBy(sessionInfo, args);</program_code>
  <reference>
    <name>Extensions.dll</name>
  </reference>
</function>

Joins

The Join Configuration topic includes detailed descriptions of each of these settings.

Outer node: <join></join>

For entity names, use Id if set, otherwise use db_name.

Possible values for join_type: inner, leftouter, rightouter, fullouter

Possible values for relation_type: 11: one to one, 1M: one to many

Possible values for affinity: Global, Report

Possible values for conjunction: AND, OR

Possible values for comparison: EQ (=), NE (<>), LT (<), GT (>), LE (<=), GE (>=), IN

Possible values for left_side_type, right_side_type: Column, Constant, SubQuery, Expression

Example

<join>
  <entity_from_name>PRO</entity_from_name>
  <entity_to_name>CAT</entity_to_name>
  <clause>
    <left_side>ProductId</left_side>
    <right_side>CategoryId</right_side>
    <conjunction>AND</conjunction>
    <comparison>EQ</comparison>
    <right_side_type>Column</right_side_type>
    <left_side_type>Column</left_side_type>
    <level>0</level>
  </clause>
</join>

Parameters

The Parameters topic includes detailed descriptions of each of these settings.

Outer node: <parameter></parameter>

Possible values for data_type: string, date, integer, decimal, Boolean

parameter_dropdown

Possible values for object_type: table, view, procedure, function, assembly, sqlstmt, websvc, file

Possible values for display_data_type: string, date, integer, decimal

Example

<parameter>
  <id>count</id>
  <data_type>integer</data_type>
  <hidden>False</hidden>
  <prompt_text />
  <parameter_dropdown>
    <db_name>Category</db_name>
    <sql_stmt />
    <datasource_id>1</datasource_id>
    <object_type>view</object_type>
    <value_field>Category_View</value_field>
    <display_value_field />
    <display_data_type>string</display_data_type>
    <sp_params />
  </parameter_dropdown>
</parameter>

<quickfunction>
    <id>year</id>
    <language_id>Year_wrQuickFunction</language_id>
    <display_formula>=Year({cell_text})</display_formula>
    <sort_text>=Year({cell_text})</sort_text>
    <return_data_type>2</return_data_type>
    <supported_data_types>Date</supported_data_types>
</quickfunction>

1
2
3
4
5
<DateFunctions>
      ...
 <element id="Year_wrQuickFunction">Year</element>
     ...
</DateFunctions>

<DateFunctions>
  	...
 <element id="Year_wrQuickFunction">Year</element>
 	...
</DateFunctions>

<quickfunction>
    <id>month-name</id>
    <language_id>MonthName_wrQuickFunction</language_id>
    <display_formula>=MonthName({cell_text})</display_formula>
    <sort_text>=Month({cell_text})</sort_text>
    <return_data_type>0</return_data_type>
    <supported_data_types>Date</supported_data_types>
</quickfunction>

<DateFunctions>
  	...
 <element id="MonthName_wrQuickFunction">Month Name</element>
 	...
</DateFunctions>

Roles

The Roles topic includes detailed descriptions of each of these settings.

Outer node: <role></role>

rolegeneral

Possible values for schedulemanagerviewlevel: user, company, all

security

folders

folder

dataobjects

dataobject

For name, use Id if set, otherwise use db_name.

dataobjectrows

dataobjectrow

For name, use Id if set, otherwise use db_name.

Example

  <role>
    <id>Restricted</id>
    <active>False</active>
    <rolegeneral>
      <reportpath />
      <dateformat />
      <timeformat />
      <datetimeformat />
      <separatorsymbol />
      <currencysymbol />
      <readfiltervalues />
      <dbtimeout>0</dbtimeout>
      <showgrid />
      <showcrosstabreports />
      <showDashboardreports />
      <showchainedreports />
      <showexpressviews />
      <allowexpressviewliveedit />
      <showexpressreports />
      <showexpressreportsgrouping />
      <showexpressreportsformulabutton />
      <showexpressreportsstylingtoolbar />
      <showexpressreportsthemes />
      <showadvancedreports />
      <showschedulereports />
      <showschedulereportsmanager />
      <schedulemanagerviewlevel />
      <cachevisibilitylevel />
      <showschedulereportsemail />
      <decimalsymbol />
      <languagefile />
      <servertimezoneoffset>0</servertimezoneoffset>
      <clienttimezonename />
      <showDashboardnewvisualizationbutton />
      <allowreportcustomsqlobjects />
    </rolegeneral>
    <security>
      <includereportcustomsqlobjects>False</includereportcustomsqlobjects>
      <folders>
        <include_all>False</include_all>
        <read_only>False</read_only>
        <allow_management>True</allow_management>
        <folder>
          <name>Sales Reports</name>
          <read_only>False</read_only>
          <propagate>True</propagate>
        </folder>
      </folders>
      <dataobjects>
        <include_all>True</include_all>
      </dataobjects>
      <dataobjectrows />
    </security>
  </role>

Server Events

The Introduction to Server Events topic includes detailed descriptions of each of these settings.

Outer node:
<serverevent></serverevent>

Possible values for event_type: None, or refer to the List of Server Events.

Possible values for language: CSharp, JavaScript, VB

reference

namespace

Example

<serverevent>
  <name>ExpandAllFolders</name>
  <id>0</id>
  <event_type>OnAfterLoadReportsList</event_type>
  <language>CSharp</language>
  <program_code>Extensions.ServerEvents.ExpandAllFolders(sessionInfo, (TreeNodeCollection)args[0]);
return null;</program_code>
  <reference>
    <name>Extensions.dll</name>
  </reference>
  <reference>
    <name>WebReports.dll</name>
  </reference>
  <namespace>
    <name>WebReports.UI.Controls</name>
  </namespace>
</serverevent>

api.SetupData.StorageMgmtConfig.ClassName = "WebReports.ContentDatabase.StorageMgmtDatabase";

<storagemgmt>
    <assembly>WebReports.ContentDatabase.dll</assembly>
    <class>WebReports.ContentDatabase.StorageMgmtDatabase</class>
    <report_list_cache_timeout>30</report_list_cache_timeout>
    <report_xml_cache_timeout>30</report_xml_cache_timeout>
    <theme_list_cache_timeout>600</theme_list_cache_timeout>
    <report_list_cache_enabled>False</report_list_cache_enabled>
    <report_xml_cache_enabled>False</report_xml_cache_enabled>
    <default_inherit_flag>False</default_inherit_flag>
    <default_party_type_id>0</default_party_type_id>
    <option name="DbType" value="SQLite" />
    <option name="DbProvider" value="SQLite" />
    <option name="ConnectionString" value="Data Source=D:StorageMgmt.sqlite" />
    <option name="ReportListCacheKey" value="" />
    <table_prefix>sm_</table_prefix>
    <identity name="userId" value="Astro Boy" />
    <identity name="classId" value="Exago, Inc." />
    <identity name="location" value="Kingston" />
    <identity name="companyId" value="Development" />
  </storagemgmt>