FixPortalDocsSimulator
Browse documentation

Tenant administration

Platform → Tenants is available only to users with the PlatformAdmin role. It is a cross-workspace administration screen. Session write access alone does not grant access to it.

Find and review a tenant

The left pane lists tenants by name and slug. Use the search box to filter either value, then select a tenant. Each row shows status and today's outbound usage against its daily budget. The detail pane shows:

  • status
  • slug
  • creation date
  • active logged-on sessions
  • today's outbound usage and daily budget

Tenant usage refreshes while the page is open. Use Diagnostics to investigate a specific simulator session.

Change settings and limits

Edit the selected tenant's values and select Save changes. The page saves the displayed settings together as one change. If another administrator changes the tenant first, the save is rejected, the latest settings are reloaded, and you must reapply the intended edit before saving again.

Load testing and traffic limits

Enabled under Load testing allows the tenant to start a load test from a session's Traffic page. It does not start a test by itself. A suspended tenant cannot start a load test.

Outbound rate cap accepts 10 through 100000 messages per second. Despite its label, the cap shapes both inbound and outbound traffic. Outbound messages wait for capacity; inbound messages that exceed capacity are rejected.

Daily outbound budget accepts 100 through 1048576 MB. The usage figure measures outbound FIX bytes for the current day. When a session exceeds the budget, the simulator sends a business-message rejection where possible and disconnects that session. The usage counter resets at UTC midnight.

See Traffic before enabling load testing.

Routing and engine settings

The tenant screen provides the same Override precedence, Pending route timeout, Remove orphaned overrides on save, and Allow order reactivation settings as Global Settings. Their effects are described there, with related workflows in Sim Config reference, Multi-broker routing, and Blotters.

The tenant detail screen does not expose the FX execution or allocation controls. Configure those in the tenant's Global Settings and use FX dealing for order handling.

Disconnect or suspend

Force-disconnect all asks for confirmation, then logs out and disconnects every live FIX session bound to the selected tenant. The tenant remains active and can reconnect.

Suspend tenant asks for confirmation, marks the tenant suspended, and disconnects its live sessions. Use Unsuspend to return the tenant to active status. Suspending does not delete the tenant, its sessions, or its configuration.

Disconnecting or suspending a tenant interrupts every live FIX session for that tenant. Check active sessions and coordinate the change before confirming it.

Operations not provided here

The current Tenants page does not create, rename, delete, or merge tenants. It also has no tenant membership manager and does not issue invitations. Use the available Account and Invitations workflows for user access; tenant creation and membership changes are not controls on this page.

Updated 2026-09-08 · Edit on GitHub