This documentation is for an old version of Dataplane Reports.

View the latest documentation, or the list of documentation for all versions.


Dataplane report exports in Comma Separated Value (CSV) format are suitable for batch processing or for importing into other applications that only accept CSV-format files.

To export the currently viewed Dataplane report, click the Export toolbar dropdown and select CSV Format. A version of the report results in the desired file format will then begin downloading.

CSV Format Details

When exporting reports to a CSV-format file, note the following:

  • only tabular results data is included. The plain-text CSV file format does not support graphic charts or any other richly-formatted data.
  • by default a comma (,) is used to separate the individual fields on a line.

  • character set encoding is always UTF-8.

  • all dates are expressed in the ISO date format as "yyyy-mm-dd". For example, 2013-07-01 represents July 1, 2013. 

Customizing Individual Reports

Using a Customizer Script

With a Dataplane Customizer Script, you can customize the CSV export on a report-by-report basis.

If you're not yet familiar with using Customizer Scripts in your reports, read through Customizing Reports with Scripts for some background and then return back here to get going.

Here's the general syntax for a Customizer Script that sets a property of the CSV export:

customizeExport {
	format "csv" <property1> <value1> <property2> <value2>

The words format "csv" indicate you are customizing the CSV export format, and following that are one or more pairs of properties and values.

For example:

customizeExport {
	format "csv" separator ";"			// export the file using semi-colons to separate values
customizeExport {
	format "csv" separator "\t"        	// export the file using tabs to separate values

Customizer Script Options

The following list shows the available properties and values that can be used to customize CSV exports:


<single character> 

Specifies the character to use as a field separator on each line of the file.

Any single character in quotes may be used. Common options are:

  • "," – comma (default)
  • ";" – semi-colon
  • ":" – colon
  • "|" – bar
  • "/" – slash

Use the following special notation to indicate a tab character:

  • "\t"– tab

Page Contents

Copyright © 2023 Appfire Technologies, LLC · All rights reserved · Contact Us · Powered by Atlassian Confluence