Skip to main content
Version: Upcoming

AccountRouteConfig

V8 Message Definiton

METADATA

AttributeValue
Topic1800-client-config
MLink TokenClientControl
ProductSRControl
accessTypeSELECT
MLink EndpointMLink-Live

Table Definition

FieldTypeKeyDefault ValueComment
accntVARCHAR(16)PRI''SR assigned accnt code
clientFirmVARCHAR(16)PRI''SR assigned client firm acronym
execBrkrCodeVARCHAR(16)PRI''SR execBrkrCode SR Assigned
enabledenum - YesNo'None'yesroute enabled
relationshipenum - RelationshipType'None'
catDestFirmIMIDVARCHAR(16)''Destination Firm IMID supplied by FINRA fbo destination can be BD or Exchange
catDestDeptTypeenum - CatDeptType'None'CAT destination department type
routingRuleenum - RoutingRule'RoundRobin'
backupRouteCodeVARCHAR(65)''backup route code if above are unavailable
commentTINYTEXT''maintainer commments
modifiedByVARCHAR(24)''user who last modified this record
modifiedInenum - SysEnvironment'None'
timestampDATETIME(6)'1900-01-01 00:00:00.000000'timestamp of last modification
ClearingFlipListJSON'JSON_ARRAY()'
ExchControlListJSON'JSON_ARRAY()'
ExecBrkrAccntsListJSON'JSON_ARRAY()'
RoutingTableListJSON'JSON_ARRAY()'
SupportSwapProvidersListJSON'JSON_ARRAY()'

PRIMARY KEY DEFINITION (Unique)

FieldSequence
accnt1
clientFirm2
execBrkrCode3

JSON Block (ClearingFlipList)

FieldTypeComment
exDestenum - exDestexDest eg CBOEOPT NMSOPT NMSSTK CMXFUT
clrFlipTypeenum - FlipTypetype of clearing corp delivery
clrFlipFirmenum - clrFlipFirmdeliverTo clearing member eg OCC NSCC MPID or InstitutionID
clrFlipAccntenum - clrFlipAccntdeliverTo client account eg OCC AID or a DVP FBO code
clrAgentenum - clrAgentdeliverTo agent eg DVP Agent Bank ID
clrTaxIDenum - clrTaxIDdeliverTo taxID eg DVP TaxID
clrBrkrMPIDenum - clrBrkrMPIDclearing broker equity clearing only exDest is an option exch exDestNMSSTK must exist in this list

JSON Block (ExchControlList)

FieldTypeComment
exDestenum - exDestexchange eg NYSESTK CBOEOPT NMSOPT NMSSTK CMXFUT or external broker algo eg NIGHTHAWKSTK NIGHTHAWKOPT
disableenum - YesNo
externParamsenum - externParamsalgo params for style algo exDest entries tagvaluetagvaluetagvalue

JSON Block (ExecBrkrAccntsList)

FieldTypeComment
exchGroupenum - ExchGroupeg NMS CMX ICE EUREX NONEANY
secTypeenum - SpdrSecTypeeg Stock Future Option NONEANY
execBrkrAccntenum - execBrkrAccntexec broker account supplied by exec broker usually Account1
execBrkrClFirmenum - execBrkrClFirmexec broker clientfirm supplied by exec broker usually OnBehalfOfCompId115
execBrkrUserNameenum - execBrkrUserNameexec broker user name supplied by exec broker
catDestFirmIMIDenum - catDestFirmIMIDperexchGroupsecType override of toplevel catDestFirmIMID empty falls through

JSON Block (RoutingTableList)

FieldTypeComment
routingCodeenum - routingCoderouting session code is a RouteDefinitionpkeyroutingCode RouteDefinitionexecBrkrCode must match execBrkrCode
featureDisableenum - FeatureDisableused to disable certain route features before reaching the routingCoderouteDefinition

JSON Block (SupportSwapProvidersList)

FieldTypeComment
swapProviderenum - SwapProvider

SELECT TABLE EXAMPLE QUERY

SELECT *
FROM `SRControl`.`MsgAccountRouteConfig`
WHERE
/* Replace with a VARCHAR(16) */
`accnt` = 'Example_accnt'
AND
/* Replace with a VARCHAR(16) */
`clientFirm` = 'Example_clientFirm'
AND
/* Replace with a VARCHAR(16) */
`execBrkrCode` = 'Example_execBrkrCode';

Doc Columns Query

SELECT * FROM SRControl.doccolumns WHERE TABLE_NAME='AccountRouteConfig' ORDER BY ordinal_position ASC;