Formats of Importable Files (Full-featured Version)
This manual is in pilot operation.
|
File and Row Formats
The file to be imported must be in CSV format (comma-separated values). However, if there are rows at the beginning of the import target file that you do not wish to import, you can skip them by specifying the number of those rows in "Header Skip Rows" in the import specification.
Each row, except those skipped, will have several fields, one or more of which will be value fields, i.e., fields holding the values you wish to import. Multiple value fields can be set.
The number of fields and the meaning of each field depend on the design, meaning the "Data Source Fields" in the Import Specification correspond to each field in order. However, if no value fields are defined in the import specification, an implicit value field is added at the end of the defined data source fields' sequence.
As newline characters, both LF (Line Feed) and CR (Carriage Return) can be used. If LF and CR occur consecutively (LF + CR, CR + LF), they are considered as a single newline.
Fields should be separated by a comma, and spaces before and after a comma are ignored. Values can be enclosed in double quotes (if the value contains a comma, the entire value must be enclosed in double quotes). Newline characters within a double-quoted string are not considered as row delimiters in the CSV file. Furthermore, if a string value for a field contains two consecutive double quotes, they are read as a single double quote [1].
Blank lines in the import file are skipped.
Correspondence between Key Fields and Dimensions
Fields whose labels match any of the labels used in the dimensions of the target ledger are called key fields. If a key field is a data source field, its pre-conversion value is obtained from the row data of the import file. If a key field is a derived field, its pre-conversion value is calculated by a calculation formula. In both cases, the values are then converted, and the post-conversion values are associated with dimension member labels. Translation tables are used for conversion. Both the calculation and conversion specifications depend on the design (specified by the form designer in the Import Specification).
It’s permissible for there to be multiple rows in the CSV file that correspond to the same combination of members as a result of calculating and converting the values of key fields. In that case, if the data type of the ledger cell corresponding to that combination of members is numeric (flow/balance), the cell value is cleared at the beginning of the process, and then the values from those multiple rows are sequentially added. If the data type is not numeric, the value from the last row is written.
Key fields and value fields are not mutually exclusive. A field can be both a key field and a value field, although such situations are rare.
Format of Value Fields
Value fields can hold values in the form of amounts/numbers, Boolean values, enumerated values, or string values, but they must match the data type of the ledger cell where the values are to be stored.
Format for Numeric Values
Numeric data may include plus ( + ) and minus ( - ) signs, commas ( , ) for thousand separators, and decimal points ( . ).
-
Place the plus or minus sign either before or after the number. If no sign is present, the value is considered positive.
-
Use double quotes around the number if you use commas.
-
Keep decimal values to a maximum of 4 digits. Values exceeding 4 digits may not be correctly read.
The sign of numeric data can be chosen among options like 'debit plus', 'credit plus', or according to the debit/credit type of the account (specified in the "Sign Display Type" in the import specification).
When importing data by change account, set the sign according to the "Sign Display Type" in the import specification as follows:
-
If "Sign Display Type" is 'debit plus', debit increases are plus, and credit increases are minus.
-
If "Sign Display Type" is 'credit plus', debit increases are minus, and credit increases are plus.
-
If "Sign Display Type" is 'according to account attribute', set it according to the 'debit/credit type' of the account. That is:
-
For debit accounts, if the 'sign' of the change account is 'balance or increase', debit increases are considered plus, and if the 'sign' is 'decrease', debit increases are considered minus.
-
For credit accounts, the reverse applies.
-
Format for Boolean Values
For importing Boolean data, specify either TRUE or FALSE in the value field (case-insensitive).
Format for Enumerated Values
For importing enumerated data, specify the label of the value in the value field (case-insensitive).
Format for String Values
For importing string values, simply specify the string in the value field. However, if the string contains a comma, make sure to enclose the entire string in double quotes. Additionally, if the string value contains double quotes, replace each double quote with two consecutive double quotes for representation (to avoid confusion with the double quotes that enclose the entire value).
Encoding
The encoding to be applied to the import file can be specified by the user at the time of operation (independent of the form design). Correctly specifying the encoding is crucial when reading string data that includes non-ASCII characters, such as Japanese characters. The following two encodings are available when importing from the [browser]:
-
UTF-8
-
Shift JIS
When importing using a requester, the encoding can be specified in the XML declaration at the beginning of the request XML.