BackOffice Plugin

Version: 1.0

Status:

BackOffice plugin for Thunder framework.

Introduction

Scope

This document describes purpose and functionality of the BackOffice plugin. It includes detailed specification about its configuration.

Case Sensitivity

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.

Acronyms, Abbreviations and Terms

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.

References

Ref ID	Description
HTTP	HTTP specification
JSON-RPC	JSON-RPC 2.0 specification
JSON	JSON specification
Thunder	Thunder API Reference

Description

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].

Configuration

The table below lists configuration options of the plugin.

Name	Type	M/O	Description
callsign	string	mandatory	Plugin instance name (default: BackOffice)
classname	string	mandatory	Class name: BackOffice
locator	string	mandatory	Library name: libThunderBackOffice.so
startmode	string	mandatory	Determines in which state the plugin should be moved to at startup of the framework
configuration	object	mandatory	...
configuration.server_address	string	mandatory	Back office server address
configuration.server_port	integer	mandatory	Back office server port
configuration.customer	string	mandatory	Customer name
configuration.platform	string	mandatory	Platform name
configuration.country	string	mandatory	Country code
configuration?.type	string	optional	Type
configuration?.session	integer	optional	Session number
configuration.callsign_mapping	string	mandatory	Mapping on how to map callsigns to server accepted names
configuration.state_mapping	string	mandatory	Mapping on how to map state to server accepted states