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.

Table of Contents

...

If the JSON representation is used, the "Content-Type" header in the HTTP request is set to "application/json". For all formats other than JSON, the "Content-Type" header is specified as "text/plain".

The message conversion type is specified with the TransportLayer.RestOutTA.ConversionMethod parameter.

...

Property 

Description 

Required 

Values/Examples 

Configuration parameters 




TransportLayer.TransportAdapters

The list of user-defined Transport Adapter names. The several instances should be separated by a comma 

Info

The following configuration will show configuration parameters for an adapter with the name TransportLayer.RestOutTA, i.e. TransportLayer.TransportAdapters = TransportLayer.RestOutTA


No


TransportLayer.RestOutTA.Description

The description of the adapter. This information is shown in Monitoring API

Yes 

REST Initiator Client 

TransportLayer.RestOutTA.DllName

Path to Transport Adapter library. In case this parameter is not specified, the TransportLayer.RestOutTA.AdapterId is applied to define the adapter's library by ID

Yes 

Linux:

  • libREST_Initiator_TA-gcc44-MD-x64.so

Windows:

  • bin/REST_Initiator_TA-vc10-MD-x64.dll

TransportLayer.RestOutTA.AdapterId

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

Info

This parameter is applicable since FIXEdge C++ version 6.14.0


NoREST_INITIATOR

TransportLayer.RestOutTA.Type 

Transport Adapter library type 

Info

deprecated parameter


No

 Supported values:

  • DLL

TransportLayer.RestOutTA.ClientID

User-defined id/name for referencing to Transport Adapters in Business Logic  configuration

Yes 

 RestInitiatorClient 

TransportLayer.RestOutTA.LogCategory

Transport adaptor log category. 

Yes 

 RestInitiatorClient 

TransportLayer.RestOutTA.Protocol 

Connection protocol

Yes 

Supported values:

  • HTTP - for non-secure connections
  • HTTPS - for secure connections 

TransportLayer.RestOutTA.ServerHost

The destination host or IP address for sending messages 

Yes 


TransportLayer.RestOutTA.ServerPort 

The Port for the destination host 

Yes 


TransportLayer.RestOutTA.URI

URI for HTTP request.
The resulted URI will be composed as:

Info

<Protocol>://<ServerHost>:<ServerPort><URI>


Yes 

/messages 

TransportLayer.RestOutTA.SendingTimeout

Time (in seconds) for waiting for the response. If there is no response from the server during this time and the SendingTimeout is reached, then the RestOut TA sends another request.

Operating System may limit the maximum value.

No 

Default value = 0 - no timeout 

TransportLayer.RestOutTA.SendingMaxAttempts

Number of connection attempts 

No 

Default value = 2 

TransportLayer.RestOutTA.ConversionMethod 

The conversion method is the way the outgoing message is converted

Yes 

Supported values:

  • Raw - Raw FIX message with SOH as a delimiter
  • NumericTagValueMapping - JSON representation of FIX messages tags and values
  • WrapInXmlMessage - content of tag XmlData (213) of the FIX message

TransportLayer.RestOutTA.FIXVersion

FIX version that used for FIX to JSON mapping if TransportLayer.RestOutTA.ConversionMethod is set to NumericTagValueMapping.



No

Supported values:

  • 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

TransportLayer.RestOutTA.ResendMessageOnServerError

Controls undelivered message resending in the case of an error received from the server.


Info

This parameter does not control resending in the case of network errors.


YesDefault value = False

TransportLayer.RestOutTA.ErrorCodesForUndeliveredEvent

String parameter with a comma-separated list of error codes that generates an OnUndeliveredMessageEvent event and prevents resending.

Yes

Default value = 503 (Service Unavailable), 504 (Gateway Timeout)

The list can be empty.

Proxy connection parameters




TransportLayer.RestOutTA.ProxyHost

Proxy host 

No 


TransportLayer.RestOutTA.ProxyPort

Proxy port 


Conditional
Mandatory if ProxyHost is set


TransportLayer.RestOutTA.ProxyLogin

Proxy user name 

No 


TransportLayer.RestOutTA.ProxyPassword

Proxy user password 

Conditional
Mandatory if ProxyLogin is set


Validation parameters




TransportLayer.RestOutTA.ValidateFIXMessage  

Enables/disables validation of FIX message

Info
The validation isn't applied for raw conversion method. 
I.e.  TransportLayer.RestOutTA.ConversionMethod = Raw


No 

Supported values:

  • No - the validation is disabled. Default 
  • ValidateAndReject - validation is enabled.
    The Adapter doesn't send a message to BL if the message doesn't pass validation. 
  • ValidateAndWarn - validation is enabled.
    The Adapter sends a message to BL even if the message doesn't pass validation. The validation error warning message is logged in this case  

Security parameters




TransportLayer.RestOutTA.HTTPS.PrivateKey

path to the private key file



Conditional

Mandatory if 
Protocol = HTTPS



TransportLayer.RestOutTA.HTTPS.Certificate

path to certificate key file 

Conditional 
Mandatory if 
Protocol = HTTPS


TransportLayer.RestOutTA.HTTPS.PrivateKeyPassword

password for encrypted private key file 

No


TransportLayer.RestOutTA.authHeader 

The HTTP header name for authentication. 

All outgoing requests will contain the HTTP header with the value of the parameter. 

No 


TransportLayer.RestOutTA.authValue

Authentication value in HTTP header 

No 


...