Interface Manual

Home Screen

Navigation

_images/navigation.png
  1. Sidebar menu

  2. Refresh button

  3. Settings button

  4. Errors button

  5. Logs button

  6. Trade and access server versions

Settings

_images/settings.png

The Global Settings contain several tabs:

  • User rules: ref. to User Rules for more information

  • Trading rules: ref. to Trading Rules for more information

  • Balances: ref. to Balances for more information

  • Logging: ref. to Logging for more information

User Rules

_images/user-rules.png
Create account with read-only flag

Field is aimed to create accounts in MT with a check mark Read-only (accounts cannot trade in MT4/5, they only receive signals from masters)

Modify ‘state’

One of the User Record fields in MT4/5 — State. It can be used to write a comment (for example, PAMM account or Investor)

Archive inactive accounts (zero balance, no subscription)

Automatic account archiving option, used if an account has zero balance and is not subscribed to any trader for a set number of days (X)

Archive account if it is disabled in MT

Automatic account archiving option6 used if an account is not available in a trading terminal during the set number of days (X)

Archive disabled account only without positions

Account archiving option that can be used only if there are no open positions

Copy data from Authorization account into New MT Account

Concept of “authorization account” or “payment account” is used in the process of creating an account

Note

When creating new accounts, the system may copy client’s data to those accounts in order to identify a client in MT Manager.

Trading Rules

_images/trading-rules.png
Deposit option for IA position

Allows an investor to choose a deposit format: with reallocation or without it

Withdrawal option for IA positions

Allows an investor to choose a withdrawal format: with reallocation, autocorrection or none of them

Note

Ref. to Accounts: types & settings for the detailed information about reallocation and autocorrection.

Default Allocation

The core formula for the distribution of positions between investors on PAMM accounts

Note

Ref. to MAM for all formulas.

Change ‘Withdrawal’ → ‘Close’ when there is a shortage of money

Checkbox is checked by default. If not checked, an investor’s request of withdrawal won’t be executed if there is not enough money

Forced autocorrection by a lack of MA’s free margin

If the checkbox is checked: in case there is no money on a master account, autocorrection is forced

Copier rule - Allow opening order on new subscribers when master position is at loss

If the checkbox is checked: it is possibles to open positions on an investor’s copy trading account when they are not profitable and still not closed on a master account

Note

Only unprofitable trader’s transactions can be copied for investors due to higher reward/risk ratio in comparison with profitable ones. If transactions are closed with a loss, investor loses less than if he would copy them at the opening. Moreover, the transaction will be closed even with a greater plus than the initial position.

Copier rule - Repeat order opening after rejecting, until ‘X’ times & ‘Y’ seconds

Allows an investor to repeat attempts to open an order X times every Y seconds

Common rule - Wait LP’s answer for X seconds

Number of seconds the system has been waiting for LP’s response without making repeated attempts to open a position

Symbol mapping - Consider the contract’s size of the subscriber and master

If the checkbox is checked: master and investor orders are equal, regardless of their contract’s sizes

Balances

_images/balances.png
Minimum % of free margin on PA after transfer to IA

Allows to set minimum % of free margin left on PA after a transfer to IA

Performance fee on Balance with Floating profit

If the checkbox is checked, an investor always pays performance fee from Equity (Balance + Floating Profit/Loss). If the checkbox is not checked, an investor pays performance fee from Balance in case Equity is greater than Balance. If Equity is less than Balance, an investor pays from Equity

Management fee on Equity

If the checkbox is checked, management fee is paid from Balance. If the checkbox is not checked, management fee is paid from Equity

Profit fee with commission & swaps

If the checkbox is checked, profit fee is paid from your profit including commissions and swaps. If the checkbox is not checked, profit fee is paid from your profit excluding all additional costs

Dividends distribution on PAM

In case a broker company is able to pay dividends according to some CFDs, this service provides the opportunity to receive such dividends and split them up among all investors

Logging

_images/logging.png
Archive folder

The path to a folder with archived logs

Archive older logs

Automatic archivation of logs older than the set number of days

Delete older archives

Automatic deletion of archives older than the set number of days

All logs can be viewed from the Home screen.

_images/all-logs.png

Errors

All errors that occur in the system can be viewed from the Errors monitor screen.

_images/errors.png

Users

On the Users page you can see a list of brokers’ clients and their data

_images/users.png
  1. Sidebar Menu

  2. Refresh Button

  3. Create New User Button

The current version of the backend server separates user and account concepts to provide full integration to Trader’s Room. Now a wallet for user’s account can be a separate MT account, and login for authorization and token receipt are just user’s ID from Trader’s Room database which does not necessarily need to exist and correspond to account’s login in the MetaTrader server.

Creating New User

_images/creating-new-user.png

Basic version without integration to the client’s Trader’s Room

  1. Select White label (there is only one option available in management application).

  2. Select payment account, which will be used as a wallet for transfers to master and investment accounts, and a login to the web interface as well.

Note

Login and password to the MT account are needed for authorization in the web interface.

  1. E-mail will be copied from the payment account (unless you want to specify a special one).

Note

If the Restrict authorization checkbox is checked, a user won’t be able to authorize in the web interface.

Extended version with integration to broker’s Trader’s Room

  1. Select payment account.

  2. Specify authorization account (from MT) or select Set special ID for authorization. Note that the provided ID must correspond to user’s ID from the database (or admin panel) of Trader’s Room.

  3. Specify client’s email.

Master and Investment Accounts

Master Account Page

_images/master-account-page.png

Master Account page consists of the following items:

  1. Sidebar Menu

  2. Refresh button

  3. Create new master account button

  4. Show archived checkbox to show archived accounts

  5. Show master as investor checkbox

  6. Export to file button

Name is an account’s name which will be visible on Leaderboard in the web-interface.

Investment Account Page

_images/investment-accounts-page.png

Investment Account page consists of the following items:

  1. Sidebar Menu

  2. Refresh button

  3. Create new master account button

  4. Show archived checkbox to show archived accounts

  5. Show master as investor checkbox

  6. Export to file button

Master and investment account pages are 90% identical.

They show all account logins which can be Copier/MAM or PAMM-masters or relevant to them investors.

All main information is collected on the Home screen for easy navigation and search all necessary parameters. It is also easy to find subscribers’ emails, name in Leaderboard or MT.

By double-clicking you can navigate to the :ref: Account Settings page, on which you can look through all subscriptions and deposits of an account.

Account Settings

_images/account-settings.png

This is the main screen for account settings. On this screen you can view and configure details in the following fields:

  1. User — a user who owns a particular account.

  2. Login — account login.

  3. Partners — in this field you can set % of fees transferring to your associate (as subscriber and as master).

  4. Test account checkbox — check it in case you have created an account for some testing purposes.

  5. Close position by Unsubscribe checkbox.

  6. Leverage — set leverage ratio.

  7. Currency — select the currency.

  8. Account type — set the type of the account.

  9. Masters settings:

For PAMM managers:

  • Subscribe only “Fund Investors” checkbox

  • Use own D/W behavior field

Note

All deposit/withdrawal settings are equal to those described in the Trading Rules section.

  • Minimal deposit field

  • Hide from rating checkbox

  • Dropdown list from which you can select options that will be visible for investors: all information or limited (without open/close time or opened positions)

  • Daily profit/loss limits

  • Recommended allocation for new subscribers

  • Fees schedule

Note

All fees settings are described in the How to set fees for particular investor article of How-To-Use Guide.

  1. Nickname — it is visible on Leaderboard in the web-interface only for master accounts.

  2. Description — description of the account.

Creating a User

You can link any account, which has already been created, to another existing account or a new user.

_images/create-a-user.png

To create a new user, click on the plus icon to the right of the User field.

Note

Ref. to Creating New User for more details on the process of new user creation.

Editing User Details

You can edit user information directly from the page of the particular account.

To edit user information, click the pencil icon to the right of the User field, then fill out the form.

_images/editing-user-details.png

Choosing a User

If you have linked an account to another user by mistake, you can easily correct it.

There is no need to delete an account and create it once more. Just select the correct account from the dropdown list of available accounts by clicking the account name.

_images/choosing-a-user.png

Partner Rewards Settings

Partner (or agent) payments can be configured not only on a master account but also on an investment account.

_images/partner-rewards-settings.png

If an account is copy/MAM subscriber or fund investor, % of fees paid by an investor will be transferred to specified MT account of an agent. In this case you need to fill out the agent’s login in the right part of the drop-down window and set a percentage.

If an account is master, % of fees to this master from all investors’ accounts will be transferred to partner’s account. In this case you need to fill out the partner’s login in the left part of the drop-down window and set a percentage.

Account Subscriptions Screen

The screen can be divided into three sections:

  1. Informational area

  2. Subscription details table

  3. Positions information table

_images/account-subscriptions-screen.png

Informational Area

_images/informational-area.png
  1. Refresh button.

  2. Create new button.

Note

For the detailed process of creating a new subscription ref. to How to subscribe an investor to a master.

  1. Only active subscription checkbox, which allows you to hide all inactive subscriptions as Master tab — an account is a master and all accounts in the table are its subscribers.

  2. as Subscriber tab — an account is an investor and the table displays all masters, to whom an account is signed.

Subscription Details Table

_images/subscription-details-table.png
  1. Master (or Subscriber) — selected account’s login.

  2. Pause button — allows to pause trading for some particular account.

  3. Reverse button — activates reverse trading starting from the next position.

  4. Active Minimum lot button — an order can be executed even if its initial volume is less than 0.01. It just sets 0.01 lot automatically for such cases.

  5. Ratio — according to this ratio an investor follows a master.

  6. Allocation — type of allocation for particular subscription which masters can change.

When master changes allocation type, the indicators included in it are highlighted accordingly.

Note

Learn more about allocation methods for every single account type here.

  1. Amount of Positions that have already been opened for an account.

  2. Currency — account currency.

  3. Balance and credit funds (if it is used) — amount of money at the current time, excluding open positions.

  4. Equity/Floating Profit/Loss — account balance, results of trading operations, swaps and all broker commissions.

  5. Free margin — account balance, excluding margin, floating profit/loss and overnight operations.

  6. Loss limit — maximum loss amount which a master/investor can to allow.

  7. Current loss

  8. Profit limit — is set if needed.

  9. Current profit

  10. Summed Profit/Loss — summed result of profit and loss.

  11. Status — subscription status.

Positions Information Table

_images/positions-information-table.png
  1. ID — index number in MetaTrader.

  2. Position — index number of an investment platform’s database.

  3. Login — account login.

  4. Actionsell or buy.

  5. Symbol — specifies a trading tool.

  6. Lot — lot volume.

  7. Time — time of order execution.

  8. Price — opening price.

  9. Current — current price.

  10. Real.PL — real profit/loss.

  11. Float PL — float profit/loss.

  12. Pos MA — a master’s position that is copied.

  13. % base — the size ratio of investor position to master position.

Account subscriptions screens for masters and investors are almost identical but there are some differences.

_images/screen-diff-1.png
_images/screen-diff-2.png
  1. Master can also view all positions of the subscribers as well as their balance and equity.

  2. Create new button is slightly different for masters and subscribers. By clicking this button you create the subscription for this particular account:

    • as Master, it subscribes an Investor according to the login you typed in the box

    • as Investor, it subscribes to a Master

Subscription Settings Screen

This screen displays all the settings for each particular subscription.

Subscription Information

_images/subscriptions-properties-info.png

On this page you can edit the details, described in the Account Subscriptions Screen article.

Positions Opened by Subscription

On the Positions screen you can view all positions that have been copied to an investor according to some particular subscription.

_images/subscriptions-properties-positions.png

Fees

The Fees screen demonstrates all payments from investors to masters.

_images/fees.png

Account Balance Screen

On this screen you can view balance and free margin of a payment account (how much can be transferred), as well as the same data for investment/master account to or from which the transfer is going to be made.

_images/account-balance.png

By clicking on the Unsubscribe and withdraw all button you can unsubscribe an account from all masters, all trades will be closed and remaining funds will be withdrawn to a payment account.

Account Positions Screen

On this screen you can view all opened positions as well as subscription positions if the account is master.

_images/account-position-screen.png

Account History Screen

On this screen you can view all deals in MT5 (or orders in MT4).

_images/account-history-screen.png
  1. Balance / Credit box — balance/credit values. If there are no credit funds, the second part after the slash isn’t visible.

  2. Sum DW / PL — deposit-withdrawal and profit-loss values.

  3. HWM — the highest value of your portfolio, after deducting other costs and removing deposits or withdrawals.

  4. Equity / Margin free — equity and free margin values.

  5. First deal — the date and time of the first executed order.

  6. TWR — coefficient of profitability which reflects profit to initial capital ratio.

  7. TWR (30 days) — TWR within 30 days.

  8. Equity DD — a peak-to-trough decline from amount of equity during a specific period for an investment.

Some deals can have Statist in the Comment column, which means that a record is informational and it is used only for collecting and statistics purposes.

Each line in the database contains information about the account’s equity, balance and other data necessary for statistics.

Note

In the upper right corner you can find the History button which allows you to upload existing history in a CSV file or import history from a pre-created CSV file.

On this page you can also see 2 tabs: Deals and Positions.

Positions tab consists of only trades, and Deals tab includes also statistics.

_images/positions-tab.png
_images/deals-tab.png

Account Fees Screen

On this page you can view all fees of subscribers (as master) or fees to all masters, to whom an account is subscribed (as investor).

You can sort all fees by receiver and type to find a specific payment.

_images/account-fees-screen.png

Subscriptions Screen

On this screen you can view all subscriptions of the server and information related to them.

_images/subscriptions-screen.png
  1. Sidebar Menu.

  2. Refresh Button.

  3. Create new subscription Button.

  4. Show archived checkbox to show archived accounts.

  5. Export to file button.

To see all details of a particular subscription, double click on the subscription.

_images/subscriptions-details.png

Ref. to Subscription Settings Screen for the detailed description of all settings.

WhiteLabels Screen

On this screen you can view all WhiteLabel brokers and manage their main settings.

_images/whiteLabels-screen.png
  1. Sidebar menu.

  2. Refresh button.

  3. Managers button for access to B2Broker Manager App.

To activate the settings field, click on the required WhiteLabel at the top of the screen.

After the changes are implemented, click the Save button on the right.

Also you are can copy all settings from another WhiteLabel, including SMTP (Simple Mail Transfer Protocol) settings and Mail’s text.

_images/WL-copy-from.png

Access

On this page you can view all settings related to access configurations.

_images/whiteLabels-access.png
  1. The range of accounts that are allowed to logon to the web-interface.

  2. Address (or IP) of MetaTrader server.

  3. Address of Trader’s room.

  4. Address of Trader’s room restore password.

  5. Web server (for notification) — address for sending balance and trading notifications.

  6. Token lifetime, minutes — time period when the token is valid.

  7. Disable user registration by E-mail checkbox.

  8. Allow reset MT account’s password.

  9. Allow change Name or Description of accounts.

Accounts

On this page you can view all settings related to accounts and their work.

_images/whiteLabels-accounts.png
  1. Allow create account — allows clients to create new accounts on their own.

Note

If inactive, the buttons for creating new accounts will be hidden in the web interface.

  1. Do not create account for read-only MT Auth. account — restrict clients to create accounts if their MT payment account is read-only (without ability to trade).

Note

Usually, Read-only status is assigned to accounts with minimal deposit.

  1. Use ‘next’ MT login — use the method of naming accounts that automatically sets the next number after the previous one created.

  2. Use specified range for accounts login — use the range in which new accounts can be created.

Note

If all groups are unavailable to managers who connect the service to the MT, you have to specify the range.

You can also set separate range for Masters, for example, to be able to identify them easier.

  1. Maximum accounts for User — maximum number of accounts that can be created by one client.

  2. Hide all passwords for subscribers — if the checkbox is active, the passwords for subscribers won’t be visible in the web interface.

  3. Allow become Signal (Master) account — make social trading available.

  4. Allow become Manager of subscription properties — make MAM-accounts available.

  5. Allow become Fund account and receive investments — make PAMM-accounts available.

  6. Allow close positions from web requests — allow to close trades on copy trading accounts via web interfaces.

  7. Allow deposit / withdrawal queue for Fund investor — allow to deposit/withdraw the funds for PAMM accounts.

Note

If inactive, the buttons will be hidden from the web interface.

  1. Allow deposit / withdrawal queue for Other accounts — allow to deposit/withdraw the funds for MAM and Copier accounts.

  2. Show day risk / Edit — show loss limit for masters in web interfaces.

  3. Show ‘hide from rating’ — show in web interfaces a setting to hide accounts from the Leaderboard.

  4. Account currency — set up account currency.

  5. Currency groups — set up groups for each account type.

Note

You may choose only from those groups that are available to MT managers through which the platform connects to MT.

After adding a group to a Manager, you have to restart the dapli service.

  1. Leverage (here: 100) — setting of leverage which clients may select when creating accounts.

Subscriptions

_images/whiteLabels-subscriptions.png
Max Subscriptions for IA

Maximum number of subscriptions per investment account

Max Subscriptions for LA

Maximum number of subscriptions for all accounts tied to one authorization/payment account

Setup fee

Entrance fee (subscription)

Note

Absent in web interfaces.

Show Trade fee

Show and allow to edit the rewards for volume

Show performance fee

Show and allow to edit the rewards for success

Show profit fee

Show and allow to edit reward only with profitable trades

Show management fee

Show and allow to edit remuneration for management

Hour

Setting of rule for PAMM Account Rollover (how and when clients’ funds are deposited and withdrawn)

Description of options for time selection rollover setting:

Manual — only upon confirmation of a trader in the web interface or confirmation of a broker in the admin panel/Manager application

Immediately — all deposits/withdrawals will be carried out instantly after application on deposit/withdrawal is created by a client

Hour — on schedule

View

_images/view.png

On this screen you can manage web interface settings.

Hide WA info

Remove a payment account from the web interface

View Rating

Show/hide ranking (leaderboard) in the website menu interfaces

Only active accounts

Show only active accounts (which have had trades in the last 60 days)

Login / description

Show login and account description in rating

Performance

Show profitability in rating

IA count

Show number of subscribers

Max DD

Show maximum drawdown

Note

You can also choose a formula for calculation: from invested funds or from a high watermark in terms of profitability.

Age of account

Show account’s age

Balance / equity

Show a balance-equity on the statistics page

Performance chart

Show a graph of yield

IA money

Show amount of subscribers money

View subscription

Show traders the number of investors subscribed to them

View MA trading

Show trader’s deals

Below you can find description of fields of the Statistics section:

Balance

Show account balance

Float P/L

Show floating profit

Day P/L

Show number of profitable and unprofitable days

Max day profit

Show maximum profit per day

Trade series

Show a series of profitable and unprofitable transactions

Equity chart

Show chart of account funds

Equity

Show account funds

Realized P/L

Show realized profit

Positions count

Show number of positions

Max day loss

Show maximum loss per day

Day series

Show a series of profitable and unprofitable days

Mail

_images/mail.png

On this page you can configure the platform to send e-mails to clients automatically after an account is created or other client’s actions are made.

To do so, enter the SMTP Server data in the form on the left.

After clicking the plus icon, you can choose the account types and emails you want to send to these accounts.

_images/mails-by-account-types.png

After clicking the letter and the pencil icon, you will be redirected to the screen where you can insert HTML email template.

_images/insert-template.png

Below you can see the basic email template. You can edit it for any Whitelabel or broker.

_images/basic-template.png