Skip to main content
Version: Staging

AccountRouteConfig

V8 Message Definiton

METADATA

AttributeValue
Topic1800-client-config
MLink TokenSystemData
ProductSRControl
accessTypeSELECT

Table Definition

FieldTypeKeyDefault ValueComment
accntVARCHAR(16)PRI''SR assigned accnt code
execBrkrCodeVARCHAR(16)PRI''SR execBrkrCode SR Assigned
clientFirmVARCHAR(16)PRI''SR assigned client firm acronym
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'None'
backupRouteCodeVARCHAR(65)''backup route code if above are unavailable
externParamsTINYTEXT''pass through params must be understood by end point handler usually tagvaluetagvaluetagvalue
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_OBJECT()'
ExchControlListJSON'JSON_OBJECT()'
ExecBrkrAccntsListJSON'JSON_OBJECT()'
RoutingTableListJSON'JSON_OBJECT()'

PRIMARY KEY DEFINITION (Unique)

FieldSequence
accnt1
execBrkrCode2
clientFirm3

JSON Block (ClearingFlipList)

FieldTypeComment
exchGroupenum - exchGroupeg NMS CMX ICE EUREX
secTypeenum - secTypeeg Stock Future Option
exchStrstringcan be or specific exchStr eg CBOEOPT will be used only if there isnt a more specific match
clrFlipTypeenum - clrFlipTypetype of clearing corp delivery
clrFlipFirmstringdeliverTo clearing member eg OCC NSCC MPID or InstitutionID
clrFlipAccntstringdeliverTo client account eg OCC AID or a DVP FBO code
clrAgentstringdeliverTo agent eg DVP Agent Bank ID
clrTaxIDstringdeliverTo taxID eg DVP TaxID

JSON Block (ExchControlList)

FieldTypeComment
exDeststringexchange eg NYSESTK CBOEOPT AMEXCOB NMSOPT NMSSTK NMSCOB CMXFUT or custom eg INETNIGHTHAWK
disableenum - disable

JSON Block (ExecBrkrAccntsList)

FieldTypeComment
exchGroupenum - exchGroupeg NMS CMX ICE EUREX NONEANY
secTypeenum - secTypeeg Stock Future Option NONEANY
execBrkrAccntstringexec broker account supplied by exec broker usually Account1
execBrkrClFirmstringexec broker clientfirm supplied by exec broker usually OnBehalfOfCompId115
execBrkrUserNamestringexec broker user name supplied by exec broker

JSON Block (RoutingTableList)

FieldTypeComment
routingCodestringrouting session code is a RouteDefinitionpkeyroutingCode RouteDefinitionexecBrkrCode must match execBrkrCode
cobTiedenum - cobTiedcan handle COB MLegAB orders tied to an underlier must be yes here and also must be yes on the underling route definitionexDest

CREATE TABLE EXAMPLE QUERY

CREATE TABLE `SRControl`.`MsgAccountRouteConfig` (
`accnt` VARCHAR(16) NOT NULL DEFAULT '' COMMENT 'SR assigned accnt code',
`execBrkrCode` VARCHAR(16) NOT NULL DEFAULT '' COMMENT 'SR execBrkrCode (SR Assigned)',
`clientFirm` VARCHAR(16) NOT NULL DEFAULT '' COMMENT 'SR assigned client firm acronym',
`enabled` ENUM('None','Yes','No') NOT NULL DEFAULT 'None' COMMENT 'yes=route enabled',
`relationship` ENUM('None','EXSMember','EXSRouter','EXSTech','Platform','SRConnect','Advisor') NOT NULL DEFAULT 'None',
`catDestFirmIMID` VARCHAR(16) NOT NULL DEFAULT '' COMMENT 'Destination Firm IMID (supplied by FINRA fbo destination; can be B/D or Exchange)',
`catDestDeptType` ENUM('None','Exchange','Agency','ATS','DMA','Sponsored','Trading','Other') NOT NULL DEFAULT 'None' COMMENT 'CAT destination department type',
`routingRule` ENUM('None','RoundRobin','InOrder') NOT NULL DEFAULT 'None',
`backupRouteCode` VARCHAR(65) NOT NULL DEFAULT '' COMMENT 'backup route code (if above are unavailable)',
`externParams` TINYTEXT NOT NULL DEFAULT '' COMMENT 'pass through params (must be understood by end point handler) usually [tag=value;tag=value;tag=value]',
`comment` TINYTEXT NOT NULL DEFAULT '' COMMENT 'maintainer commments',
`modifiedBy` VARCHAR(24) NOT NULL DEFAULT '' COMMENT 'user who last modified this record',
`modifiedIn` ENUM('None','Neptune','Pluto','V7_Stable','V7_Latest','Saturn','Venus','Mars','SysTest','V7_Current') NOT NULL DEFAULT 'None',
`timestamp` DATETIME(6) NOT NULL DEFAULT '1900-01-01 00:00:00.000000' COMMENT 'timestamp of last modification',
`ClearingFlipList` JSON NOT NULL DEFAULT JSON_OBJECT() CHECK(JSON_VALID(ClearingFlipList)),
`ExchControlList` JSON NOT NULL DEFAULT JSON_OBJECT() CHECK(JSON_VALID(ExchControlList)),
`ExecBrkrAccntsList` JSON NOT NULL DEFAULT JSON_OBJECT() CHECK(JSON_VALID(ExecBrkrAccntsList)),
`RoutingTableList` JSON NOT NULL DEFAULT JSON_OBJECT() CHECK(JSON_VALID(RoutingTableList)),
PRIMARY KEY USING HASH (`accnt`,`execBrkrCode`,`clientFirm`)
) ENGINE=SRSE DEFAULT CHARSET=LATIN1 COMMENT='';

SELECT TABLE EXAMPLE QUERY

SELECT
`accnt`,
`execBrkrCode`,
`clientFirm`,
`enabled`,
`relationship`,
`catDestFirmIMID`,
`catDestDeptType`,
`routingRule`,
`backupRouteCode`,
`externParams`,
`comment`,
`timestamp`,
`ClearingFlipList`,
`ExchControlList`,
`ExecBrkrAccntsList`,
`RoutingTableList`
FROM `SRControl`.`MsgAccountRouteConfig`
WHERE
/* Replace with a VARCHAR(16) */
`accnt` = 'Example_accnt'
AND
/* Replace with a VARCHAR(16) */
`execBrkrCode` = 'Example_execBrkrCode'
AND
/* Replace with a VARCHAR(16) */
`clientFirm` = 'Example_clientFirm';

Doc Columns Query

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