Export Custom Report to CSV
Export Custom Report to CSV allows you to automatically export Custom report from the Quant system to an FTPS server. This feature allows you to regularly export a CSV file containing a customized analysis that combines information available in various reports (e.g., Placed Product Overview, Category Opportunities, Fixture Overview, Published Planograms, etc.) and offers the option to add any additional attribute (including sales data) to the source report.
1. FTPS Setting
First, you can create a folder on FTPS into which a CSV file will be uploaded e.g. Analysis Report. However, if you set up the export correctly, the folder will be created on the FTP site automatically under the name you fill in the settings in the Primary Server Path property.
More information can be found in the manual CSV/FTPS Introduction and login.
2. Automatic Task Settings
In Automatic Tasks, create a new automatic task Export Custom Report to CSV.
Export Custom Report to CSV
Before starting the export, you need to edit the following attributes on the Settings tab:
- Check the Enabled attribute to enable the task.
- Custom Report Criteria can be imported directly from the analysis via the library.
- Fill in the Host Address (Primary Server) line with "ftp.extech.eu", your Username (Primary Server) and Password (Primary Server) for the FTPS server.
- Fill in the Server Path (Primary Server) line with the name of the folder where you have the imported file stored on your FTP.
- We also recommend filling in the Emails for Notifications field, where you can enter one or more email addresses to which error notifications will be sent.
Automatic Task Settings
Saving the configured criteria to the library
Atributes
Below is a list of other attributes that you can set as part of an automatic task:
Attribute | Description | Type |
Enabled | Specifies whether the automatic task is active and data can be sent through it. | yes/no |
Title | Custom name of the automatic task. | text |
Description | Custom description of the automatic task function. | formatted text |
Frequency | Specifies when to export files to FTPS. | time |
Notes | Notes. | text |
Emails for Notifications | One or more email addresses to which emails with error conditions will be sent. | list of strings |
Export to Zip | Check if you want the exported file to be zipped. | yes/no |
Filename | Fill in how the exported file should be named e.g., analyze_report.csv | text |
Add Timestamp to Filename | Check if you want the export date (and time) to appear in the file name. | yes/no |
Timestamp as Prefix | Check if you want the timestamp to appear as a filename prefix. If unchecked, the timestamp will appear as an extension. | yes/no |
Filename Date Format | Timestamp format in the file name, e.g., 2023-12-23-23-59-059 or 2023-12-23; learn more about the settings here. | text |
Do Not Export Empty File | If the file does not contain any data, it will not be exported. | yes/no |
Primary Server Host | By default "ftp.extech.eu", unless you use your own server. | text |
Primary Server Port | Standard 21. | text |
Primary Server Username | Your username in FTPS server. | text |
Primary Server Password | Your password in FTPS server. | text |
Primary Server FTP Client Type | Choose the FTP client type. | selection |
Primary Server Implicit SSL | Select if you want to use default SSL. If you do not check the box, explicit SSL for FTPS will be used. | yes/no |
Primary Server Plain FTP | Select if you want to use an unsecured FTP protocol. | yes/no |
Primary Server Keep Source Files Untouched | For exports, this attribute has no meaning. | yes/no |
Primary Server Path | Write the name of the folder into which the product file should be exported, e.g., Analysis Report V2. | text |
Character set | Select the character set of your CSV file. | selection |
Date and Time Format | The format in which the date and time is entered e.g. 31.12.23 23:59:59 | selection |
Date Format | Date entry format, eg 31.12.23. | selection |
Measure Unit | Set the desired unit of measurement (e.g., cm) | selection |
String value for TRUE | Write what value in the file represents "TRUE" e.g. 1. | text |
String value for FALSE | Write what value in the file represents "FALSE" e.g. 0. | text |
Fraction Digits | Number of decimal places. | text |
Decimal Point | Select the sign for the decimal point used in your CSV file. | selection |
Thousands Separator | The character you want to use to separate thousands in the file, e.g. comma - 1,000. | selection |
Column Separator | Select which column separator to use for the exported file. | selection |
Custom Report Criteria | Select saved analysis criteria from the library. | selection |
3. Launching the Automatic Task
After setting all necessary attributes, you can use the Launch button to export the file immediately or you can wait for the export to start automatically based on the set Frequency. If the automatic task is complete, a message will appear in the upper right corner indicating that the export was successful.
If the export has not succeeded, in the Latest Logs you will find more details about why did the export fail.
4. Exported File
On FTPS you can find the exported file in the appropriate folder.
5. Latest Logs
In the Latest Logs tab, you can view a summary of each execution of an automatic task, including statistics, errors, and warnings.
If you select a specific line of the log, you can view its detail via the Show Items button.