SystemMode
Set the current operational mode of the system.
- Section: Transactions
- Related Message: SystemModeReply
System Mode examples include Started, Bootstrapping, Initialising and Ready.
The modes are generally set by the system itself (or operational tools). It should not be set manually without careful consideration.
Metadata
- Message Type: TransactionMessage
- Message Number: 1016
Inherited fields
| Name | Type | Size (bytes) | Description |
|---|---|---|---|
| MessageType | Integer (unsigned) | 2 | The unique identifier of this message. |
| ClientId | Integer (unsigned) | 4 | The unique identifier of a session with the server, returned in a successful LoginReply message. |
| RequestId | Integer (unsigned) | 4 | Within each session each message must be uniquely identified by this field. It must be monotonically increasing for the duration of the session. |
Fields
| Name | Type | Size (bytes) | Description |
|---|---|---|---|
| Mode | One of SystemMode | 1 | |
| ClearFlag | Integer (unsigned) | 1 | Set to withdraw all orders with the system mode change. |
Permissions
Changing System Mode
{ mode: SystemMode.Unload }
Permission Checks
| PermissionAction | Table | Scope | Index |
|---|---|---|---|
| Amend | Venue | Instance | 0 |
Test file: SystemMode