Bulk Edit
Set or remove a payment plan for many symbols, trading groups and IB types in one operation, and track the progress of bulk operations and CSV imports
On this page, you can set or remove a payment plan for many symbols, trading groups and IB types at once, instead of editing symbols one by one on the Symbols tab of an IB type or preparing a CSV file for import.
A bulk operation runs in the background. Before any payment plan is changed, a snapshot of the affected plans is saved, so the change can be reverted on request.
To start a new operation, click Create. To open the details of an operation, click its row in the list.
Operation list
The list shows bulk operations together with CSV imports of payment plans, providing the following information:
Created
The date and time when the operation was created.
Type
The type of the operation. Possible values:
- Bulk edit — an operation created on this page.
- CSV import — a payment plan file imported on the Symbols tab of an IB type.
- Restore — a restore of an earlier operation from its snapshot, performed by the B2BROKER support team on request.
Platform
The trading platform the operation applies to. Shown as — for CSV imports and restores.
IB types
The IB types the operation applies to: the name of a single IB type, the number of selected IB types, or All (N) when no IB type was selected and the operation applied to all N IB types that existed at the time.
Scope
The number of selected trading groups and symbols, for example 15 groups · 39 symbols. When no trading group or no symbol was selected, the scope reads All groups or All symbols. For a CSV import, the name of the imported file.
Action
What the operation does: Set: <payment plan> <amount> <currency>, <position> (for example Set: Lot 10 USD, Closed), Remove, Import or Restore.
Status
The current status of the operation. Possible values:
- Pending — the operation is queued and has not started yet.
- Processing — the operation is running.
- Completed — the operation has finished. Rows that could not be processed are counted in the Errors column.
- Failed — the operation stopped before it finished. The error message is shown on the details page.
Rows
The number of processed payment plan rows out of the total, for example 661 / 1,170.
Errors
The number of payment plan rows that could not be processed.
Use the filters above the list to narrow it down by the creation date range, type, platform, IB type or status.
Creating an operation
Click Create and fill in the form. The fields are applied from top to bottom: the platform scopes everything below it.
Platform
The trading platform whose symbols and trading groups you want to change. Choose it first: the available payment plans, trading groups, symbols and symbol groups depend on the platform.
IB types
The IB types whose payment plans are changed. Type at least two characters to search, then select one or more IB types.
Leave the field empty to apply the change to every IB type. In this case a warning is displayed below the coverage line: No IB type selected: the change applies to all N IB types, including tiers with a different rebate.
Trading groups
The trading groups on the selected platform. Type at least two characters to search. The search returns both individual groups, such as real\OX\Cash\Std\15, and folders, such as real\OX\Cash\Vip\*.
An entry ending in \* is a folder and covers the group with that path, if one exists, and every group below it. Type a path ending in \* (for example real\OX\Cash\Vip\*) to jump straight to that folder; entries you have already selected, and everything under a selected folder, are hidden from the search results. Leave the field empty to apply the change to all trading groups on the platform.
Symbols
The symbols on the selected platform. Type at least two characters to search. The search returns both individual symbols, such as Forex\Majors\EURUSD, and folders, such as Shares\Shares Asia\*.
An entry ending in \* is a symbol group folder and covers the symbol with that path, if one exists, and every symbol below it. Type a path ending in \* (for example Shares\Shares Asia\*) to jump straight to that folder; entries you have already selected, and everything under a selected folder, are hidden from the search results. Symbol groups exist only on MetaTrader 5; on other platforms, the search returns individual symbols only. Leave the field empty to apply the change to all symbols on the platform.
Archived trading groups and symbols are never included in an operation.
Coverage
A read-only line that shows what the current selection covers: the number of IB types, trading groups, symbols and the resulting number of payment plan rows, for example 2 IB types · 15 trading groups · 39 symbols · 1,170 plan rows. Until a platform is chosen, the line reads Choose a platform to see what the selection covers. The line is recalculated after every change to the fields above. For very large selections, the number of plan rows may be shown as an estimate: about 1,170 plan rows.
The number of payment plan rows is limited. If the selection exceeds the limit, a warning is displayed below the line (The selection covers N plan rows, more than the limit of M. Narrow the selection before applying.) and the Apply button is disabled until you narrow the selection.
Operation
The action to perform. Possible values:
- Set payment plan — create the specified payment plan for every selected symbol and trading group for each selected IB type. Existing plans for the same symbols are replaced.
- Remove payment plan — remove the payment plans of the selected symbols and trading groups for each selected IB type. The payment plan fields are hidden, and the Apply button turns into Remove.
Payment plan
Applicable only for the Set payment plan operation.
The reward calculation model. The list contains the same payment plans as the symbol form, filtered by the selected platform. The Max amount plan is available only when exactly one IB type is selected, because its level table depends on the number of levels configured for that type.
Currency, Amount (Percentage or Markup, depending on the payment plan), Position
Applicable only for the Set payment plan operation.
The settings of the selected payment plan: the reward currency, the amount or percentage, and the state of positions for which rewards are paid (Open, Closed or Open & Closed). The set of fields depends on the payment plan, as described in How to set up a payment plan for symbols. For the Max amount plan, the level table is filled in via the Levels 2, Levels 3, … links that appear below the amount, one per level configured for the selected IB type.
Click Apply (or Remove) to start the operation. There is no confirmation dialog: the coverage line is your confirmation step.
After you click Apply
- The operation is queued and its details page opens. While the status is Pending or Processing, the page refreshes automatically and shows the number of processed rows out of the total.
- Before the first payment plan is changed, a snapshot of every existing payment plan in the selected scope is saved to your storage bucket. If the snapshot cannot be saved, the operation fails without changing anything. Once the snapshot is saved, the Backup row of the details page shows a Download snapshot link together with the number of saved rows and the time the snapshot was taken.
- The payment plans are created, replaced or removed in chunks. Bulk operations and CSV imports run one at a time, so a new operation waits until the previous one finishes.
- When the operation finishes, its status changes to Completed or Failed. Rows that could not be processed are listed in the Errors table on the details page with the columns IB type, Trading group, Symbol and Error; the table shows the first failed rows, and the Errors column of the list holds the full count. For a CSV import, the Error column shows the line number and the message. A failed operation shows the error message in a red alert.
The details page also lists the operation's parameters: the type, platform, IB types, trading groups, symbols (folders are shown with the trailing \*) and the action, as well as a Rows line in the form 1,170 total · 661 processed · 0 errors. For a CSV import, the File row shows the imported file name instead of the trading groups and symbols; click the file name to download the uploaded file.
To revert a completed operation, contact the B2BROKER support team and provide the link to the operation's details page (or its date and time from the list). The snapshot is kept in your storage bucket, and the support team restores the payment plans that existed before the operation. Payment plans edited manually after the operation are also reverted to the snapshot. The restore appears in the operation list as a separate operation of the Restore type.
You can also download the snapshot yourself via the Download snapshot link in the Backup row of the details page. The file is a compressed CSV (.csv.gz) with the same columns as a payment plan import file: unpack it, and a snapshot of an operation that covered a single IB type can be imported as is on the Symbols tab of that IB type.
Permissions
Access to this page is controlled by two permissions in the System > Groups > Introducing brokers section of the B2CORE Back Office.
| Permission | What it unlocks |
|---|---|
| View bulk payment plan operations | The Bulk Edit menu item, the operation list and the details pages, including CSV imports. |
| Create bulk payment plan operations | The Create button and the form, as well as the Bulk edit shortcuts on the Symbols tab of an IB type and on the Platforms > Symbols page. |
When the feature is installed, existing user groups receive the new permissions automatically: groups with the Import permission receive both, and groups with the View programs, tiers, levels and preferences permission receive View bulk payment plan operations. Review the assignment if your groups need a different split.
آخر تحديث في