Skip to main content

How to Import File in PMS Core and PMS Plus

Prerequisites

We assume you have all prerequisites you may need, including:

  1. Get Access to Finmars
  2. Link with Finmars ID
  3. Install PMS Core or PMS Plus add-on

Import File in PMS Core and PMS Plus

In this guide we will demonstrate how to import excel files in PMS Plus add-on, while commenting what is available to PMS Plus only and absent in PMS Core (which is the subset of PMS Plus). 

    Step

  1. 1:

    Go to the Dashboardsidebar menu tab.Add-ons "> PMS 5: File ImportPMS." layout should be selected. If it's selected, proceed from the step 5. If it's not selected, follow the steps below.

    image.pngimage.png


  2. Step 2: You will see the PMS add-on page which provide the access to the Excel Import (1) interface and Helper (2) they both have similar structure of 2 panes: left pane - run page where you configure what to do, and right pane - execution info page where you can see logs and result.

    image.png

    image.png

    In this guide we will go through how to use Excel Import tab of PMS add-on. 

    Step 3: Let me guide you through Excel Import tab of PMS add-on.

    image.png

    PMS Plus version

    image.png

    PMS Core version (marked differences)

    Overview of the elements on the Excel Import tab:

    1. After"Plus" badge - indicator that you are using PMS Plus version. If you have finishedPMS theCore, installationthere (rightwill upperbe corner"Core" hadbadge successand popup),"Upgrade" button that will link you should go to the DashboardPMS menuPlus tab. Depending on your default layout settings, it may have different layout selected, you need to click on the layout name to navigate to the needed layout.

      Screenshot_20250115_125627-1.png

    2. Once the menu is opened, you will be presented a choice of selecting multiple menus. Select STD Manual Import layout.

      Screenshot_20250115_125939.png

    3. Workflow field denotes which workflow will handle the input. For now, use the default com.finmars.standard-workflow:std-import-pipeline. If you see this import, skip steps 5-6 and go to Step 7

    4. If you do not see this import, double check that you have installed Standard - Workflows module as a part of the Standard Configuration package by following the steps below. This can be done by going to the Configuration → Configuration → Manage

      Screenshot_20250115_130323.png

    5. Standard - Workflow should be installed there

      Screenshot_20250115_130443.png

    6. The basic way to use STD Import Pipeline is to add all of the needed files yourself.
      1. That includes currencies, accounts, portfolios, instruments, instruments factor scheduled, instruments accrual scheduled, responsibles, strategies1, transactions, prices, fx-rates, for files see instruction: How to Prepare Standard Template Files for Import.
      2. You can add multiple files at once in one field. 
      3. Any combination of previously mentioned files is possible. Which means that some fields can be left without any file selected, but it's your responsibility to make sure that you won't be lacking any data.add-on. 
      4. Parse"Download Entitiesexcel from Transactions & PositionsExample" checkboxthe isbutton used whenallows you don’tto havedownload simpleExcel entitiesfiles alreadyfor importedimport, orthere are 2 set of them:
        1. excel_demo_data - ready to import data that will allows you to check Finmars platform in action;
        2. excel_import_file_templates - templates how to populate the correspondingexcel filesfile (notin includingFinmars Instruments,format and you still can import them as well but they needwon't togive beyou nice values in the corresponding file with instruments).
        3. After adding all those files, you should click Import.
        4. Screenshot_20250115_130539.png

           

          reports. 
      5. Next

        Afterto clickingsome Import,labels informationin aboutfile theselect, workflowinput statusor checkboxes elements you will appear.see RefreshInfo statusicon button- willclick refreshon theit statusto see description of the workflow.

        element. 

        Screenshot_20250115_130738.png

      6. You will see Multiple File Select input and Text Input elements where your input required.
      7. "Reset" button allows to reset selected files. 
      8. "File Fields (Advanced Import)" section is only for "PMS Plus" and contains Multiple File Select inputs for: 
        1. Simple entities (more control over creation): currencies, accounts, portfolios, counterparties, responsibles, strategies;
        2. Instruments: Factor and Accrual schedules;
        3. Positions: Daily (one day living snapshot), Initial (starting positions in case you can't import historical transactions).
      9. Open Workflow link will open a more detailed view of the workflow progress. This view shows all of the workflows that will be executed by std-import-pipeline.

        Screenshot_20250220_075130.png

      10. Zooming in, more information about each separate workflow is shown. Clicking on the workflow, detailed information is shown on the right, including status, created at and finished at, logs, as well as results. Status field has following values: Progress, Success, Nested-Progress, Error. Nested-Progress denotes that a workflow inside the Nested-Progress workflow is being executed.

        Screenshot_20250108_175652.png

      11. std-import-pipeline executes multiple other workflows. After all of them are completed, the workflow progress will be Success.

        Screenshot_20250108_180235.png

      12. More details about each workflow can be obtained by clicking on the id of that workflow.

        Screenshot_20250108_180853.png

      13. After all other workflows have finished Successfully “Status: success” will be shown.

        Screenshot_20250115_134709.png

      14. However, this only confirms that the data transfer was completed, not that the data is free of errors. To check that import has no errors you need to click on Open Workflow after the import is marked as successful.
        screenshot-20250115-130738.png
      15. The workflow visualization will open. Locate the last executed block in the workflow and click on it, as shown in the screenshot.
        image.png
      16. On the right panel, find the Result section. In this section, the top row will indicate whether any errors were encountered. Below, a detailed list of errors will be displayed, specifying the affected files.
        image (1).png
      17. If errors are present, review them carefully and take corrective actions as needed before re-running the import.