Skip to content

Commit

Permalink
moving requesting-new-importer.md to how-to section
Browse files Browse the repository at this point in the history
  • Loading branch information
hug-sch committed Aug 14, 2024
1 parent a04681b commit 16d4149
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 18 deletions.
1 change: 1 addition & 0 deletions config/en/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ nav:
- How-to:
- How-to: how-to/index.md
- User Interface: how-to/user-interface.md
- Requesting a new PDF Importer: how-to/requesting-new-importer.md
- Downloading historical prices:
- Downloading historical prices: how-to/downloading-historical-prices/index.md
- Alpha Vantage: how-to/downloading-historical-prices/alpha-vantage.md
Expand Down
35 changes: 35 additions & 0 deletions docs/en/how-to/requesting-new-importer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: Requesting a new PDF Importer
---

If PP doesn't have a PDF importer for your bank or broker, or for the specific type of transaction you need, you can request the development of this importer. Since PP developers don't have access to every bank or broker, you — as a user — must provide some sample PDF documents with **real** but **anonymised** examples of transactions with that specific bank or broker. The following text outlines all the necessary steps. You can also watch the [accompanying video](./requesting-new-importer.md#video-request-importer) at the bottom.

1. **Collect a PDF document** of each transaction that you would like to import into your PP portfolio. Probably, you should provide an example of a buy, sell, and dividend transaction. Don't use PDFs that are converted to PDF from a browser or self-scanned paper notes but only the original documents from the bank or broker.

2. **Convert these PDFs to text documents, one by one.** Use the parser from PP, which can be found at `File > Import > Debug: Extract Text from PDF` (see Figure 1).

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

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

You can use [this sample (fictitious) PDF document](../../en/assets/PDF-Debug%20Testfile%20-%20Selfwealth-buy.pdf) for testing. The extracted text will appear in the textbox below the instructions (see Figure 2).

3. **Replace (anonymise) personal information** in the extracted text, such as your name, address, and account number. You can do this by double-clicking on a word, e.g., your name. The text will be selected and replaced with random characters.

Personal info can occur at multiple places within the document.

Leave all other information intact, especially amounts, dates, and security names. The following strings cannot be anonymised automatically: currencies (EUR, etc.), ISIN, and text groups containing the following characters: hyphen(-), period(.), comma(,), colon(:), apostrophe('), and slash(/). Do not delete or add anything manually.

Figure: Extracted text from testPDF. {class=pp-figure}

![](images/pdf-import-extract-text.png)

4. **Copy the extracted and anonymised text** to the clipboard or save the file. You will need it later in the request form of the PP forum.
5. If there isn't already an importer for your needs, **create a new thread** in the [forum](https://forum.portfolio-performance.info/c/english/16) with the name `PDF Import from [your bank or broker]`. Otherwise, post a reply in an existing thread, for example [PDF import from SelfWealth](https://forum.portfolio-performance.info/t/pdf-import-from-selfwealth/17399). Add the extracted text for all transactions, one by one. Ensure that these text fragments are within ```triple quotes```, so that it is formatted as code. If your transaction is in a foreign language, please provide some guidance about the translation of the used terms.
6. **Wait for a reply** from the developer. When the importer is finished, it will be added to the next update of PP.

<a name = "video-request-importer"></a>

<video width="100%" controls>
<source src="../../assets/videos/request-importer/PP-request-importer.mp4" type="video/mp4">
</video>
19 changes: 1 addition & 18 deletions docs/en/reference/file/import/pdf-import.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,21 +35,4 @@ In case of a new security, a `Search for suppliers of historical prices` box is

## Requesting a New Importer

If PP doesn't have a PDF importer for your bank/broker or for the specific type of transaction you need, you can request the development of this importer. Since PP developers don't have access to every bank or broker, you — as a user — must provide some sample PDF documents with real but anonymised examples of transactions with that specific bank or broker. The following text describes all the necessary steps:

Figure: Extracted text from testPDF. {class=pp-figure}

![](images/pdf-import-extract-text.png)

1. **Collect the PDF** of each transaction that you would like to import into your PP portfolio. Probably, you should provide an example of a buy, sell, and dividend transaction. Don't use PDFs that are converted to PDF from a browser or self-scanned paper notes but only the original documents from the bank or broker.
2. **Convert these PDFs to text documents, one by one.** Use the parser from PP, which can be found at `File > Import > Debug: Extract Text from PDF`.
3. **Replace (anonymise) personal information** in the extracted text, such as your name, address, and account number. You can do this by double-clicking on a word, e.g., your name. The text will be selected and replaced with random characters. Personal info can occur at multiple places within the document.
Leave all other information intact, especially amounts, dates, and security names. The following strings cannot be anonymised automatically: currencies (EUR, etc.), ISIN, and text groups containing the following characters: hyphen(-), period(.), comma(,), colon(:), apostrophe('), and slash(/). Do not delete or add anything manually.

4. **Copy the extracted and anonymised text** to the clipboard or save the file. You will need it later in the request form.
5. If there isn't already an importer for your needs, **create a new thread** in the [forum](https://forum.portfolio-performance.info/c/english/16) with the name `PDF Import from [your bank or broker]`. Otherwise, post a reply in an existing thread. Add the extracted text for all transactions, one by one. Ensure that these text fragments are within ```triple quotes```, so that it is formatted as code. If your transaction is in a foreign language, please provide some guidance about the translation of the used terms.
6. **Wait for a reply** from the developer. When the importer is finished, it will be added to the next update of PP.

<video width="100%" controls>
<source src="../images/PP-request-importer.mp4" type="video/mp4">
</video>
If PP doesn't have a PDF importer for your bank/broker or for the specific type of transaction you need, you can request the development of this importer. More info can be found at [How-to > Requesting a new PDF Importer](../../../how-to/requesting-new-importer.md).

0 comments on commit 16d4149

Please sign in to comment.