# CSV ZIP Export

> 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/logic/csv-zip-export/

_Requires Symcon >= 5.5_

This module provides the possibility to export the aggregated values of a variable as a CSV file in a ZIP archive.

### function scope
- Exporting aggregated data of a variable or several variables
- Export data to CSV file in a ZIP archive
- Listing of all logged variables
- Period of aggregation can be freely selected
- Aggregation level can be selected
- Cyclic creation and sending of an archive by email or ftp/ftps/sftp

### software installation
- Install the 'CSVZipExport' module via the [Module Store](https://www.symcon.de/en/service/documentation/components/management-console/module-store/).

### Setting up instances in IP-Symcon
- Under "Add Instance", the 'CSV-ZIP-Export' 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                                                                                                                                         |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| Export Options         | Option whether one or more variables per file should be exported, or a single variable used by MySQL should be exported                             |
| Selected variables     | [Export options: One file per variable, One file with multiple variables] List of variables that can be set for the CSV column                      |
| Filter                 | [Export options: MySQL] Filters the selection of logged variables                                                                                   |
| Logged Variables       | [Export options: MySQL] Selection of the variable to be exported                                                                                    |
| Create zip file        | Checkbox whether the file should be compressed into a zip archive                                                                                   |
| Decimal separator      | Select whether point or comma should be used as decimal separator                                                                                   |
| Start of aggregation   | Start of aggregation period                                                                                                                         |
| End of aggregation     | End of aggregation period                                                                                                                           |
| Decimal separator      | Selection of decimal separator comma or point.                                                                                                      |
| Aggregation Level      | Level of Aggregation                                                                                                                                |
| Export                 | The aggregated data of the variable will be exported                                                                                                |
| Cyclic send            |                                                                                                                                                     |
| Enable cyclic send     | Activates the cyclical sending of data                                                                                                              |
| Interval               | Interval at which data is sent. With “Weekly”, data is sent on Monday and with “Monthly”, data is sent on the 1st of the month at the selected time |
| Time                   | Time at which to send                                                                                                                               |
| Mail                   |                                                                                                                                                     |
| Send by mail           | Checkbox whether the data should be sent by mail                                                                                                    |
| SMPT instance          | Select the e-mail instance                                                                                                                          |
| Send mail now          | Sends a mail manually                                                                                                                               |
| FTP, FTPS, SFTP        |                                                                                                                                                     |
| Send via SFTP/FTP/FTPS | Checkbox whether the data should be sent via SFTP, FTP or FTPS                                                                                      |
| Connection type        | Connection whether to send via SFTP, FTP or FTPS                                                                                                    |
| Host                   | IP address of the server                                                                                                                            |
| Port                   | Port                                                                                                                                                |
| Username               | Username for the SFTP connection                                                                                                                    |
| Password               | Password for the SFTP connection                                                                                                                    |

## CSV_DeleteZip

Source: https://www.symcon.de/en/service/documentation/module-reference/logic/csv-zip-export/csv-deletezip/

`bool CSV_DeleteZip(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
CSV_DeleteZip(12345);
```

## CSV_Export

Source: https://www.symcon.de/en/service/documentation/module-reference/logic/csv-zip-export/csv-export/

`string CSV_Export(int $InstanceID, int $ArchiveVariable, int $AggregationStage, int $AggregationStart, int $AggregationEnd)`

_Requires Symcon >= 5.5_

**Parameters**

- `$InstanceID` (int): ID of the Instance
- `$ArchiveVariable` (int): VariableID, which should be exported
- `$AggregationStage` (int): Aggregation level analogous to [AC_GetAggregatedValues](https://www.symcon.de/en/service/documentation/module-reference/archive-control/ac-getaggregatedvalues/)
- `$AggregationStart` (int): Date/time as Unix timestamp (0 = from beginning)
- `$AggregationEnd` (int): Datum/Zeit as  Unix timestamp (0 = until now)

**Returns** (string): The relative path of the zip archive.

Datum/Zeit as  Unix timestamp (0 = until now)

**Example**

```text
CSV_Export(12345, 54321, 4, 2293574400, 3127161600);
```

## CSV_SendMail

Source: https://www.symcon.de/en/service/documentation/module-reference/logic/csv-zip-export/csv-sendmail/

`bool CSV_SendMail(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
CSV_SendMail(12345);
```