th2-conn-qfj

This microservice allows you to send and receive messages over the FIX protocol

Configuration

• grpcStartControl - enables start/stop control via gRPC service (false by default)

• autoStart - start service automatically (true by default and if startControl is false)

• autoStopAfter - stop after N seconds if the service was started automatically prior to send (0 by default which means disabled)

• sessionsSettings - list with sessions settings for QuickFix:

  Name of tag	Description	Valid Values	Default value
  BeginString	Version of FIX this session should use	FIX.4.4, FIX.4.3, FIX.4.2, FIX.4.1, FIX.4.0, FIXT.1.1 (which then requires DefaultApplVerID, see below)
  SenderCompID	Your compID as associated with this FIX session	case-sensitive alpha-numeric string
  SenderSubID	(Optional) Your subID as associated with this FIX session	case-sensitive alpha-numeric string
  SenderLocationID	(Optional) Your locationID as associated with this FIX session	case-sensitive alpha-numeric string
  TargetCompID	Counterparty's compID as associated with this FIX session	case-sensitive alpha-numeric string
  TargetSubID	(Optional) Counterparty's subID as associated with this FIX session	case-sensitive alpha-numeric string
  TargetLocationID	(Optional) Counterparty's locationID as associated with this FIX session	case-sensitive alpha-numeric string
  DefaultApplVerID	Required only for FIXT 1.1 (and newer). Ignored for earlier transport versions. Specifies the default application version ID for the session. This can either be the ApplVerID enum (see the ApplVerID field) the beginString for the default version.	String. Examples: FIX 5.0 over FIXT 1.1 DefaultApplVerID=7 # BeginString: FIX 5.0 over FIXT 1.1 DefaultApplVerID=FIX.5.0 # BeginString: FIX 4.2 over FIXT 1.1 DefaultApplVerID=FIX.4.2	No default. Required for FIXT 1.1
  ConnectionType	Defines if session will act as an acceptor or an initiator	initiator / acceptor
  ValidateUserDefinedFields	If set to N, user defined fields (field with tag >= 5000) will not be rejected if they are not defined in the data dictionary, or are present in messages they do not belong to.	Y / N	Y
  ValidateIncomingMessage	Allow to bypass the message validation (against the dictionary).	Y / N	Y
  CheckLatency	If set to Y, messages must be received from the counterparty within a defined number of seconds (see MaxLatency). It is useful to turn this off if a system uses localtime for its timestamps instead of GMT.	Y / N	Y
  ReconnectInterval	Time between reconnection attempts in seconds. Only used for initiators	positive integer	30
  HeartBtInt	Heartbeat interval in seconds. Only used for initiators.	positive integer
  LogonTimeout	Number of seconds to wait for a logon response before disconnecting.	positive integer	10
  LogoutTimeout	Number of seconds to wait for a logout response before disconnecting.	positive integer	2
  NonStopSession	If set the session will never reset. This is effectively the same as setting 00:00:00 as StartTime and EndTime.	Y / N	N
  SocketConnectPort	Socket port for connecting to a session. Only used with a SocketInitiator	positive integer
  SocketConnectHost	Host to connect to. Only used with a SocketInitiator	valid IP address in the format of x.x.x.x or a domain name
  SocketConnectProtocol	Specifies the initiator communication protocol. The SocketConnectHost is not used with the VM_PIPE protocol, but the SocketConnectPort is significant and must match the acceptor configuration.	"TCP" or "VM_PIPE".	"TCP"
  SocketConnectPort	Alternate socket port(s) for connecting to a session for failover or load balancing, where n is a positive integer, i.e. SocketConnectPort1, SocketConnectPort2, etc. Must be consecutive and have a matching SocketConnectHost	positive integer
  SocketConnectHost	Alternate socket host(s) for connecting to a session for failover or load balancing, where n is a positive integer, i.e. SocketConnectHost1, SocketConnectHost2, etc. Must be consecutive and have a matching SocketConnectPort Connection list iteration rules: Connections are tried one after another until one is successful: SocketConnectHost:SocketConnectPort, SocketConnectHost1:SocketConnectPort1, etc. Next connection attempt after a successful connection will start at first defined connection again: SocketConnectHost:SocketConnectPort.	valid IP address in the format of x.x.x.x or a domain name
  FileStorePath	Directory to store sequence number and message files. Only used with FileStoreFactory.	valid directory for storing files, must have write access
  FileLogPath	Directory to store logs. Only used with FileLogFactory.	valid directory for storing files, must have write access
  RefreshOnLogon	Refresh the session state when a Logon is received. This allows a simple form of failover when the message store data is persistent. The option will be ignored for message stores that are not persistent (e.g., MemoryStore).	Y / N	N
  ResetOnLogon	Determines if sequence numbers should be reset before sending/receiving a logon request.	Y / N	N
  ResetOnLogout	Determines if sequence numbers should be reset to 1 after a normal logout termination.	Y / N	N
  ResetOnDisconnect	Determines if sequence numbers should be reset to 1 after an abnormal termination.	Y / N	N
  ResetOnError	Session setting for doing an automatic reset when an error occurs. A reset means disconnect, sequence numbers reset, store cleaned and reconnect, as for a daily reset.	Y / N	N
  DisconnectOnError	Session setting for doing an automatic disconnect when an error occurs.	Y / N	N
  SessionAlias	session alias for incoming/outgoing th2 messages.	case-sensitive alpha-numeric string
  QueueCapacity	maximum size of the session message queue	integer value

We can also put these settings in the root directory to set the default session settings.

The service will automatically connect before sending the message, if it was not connected

MQ pins

• input queue with subscribe and send attributes for outgoing messages
• output queue with publish, first (for incoming messages) or second (for outgoing messages) attributes

Inputs/outputs

This section describes the messages received and produced by the service

Inputs This service receives messages that will be sent via MQ as MessageGroups, containing a single RawMessage with a message body

Outputs Incoming and outgoing messages are sent via MQ as MessageGroups, containing a single RawMessage with a message body.

Deployment via infra-mgr

Here's an example of infra-mgr config required to deploy this service.

apiVersion: th2.exactpro.com/v1
kind: Th2Box
metadata:
  name: conn-qfj
spec:		
  image-name: ghcr.io/th2-net/th2-conn-qfj
  image-version: 0.0.1
  custom-config:
    grpcStartControl: true
    autoStart: true
    autoStopAfter: 0
    fileStorePath: storage/messages/
    fileLogPath: outgoing
    connectionType: initiator
    reconnectInterval: 60
    heartBtInt: 30
    useDataDictionary: Y
    nonStopSession: Y
    sessionsSettings:
      -  
        beginString: FIXT.1.1
        defaultApplVerID: 9
        socketConnectHost: 10.119.1.45
        socketConnectPort: 32104
        senderCompID: client2
        targetCompID: server
        sessionAlias: client2
        appDataDictionary: FIX.5.0.xml
        transportDataDictionary: FIXT.1.1.xml
      -
        beginString: FIX.4.2 
        socketConnectHost: 10.119.1.45
        socketConnectPort: 32102
        senderCompID: client1
        targetCompID: server
        sessionAlias: client1
        dataDictionary: FIX.4.2.xml
  type: th2-conn
  pins:
    - name: to_send
      connection-type: mq
      attributes:
        - subscribe
        - send
        - raw
    - name: outgoing_messages
      connection-type: mq
      attributes:
        - second
        - publish
        - raw
    - name: incoming_messages
      connection-type: mq
      attributes:
        - first
        - publish
        - raw
  extended-settings:
    service: 
      enabled: false
    resources:
      limits:
        memory: 400Mi
        cpu: 800m
      requests:
        memory: 100Mi
        cpu: 20m