Format requirements for CSV files

This guide explains how to format Comma-Separated Values (CSV) files for importing asset data into the Assets & Inventory Plugin for Jira. By following these guidelines, you can ensure the successful import of your data using CSV files.

General CSV format

CSV files store data in a tabular format similar to spreadsheets. Each line represents a record, and commas (",") separate the values (fields) within that record.

Format type requirements

1. Headers: The first line of your CSV file must contain column headers that describe the data in each field. For details, refer to Import assets from CSV.

2. Line Breaks: Each record (data row) should be on a separate line, separated by a line break character (CRLF or LF). For example:

   Asset name,bbb,ccc CRLF zzz,yyy,xxx CRLF

   The last record in the file may or may not have an ending line break:

   Asset name,bbb,ccc CRLF zzz,yyy,xxx

3. Consistent Fields: All rows in your file must have the same number of fields throughout the file.

4. Field Quoting: Fields can be enclosed in double quotes ("). This is mandatory if a field contains commas, line breaks (CRLF), or double quotes itself.

   "Asset name","b CRLF bb","ccc" CRLF zzz,yyy,xxx

   If fields are not enclosed with double quotes, then double quotes may not appear inside the fields. For example:

   If double quotes are used to enclose fields, then a double quote appearing inside a field must be escaped by preceding it with another double quote. For example:

References and additional information

• For a comprehensive understanding of CSV formatting, see RFC 4180.

• Newline Characters: Both Windows standard (CR+LF) and Unix-like systems (LF) are acceptable for new line characters. More details can be found in Wikipedia's Newline article.

• Handling of New Line Characters in Fields: When uploading a CSV file with newline characters in fields other than the Text Area Field, the text will be saved. However, it is important to note that only the Text Area Field retains the new line upon editing. Other field types, such as Text Field, will not preserve new lines after editing.

Sample CSV file

Below is a text representation of an example CSV file as it might appear in MS Excel. The form includes an asset name, and two additional fields: Author [Text] and Notes [TextArea]. The first line is the header from the template:

Open

This is the text representation of the file: