Versions Compared

Version Old Version 31 New Version Current
Changes made by

author

author

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property NameDescriptionRequiredDefault Value 

Transport adapter parameters

TransportLayer.RestTA.Description

User-defined description of the Transport Adapter

Y

REST Acceptor TA

TransportLayer.RestTA.DllName

TA library file name. In case this parameter is not specified, the TransportLayer.RestTA.AdapterId is applied to define the adapter's library by ID

Y

  

TransportLayer.RestTA.AdapterId

The parameter to define the adapter's library by ID. In case this parameter is not specified, or TransportLayer.RestTA.DllName parameter is specified too, the TransportLayer.RestTA.DllName is applied

Info

This parameter is applicable since FIXEdge C++ version 6.14.0


NREST_ACCEPTOR

TransportLayer.RestTA.Type

TA library type

Y

DLL

TransportLayer.RestTA.ClientID 

Transport adaptor Client ID which identifies the source of messages in BL config

Y


TransportLayer.RestTA.ListenPort

TCP port number for incoming HTTP connections. Allowed range is 1 - 65535

N

8001

TransportLayer.RestTA.FIXVersion

FIX version of generated messages:

  • FIX40 - FIX 4.0
  • FIX41 - FIX 4.1
  • FIX42 - FIX 4.2
  • FIX43 - FIX 4.3
  • FIX44 - FIX 4.4
  • FIX50 - FIX 5.0
  • FIX50SP1 - FIX 5.0 SP1
  • FIX50SP2 - FIX 5.0 SP2 
  • FIXLatest - FIX Latest
  • custom dictionaries

N

 

FIX44

 

TransportLayer.RestTA.ConversionMethod

The method used to convert input messages into FIX format:

  • WrapInXmlMessage - put the input data into FIX XML message of 'n' type
  • NumericTagValueMapping - parse the input JSON file format to corresponding FIX message

  • Raw- raw FIX message (FIX message is sent to BL as is)

    Info

    Introduced in FIXEdge 6.9.0


N

 

NumericTagValueMapping

 

TransportLayer.RestTA.ValidateFIXMessage

Enables/disables validation of resulting FIX message:

  • No – validation disabled
  • ValidateAndWarn – validation enabled, a warning message is added to the log when validation fails
  • ValidateAndReject – validation enabled, service returns HHTP error 400 (bad request) and rejects the message if validation fails 

N

No

TransportLayer.RestTA.SourceIPAddress

Provides the ability to filter IP addresses on the REST Acceptor TA. Allows specifying multiple comma-separated IP addresses as well as hostnames.

Info

Available since FIXEdge 6.17.0


N

HTTP(S) Server Parameters

TransportLayer.RestTA.Protocol

Security type of connection. Allows user to setup secure or non-secure HTTP connection. 
Info

Introduced in FIXEdge 6.9.0

  • HTTP - non-secure connections 

  • HTTPS - secure connections 

Yes 

TransportLayer.RestTA.HTTP.timeout

Connection timeout for HTTP connections in seconds.

 

N

 

60

 

TransportLayer.RestTA.HTTP.keepAlive 

Enables/disables persistent HTTP connections:

  • false – persistent HTTP connections are disabled
  • true – persistent HTTP connections are enabled 

N

true

 

TransportLayer.RestTA.HTTP.maxKeepAliveRequests

Specifies the maximum number of requests allowed during a persistent connection. 0 means unlimited connections.

N

0

 

TransportLayer.RestTA.HTTP.keepAliveTimeout

Connection timeout for persistent HTTP connections in seconds. 

N

10

TransportLayer.RestTA.HTTP.maxThreads

A maximum number of threads processing HTTP requests. The allowed range is 1 – 16. 

N

1

TransportLayer.RestTA.HTTPS.PrivateKey

Path to a private key

Info

Introduced in FIXEdge 6.9.0


Conditional. 
Required with secure connections:
TransportLayer.RestTA.Protocol = HTTPS

 FIXEdge1/conf/AdminRESTAPI.key

TransportLayer.RestTA.HTTPS.Certificate 

Path to certificate 

Info

Introduced in FIXEdge 6.9.0


Conditional. 
Required with secure connections:
TransportLayer.RestTA.Protocol = HTTPS

 FIXEdge1/conf/AdminRESTAPI.key

TransportLayer.RestTA.HTTPS.PrivateKeyPassword

Private key passwordConditional
Used when the private key is password-encrypted.

TransportLayer.RestTA.AuthHeader

Authentication header (may be used in HTTP mode also)

Info

Introduced in FIXEdge 6.9.0


No

TransportLayer.RestTA.AuthValue

Authentication value (may be used in HTTP mode also)

Info

Introduced in FIXEdge 6.9.0


No

Logging Parameters

TransportLayer.RestTA.LogCategory

Transport adaptor log category

Y


 Log.RESTTA.Device

The target device for logging the received and sent messages:

  • File – writes a log to a separate file
  • Console – sends a log to console window 

N

 

 Log.RESTTA.File.Name

 Filename used to log the received and sent messages

N

 

...