User Quick Start


How to Register in Finmars

  1. To register at finmars.com you need to click to "SIGN UP" button

    image.png

  2. It will direct you to the "CONTACT US" section 

    image.png

  3. You should fill in your information and click "Submit"

    image.png

  4. Then you will get a confirmation message that your form was submitted successfully.

    image.png

  5. After that Finmars will contact you for finishing the Registration. 

How to Get an Access to the Workspace

Prerequisites

Getting an Access to the Workspace

  1. Go to your allocated Finmars URL (environment) which was as the part of your credentials and usually defined for a specific regions in accordance with the compliance requirements. 
  2. You will access the Profile page which will contain your Workspace (an instance of your Finmars engine with your data).

    image.png

  3. At the moment you may not have available Workspaces (like in the screenshot above). You should request Finmars to create your own Workspace, you should provide your Username to get an invitation to the Workspace. 
    • You can find your Username in the upper right corner of the profile page (new_user - in the example above)
    • That is the exact Username you use as a login
  4. Then Finmars will sent you an invitation, which can be found in the "Invites" section of the Profile page: you will see the card with the name of the Workspace, then click "Accept" button

    image.png

  5. After the "Accept" is clicked you will be redirected to the "New User Setup" page consisting of 2 steps:
    1. "Please select your complexity level" (deprecated setting) -> Always select "Advanced Sophisticated User"

      image.png

    2. "Please select init configuration you would like to use" (selecting the layouts for reports) -> Select a card representing needed configuration and click button "Finish" (if no cards from the configurations you may select "Blank" card and install layouts directly from the Marketplace.

      image.png

  6. Upon finishing installation you will be redirected to the "Home" page, meaning that now you have an access to the Workspace. 

    image.png

  7. Also the Workspace now will be listed in the "Profile" page

    image.png

How to Navigate in a Profile page

Prerequisites

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

  1. If needed: the VPN is configured to access the Finmars resources
  2. If needed: access to the Virtual Machine to work with the sensitive information
  3. Must have: registered in Finmars in the needed region environment (self-registered or registered by Finmars) 
  4. Must have: having permissions set to allow continue with the Action in the Guide

Navigating in a Profile page

  1. Go to the needed region environment URL

    image.png

  2. Login

    image.png

  3. You will be redirected to the Profile page: it's the page where you can find

    image.png

  4. Profile page has a sidebar menu:
    1. Realm - default tab with Dashboard with all available Realm & Workspaces in them (see screenshot above). You can:
      1. open available workspaces by clicking "Open"
      2. click on cog icon on a workspace card to
        1. Export Backup
        2. Exit the Workspace (if you are not an owner of the workspace)
        3. Delete the Workspace (if you are an owner of the workspace)
    2. Backups - list of all available workspaces and their backups statuses 

      image.png

    3. Invites - list of all pending invitations to join workspaces (reference to the How to get Access to the Workspace point 4)
    4. User - tab with the user info

      image.png

How to Import Data into a Workspace via Dashboard (STD Manual Import)

Prerequisites

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

  1. If needed: the VPN is configured to access the Finmars resources
  2. If needed: access to the Virtual Machine to work with the sensitive information
  3. Must have: registered in Finmars in the needed region environment (self-registered or registered by Finmars)
  4. Must have: having permissions set to allow continue with the Action in the Guide
  5. Must have: to create a new Workspace you must have a License Key (provided by Finmars)
  6. Must have: installed Standard Configuration package from the marketplace

Import Data into a Workspace via Dashboard (STD Manual Import)

  1. Go to the Dashboard menu tab. STD Manual Import tab should be selected. If it's selected, proceed from the step 5. If it's not selected, follow the steps below.

    Screenshot_20250115_125627-1.png

     

  2. After you have finished the installation (right upper corner had success popup), you should go to the Dashboard menu 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

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

    Screenshot_20250115_125939.png

  4. 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. 

  5. 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

  6. Standard - Workflow should be installed there

    Screenshot_20250115_130443.png

  7. 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. 
    4. Parse Entities from Transactions & Positions checkbox is used when you don’t have simple entities already imported or in the corresponding files (not including Instruments, they need to be in the corresponding file with instruments).
    5. After adding all those files, you should click Import.

    6. Screenshot_20250115_130539.png

  8. After clicking Import, information about the workflow status will appear. Refresh status button will refresh the status of the workflow.

    Screenshot_20250115_130738.png

  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.

How to Prepare Standard Template Files for Import

Prerequisites

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

  1. If needed: the VPN is configured to access the Finmars resources
  2. If needed: access to the Virtual Machine to work with the sensitive information
  3. Must have: registered in Finmars in the needed region environment (self-registered or registered by Finmars)
  4. Must have: having permissions set to allow continue with the Action in the Guide
  5. Must have: to create a new Workspace you must have a License Key (provided by Finmars)
  6. Must have: installed Standard Configuration package from the marketplace

Prepare Standard Template Files for Import

Standard Configuration supports importing from Excel files:

Currencies, Accounts, Portfolios, Instruments, Instruments Factor Schedules, Instruments Accrual Schedules, Counterparties, Responsibles, Strategies1, Transactions, Positions, Prices & FX Rates.

To import this files follow instruction: How to Import Data into a Workspace via Dashboard (STD Manual Import)

Below you can find instructions on how to fill in templates.

General Requirements:

Transactions

Deposit/Withdraw

Expense/Income (Non-instrument)

Coupon/Dividend

Expense/Other Income (Instrument)

Buy/Sell

FX Trade

Transfer Cash

Transfer Instrument

FX Forward (Open)/FX Forward (Expiration)

Positions Initial/Daily

Position Cash

Daily transaction type is valid only on the trade date then position will be nullified.

Position Instrument

Daily transaction type is valid only on the trade date then position will be nullified.

Position FX Forward

Instruments

Instruments

Instruments Accrual Schedules

Instruments Factor Schedules

Prices

FX Rates

Other Entities

Currencies

Accounts

Portfolios

Counterparties

Responsibles

Strategies

How to Duplicate the Layout

Prerequisites

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

  1. If needed: the VPN is configured to access the Finmars resources
  2. If needed: access to the Virtual Machine to work with the sensitive information
  3. Must have: registered in Finmars in the needed region environment (self-registered or registered by Finmars)
  4. Must have: having permissions set to allow continue with the Action in the Guide

Duplicating the Layout

  1. Go to the layout list. Click on the layout name to open the dropdown menu. Choose the layout you want to duplicate (for example, Profit and Loss).
    Снимок экрана 2025-03-04 061527.png
  2. In the dropdown menu, select "Make a Copy" to create a duplicate of the selected layout.
    Снимок экрана 2025-03-04 061756.png
  3. To confirm that the copy was successfully created, check the selected layout name at the top. It should indicate that it is a copy (e.g., Profit and Loss_copy).
    Снимок экрана 2025-03-04 062415.png
  4.  After copying, you can Rename the new layout for clarity and organization. Click on the Rename option.
    Снимок экрана 2025-03-04 061909.png
  5. A dialog box will appear where you can enter any desired name for the copied layout. Also, you can change configuration and user code.Снимок экрана 2025-03-13 123409.png
  6. After choosing a new name, click Save to confirm the changes.
    Снимок экрана 2025-03-13 123717.png

How To Check Transaction Report

Prerequisites

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

  1. If needed: the VPN is configured to access the Finmars resources
  2. If needed: access to the Virtual Machine to work with the sensitive information
  3. Must have: registered in Finmars in the needed region environment (self-registered or registered by Finmars)
  4. Must have: having permissions set to allow continue with the Action in the Guide

Checking Trasaction Report

  1. Go to the left sidebar. Locate and select the Report section and click on Transaction. Ensure that the correct layout is selected from the dropdown in the upper-left corner. If the wrong layout is selected, change it before proceeding.
    Снимок экрана 2025-04-02 135648.png
  2. Once on the Transaction page, ensure the Report Date is set correctly. You can select predefined periods like YTD, MTD, QTD, or choose a custom date range for more precise reporting. The system displays data as of the end of the selected day. After choosing click Save.
    Снимок экрана 2025-04-02 140342.png
  3. If you want to configure more detailed report settings, click on the gear icon in the top-right corner to open the settings panel. 
    Снимок экрана 2025-04-02 141545.png
  4. In the Report Settings, you can configure is:
    1. Report Date - defines the date range for the report. Users can select a specific date range or predefined periods (e.g., YTD, MTD). The system displays the transactions on the end of the selected day.
    2. Table Font Size - adjusts the text size within the report (Small, Medium, Large).
    3. Expression Iterations Count - defines how many times the system applies calculations for custom columns in the report. Set to "1" for most reports. Increase only if your report data has dependencies between diferent custom columns, and is not calculated  with one iteration.
    4. Date Field - lets users choose which date type to apply in the report (e.g., Transaction Date, Accounting Date, Cash Date, etc.)
    5. Custom Fields - this option allows users to enable additional user-defined fields (with expression formulas) in the report for more detailed or specific reporting needs. Not recommended to use due its high resource consumption. 
    6. Depth Level - defines the level of detail in the report, with options: 
      1. Complex Transaction - shows the transaction as a whole, without breaking it down into internal actions or money movements. Best for a quick overview of operations.
      2. Base Transaction - shows the internal actions within the transaction (for example, different steps of execution), but without splitting it into cash or position movements.
      3. Entry - shows the most detailed view with all accounting records. Here the transaction is fully broken down into cash flows and position changes.
    7. Filters – Allows users to refine the displayed data by using multi-selectors for Portfolios, Accounts, and Strategies.
      Снимок экрана 2025-04-02 154903.png
  5.  After adjusting these settings, confirm by clicking OK.
    Снимок экрана 2025-04-02 190428.png
  6. To apply the selected settings and view the updated report, simply refresh the page. Once refreshed, the report will be displayed with the updated parameters, reflecting the selected configurations.
    Снимок экрана 2025-04-02 190639.png
  7. Once the report has been prepared, verify the displayed information to ensure that the Grand Total and individual portfolio data are correct. If mistakes are discovered, review the imported data to ensure that all relevant files were included through the import process. If changes are required, return to the Report Settings, alter the settings, and reload the page to update the report.
  8. After verifying the report, you can either save it within the system for future reference or export it for external use. To do this, locate the Save button, which is positioned in the upper-left corner of the report interface. Clicking this button will store the current report layout and data for future access. It’s important to use the standard settings whenever possible to maintain consistency. If changes are needed, create a duplicate of the layout (see How to Duplicate the Layout) and save it locally to avoid potential data loss during updates or reinstallation of marketplace modules.
    Снимок экрана 2025-04-02 190927.png
  9. The Export option is located in the top-right corner, providing multiple formats for downloading the report. You can choose to Export to PDF, Export to CSV, or Export to Excel, depending on the preferred format for further analysis.
    Снимок экрана 2025-04-02 191103.png
  10. Additionally, there are options to Copy all to buffer or Copy selected to buffer, allowing you to quickly copy report data for use in other applications. Ensure that the exported or copied data accurately reflects the report before using it for financial reporting or analysis.
    Снимок экрана 2025-04-02 191213.png
  11. In case of any errors or missing data warnings, check that the required Import has been successfully completed. Ensure that all necessary financial and transactional data has been imported into the system before running the Transaction Report. If issues persist, contact the administrator for further assistance.