Semaphor

CSV Downloads

Download card data as CSV files that open cleanly in Excel or load straight into import tools

You can download the data behind a card as a CSV file, either for yourself or for a system that imports it. Every CSV follows the same format, whether you download it directly, export a large table in the background, or receive it as a scheduled attachment. The same data and settings always give you the same file.

Download a card as CSV

  1. On the card, open Download (from the card's menu or the toolbar's More options).
  2. In the export dialog, choose CSV.
  3. Set the file options:
    • Delimiter: comma, semicolon or tab.
    • Encoding: how the file is encoded (see Choose an encoding).
    • Include column headers: whether the first row holds the column names.
  4. Click Export.

Small results download right away. For a table with more than 10,000 rows, choose Export full dataset under Export size: the file is prepared in the background, and you get a notification when it's ready to download. Both ways produce the same file format.

Choose an encoding

EncodingWhat it doesChoose it when
UTF-8 with BOM (best for Excel)Starts the file with a three-byte marker that tells Excel the file is UTF-8, so accented names and symbols like € display correctly. This is the default.People open the file in Excel.
UTF-8 without BOM (best for import tools)Leaves the marker out, so the file starts directly with the first column name.The file goes into accounting software, an ERP, a database or a script that reads it as plain text.

If an import tool shows  in front of the first column name, it is reading the Excel marker as text. Switch the encoding to UTF-8 without BOM.

Set the encoding for a dashboard

When a dashboard produces files for a particular system, such as an accounting import, set its encoding once so every download matches:

  1. Open the dashboard and click Edit.
  2. Open More options (the three dots) and choose Download settings.
  3. Choose a CSV encoding.
  4. Save the dashboard.

The setting applies to every CSV downloaded from the dashboard, including large background exports, and to its scheduled CSV attachments. Your viewers don't need to know about it: the export dialog opens with the dashboard's encoding already selected. Anyone can still pick a different encoding for a single download.

If you manage dashboards through the API, the setting is the exportDefaults field of the dashboard template:

{
  "exportDefaults": { "csvEncoding": "utf-8" }
}

csvEncoding is "utf-8-bom" or "utf-8". Leave exportDefaults out to use UTF-8 with BOM. A template with any other value is rejected when you save it.

Scheduled CSV attachments

CSV attachments in scheduled reports and briefings have the same Delimiter, Encoding and Include headers settings. Encoding starts at Use dashboard setting, so an attachment follows its dashboard's download settings, including any later change to them. Choose an encoding on the attachment only when that one file needs something different.

The file format

Every CSV file has the same structure:

  • Text: UTF-8, with or without the BOM marker, as chosen above.
  • Rows: every row, including the last, ends with a Windows line break (CRLF), as the CSV standard (RFC 4180) specifies. Excel, import tools and CSV libraries all read it.
  • Values: a value that contains the delimiter, a double quote or a line break is wrapped in double quotes, and any double quote inside it is doubled. For example, Acme, "West" becomes "Acme, ""West""".
  • Headers: one header row first when Include column headers is on, and never repeated, however large the file.
  • Delimiter: comma, semicolon or tab, as chosen.

Values appear the way the card formats them, such as currency symbols, date formats and number formats. See Display formats for how formats are chosen.

On this page