Version: 1.0
Status: ⚪⚪⚪
BackOffice plugin for Thunder framework.
This document describes purpose and functionality of the BackOffice plugin. It includes detailed specification about its configuration.
All identifiers of the interfaces described in this document are case-sensitive. Thus, unless stated otherwise, all keywords, entities, properties, relations and actions should be treated as such.
The table below provides and overview of acronyms used in this document and their definitions.
| Acronym | Description |
|---|---|
| API | Application Programming Interface |
| HTTP | Hypertext Transfer Protocol |
| JSON | JavaScript Object Notation; a data interchange format |
| JSON-RPC | A remote procedure call protocol encoded in JSON |
The table below provides and overview of terms and abbreviations used in this document and their definitions.
| Term | Description |
|---|---|
| callsign | The name given to an instance of a plugin. One plugin can be instantiated multiple times, but each instance the instance name, callsign, must be unique. |
| Ref ID | Description |
|---|---|
| HTTP | HTTP specification |
| JSON-RPC | JSON-RPC 2.0 specification |
| JSON | JSON specification |
| Thunder | Thunder API Reference |
The BackOffice plugin responsible for monitoring lifecycle of observables and passing this info to the server.
The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [Thunder].
The table below lists configuration options of the plugin.
| Name | Type | Description |
|---|---|---|
| callsign | string | Plugin instance name (default: BackOffice) |
| classname | string | Class name: BackOffice |
| locator | string | Library name: libThunderBackOffice.so |
| startmode | string | Determines if the plugin shall be started automatically along with the framework |
| configuration | object | |
| configuration.server_address | string | Back office server address |
| configuration.server_port | number | Back office server port |
| configuration.customer | string | Customer name |
| configuration.platform | string | Platform name |
| configuration.country | string | Country code |
| configuration?.type | string | (optional) Type |
| configuration?.session | number | (optional) session number |
| configuration.callsign_mapping | string | Mapping on how to map callsigns to server accepted names |
| configuration.state_mapping | string | Mapping on how to map state to server accepted states |