# Reports A report definition in SanteDB's BI services framework represents an asset which is ultimately rendered to one or more output formats (like HTML, XLS, etc.). Data sources for reports can be either a view or a query which can be referenced or inline with the report definition itself. ## Report Definition Files Report definition files define one or more data sources (query or view), metadata (including permission), and one or more views. These views represent different ways of representing data. For example you may have a report with a tabular view and a chart view. ```markup SanteSuite Contributors

A simple report
``` The view contents are defined using XHTML and the content is generated using view components defined in the **** namespace. ## Report View Components There are several built-in view components which you can use for creating your report. They are: | Component | Description | | --------------- | ---------------------------------------------------------------- | | \ | Aggregate one of the reports data sources | | \ | Render a localized string into the report | | \ | Repeat the contents of for each row contained in the data source | | \ | Conditional rendering of report components | | \ | Bind the contents to a particular column in the current row. | | \ | Render a pie, line, bar, radar, donut or combination chart. | ### Aggregate Component The aggregate component is used to aggregate a particular data source. This is useful for showing totals, averages, counts, etc. ```markup fieldOrExpression ``` The aggregation functions currently supported are: | Function | Description | | -------------- | ------------------------------------------------------------ | | sum | Adds the particular field or expression together | | count | Counts the number of non-null values | | count-distinct | Counts the unique instances of a value or expression | | min | The minimum value for the value or expression in the dataset | | max | The maximum value | | avg | Average value | You can either aggregate a field, or an expression, for exam ```markup ui.total n_patients ui.somecalc n_patients / cohort ``` ### Locale Component The locale component will replace the value of the element with the correct string from the current locale. ```markup ui.welcome ``` ### Repeat Component The repeat component is an iterator which opens a dataset and repeats until the rows in the data source are exhausted. ```markup ``` The contents of the repeat element is any content, for example, this component is used to create tables: ```markup ui.dateui.name
date name
Total Patients name
``` ### Switch Component The switch component is used to provide conditional rendering of components. ```markup ``` For example, the switch statement can be used to provide iconography: ```markup ``` ### Value Component The value component allows the rendering of report data elements or expressions. ```markup expressionOrField ``` The when changed indicates that the value should only be emitted when the previous rows' value is not equal to this row's value. For example: ```markup
ui.patient ui.visitDate
name visitDate
name ui.patients.total visitDate
``` This may output a table such as: | ui.patient | ui.visitDate | | ------------------- | ------------ | | SMITH, JOHN | 2019-03-11 | | | 2019-04-11 | | JONES, JENNIFER | 2019-11-01 | | 2 ui.patients.total | 3 | ### Chart Component The charting component allows for quick creation of basic charts using the data found in the data source. ```markup title of chart fieldOrExpression ``` For example, to create a simple pie chart: ```markup Patients By Gender id ``` It is also possible to create composite charts ```markup Patient Trends gender == 'M' ? 1 : 0 gender == 'F' ? 1 : 0 ``` #### Reference Data / Layers Within a bar, line or radar chart you can add reference data sets which are useful for comparing data against a known good value set. These reference sets will appear as other datasets on the chart, however are drawn from a different data source than the primary view. Reference data sets must: * Have their first column match the `` or `` elements as they appear on the chart * Should be sorted in the same manner as the primary axis or dataset Reference datasets are included via the `@ref-source` attribute on the ` Patient Population (Age in Years) (DateTime.Now - birth_time).TotalDays / 365.25 Male Female Male Female ``` #### Styling Chart Data Charts can be styled using the following attributes on the `AttributeTypeDescriptionbackgroundColorColorControls the fill color of the seriesborderColorColorControls the line color of the borderborderWidthNumberControls the width of the border drawnfillBooleanWhen false the series will not be a filled seriesorderNumberThe relative order of the series in the chartpointRadiusNumberThe radius of the data points on the series (so users can see the data value)spanGapsBooleanWhen true, any gaps in data will be filled, when false the line will be brokenbarThicknessNumberWhen using a bar graph, controls the width of each bar.skipNullBooleanWhen true, elements with no value are skipped in the dataset.