ch_Transactions.xml (gnucash-docs-4.12) | : | ch_Transactions.xml (gnucash-docs-4.13) | ||
---|---|---|---|---|
skipping to change at line 1608 | skipping to change at line 1608 | |||
<sect2 id="trans-import-csv"> | <sect2 id="trans-import-csv"> | |||
<title>Import CSV</title> | <title>Import CSV</title> | |||
<para>Clicking on | <para>Clicking on | |||
<emphasis role="bold"><guimenu>File</guimenu>-><guisubmenu>Import</guisu bmenu>-><guimenuitem>Import | <emphasis role="bold"><guimenu>File</guimenu>-><guisubmenu>Import</guisu bmenu>-><guimenuitem>Import | |||
Transactions from CSV</guimenuitem></emphasis> will bring up the CSV Tra nsaction Import | Transactions from CSV</guimenuitem></emphasis> will bring up the CSV Tra nsaction Import | |||
Assistant dialog illustrated below. | Assistant dialog illustrated below. | |||
</para> | </para> | |||
<figure pgwide="1"> | ||||
<title>The CSV Transaction Import Assistant - Introduction</title><scree | ||||
nshot id="CSV_Transaction_Import_Assistant"> | ||||
<mediaobject> | ||||
<imageobject role="html"> | ||||
<imagedata fileref="figures/CSV_Transaction_Import_Assistant.png" | ||||
srccredit="David Cousens" width="&img-w;"/> | ||||
</imageobject> | ||||
<imageobject role="fo"> | ||||
<imagedata fileref="figures/CSV_Transaction_Import_Assistant.png" | ||||
srccredit="David Cousens"/> | ||||
</imageobject> | ||||
</mediaobject> | ||||
</screenshot> | ||||
</figure> | ||||
<para>The CSV Transaction import Assistant is largely self explanatory wit h information panes which | <para>The CSV Transaction import Assistant is largely self explanatory wit h information panes which | |||
describe the functionality. | describe the functionality. | |||
</para> | </para> | |||
<formalpara> | <formalpara> | |||
<title>Dialog Navigation</title> | <title>Dialog Navigation</title> | |||
<para>Each pane displays a selction of the following navigation buttons at the bottom right: | <para>Each pane displays a selction of the following navigation buttons at the bottom right: | |||
<itemizedlist> | <itemizedlist> | |||
<listitem> | <listitem> | |||
skipping to change at line 1656 | skipping to change at line 1640 | |||
<para><emphasis role="bold"><guibutton>Next</guibutton></emphasis> Proceed to the next step in the | <para><emphasis role="bold"><guibutton>Next</guibutton></emphasis> Proceed to the next step in the | |||
assistant. | assistant. | |||
</para> | </para> | |||
</listitem> | </listitem> | |||
</itemizedlist> | </itemizedlist> | |||
The buttons displayed are determined by the validity of the traget ste p from the current | The buttons displayed are determined by the validity of the traget ste p from the current | |||
step. | step. | |||
</para> | </para> | |||
</formalpara> | </formalpara> | |||
<formalpara> | <procedure> | |||
<title>CSV Import Process Steps</title> | <title>CSV Import Process Steps</title> | |||
<para>The steps in the CSV import process are listed in the left hand pa | <highlights> | |||
ne with the current step | <para>The steps in the CSV import process are listed in the left hand | |||
highlighted. Explanatory text and the widgets to setup and carry out t | pane with the current step | |||
he step are | highlighted. Explanatory text and the widgets to setup and carry out | |||
displayed in the right hand pane. The function of the controls in each | the step are | |||
step is explained | displayed in the right hand pane. The function of the controls in ea | |||
below, in the explanatory information in the panes or in tooltips on s | ch step is explained | |||
ome controls. The | below, in the explanatory information in the panes or in tooltips on | |||
steps in the CSV import process are: | some controls. The | |||
<itemizedlist> | steps in the CSV import process are: | |||
<listitem> | </para> | |||
<para><emphasis role="bold">Transaction Import Assistant</emphasis | </highlights> | |||
>: Introductory information panel. Click | <step> | |||
<emphasis role="bold"><guibutton>Next</guibutton></emphasis> to | <title>Introductory information panel</title> | |||
continue; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | <figure pgwide="1"> | |||
<para><emphasis role="bold"><guilabel>Select File for Import</guil | <title>The CSV Transaction Import Assistant - Introduction</title><scree | |||
abel></emphasis>: Display the File | nshot id="CSV_Transaction_Import_Assistant"> | |||
selection dialog. Navigate to the file you wish to import then c | <mediaobject> | |||
lick the | <imageobject role="html"> | |||
<emphasis role="bold"><guibutton>Next</guibutton></emphasis> but | <imagedata fileref="figures/CSV_Transaction_Import_Assistant.png" | |||
ton; | srccredit="David Cousens" width="&img-w;"/> | |||
</para> | </imageobject> | |||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold">Import Preview</emphasis>: The Import | ||||
Preview pane controls set options for | ||||
the import of CSV data and provides a preview of the data to be | ||||
imported. | ||||
<figure pgwide="1"> | ||||
<title>The CSV Import Preview Pane</title><screenshot id="CSV_ | ||||
Import_Preview"> | ||||
<mediaobject> | ||||
<imageobject role="html"> | ||||
<imagedata fileref="figures/CSV_Import_transactions_Prev | ||||
iew.png" width="&img-w;" | ||||
srccredit="David Cousens"/> | ||||
</imageobject> | ||||
<imageobject role="fo"> | ||||
<imagedata fileref="figures/CSV_Import_transactions_Prev | ||||
iew.png" | ||||
srccredit="David Cousens"/> | ||||
</imageobject> | ||||
<caption> | ||||
The CSV Import Preview Pane with settings to import the | ||||
shown data. | ||||
</caption> | ||||
</mediaobject> | ||||
</screenshot> | ||||
</figure> | ||||
<itemizedlist> | ||||
<title>Import preview Controls</title> | ||||
<listitem> | ||||
<para id="trans-import-csv-save"><emphasis role="bold"><guil | ||||
abel>Load and Save Settings</guilabel></emphasis>: Once you have set all | ||||
the import parameters, you can save these settings by typi | ||||
ng in a setting a | ||||
unique name in the <guilabel>Load and Save Settings Entry< | ||||
/guilabel> combo box | ||||
and clicking the Save icon just to the right of the box. A | ||||
previously defined | ||||
settings group can be retrieved by selecting the appropria | ||||
te setting group | ||||
name from the dropdown list activated by the down arrow at | ||||
the right end of | ||||
the text box. This will set all other settings to the stor | ||||
ed values. | ||||
</para> | ||||
<para>The delete/trashcan icon to the right of the Save icon | ||||
can be used to remove the saved settings | ||||
group selected from the drop down list for the box. | ||||
</para> | ||||
<imageobject role="fo"> | ||||
<imagedata fileref="figures/CSV_Transaction_Import_Assistant.png" | ||||
srccredit="David Cousens"/> | ||||
</imageobject> | ||||
</mediaobject> | ||||
</screenshot> | ||||
</figure> | ||||
<para>Click <emphasis role="bold"><guibutton>Next</guibutton></emphasi | ||||
s> to continue; | ||||
</para> | ||||
</step> | ||||
<step> | ||||
<para><emphasis role="bold"><guilabel>Select File for Import</guilabel | ||||
></emphasis>: Display the File | ||||
selection dialog. Navigate to the file you wish to import then click | ||||
the | ||||
<emphasis role="bold"><guibutton>Next</guibutton></emphasis> button; | ||||
</para> | ||||
</step> | ||||
<step> | ||||
<para><emphasis role="bold">Import Preview</emphasis>: The Import Prev | ||||
iew pane controls set options for | ||||
the import of CSV data and provides a preview of the data to be impo | ||||
rted. | ||||
<figure pgwide="1"> | ||||
<title>The CSV Import Preview Pane</title><screenshot id="CSV_Impo | ||||
rt_Preview"> | ||||
<mediaobject> | ||||
<imageobject role="html"> | ||||
<imagedata fileref="figures/CSV_Import_transactions_Preview. | ||||
png" width="&img-w;" | ||||
srccredit="David Cousens"/> | ||||
</imageobject> | ||||
<imageobject role="fo"> | ||||
<imagedata fileref="figures/CSV_Import_transactions_Preview. | ||||
png" | ||||
srccredit="David Cousens"/> | ||||
</imageobject> | ||||
<caption> | ||||
The CSV Import Preview Pane with settings to import the show | ||||
n data. | ||||
</caption> | ||||
</mediaobject> | ||||
</screenshot> | ||||
</figure> | ||||
<itemizedlist> | ||||
<title>Import preview Controls</title> | ||||
<listitem> | ||||
<variablelist id="trans-import-csv-save"> | ||||
<title>Load and Save Settings</title> | ||||
<abstract> | ||||
<para>The settings group <emphasis role="bold"><guilabel>&ap pname; Export Settings</guilabel></emphasis> | <para>The settings group <emphasis role="bold"><guilabel>&ap pname; Export Settings</guilabel></emphasis> | |||
defines a setting group for used for the export and reimpo rt of | defines a setting group for used for the export and reimpo rt of | |||
<application>&appname;</application> transaction data - us e this if importing | <application>&appname;</application> transaction data - us e this if importing | |||
data previously exported from <application>&appname;</appl | data previously exported from <application>&appname;</appl | |||
ication>; | ication>. | |||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Account</guilabel></em | ||||
phasis>: If the data you are importing does | ||||
not specify the source account for the transaction an acco | ||||
unt can be selected | ||||
from the drop down list will import all transactions to th | ||||
e selected account. | ||||
Leave blank if your imported data specifies a source accou | ||||
nt; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>File Format</guilabel> | ||||
</emphasis>: | ||||
<itemizedlist> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Separators</guil | ||||
abel></emphasis>: Selecting this radio button will | ||||
allow you to define characters which will be used to | ||||
distinguish columns | ||||
in the input file. The default is comma separated. I | ||||
n countries using | ||||
the comma as decimal separator the semicolon is comm | ||||
on as column | ||||
separator. However spaces, tabs, colons or semicolon | ||||
s or any combination | ||||
of them may be used to separate columns in the input | ||||
file by selecting | ||||
the appropriate check boxes. You may also define cus | ||||
tom separators by | ||||
typing the required characters into the text box and | ||||
selecting the | ||||
<guilabel>Custom</guilabel> checkbox. This may be us | ||||
ed in combination | ||||
with any of the predefined separators; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Fixed-Width</gui | ||||
label></emphasis>: Selecting this radio button will | ||||
allow you to define column boundaries by double clic | ||||
king at the | ||||
appropriate positions in the sample records displaye | ||||
d in the panel | ||||
below. Single clicking in a column will narrow, wide | ||||
n or merge the | ||||
column. | ||||
</para> | ||||
</listitem> | ||||
</itemizedlist> | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Multi-split</guilabel> | ||||
</emphasis>: Selecting this check box allows | ||||
the splits for a single transaction to be defined on conse | ||||
cutive lines within | ||||
the file with each line defining a single split. If not se | ||||
lected each line is | ||||
assumed to contain the information for a single transactio | ||||
n including one or | ||||
two splits; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Miscellaneous</guilabe | ||||
l></emphasis>: The miscellaneous settings | ||||
allow you to set: | ||||
<itemizedlist> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Encoding</guilab | ||||
el></emphasis>: This is usually UTF-8, but may | ||||
differ for files from other sources; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Date Format</gui | ||||
label></emphasis>: This does not default to the | ||||
Locale setting so check it matches the data you are | ||||
importing; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Currency Format< | ||||
/guilabel></emphasis>: Select the format of the | ||||
decimal separator (full stop or comma or other) for | ||||
the currency if the | ||||
correct value is not supplied by Locale; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Leading Lines to | ||||
Skip</guilabel></emphasis>: Select the number of | ||||
header lines to skip in the imported file;<footnote | ||||
id='txn-imp-skip'><simpara> | ||||
While we only want to import <emphasis>transaction | ||||
s</emphasis>, some banks send additional informations like | ||||
a <emphasis>fieldname</emphasis> header or <emphas | ||||
is>account status</emphasis> information as header or footer.</simpara></footnot | ||||
e> | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Trailing Lines t | ||||
o Skip</guilabel></emphasis>: Select the number of | ||||
trailing lines to skip in the import file;<footnoter | ||||
ef linkend='txn-imp-skip'/> | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Skip alternate l | ||||
ines</guilabel></emphasis>: Use to skip every second | ||||
line in the import file. | ||||
</para> | ||||
</listitem> | ||||
</itemizedlist> | ||||
to match the settings for the file you are importing. Tool | ||||
tips may also | ||||
contain information on the setting and options. | ||||
</para> | </para> | |||
</listitem> | </abstract> | |||
</itemizedlist> | <varlistentry> | |||
</para> | <term>Save</term> | |||
<listitem> | ||||
<para>The import panel shows the data being imported as it is inte | <para>Once you have set all the import parameters, you can | |||
rpreted using the settings chosen to | save these settings by typing a | |||
define columns and formats. The dropdown lists in the headers fo | unique name in the <guilabel>Load and Save Settings Entr | |||
r each column of the | y</guilabel> combo box | |||
import allow you to associate a specific column in the imported | and clicking the Save icon just to the right of the box. | |||
data with a specific | </para> | |||
field in the display of a transaction in an account register. At | </listitem> | |||
a minimum to import | </varlistentry> | |||
data, columns in the imported data containing the following info | <varlistentry> | |||
rmation | <term>Load</term> | |||
<emphasis>must</emphasis> be specified: | <listitem> | |||
<itemizedlist> | <para>A previously defined settings group can be retrieved | |||
<listitem> | by selecting the appropriate setting group | |||
<para><guilabel>Date</guilabel>: of transaction; | name from the dropdown list activated by the down arrow | |||
</para> | at the right end of | |||
</listitem> | the text box. This will set all other settings to the st | |||
ored values. | ||||
<listitem> | </para> | |||
<para><guilabel>Account</guilabel>: into which transaction i | </listitem> | |||
s to be imported (or alternatively set the | </varlistentry> | |||
base account as above); | <varlistentry> | |||
</para> | <term>Delete</term> | |||
</listitem> | <listitem> | |||
<para>The delete/trashcan icon to the right of the Save ic | ||||
<listitem> | on can be used to remove the saved settings | |||
<para><guilabel>Description</guilabel>: of the transaction; | group selected from the drop down list for the box. | |||
</para> | </para> | |||
</listitem> | </listitem> | |||
</varlistentry> | ||||
<listitem> | </variablelist> | |||
<para><guilabel>Deposit or Withdrawal</guilabel>: column. | </listitem> | |||
</para> | ||||
</listitem> | <listitem> | |||
</itemizedlist> | <para><emphasis role="bold"><guilabel>Account</guilabel></emphas | |||
</para> | is>: If the data you are importing does | |||
not specify the source account for the transaction an account | ||||
<para>The dropdown list of <application>&appname;</application> tr | can be selected | |||
ansaction data fields which may be | from the drop down list will import all transactions to the se | |||
associated with a column of the imported data contains the follo | lected account. | |||
wing: | Leave blank if your imported data specifies a source account; | |||
<itemizedlist> | </para> | |||
<listitem> | </listitem> | |||
<para><emphasis role="bold"><guilabel>None</guilabel></empha | ||||
sis>: The column is not assigned to a | <listitem> | |||
transaction data field and is not imported; | <para><emphasis role="bold"><guilabel>File Format</guilabel></em | |||
</para> | phasis>: | |||
</listitem> | <itemizedlist> | |||
<listitem> | ||||
<listitem> | <para><emphasis role="bold"><guilabel>Separators</guilabel | |||
<para><emphasis role="bold"><guilabel>Date</guilabel></empha | ></emphasis>: Selecting this radio button will | |||
sis>: Ensure the date format in the column | allow you to define characters which will be used to dis | |||
matches the Miscellaneous date Format Setting; | tinguish columns | |||
</para> | in the input file. The default is comma separated. In co | |||
</listitem> | untries using | |||
the comma as decimal separator the semicolon is common a | ||||
<listitem> | s column | |||
<para><emphasis role="bold"><guilabel>Num</guilabel></emphas | separator. However spaces, tabs, colons or semicolons or | |||
is>: Transaction Num field - Use for check | any combination | |||
numbers etc.; | of them may be used to separate columns in the input fil | |||
</para> | e by selecting | |||
</listitem> | the appropriate check boxes. You may also define custom | |||
separators by | ||||
<listitem> | typing the required characters into the text box and sel | |||
<para><emphasis role="bold"><guilabel>Description</guilabel> | ecting the | |||
</emphasis>; | <guilabel>Custom</guilabel> checkbox. This may be used i | |||
</para> | n combination | |||
</listitem> | with any of the predefined separators; | |||
</para> | ||||
<listitem> | </listitem> | |||
<para><emphasis role="bold"><guilabel>Notes</guilabel></emph | ||||
asis>; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Transaction Commodity< | ||||
/guilabel></emphasis>; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Void Reason</guilabel> | ||||
</emphasis>; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Action</guilabel></emp | ||||
hasis>; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Account</guilabel></em | ||||
phasis>: This header should be matched to a | ||||
column specifying the source account for a transaction if | ||||
it is present. | ||||
Otherwise, set the source account in the | ||||
<emphasis role="bold"><guilabel>Account</guilabel></emphas | ||||
is> combo box; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Deposit</guilabel></em | ||||
phasis>: Apply this header to a column | ||||
containing the amount of the transaction. Positive amounts | ||||
in the column | ||||
generally represent an increase in the account balance and | ||||
negative amounts a | ||||
decrease in the balance (asset accounts: Checking, Savings | ||||
). In external | ||||
statements supplied by a bank for a check or savings accou | ||||
nt, a credit (Cr) is | ||||
normally an increase in the account balance and a debit (D | ||||
r) a decrease in the | ||||
account balance. In the banks eyes, your savings or checki | ||||
ng account is a | ||||
Liability to them; | ||||
</para> | ||||
<para>If the amount data is in separate columns for debits a | ||||
nd credits you will have to apply both this | ||||
heading and the Withdrawal heading. | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Withdrawal</guilabel>< | ||||
/emphasis>: Apply this header to a column with | ||||
the amount of the transaction where positive amounts in th | ||||
e column represent a | ||||
decrease in the account balance and negative amounts an in | ||||
crease in the | ||||
balance (e.g. Liability account: credit card). | ||||
</para> | ||||
<para>Where separate columns are used for debits and credit | ||||
to the account apply it to the opposite to the | ||||
column to which Deposits is applied; | ||||
</para> | ||||
<note> | ||||
<para>Some experimentation may be necessary to determine t | ||||
he correct allocation of the Deposit and | ||||
Withdrawal headings. | ||||
</para> | ||||
</note> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Price</guilabel></emph | ||||
asis>: The price for commodity transactions | ||||
and/or transactions involving currency exchange; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Memo</guilabel></empha | ||||
sis>: Additional column containing descriptive | ||||
information relevant to one split of a transaction. If in | ||||
the first line of a | ||||
multi-split import it will apply to the source account. In | ||||
subsequent | ||||
lines/splits it is applied to the transfer account defined | ||||
in that line or | ||||
allocated to it in the matcher; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Reconciled</guilabel>< | ||||
/emphasis>: Apply to a column indicating the | ||||
reconciliation status of the transaction. This generally o | ||||
nly applies to data | ||||
exported from <application>&appname;</application>; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Reconcile Date</guilab | ||||
el></emphasis>: Apply to a column which | ||||
specifies the date of reconciliation, generally only for | ||||
<application>&appname;</application> exported data; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Transfer Action</guila | ||||
bel></emphasis>; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Transfer Account</guil | ||||
abel></emphasis>: This header should be | ||||
applied to a column which specifies the transfer account f | ||||
or the second split | ||||
of a single line import and/or for subsequent splits in mu | ||||
ltiline exported | ||||
transactions; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Transfer Memo</guilabe | ||||
l></emphasis>: Apply to a column with | ||||
descriptive information relevant to a split to a transfer | ||||
account specified by | ||||
<emphasis role="bold"><guilabel>Transfer Account</guilabel | ||||
></emphasis>; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Transfer Reconciled</g | ||||
uilabel></emphasis>: Apply to a column with | ||||
reconciliation status information relevant to a split to a | ||||
transfer account | ||||
specified by <emphasis role="bold"> <guilabel>Transfer | ||||
Account</guilabel></emphasis>; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Transfer Reconcile Dat | ||||
e</guilabel></emphasis>: Apply to a column | ||||
containing a reconciliation date relevant to a split to a | ||||
transfer account | ||||
previously specified in <emphasis role="bold"><guilabel>Tr | ||||
ansfer | ||||
Account</guilabel></emphasis>. | ||||
</para> | ||||
</listitem> | ||||
</itemizedlist> | ||||
</para> | ||||
<para>The <guilabel>Skip Errors</guilabel> check box will skip try | <listitem> | |||
ing to import any rows with errors in | <para><emphasis role="bold"><guilabel>Fixed-Width</guilabe | |||
matching the columns. | l></emphasis>: Selecting this radio button will | |||
</para> | allow you to define column boundaries by double clicking | |||
at the | ||||
appropriate positions in the sample records displayed in | ||||
the panel | ||||
below. Single clicking in a column will narrow, widen or | ||||
merge the | ||||
column. | ||||
</para> | ||||
</listitem> | ||||
</itemizedlist> | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Multi-split</guilabel></em | ||||
phasis>: Selecting this check box allows | ||||
the splits for a single transaction to be defined on consecuti | ||||
ve lines within | ||||
the file with each line defining a single split. If not select | ||||
ed each line is | ||||
assumed to contain the information for a single transaction in | ||||
cluding one or | ||||
two splits; | ||||
</para> | ||||
<para>Multi-split is a gnucash specific variant of a csv file to | ||||
support easier | ||||
data preparation. | ||||
</para> | ||||
<para>Each line should define one split by | ||||
<variablelist> | ||||
<varlistentry> | ||||
<term>transaction-specific fields</term> | ||||
<listitem> | ||||
<para>date and description as bare minimum | ||||
<emphasis>and</emphasis> | ||||
</para> | ||||
</listitem> | ||||
</varlistentry> | ||||
<varlistentry> | ||||
<term>split specific fields</term> | ||||
<listitem> | ||||
<para>account and deposit/withdrawal as bare minimum. | ||||
</para> | ||||
</listitem> | ||||
</varlistentry> | ||||
</variablelist> | ||||
</para> | ||||
<tip> | ||||
<para>There is a convenience feature built-in so you don't hav | ||||
e to repeat the | ||||
transaction fields if the split belongs to the same transact | ||||
ion as the | ||||
previous one (though you can repeat them if that makes csv p | ||||
reparation | ||||
easier). | ||||
</para> | ||||
</tip> | ||||
<example> | ||||
<title>Sample Multi-split.csv</title> | ||||
<programlisting language="csv">Date,Description,Deposit,Accoun | ||||
t | ||||
05/03/2006,Grocery Store,-45.21,Assets:Checking | ||||
,,45.21,Expenses:Groceries | ||||
14/03/2006,Employers R Us,670.00,Assets:Checking | ||||
,,180.00,Expenses:Taxes:Federal | ||||
,,90.00,Expenses:Taxes:Medicare | ||||
,,60.00,Expenses:Taxes:Social Security | ||||
,,-1000.00,Income:Salary</programlisting> | ||||
</example> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Miscellaneous</guilabel></ | ||||
emphasis>: The miscellaneous settings | ||||
allow you to set: | ||||
<itemizedlist> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Encoding</guilabel>< | ||||
/emphasis>: This is usually UTF-8, but may | ||||
differ for files from other sources; | ||||
</para> | ||||
</listitem> | ||||
<para>When you are happy with all the import settings, <link linke | <listitem> | |||
nd="trans-import-csv-save">save</link> | <para><emphasis role="bold"><guilabel>Date Format</guilabe | |||
them if you will use the same settings again, then press the | l></emphasis>: This does not default to the | |||
<emphasis role="bold"><guibutton>Next</guibutton></emphasis> but | Locale setting so check it matches the data you are impo | |||
ton. | rting; | |||
</para> | </para> | |||
</listitem> | </listitem> | |||
<listitem> | <listitem> | |||
<para><emphasis role="bold">Match Import and <application>&appname | <para><emphasis role="bold"><guilabel>Currency Format</gui | |||
;</application> accounts</emphasis>: | label></emphasis>: Select the format of the | |||
This window allows you to map the accounts identified in the acc | decimal separator (full stop or comma or other) for the | |||
ount columns | currency if the | |||
(Account and Transfer Account) with accounts in the | correct value is not supplied by Locale; | |||
<application>&appname;</application> account tree (Account name) | </para> | |||
. Double click on a | </listitem> | |||
row to bring up a dialog to select the matching <application>&ap | ||||
pname;</application> | ||||
account. If you have previously imported transactions to this ac | ||||
count and account | ||||
mappings can be matched automatically, this window will not be d | ||||
isplayed. When you | ||||
have selected a match for all accounts, click on the | ||||
<emphasis role="bold"><guibutton>Next</guibutton></emphasis> but | ||||
ton; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | <listitem> | |||
<para><emphasis role="bold">Transaction Information</emphasis>: Th | <para><emphasis role="bold"><guilabel>Leading Lines to Ski | |||
e Transaction Information panel allows | p</guilabel></emphasis>: Select the number of | |||
review of data entry settings so far. Clicking Next will perform | header lines to skip in the imported file;<footnote id=' | |||
checks on the data. | txn-imp-skip'><simpara> | |||
If there are errors you will be returned to the <emphasis role=" | While we only want to import <emphasis>transactions</e | |||
bold">Import | mphasis>, some banks send additional informations like | |||
Preview</emphasis> pane to edit the settings. For no errors you | a <emphasis>fieldname</emphasis> header or <emphasis>a | |||
proceed to the next | ccount status</emphasis> information as header or footer.</simpara></footnote> | |||
step; | </para> | |||
</para> | </listitem> | |||
</listitem> | ||||
<listitem> | <listitem> | |||
<para><emphasis role="bold">Match Transactions</emphasis>: Clickin | <para><emphasis role="bold"><guilabel>Trailing Lines to Sk | |||
g on Match Transactions will then bring | ip</guilabel></emphasis>: Select the number of | |||
up the main <link linkend="trans-import-matcher">Import Matcher< | trailing lines to skip in the import file;<footnoteref l | |||
/link> window. The | inkend='txn-imp-skip'/> | |||
Import Matcher is described in a separate section; | </para> | |||
</para> | </listitem> | |||
</listitem> | ||||
<listitem> | <listitem> | |||
<para><emphasis role="bold">Import Summary</emphasis>: <applicatio | <para><emphasis role="bold"><guilabel>Skip alternate lines | |||
n>&appname;</application> displays a | </guilabel></emphasis>: Use to skip every second | |||
summary of the imported data. Click on the | line in the import file. | |||
<emphasis role="bold"><guibutton>Close</guibutton></emphasis> to | </para> | |||
exit the wizard. | </listitem> | |||
</para> | </itemizedlist> | |||
</listitem> | to match the settings for the file you are importing. Tooltips | |||
</itemizedlist> | may also | |||
</para> | contain information on the setting and options. | |||
</formalpara> | </para> | |||
</listitem> | ||||
</itemizedlist> | ||||
</para> | ||||
<para>The import panel shows the data being imported as it is interpre | ||||
ted using the settings chosen to | ||||
define columns and formats. The dropdown lists in the headers for ea | ||||
ch column of the | ||||
import allow you to associate a specific column in the imported data | ||||
with a specific | ||||
field in the display of a transaction in an account register. At a m | ||||
inimum to import | ||||
data, columns in the imported data containing the following informat | ||||
ion | ||||
<emphasis>must</emphasis> be specified: | ||||
<itemizedlist> | ||||
<listitem> | ||||
<para><guilabel>Date</guilabel>: of transaction; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><guilabel>Account</guilabel>: into which transaction is to | ||||
be imported (or alternatively set the | ||||
base account as above); | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><guilabel>Description</guilabel>: of the transaction; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><guilabel>Deposit or Withdrawal</guilabel>: column. | ||||
</para> | ||||
</listitem> | ||||
</itemizedlist> | ||||
</para> | ||||
<para>The dropdown list of <application>&appname;</application> transa | ||||
ction data fields which may be | ||||
associated with a column of the imported data contains the following | ||||
: | ||||
<itemizedlist> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>None</guilabel></emphasis> | ||||
: The column is not assigned to a | ||||
transaction data field and is not imported; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Date</guilabel></emphasis> | ||||
: Ensure the date format in the column | ||||
matches the Miscellaneous date Format Setting; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Num</guilabel></emphasis>: | ||||
Transaction Num field - Use for check | ||||
numbers etc.; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Description</guilabel></em | ||||
phasis>; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Notes</guilabel></emphasis | ||||
>; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Transaction Commodity</gui | ||||
label></emphasis>; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Void Reason</guilabel></em | ||||
phasis>; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Action</guilabel></emphasi | ||||
s>; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Account</guilabel></emphas | ||||
is>: This header should be matched to a | ||||
column specifying the source account for a transaction if it i | ||||
s present. | ||||
Otherwise, set the source account in the | ||||
<emphasis role="bold"><guilabel>Account</guilabel></emphasis> | ||||
combo box; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Deposit</guilabel></emphas | ||||
is>: Apply this header to a column | ||||
containing the amount of the transaction. Positive amounts in | ||||
the column | ||||
generally represent an increase in the account balance and neg | ||||
ative amounts a | ||||
decrease in the balance (asset accounts: Checking, Savings). I | ||||
n external | ||||
statements supplied by a bank for a check or savings account, | ||||
a credit (Cr) is | ||||
normally an increase in the account balance and a debit (Dr) a | ||||
decrease in the | ||||
account balance. In the banks eyes, your savings or checking a | ||||
ccount is a | ||||
Liability to them; | ||||
</para> | ||||
<para>If the amount data is in separate columns for debits and c | ||||
redits you will have to apply both this | ||||
heading and the Withdrawal heading. | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Withdrawal</guilabel></emp | ||||
hasis>: Apply this header to a column with | ||||
the amount of the transaction where positive amounts in the co | ||||
lumn represent a | ||||
decrease in the account balance and negative amounts an increa | ||||
se in the | ||||
balance (e.g. Liability account: credit card). | ||||
</para> | ||||
<para>Where separate columns are used for debits and credit to t | ||||
he account apply it to the opposite to the | ||||
column to which Deposits is applied; | ||||
</para> | ||||
<note> | ||||
<para>Some experimentation may be necessary to determine the c | ||||
orrect allocation of the Deposit and | ||||
Withdrawal headings. | ||||
</para> | ||||
</note> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Price</guilabel></emphasis | ||||
>: The price for commodity transactions | ||||
and/or transactions involving currency exchange; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Memo</guilabel></emphasis> | ||||
: Additional column containing descriptive | ||||
information relevant to one split of a transaction. If in the | ||||
first line of a | ||||
multi-split import it will apply to the source account. In sub | ||||
sequent | ||||
lines/splits it is applied to the transfer account defined in | ||||
that line or | ||||
allocated to it in the matcher; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Reconciled</guilabel></emp | ||||
hasis>: Apply to a column indicating the | ||||
reconciliation status of the transaction. This generally only | ||||
applies to data | ||||
exported from <application>&appname;</application>; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Reconcile Date</guilabel>< | ||||
/emphasis>: Apply to a column which | ||||
specifies the date of reconciliation, generally only for | ||||
<application>&appname;</application> exported data; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Transfer Action</guilabel> | ||||
</emphasis>; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Transfer Account</guilabel | ||||
></emphasis>: This header should be | ||||
applied to a column which specifies the transfer account for t | ||||
he second split | ||||
of a single line import and/or for subsequent splits in multil | ||||
ine exported | ||||
transactions; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Transfer Memo</guilabel></ | ||||
emphasis>: Apply to a column with | ||||
descriptive information relevant to a split to a transfer acco | ||||
unt specified by | ||||
<emphasis role="bold"><guilabel>Transfer Account</guilabel></e | ||||
mphasis>; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Transfer Reconciled</guila | ||||
bel></emphasis>: Apply to a column with | ||||
reconciliation status information relevant to a split to a tra | ||||
nsfer account | ||||
specified by <emphasis role="bold"> <guilabel>Transfer | ||||
Account</guilabel></emphasis>; | ||||
</para> | ||||
</listitem> | ||||
<listitem> | ||||
<para><emphasis role="bold"><guilabel>Transfer Reconcile Date</g | ||||
uilabel></emphasis>: Apply to a column | ||||
containing a reconciliation date relevant to a split to a tran | ||||
sfer account | ||||
previously specified in <emphasis role="bold"><guilabel>Transf | ||||
er | ||||
Account</guilabel></emphasis>. | ||||
</para> | ||||
</listitem> | ||||
</itemizedlist> | ||||
</para> | ||||
<para>The <guilabel>Skip Errors</guilabel> check box will skip trying | ||||
to import any rows with errors in | ||||
matching the columns. | ||||
</para> | ||||
<para>When you are happy with all the import settings, <link linkend=" | ||||
trans-import-csv-save">save</link> | ||||
them if you will use the same settings again, then press the | ||||
<emphasis role="bold"><guibutton>Next</guibutton></emphasis> button. | ||||
</para> | ||||
</step> | ||||
<step> | ||||
<para><emphasis role="bold">Match Import and <application>&appname;</a | ||||
pplication> accounts</emphasis>: | ||||
This window allows you to map the accounts identified in the account | ||||
columns | ||||
(Account and Transfer Account) with accounts in the | ||||
<application>&appname;</application> account tree (Account name). Do | ||||
uble click on a | ||||
row to bring up a dialog to select the matching <application>&appnam | ||||
e;</application> | ||||
account. If you have previously imported transactions to this accoun | ||||
t and account | ||||
mappings can be matched automatically, this window will not be displ | ||||
ayed. When you | ||||
have selected a match for all accounts, click on the | ||||
<emphasis role="bold"><guibutton>Next</guibutton></emphasis> button; | ||||
</para> | ||||
</step> | ||||
<step> | ||||
<para><emphasis role="bold">Transaction Information</emphasis>: The Tr | ||||
ansaction Information panel allows | ||||
review of data entry settings so far. Clicking Next will perform che | ||||
cks on the data. | ||||
If there are errors you will be returned to the <emphasis role="bold | ||||
">Import | ||||
Preview</emphasis> pane to edit the settings. For no errors you proc | ||||
eed to the next | ||||
step; | ||||
</para> | ||||
</step> | ||||
<step> | ||||
<para><emphasis role="bold">Match Transactions</emphasis>: Clicking on | ||||
Match Transactions will then bring | ||||
up the main <link linkend="trans-import-matcher">Import Matcher</lin | ||||
k> window. The | ||||
Import Matcher is described in a separate section; | ||||
</para> | ||||
</step> | ||||
<step> | ||||
<para><emphasis role="bold">Import Summary</emphasis>: <application>&a | ||||
ppname;</application> displays a | ||||
summary of the imported data. Click on the | ||||
<emphasis role="bold"><guibutton>Close</guibutton></emphasis> to exi | ||||
t the wizard. | ||||
</para> | ||||
</step> | ||||
</procedure> | ||||
<caution> | <caution> | |||
<para>Multi-split imports of multicurrency transactions and commodity tr ansactions are experimental and | <para>Multi-split imports of multicurrency transactions and commodity tr ansactions are experimental and | |||
may currently experience some errors. Please experiment and report any bugs encountered. | may currently experience some errors. Please experiment and report any bugs encountered. | |||
</para> | </para> | |||
<!--FIXME remove when bug fixes are incorporated.--> | <!--FIXME remove when bug fixes are incorporated.--> | |||
</caution> | </caution> | |||
</sect2> | </sect2> | |||
<sect2 id="trans-import-MT940-MT942-DTAUS"> | <sect2 id="trans-import-MT940-MT942-DTAUS"> | |||
End of changes. 13 change blocks. | ||||
530 lines changed or deleted | 588 lines changed or added |