MT5 Gateway Configuration Examples

The example below contains four routing rules. The Gateway uses the match priority to select a rule, then uses the last matching rule within that priority.

Configuration example — edited values.

A login-specific match takes precedence over a group-specific match. Within the same account match type, a symbol-specific match takes precedence over a security match.

When several rules match at the same priority, the Gateway uses the last matching rule. For example, these two rules match the same group and security:

With the rules in this order, an order from DEMO for a symbol under Forex\* uses Account3, provided no rule at a higher priority matches. Check both the match priority and the rule order when troubleshooting routing.

Use a general group/security rule to route orders for a group of clients and a symbol path.

sec=Forex\*;g=DEMO;acc=Account4

This rule routes orders from group DEMO for symbols under Forex\* to XCore Connector Account Account4. A matching rule with a higher priority takes precedence.

Use c to route a specific MT5 client login independently of its group.

sec=Forex\*;c=10000;acc=Account2

This rule routes orders from login 10000 for symbols under Forex\* to Account2. It takes precedence over a group/security rule for the same order. A matching login/symbol rule has higher priority.

Use sym to configure routing for a specific symbol. This example follows the symbol path used in the illustrated configuration.

sym=Forex\EURUSD;g=DEMO;acc=Account3

This rule routes Forex\EURUSD orders from group DEMO to Account3. Other symbols continue to use the applicable security rule. A matching login-specific rule takes precedence.

Use color together with the group and security selectors to route orders from accounts with a specific MT5 client login color.

sec=Forex\*;g=OBO-TEST;color=222;acc=Account2

Replace 222 with the first component of the target accounts' color (R in R,G,B). The example selects orders that match the group, security, and color conditions together.

For the displayed color 222,0,0, the first component is 222, so use:

public int login2_color = 222;

The screenshot shows Color set to 222,0,0. The rule uses its first component: color=222. The second and third components are not used by this condition.

The table lists the rules in match-priority order. Select the first applicable match type; within that type, the last matching rule is used.

The table lists the rules in match-priority order. Select the first applicable match type; within that type, the last matching rule is used.

Execution settings apply to the routing rules that follow them in the configuration. The example shows how changing OrderRule entries affects each group:

How settings carry forward: Each execution category keeps its last configured settings until another rule changes that category. If no settings have been configured for a category, the Gateway uses its defaults. In this example, routing rule 2 uses OrderRule1 and OrderRule2; routing rule 3 uses OrderRule1 and OrderRule3.

After changing Gateway rules, check the MT5 Connector's trading log. Locate PARSE CONFIG START, review the following GatewayConfig entries, and confirm PARSE CONFIG SUCCESS. Investigate any configuration errors before relying on the new rules.

Example of a successful configuration load:

2022-04-18 07:45:10.989|671380 [INFO ] in : msg : PARSE CONFIG START
2022-04-18 07:45:10.989|671394 [INFO ] in : msg : GatewayConfig: name=1000:Gateway value=sec=*;g=*;acc=acc1
2022-04-18 07:45:10.989|671395 [INFO ] in : msg : GatewayConfig: name=1001:Gateway value=sec=Forex\*;c=10000;acc=acc2
2022-04-18 07:45:10.989|671395 [INFO ] in : msg : PARSE CONFIG SUCCESS