diff --git a/manual/C/Help_ch_Reports.xml b/manual/C/Help_ch_Reports.xml index ad6272c21..2f18460fa 100644 --- a/manual/C/Help_ch_Reports.xml +++ b/manual/C/Help_ch_Reports.xml @@ -221,7 +221,7 @@ - Common Report Options + Common Report Options Many reports share similar options. Some common ones include: @@ -2192,7 +2192,7 @@ Income (type INCOME) Report Options - See in the Configuring + See in the Configuring Reports and Charts section of this help manual for more details of the common options. @@ -2206,26 +2206,26 @@ Income (type INCOME) Report name: Enter a descriptive name for this report - see - . + . Stylesheet: Select a style sheet for this report - see - . + . To: Select a date to report on or a named date. Transactions up to and including the selected date will be used to calculate the outstanding aged - balances. See . + balances. See . Report's currency: Select the currency to display the values in - see - + @@ -2487,7 +2487,7 @@ Income (type INCOME) Report Options - See in the Configuring + See in the Configuring Reports and Charts section of this help manual for more details of the common options. @@ -2501,26 +2501,26 @@ Income (type INCOME) Report name: Enter a descriptive name for this report - see - . + . Stylesheet: Select a style sheet for this report - see - . + . To: Select a date to report on or a named date. Transactions up to and including the selected date will be used to calculate the outstanding aged - balances. See . + balances. See . Report's currency: Select the currency to display the values in - see - . + . diff --git a/manual/C/Help_ch_Transactions.xml b/manual/C/Help_ch_Transactions.xml index 889020ec3..2024e219a 100644 --- a/manual/C/Help_ch_Transactions.xml +++ b/manual/C/Help_ch_Transactions.xml @@ -2098,486 +2098,505 @@ Translators: Generic Transaction Import Matcher -
- The Generic Transaction Import Matcher Window - - - - - - - - - - - This is an image of the import transaction matcher window after opening a file to - import. - - - -
- - The Import Matcher checks whether an imported transaction matches an existing transaction already - recorded in &appname; within a predefined time window (~+_42 - days) for the account into which the transactions are being imported. A match probablity is - calculated based on the Date, Amount, Transaction ID's (if present), Check numbers (if - present) and the Description and split Memo fields. Exact matches will generate a high match - probability and flag a transaction as matching an existing transaction and therefore not to - be imported. If there is a lower quality match to an existing transaction, the imported - transaction may be flagged for updating of non-matching information in the - &appname; record of the matching transaction. These decisions can - be overridden by the user. - - - If no matching transaction can be identified the transaction will be flagged for import. The matcher - will attempt to assign a transfer account based on matches between tokenized information for - previously imported transactions stored in lists associated with the transfer accounts which - were assigned to them on import. - - - If a good match is obtained, the transfer account is assigned and the transaction is flagged as - ready to import. - - - - - If a transfer account cannot be assigned, the transaction will be flagged for import and manual - assignment of the transfer account by the user. By default, if no transfer account is - assigned, transactions will be assigned to an Imbalance account on import. This is to - indicate that they need an appropriate account assigned to them. - - - - - - The generic import transaction matcher is invoked when transaction data is imported using any of the - following import formats: - - - QIF; - - - - - OFX/QXF; - - - - - CSV; - - - - - MT940; - - - - - MT942; - - - - - DTAUS. - - - - + + Introduction +
+ The Generic Transaction Import Matcher Window + + + + - This window has the following - - Controls: + + + - - List of downloaded transactions: Table - containing information from the imported transactions. - - + + This is an image of the import transaction matcher window after opening a file to + import. + + + +
- - Show Account column: Checkbox to - display the account into which the transactions are being imported. This is the - second column labelled Account in the screenshot; - - + The Import Matcher checks whether an imported transaction matches an existing transaction already + recorded in &appname; within a predefined time window (~+_42 + days) for the account into which the transactions are being imported. A match probablity is + calculated based on the Date, Amount, Transaction ID's (if present), Check numbers (if + present) and the Description and split Memo fields. Exact matches will generate a high match + probability and flag a transaction as matching an existing transaction and therefore not to + be imported. If there is a lower quality match to an existing transaction, the imported + transaction may be flagged for updating of non-matching information in the + &appname; record of the matching transaction. These decisions can + be overridden by the user. + + + If no matching transaction can be identified the transaction will be flagged for import. The matcher + will attempt to assign a transfer account based on matches between tokenized information for + previously imported transactions stored in lists associated with the transfer accounts which + were assigned to them on import. + + + If a good match is obtained, the transfer account is assigned and the transaction is flagged as + ready to import. + + - - Show Memo column: Checkbox to - display the Memo from the imported transactions after the column - labelled Description; - - + + If a transfer account cannot be assigned, the transaction will be flagged for import and manual + assignment of the transfer account by the user. By default, if no transfer account is + assigned, transactions will be assigned to an Imbalance account on import. This is to + indicate that they need an appropriate account assigned to them. + + + + +
- - Show matched information: Checkbox to - display the matched transaction which has been already imported or entered into - &appname;. If there is one, this will be a line with a white - background (by default) after the imported transaction. This is either the manually selected match - if one has been selected or the best possible match otherwise; - - + + Import Formats + The generic import transaction matcher is invoked when transaction data is imported using any of the + following import formats: + + + QIF; + + - - Append: Checkbox to indicate - that when updating and clearing a matched transaction, the imported Description - and Notes are to be appended to the matched transaction - Description and Notes respectively, rather than - overwriting them. When the OK - button is clicked, the state of the checkbox is saved so the next import for that account - will automatically default it to the saved state; - - + + OFX/QXF; + + - - Reconcile after match: Checkbox to - automatically start the reconciliation process after transactions have been matched and imported; - - + + CSV; + + - - Help: Display a popup help window; - - + + MT940; + + - - Cancel: Close this window without importing - transaction data; - - + + MT942; + + - - OK: Close this window importing transaction - data; - - - - + + DTAUS. + + +
+
+ - The List of downloaded transactions has the following columns which display the - following information for each of the downloaded transactions: - + + Controls + + List of Controls - - Columns in <quote>List of Downloaded Transactions</quote> + This window has the following + + Controls: - - Date - The date supplied with the downloaded - transaction; - - + + List of downloaded transactions: Table + containing information from the imported transactions. + + - - Account - The import or base account to which - the transactions will be imported (optional see above); - - + + Show Account column: Checkbox to + display the account into which the transactions are being imported. This is the + second column labelled Account in the screenshot; + + - - Amount - The amount of the transaction (split - to the import or base account); - - + + Show Memo column: Checkbox to + display the Memo from the imported transactions after the column + labelled Description; + + - - Description - The description of the - transaction; - - + + Show matched information: Checkbox to + display the matched transaction which has been already imported or entered into + &appname;. If there is one, this will be a line with a white + background (by default) after the imported transaction. This is either the manually selected match + if one has been selected or the best possible match otherwise; + + - - Memo - The memo for the split to the import or - base account of the transaction (optional see above); - - + + Append: Checkbox to indicate + that when updating and clearing a matched transaction, the imported Description + and Notes are to be appended to the matched transaction + Description and Notes respectively, rather than + overwriting them. When the OK + button is clicked, the state of the checkbox is saved so the next import for that account + will automatically default it to the saved state; + + - - A - Add - Checkbox which indicates that the - transaction is to be imported as a new transaction; - - + + Reconcile after match: Checkbox to + automatically start the reconciliation process after transactions have been matched and imported; + + - - U+C - Update and Clear - Checkbox which indicates that the - transaction matches an existing transaction but has some differences and the existing - transaction will be updated with the different information; - - + + Help: Display a popup help window; + + - - C - Clear - Checkbox which indicates that the - transaction matches an existing transaction and will not be imported; - - + + Cancel: Close this window without importing + transaction data; + + - - Info - For transactions which have been - matched to an existing transaction, this column displays a bar indicating the quality of the match; + + OK: Close this window importing transaction + data; + + + - + - - Additional Comments - Shows what is to happen to the - transaction and the transfer account if known; + + List of downloaded transactions + The List of downloaded transactions has the following columns which display the + following information for each of the downloaded transactions: - -
- - In addition to the checkboxes, the import status of each transaction is indicated by the background - color of the transaction row. The checkbox state, background colors and their meaning are - described in . - - - - Import Status of Transactions - - - - + + Columns in <quote>List of Downloaded Transactions</quote> - + + Date - The date supplied with the downloaded + transaction; + + - - - - Checked Box - + + Account - The import or base account to which + the transactions will be imported (optional see above); + + - - Background - + + Amount - The amount of the transaction (split + to the import or base account); + + - - Meaning - - - + + Description - The description of the + transaction; + + - - - - A - + + Memo - The memo for the split to the import or + base account of the transaction (optional see above); + + - - - - Gold - + + A - Add - Checkbox which indicates that the + transaction is to be imported as a new transaction; + + - - - - No matches, flagged for input and no transfer account matched – Import as a - new transaction. Intervention required to select a transfer account. - - + + U+C - Update and Clear - Checkbox which indicates that the + transaction matches an existing transaction but has some differences and the existing + transaction will be updated with the different information; + + - - - - - DarkSeaGreen1 - + + C - Clear - Checkbox which indicates that the + transaction matches an existing transaction and will not be imported; + + - - - - No matches detected, flagged for input and a transfer account is matched – - Import as a new transaction. Reconciliation status will be set as cleared (c) on - import. Intervention is not required. - - - - - - U+C - - - - - - DarkSeaGreen1 - + + Info - For transactions which have been + matched to an existing transaction, this column displays a bar indicating the quality of the match; + + - - - - Matches an existing transaction but not exactly on date and/or amount – - Intervention not required, import and update. Reconciliation status will be set as - cleared (c) on import. - - - - - - C - - - - - - DarkSeaGreen1 - + + Additional Comments - Shows what is to happen to the + transaction and the transfer account if known; + + + + + + + Import Status + In addition to the checkboxes, the import status of each transaction is indicated by the background + color of the transaction row. The checkbox state, background colors and their meaning are + described in . + + +
+ Import Status of Transactions + + + + + + + + + + + + Checked Box + + + + Background + + + + Meaning + + + + + + + + A + + + + + + Gold + + + + + + No matches, flagged for input and no transfer account matched – Import as a + new transaction. Intervention required to select a transfer account. + + + + + + + + DarkSeaGreen1 + + + + + + No matches detected, flagged for input and a transfer account is matched – + Import as a new transaction. Reconciliation status will be set as cleared (c) on + import. Intervention is not required. + + + + + + U+C + + + + + + DarkSeaGreen1 + + + + + + Matches an existing transaction but not exactly on date and/or amount – + Intervention not required, import and update. Reconciliation status will be set as + cleared (c) on import. + + + + + + C + + + + + + DarkSeaGreen1 + + + + + + Matches an existing transaction: – Not to be imported. The existing + transaction reconciliation status will be as cleared (c) on import. Intervention is + not required + + + + + + + + + + Brown1 + + + + + + Transaction has poor matches and no action was set: – Not to be imported. + Intervention required. + + + + + + + + + + Cornflower Blue + + + + + + Row is selected + + + + +
+ + + The colors illustrated here are the defaults for &appname; specified in + gnucash-fallback-310.css. + You may experience different colors if the gtk-3.0 CSS files have been modified + + - - - - Matches an existing transaction: – Not to be imported. The existing - transaction reconciliation status will be as cleared (c) on import. Intervention is - not required - - + You may always intervene manually to + + + change the import action by selecting another checkbox (or none) and/or + + - - + + manually assign a different transfer account + + + + after reviewing the matched transactions and accounts and the automatically selected + actions. + - - - - Brown1 - + Multi row selection is enabled for the list of downloaded transactions. The following operations can + be performed on the list of downloaded transactions: + - - - - Transaction has poor matches and no action was set: – Not to be imported. - Intervention required. - - + + + Click Button1 + (see Mouse Buttons) on a row: + Select this row (row is displayed with a blue background); + + - - + + Double-click Button1 on a row: If the + transactions is flagged for import (see below) this will open an account selection + dialog to select a destination/transfer account to be used in the second split of the + imported transaction. You may create a new account if necessary in this dialog using the + New Account button. If the + transaction is flagged as matching an existing transaction either for import or + updating, the match picker dialog is opened to allow the matched transactions to be + examined and a correct match selected; + + - - - - Cornflower Blue - + + + + CtrlButton1 + + on a row: Add the row to a selection of rows (displayed with a blue + background) to which a single destination/transfer account may be applied; + + - - - - Row is selected - - - - - + + + + ShiftButton1 + + on a row: Select all rows between the last selected row and this row and add + them to the current selection of rows; + + - - The colors illustrated here are the defaults for &appname; specified in - gnucash-fallback-310.css. - You may experience different colors if the gtk-3.0 CSS files have been modified - - + + Click Button2 in the window: Display a + popup menu which when clicked in turn opens a dialog to select a single + destination/transfer account which will be applied to all rows currently selected. + + + - You may always intervene manually to - - - change the import action by selecting another checkbox (or none) and/or + + It is important to assign a transfer account to each transaction prior to import of the + transactions. Otherwise the tokenized information from the imported transaction will not + be appended to the list of tokens for an assigned account for use in future matching of + transactions to transfer accounts. - - - - manually assign a different transfer account + + + + Note that "reconciled" in this context does not mean the same as "reconciled" in the process of + reconciling an account to an external statement. The reconciliation status of an imported + transaction is set to cleared (c) on import of a new transaction. + See Setting the reconcile status (R field) of a transaction + for details of the values of reconciliation status. - - - after reviewing the matched transactions and accounts and the automatically selected - actions. - - - Multi row selection is enabled for the list of downloaded transactions. The following operations can - be performed on the list of downloaded transactions: - - - - - Click Button1 - (see Mouse Buttons) on a row: - Select this row (row is displayed with a blue background); - - +
- - Double-click Button1 on a row: If the - transactions is flagged for import (see below) this will open an account selection - dialog to select a destination/transfer account to be used in the second split of the - imported transaction. You may create a new account if necessary in this dialog using the - New Account button. If the - transaction is flagged as matching an existing transaction either for import or - updating, the match picker dialog is opened to allow the matched transactions to be - examined and a correct match selected; + Where a row has been matched to an existing transaction or is to update an existing transaction it + will have a DarkSeaGreen background. Double-clicking + Button1 on the row will bring up the Match Picker + dialog which displays detail of the imported. If you, feel the wrong transfer account has + been assigned or the matcher has not produced a valid result, you may change the checkbox + selection if you disagree with the matcher decisions and you may reassign an assigned + transfer account (see below). - - - - - CtrlButton1 - - on a row: Add the row to a selection of rows (displayed with a blue - background) to which a single destination/transfer account may be applied; + Double-clicking Button1 on a row marked + as New with a DarkSeaGreen1 background and a transfer account assigned to + it will bring up the account selection dialog to allow you to choose a different transfer + account for the second split. - - - - - ShiftButton1 - - on a row: Select all rows between the last selected row and this row and add - them to the current selection of rows; + Double-clicking Button1 on a row marked + New with no transfer account matched with a Gold background will also bring + up the account selection dialog to allow you to assign a suitable transfer account to the + transaction. - - - - Click Button2 in the window: Display a - popup menu which when clicked in turn opens a dialog to select a single - destination/transfer account which will be applied to all rows currently selected. - - - - - - It is important to assign a transfer account to each transaction prior to import of the - transactions. Otherwise the tokenized information from the imported transaction will not - be appended to the list of tokens for an assigned account for use in future matching of - transactions to transfer accounts. - - - - - Note that "reconciled" in this context does not mean the same as "reconciled" in the process of - reconciling an account to an external statement. The reconciliation status of an imported - transaction is set to cleared (c) on import of a new transaction. - See Setting the reconcile status (R field) of a transaction - for details of the values of reconciliation status. - - - - Where a row has been matched to an existing transaction or is to update an existing transaction it - will have a DarkSeaGreen background. Double-clicking - Button1 on the row will bring up the Match Picker - dialog which displays detail of the imported. If you, feel the wrong transfer account has - been assigned or the matcher has not produced a valid result, you may change the checkbox - selection if you disagree with the matcher decisions and you may reassign an assigned - transfer account (see below). - - - Double-clicking Button1 on a row marked - as New with a DarkSeaGreen1 background and a transfer account assigned to - it will bring up the account selection dialog to allow you to choose a different transfer - account for the second split. - - - Double-clicking Button1 on a row marked - New with no transfer account matched with a Gold background will also bring - up the account selection dialog to allow you to assign a suitable transfer account to the - transaction. - + + Assign a Destination Account to a Single Transaction