Skip to content

Commit

Permalink
split import.md into two files (csv-import.md and pdf-import.md) and …
Browse files Browse the repository at this point in the history
…separate folder
  • Loading branch information
hug-sch committed Jul 31, 2024
1 parent 6b28a82 commit e27a022
Show file tree
Hide file tree
Showing 13 changed files with 250 additions and 27 deletions.
Binary file added docs/en/assets/PDF-Debug Testfile.pdf
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/en/getting-started/manage-portfolio/buy.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Recording a Buy transaction
---
When you receive a notification from your bank or broker detailing a transaction, as shown in Figure 1, you need to record this transaction in PP. If it's on paper, you must do this manually. Otherwise, you can attempt to [import](../../reference/file/import.md) the transaction.
When you receive a notification from your bank or broker detailing a transaction, as shown in Figure 1, you need to record this transaction in PP. If it's on paper, you must do this manually. Otherwise, you can attempt to [import](../../reference/file/import/csv-import.md) the transaction.

# Transaction with one currency

Expand Down
4 changes: 2 additions & 2 deletions docs/en/getting-started/updating-portfolio.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ After making physical transactions with your broker or bank, you need to update

- **Automatic Import**: You can import transaction data from your bank automatically. Depending on the format, this can be done using PDF documents or CSV files. It is very important that the structure and format of your data match the required format from the import wizard. For example, your CSV file might use a semicolon as a list separator (common in European countries). The import wizard should match this setting.

- **Importing a CSV File**: Use the menu `File > Import > CSV files (comma-separated values)` to import historical quotes, accounts, securities, and transactions. See [Reference > File > Import](../reference/file/import.md#csv-files-comma-separated-values) for further information.
- **Importing a CSV File**: Use the menu `File > Import > CSV files (comma-separated values)` to import historical quotes, accounts, securities, and transactions. See [Reference > File > Import](../reference/file/import/csv-import.md#csv-files-comma-separated-values) for further information.

- **Importing PDF Documents**: Banks and brokers often provide account statements on paper or in PDF format. PP can read PDF documents from more than 90 banks or brokers. To verify if your bank is supported, try to import a PDF document. The import wizard will either recognise it automatically or display an error message listing all the banks/brokers it has tried. You can also search the [forum](https://forum.portfolio-performance.info/c/english/) using the term `PDF import` or `PDF import [name-of-your-bank-or-broker]` to see if an importer for your institution is available or if there are any issues with it. See [Reference > File > Import > PDF Bank Documents](../reference/file/import.md#pdf-bank-documents) for further information, including how to request a new importer for your bank.
- **Importing PDF Documents**: Banks and brokers often provide account statements on paper or in PDF format. PP can read PDF documents from more than 90 banks or brokers. To verify if your bank is supported, try to import a PDF document. The import wizard will either recognise it automatically or display an error message listing all the banks/brokers it has tried. You can also search the [forum](https://forum.portfolio-performance.info/c/english/) using the term `PDF import` or `PDF import [name-of-your-bank-or-broker]` to see if an importer for your institution is available or if there are any issues with it. See [Reference > File > Import > PDF Bank Documents](../reference/file/import/csv-import.md#pdf-bank-documents) for further information, including how to request a new importer for your bank.
2 changes: 1 addition & 1 deletion docs/en/how-to/benchmarking.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A stock index is a measure of the value of a hypothetical portfolio of investmen

A list of major indexes can be found on several financial websites such as [investing.com](https://www.investing.com/indices/major-indices) and [Yahoo Finance](https://finance.yahoo.com/world-indices/). In order to use an index for benchmarking your portfolio, you need to add it as a security.

For the indexes listed on Yahoo Finance, simply [add a new security](../getting-started/adding-securities.md) and search for the ticker symbol; e.g. ^GSPC. If you want to use the data from investing.com, you have to download the historical prices. Select the correct time period and click the download button to receive a CSV-file (you need a free registration for that). Create a new empty instrument. See the section [File > Import](../reference/file/import.md#csv-files-comma-separated-values) and [How-to > Downloading Historical Prices](./downloading-historical-prices/csv-file.md#investingcom) for a detailed explanation how to import these historical prices. For appending the future daily prices, you can use the daily updated table from the last month. Set the Quote Feed of the Historical Quotes to `Table on website` and use the following Feed URL: https://www.investing.com/indices/us-spx-500-historical-data. This Quote Feed will not overwrite the existing prices but will append new ones.
For the indexes listed on Yahoo Finance, simply [add a new security](../getting-started/adding-securities.md) and search for the ticker symbol; e.g. ^GSPC. If you want to use the data from investing.com, you have to download the historical prices. Select the correct time period and click the download button to receive a CSV-file (you need a free registration for that). Create a new empty instrument. See the section [File > Import](../reference/file/import/csv-import.md#csv-files-comma-separated-values) and [How-to > Downloading Historical Prices](./downloading-historical-prices/csv-file.md#investingcom) for a detailed explanation how to import these historical prices. For appending the future daily prices, you can use the daily updated table from the last month. Set the Quote Feed of the Historical Quotes to `Table on website` and use the following Feed URL: https://www.investing.com/indices/us-spx-500-historical-data. This Quote Feed will not overwrite the existing prices but will append new ones.

There are plenty of mutual funds or ETF's that replicate an index. For example, both [Vanguard 500 Index Fund Admiral](https://investor.vanguard.com/investment-products/mutual-funds/profile/vfiax#portfolio-composition) and the [iShares Core S&P 500 ETF](https://www.ishares.com/us/products/239726/ishares-core-sp-500-etf) replicate the S&P 500 quite narrowly. So, you could use also one these funds as benchmark.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/how-to/copy-securities.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ At times, it may be simpler to manually copy and paste the desired transactions,
3. For a non-contiguous selection, click the first row, press and hold CTRL (Windows), and click on the following rows accordingly.
4. Once all desired rows are selected, press CTRL+C (Windows) to copy the content to the clipboard.
5. Navigate to a spreadsheet or text editor and paste the content. PP uses the TAB-code as a list separator.
6. Unfortunately, the header isn't copied along with the data. Therefore, you should either map the fields during the importing process (you can use a [template](../reference/file/import.md#csv-files-comma-separated-values) for that) or manually add them to the pasted content.
6. Unfortunately, the header isn't copied along with the data. Therefore, you should either map the fields during the importing process (you can use a [template](../reference/file/import/csv-import.md#csv-files-comma-separated-values) for that) or manually add them to the pasted content.
7. You still have to save the file with extension CSV and import it.

This technique will also work in the `All Transactions` view (see previous topic).
Expand Down
2 changes: 1 addition & 1 deletion docs/en/how-to/downloading-historical-prices/csv-file.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Downloading a CSV file
---
In PP, importing historical prices from a CSV file is a straightforward process through the menu [`File > Import > CSV Files`](../../reference/file/import.md#historical-quotes-import). Naturally, you would require a file containing the relevant quotes for this operation.
In PP, importing historical prices from a CSV file is a straightforward process through the menu [`File > Import > CSV Files`](../../reference/file/import/csv-import.md#historical-quotes-import). Naturally, you would require a file containing the relevant quotes for this operation.

A csv file is a comma-separated values file, which is a text file that stores tabular data. Each row in the file represents a record, and each column represents a field. For example, a typical historical quotes CSV file will contain two columns (date and quote) and several rows, one for each date with its corresponding historical quote. A csv file can be opened and edited by spreadsheet software and easily imported into PP.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/how-to/gold-prices.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can also replace the Quote Feed URL by one of the previous months (e.g. `htt

But, perhaps the better method is to use a [dynamic data URLs](https://help.portfolio-performance.info/de/kursdaten_laden/#dynamische-kursdaten-urls). Replace the `month=2024-02-29` in the URL from above in the macro version `month={DATE:yyyy-MM-32}`. This macro will iterate through all previous months (going back to 2003) and send a request for each month until there is no data available. If you start from scratch, this process can take some time and will put a significant load on the ariva.de web server.

Another option to obtain historical gold prices is to register for a free account. Then you can download the historical prices as a CSV file, which can be [imported](../reference/file/import.md#csv-files-comma-separated-values) into Portfolio Performance (PP).
Another option to obtain historical gold prices is to register for a free account. Then you can download the historical prices as a CSV file, which can be [imported](../reference/file/import/csv-import.md#csv-files-comma-separated-values) into Portfolio Performance (PP).


## London Bullion Market Association (LBMA)
Expand Down
2 changes: 1 addition & 1 deletion docs/en/how-to/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Figure: Documentation framework.{class="align-right" style="width:50%"}

This how-to section of this manual is designed to help you to use all features and functions of the Portfolio Performance program in a real working context. Unlike the "Getting-started" section, which is more general and uses simplified examples, the how-to section shows you how to handle the program in a real environment with real data.

The how-to section covers topics such as [importing stock data](../reference/file/import.md), [reinvesting dividends](./handling-choice-dividend.md), recording [stock splits](./recording-stock-split.md) and [spin-offs](./recording-spin-off.md), [downloading historical data](./downloading-historical-prices/index.md) from various sources, and many more.
The how-to section covers topics such as [importing stock data](../reference/file/import/csv-import.md), [reinvesting dividends](./handling-choice-dividend.md), recording [stock splits](./recording-stock-split.md) and [spin-offs](./recording-spin-off.md), [downloading historical data](./downloading-historical-prices/index.md) from various sources, and many more.

The how-to section is not a substitute for the tutorials, which provide a more comprehensive and pedagogical introduction to the program. Nor is it a substitute for the basic concepts and the reference manual sections, which explain the theoretical foundations and the technical details of the program. The how-to section is meant to complement these other sections by providing practical guidance and tips for using the program effectively.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@ In PP you can enter your data (buy, sell, dividends, historical quotes, … ) ma

Figure: Menu File > Import.{class=pp-figure}

![](./images/mnu-file-import.png)
![](../images/mnu-file-import.png)

There are two primary data sources: PDF documents and CSV files. Some brokers or banks may present this information in a proprietary format. Templates for major banks or brokers are available.

## PDF Bank Documents

## CSV files (comma-separated values)

Expand All @@ -30,7 +29,7 @@ In **step 2** of the wizard, you need to select the appropriate import type or t

Figure: Saving the mapping configuration.{class=align-right style="width:50%"}

![](./images/mnu-file-import-step-2-template.png)
![](../images/mnu-file-import-step-2-template.png)

- *Save Configuration* (Gear icon): To save the current mapping, click on the gear icon to the right of "Type of data." A list of `Built-in configurations` will be displayed, such as comDirect, Consorsbank, etc. (see Figure 3). Using the option `Save current configuration` will save your current mapping configuration as a custom template. This template will be available under `User-specific Configurations`, for example, `test (Account Transactions)` (see Figure 2). You can delete, export, and import configurations. The export function uses a JSON format.

Expand All @@ -56,19 +55,19 @@ Please note that the date in Table 1 is in the format `YYYY-MM-DD`. By double-cl

Figure: Importing Historical Quotes (step 2).{class=pp-figure}

![](./images/mnu-file-import-step-2.png)
![](../images/mnu-file-import-step-2.png)

In Figure 3, the `Next` and `Finish` buttons are greyed out because not all necessary information is available. The message at the top, "Unmapped required field(s): Quote," provides a clue. For this type of import, two fields are required: `Date` and `Quote`. However, the CSV file uses the headings `Date` and `Price`. The field `Price` should be mapped to the internal `Quote` field. Double-click on the column and select the appropriate mapping field, e.g. `Quote`. The `Next` and `Finish` buttons will then become available.

In step 3 of the wizard, you can select the security that the prices will be added to. If the chosen security already has some historical prices, the quotes will be added (no duplicates).

Figure: Importing Historical Quotes (step 3).{class=pp-figure}

![](./images/mnu-file-import-step-3-historical-prices.png)
![](../images/mnu-file-import-step-3-historical-prices.png)

### 2. Securities import

Use this type to create new securities from a CSV file. There are no required fields. The optional fields include `Ticker Symbol`, `Security Name`, `WKN`, `ISIN`, `Currency`, `Date of Quote`, `Note`, and `Quote`. It is evident that at least one of the first four fields should be mapped. Refer to the [glossary](../../concepts/PP-terminology.md) for the meaning of these terms. See Table 2 for an example of the CSV-file.
Use this type to create new securities from a CSV file. There are no required fields. The optional fields include `Ticker Symbol`, `Security Name`, `WKN`, `ISIN`, `Currency`, `Date of Quote`, `Note`, and `Quote`. It is evident that at least one of the first four fields should be mapped. Refer to the [glossary](../../../concepts/PP-terminology.md) for the meaning of these terms. See Table 2 for an example of the CSV-file.

*Table 2: Source data for the import of Historical Prices.*
```
Expand All @@ -80,21 +79,21 @@ Two securities will be added to the portfolio; e.g. BASF and NVIDIA. The ISIN co

Figure: Importing securities (Step 2).{class=pp-figure}

![](./images/mnu-file-import-securities-step-2.png)
![](../images/mnu-file-import-securities-step-2.png)

The field `Currency` is not recognized by PP; in fact it should be named `Transaction Currency`. You should map it manually. In step 3 (below), you can observe that the status of both securities contains a green check mark, indicating that the import will be successful. Click Finish.

Figure: Importing securities (Step 3).{class=pp-figure}

![](./images/mnu-file-import-securities-step-3.png)
![](../images/mnu-file-import-securities-step-3.png)

The securities are now created and appear in the `All Securities list`. It does not make sense to add or change the cash or security account because there is no associated buy or sell transaction. The security is only created in the `All Securities` list. Please note that several other fields such as Calendar, Additional Attributes, and Taxonomies cannot be added through CSV-import. The Quote Feed for the Historical Prices could partially be added in the following step (see Figure 7).

After the securities are created, an additional step allows you to search for a suitable quote feed. This can also be performed manually by right-clicking on a security and choosing `Quotes > Search for providers of historical prices...`

Figure: Importing securities (Step 4).{class=pp-figure}

![](./images/mnu-file-import-securities-step-4.png)
![](../images/mnu-file-import-securities-step-4.png)

Only securities listed on XETRA (Deutsche Börse) and analyzed by the Portfolio Report are eligible for an automatic Quote Feed. The BASF security in Figure 7 meets these criteria and can therefore receive an automatic quote feed. However, the NVIDIA security is not listed on XETRA in USD, so automatic quotes should be obtained through another candidate provider e.g. Yahoo Finance.

Expand All @@ -114,7 +113,7 @@ If multiple currencies in the same Buy transaction are involved, then another ty

Figure: Importing securities (Step 4).{class=pp-figure}

![](./images/mnu-file-import-securities-account-step-2.png)
![](../images/mnu-file-import-securities-account-step-2.png)


### 4. Account Transactions import
Expand All @@ -135,17 +134,17 @@ If the Cash and Securities account are not provided in the CSV file, the value f

Figure: Importing account transactions - content CSV file{class=pp-figure}

![](./images/mnu-file-import-account-transactions-csv-file.png)
![](../images/mnu-file-import-account-transactions-csv-file.png)

Figure 9 displays the content of a sample CSV file. Four transactions are described. Note that the Cash account of the first transaction is not provided. The default account from the top panel is taken in that case.

Figure: Importing account transactions - content CSV file{class=pp-figure}

![](./images/mnu-file-import-account-transactions-step-2.png)
![](../images/mnu-file-import-account-transactions-step-2.png)

Figure: Importing account transactions - content CSV file{class=pp-figure}

![](./images/mnu-file-import-account-transactions-step-3.png)
![](../images/mnu-file-import-account-transactions-step-3.png)

#### Dividend transaction

Expand Down Expand Up @@ -175,7 +174,7 @@ In this instance, we are receiving a dividend payment for three shares, with a `

Figure: Step 1 of the Import wizard: type dividends. {class=pp-figure}

![](./images/mnu-file-import-portfolio-account-transactions-dividend-step-1.png)
![](../images/mnu-file-import-portfolio-account-transactions-dividend-step-1.png)

The necessity of the `Gross Amount` field is not apparent, particularly as it is not utilized in the subsequent section. However, the Portfolio Performance (PP) software verifies the values within this field, ensuring that the following calculation holds true: `Gross Amount` multiplied by the `Exchange Rate` equals the `Value`. If the numbers do not correspond, an error message will be displayed, preventing progression to the next step.

Expand All @@ -186,7 +185,7 @@ Upon importing the CSV file detailed above and selecting the `Account Transactio

Figure: Result of import from above. {class=pp-figure}

![](images/mnu-file-import-portfolio-account-transactions-dividend-result.png)
![](../images/mnu-file-import-portfolio-account-transactions-dividend-result.png)


### 5. Portfolio Transactions import
Expand Down Expand Up @@ -216,12 +215,11 @@ Because the `(Net) Value` field is required, it makes no sense to add the `Gross

Figure: Result of import from above. {class=pp-figure}

![](images/mnu-file-import-portfolio-account-transactions-result.svg)
![](../images/mnu-file-import-portfolio-account-transactions-result.svg)

Figure 13 displays the first step of the Import wizard. Be sure that the type Portfolio Transactions is selected in step 1; otherwise an error will occur in step 2.

Figure: Result of import from above. {class=pp-figure}

![](images/mnu-file-import-portfolio-transactions.png)

![](../images/mnu-file-import-portfolio-transactions.png)

Loading

0 comments on commit e27a022

Please sign in to comment.