# SymconReport

> Symcon documentation · English · generated on 2026-09-26  
> Index: https://www.symcon.de/en/llms.txt

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/symconreport/

Creates a report as CSV or PDF depending on the modules

## MailReport

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/symconreport/mailreport/

_Requires Symcon >= 5.5_

The module regularly sends the logged aggregated data of a variable via e-mail.

### function scope
- Send e-mails with aggregated data of a variable
  - E-mails are sent after each completion of the selected time interval (Daily, Weekly or Monthly)
  - E-mails contain aggregated data, which would also be displayed in a corresponding graph (Hourly for daily time interval, Daily for weekly or monthly time interval)
  - The email contains a CSV file, which is formatted analogously to the CSV export of graphs.

### prerequisites
- Set up SMTP instance for sending e-mails

### Software Installation
The module can be found via the [Module Store](https://www.symcon.de/en/service/documentation/components/management-console/module-store/) under the category "Information"=>"Preparation" or directly by searching for "Report Module". By pressing the button "Install" the module is made available to IP-Symcon.

### Setting up the instances in IP-Symcon
 - Via "Add Instance" the 'Report(Mail)' module can be found using the quick filter.
   - More information about adding instances in the [Instances documentation](https://www.symcon.de/en/service/documentation/basics/instances/)

#### Configuration Page:

| Name                 | Description                                                          |
| -------------------- | -------------------------------------------------------------------- |
| Email SMTP           | Selection of the SMTP instance through which the emails will be sent |
| Aggregated Variable  | Selection of the variable whose aggregated data should be sent       |
| Decimal separator    | Selection of decimal separator comma or point.                       |
| Interval of messages | Select the time interval in which the messages should be sent        |
| Send data            | Click to send an info mail about the last completed time interval    |

### status variables
The status variables/categories are created automatically. Deleting individual ones can lead to malfunctions.

#### Statusvariablen

| Name               | Type     | Description                         |
| ------------------ | -------- | ----------------------------------- |
| Mail Report active | Variable | Activates or deactivates the module |

### Visualization
The Visualization can be used to activate or deactivate the module.

## MR_SendInfo

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/symconreport/mailreport/mr-sendinfo/

`bool MR_SendInfo(int $InstanceID)`

_Requires Symcon >= 5.5_

**Parameters**

- `$InstanceID` (int): ID of the Instance

**Returns** (bool): If the command could be executed successfully, it returns __TRUE__ as result, otherwise __FALSE__.

ID of the Instance

**Example**

```text
MR_SendInfo(12345);
```

## MR_SetActive

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/symconreport/mailreport/mr-setactive/

`bool MR_SetActive(int $InstanceID, bool $Active)`

_Requires Symcon >= 5.5_

**Parameters**

- `$InstanceID` (int): ID of the Instance
- `$Active` (bool): De-/Activate the module

**Returns** (bool): If the command could be executed successfully, it returns __TRUE__ as result, otherwise __FALSE__.

De-/Activate the module

**Example**

```text
// Activates the module MR_SetActive(12345, true);
```

## PDFReport (Energy)

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/symconreport/pdfreport-energy/

_Requires Symcon >= 5.5_

This module provides the function of displaying the archive values of two variables as graphs, and providing selected information as PDF for the past month.

### scope of functions
- Allows to create and download created PDF.
- Setting via instance configuration
- Logo selection for header is possible

### Software installation
Via the [Module Store](https://www.symcon.de/en/service/documentation/components/management-console/module-store/) the module can be found under the category "Information"=>"Preparation" or directly via the search for "Report Module". By pressing the button "Install" the module is made available to IP-Symcon.

### Setting up the instances in IP-Symcon
- Under "Add Instance" the 'Report (PDF, Energy)' module can be found using the quick filter.
  - More information about adding instances in the [Instances documentation](https://www.symcon.de/en/service/documentation/basics/instances/)

#### Configuration Page:

| Name                | Description                                                                                                                                                                                                |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Logo                | (optional) Selectable graphic as PNG                                                                                                                                                                       |
| Consumption type    | Free text which is below the date                                                                                                                                                                          |
| Decimal separator   | Selection of decimal separator comma or point.                                                                                                                                                             |
| Consumption counter | Variable logged as counter                                                                                                                                                                                 |
| Temperature         | (optional) Logged variable                                                                                                                                                                                 |
| prediction          | (optional) Variable which can predict consumption based on behavior, for example from the module [consumption behavior](https://www.symcon.de/de/service/dokumentation/modulreferenz/verbrauchsverhalten/) |
| CO2 type            | (optional) CO2 equivalent for consumption type                                                                                                                                                             |

#### Example document
![Example](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/benachrichtigungen/symconreport/pdfreport-energie/777ee3eada-1790424938/example.png)

### status variables
The status variables/categories are created automatically. Deleting individual ones can lead to malfunctions.

### Status variables
The PDF is generated as a "Report (PDF)".

| Name         | Type  | Description                                                                 |
| ------------ | ----- | --------------------------------------------------------------------------- |
| Report (PDF) | Media | Generated PDF which can be downloaded from Visualization or sent by e-mail. |

### Visualization
The generated PDF can be downloaded via the Visualization.

## RAC_GenerateEnergyReport

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/symconreport/pdfreport-energy/rac-generateenergyreport/

`bool RAC_GenerateEnergyReport(int $InstanceID)`

_Requires Symcon >= 5.5_

**Parameters**

- `$InstanceID` (int): ID of the Instance

**Returns** (bool): If the command could be executed successfully, it returns __TRUE__ as result, otherwise __FALSE__.

ID of the Instance

**Example**

```text
RAC_GenerateEnergyReport(12345);
```

## PDFReport (Multi)

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/symconreport/pdfreport-multi/

_Requires Symcon >= 5.5_

This module provides the function to summarize archive values as a report in a PDF.

### function scope
- Allows to create and download created PDF.
- Setting via instance configuration
- Logo selection for header is possible
- Adjustable number of records, aggregation strength, min and max values of selected variables

### software installation
The module can be found via the [Module Store](https://www.symcon.de/en/service/documentation/components/management-console/module-store/) under the category "Information"=>"Preparation" or directly by searching for "Report Module". By pressing the button "Install" the module is made available to IP-Symcon.

### Setting up the instances in IP-Symcon
- Under "Add Instance" the 'Report (PDF, Multi)' module can be found using the quick filter.
  - More information about adding instances in the [Instances documentation](https://www.symcon.de/en/service/documentation/basics/instances/)

#### Configuration Page:

| Name              | Description                                                                    |
| ----------------- | ------------------------------------------------------------------------------ |
| Logo              | Selectable graphic as PNG                                                      |
| Company           | Company name                                                                   |
| Title             | PDF Title                                                                      |
| Footer            | Footer line                                                                    |
| Data Source       | Multiple variables from which the records per column are created               |
| Decimal separator | Selection of decimal separator comma or point.                                 |
| Aggregation       | Defines aggregation level of the listed records (hour - year)                  |
| Number            | Number of records listed                                                       |
| Skip record       | If this option is enabled, the most recent incomplete record will be discarded |

#### Example document
![Example](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/benachrichtigungen/symconreport/pdfreport-multi/4e258384b7-1790424938/example.png)

### status variables
The status variables/categories are created automatically. Deleting individual ones can lead to malfunctions.

#### Statusvariables
The PDF is generated as "Report (PDF)".

| Name         | Type  | Description                                                                |
| ------------ | ----- | -------------------------------------------------------------------------- |
| Report (PDF) | Media | Generated PDF which can be downloaded via Visualization or sent by e-mail. |

### Visualization
The generated PDF can be downloaded via the Visualization.

## RAC_GenerateReport

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/symconreport/pdfreport-multi/rac-generatereport/

`bool RAC_GenerateReport(int $InstanceID)`

_Requires Symcon >= 5.5_

**Parameters**

- `$InstanceID` (int): ID of the Instance

**Returns** (bool): If the command could be executed successfully, it returns __TRUE__ as result, otherwise __FALSE__.

ID of the Instance

**Example**

```text
RAC_GenerateReport(12345);
```

## PDFReport (Multi Energy)

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/symconreport/pdfreport-multi-energy/

This module offers the function of displaying the total consumption of the selected variables as well as the individual consumption in the time period.

### scope of functions
- Enables the creation and download of created PDFs.
- Setting via instance configuration

### Software installation
The module can be found via the [Module Store](https://www.symcon.de/de/service/dokumentation/komponenten/verwaltungskonsole/module-store/) under the category "Information"=>"Preparation" or directly by searching for "Report module". The "Install" button makes the module available to IP-Symcon.

### Setting up the instances in IP-Symcon
- Under "Add instance", the 'Report (PDF, Energy)' module can be found using the quick filter.
  - Further information on adding instances can be found in the [Instances documentation](https://www.symcon.de/service/dokumentation/konzepte/instanzen/#Instanz_hinzuf%C3%BCgen)

#### Configuration page:

| Name              | Description                                                |
| ----------------- | ---------------------------------------------------------- |
| Aggregation Level | Selection of the level of detail of the data used          |
| Decimal Separator | Selection of how the decimal separator should be displayed |
| Energy Counters   | List of energy counters to be used                         |

#### Example document
![Example](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/benachrichtigungen/symconreport/pdfreport-multi-energie/3dc103a505-1790424938/example.png)

### Status variables
The status variables/categories are created automatically. Deleting individual ones can lead to malfunctions.

### Status variables
The PDF is generated as a "Report (PDF)".

| Name         | Type    | Description                                                                   |
| ------------ | ------- | ----------------------------------------------------------------------------- |
| Start        | Integer | Specifies the start date from which the data should be used                   |
| End          | Integer | Specifies the end date until when the data should be used                     |
| Generate     | Script  | Executable to update the PDF                                                  |
| Report (PDF) | Media   | Created PDF, which can be downloaded via the visualization or sent by e-mail. |

### Visualization
The start and end date can be entered via the visualization and the PDF can be generated and downloaded.

## PDFReport (Single)

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/symconreport/pdfreport-single/

_Requires Symcon >= 5.5_

This module provides the function to summarize archive values as a report in a PDF. A single target variable is displayed with its min/max/avg values.

### Scope of functions
- Allows to create and download created PDF.
- Setting via instance configuration
- Logo selection for header is possible
- Adjustable number of records, aggregation strength, min and max values of selected variables

### software installation
The module can be found via the [Module Store](https://www.symcon.de/en/service/documentation/components/management-console/module-store/) under the category "Information"=>"Preparation" or directly by searching for "Report Module". By pressing the button "Install" the module is made available to IP-Symcon.

### Setting up the instances in IP-Symcon
- Under "Add Instance" the 'Report (PDF, Single)' module can be found using the quick filter.
  - More information about adding instances in the [Instances documentation](https://www.symcon.de/en/service/documentation/basics/instances/)

#### Configuration Page:

| Name              | Description                                                                                     |
| ----------------- | ----------------------------------------------------------------------------------------------- |
| Logo              | Selectable graphic as PNG                                                                       |
| Company           | Company name                                                                                    |
| Title             | PDF Title                                                                                       |
| Footer            | Footer line                                                                                     |
| Data Source       | Variable from which the records are created                                                     |
| Aggregation       | Defines aggregation level of the listed records (hour - year)                                   |
| Decimal separator | Selection of decimal separator comma or point.                                                  |
| Number            | Number of records listed                                                                        |
| Skip record       | If this option is enabled, the most recent incomplete record will be discarded                  |
| Tolerance (Min)   | Accepted minimum value of aggregated records. Values outside the tolerance will be ignored.     |
| Tolerance (Max)   | Accepted maximum value of the aggregated records. Values outside the tolerance will be ignored. |

#### Example document
![Example](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/benachrichtigungen/symconreport/pdfreport-single/90c14fb880-1790424938/example.jpg)

### status variables
The status variables/categories are created automatically. Deleting individual ones can lead to malfunctions.

#### Status variables
The PDF is generated as "Report (PDF)".

| Name         | Type  | Description                                                                |
| ------------ | ----- | -------------------------------------------------------------------------- |
| Report (PDF) | Media | Generated PDF which can be downloaded via Visualization or sent by e-mail. |

### Visualization
The generated PDF can be downloaded via the Visualization.

## RAC_GenerateReport

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/symconreport/pdfreport-single/rac-generatereport/

`bool RAC_GenerateReport(int $InstanceID)`

_Requires Symcon >= 5.5_

**Parameters**

- `$InstanceID` (int): ID of the Instance

**Returns** (bool): If the command could be executed successfully, it returns __TRUE__ as result, otherwise __FALSE__.

ID of the Instance

**Example**

```text
RAC_GenerateReport(12345);
```