Boar Team
GitHub

UnderlyingOptAttribute (FIX tag 317)

charFIX 4.4FIX 4.2

UnderlyingOptAttribute (tag 317) is a char field defined in FIX 4.4 and FIX 4.2. It appears in 59 message types, always optionally.

At a glance

Tag
317
Name
UnderlyingOptAttribute
Datatype
char
Dialects
FIX 4.4 and FIX 4.2
Messages
59

What the specification says

FIX 4.4

Underlying security’s OptAttribute. See OptAttribute (206) field for description

FIX 4.2

Underlying security’s OptAttribute. See OptAttribute field for description

Descriptions are quoted from the FIX Orchestra sources under the Apache 2.0 licence.

A real message using tag 317

NewOrderSingle · FIX 4.4
TagFieldWire valueMeaning
8BeginStringFIX.4.4
9BodyLength153
35MsgTypeDOrder – Single
49SenderCompIDBOARTEAM
56TargetCompIDCOUNTERPARTY
34MsgSeqNum2
52SendingTime20240101-12:00:00.000
11ClOrdIDORD-10042
711NoUnderlyings2 entries2repeating group
311UnderlyingSymbolEXAMPLE
317UnderlyingOptAttribute1
311UnderlyingSymbolEXAMPLE
317UnderlyingOptAttribute1
54Side1Buy
60TransactTime20240101-12:00:00.000
40OrdType1Market
10CheckSum209
Edit and decode it yourself

Shown with | separators for readability. On the wire FIX uses SOH (0x01), an invisible control byte — and because BodyLength and CheckSum are computed over the actual bytes, the two forms have different checksums. Both are valid and both decode here.

Open in the full decoder →

Generated from the FIX 4.4 dictionary and verified at build time: it parses and validates with no issues. Open the decoder to try your own message.

Where tag 317 appears

Requiredness is a property of the message, not of the field: the same tag can be optional in one message and conditionally required in another.

MessageMsgTypeFIX 4.4FIX 4.2Where in the message
Advertisement7Optional—inside UndInstrmtGrp › UnderlyingInstrument
AllocationInstructionJOptional—inside UndInstrmtGrp › UnderlyingInstrument
AllocationReportASOptional—inside UndInstrmtGrp › UnderlyingInstrument
AssignmentReportAWOptional—inside UndInstrmtGrp › UnderlyingInstrument
CollateralAssignmentAYOptional—inside UndInstrmtCollGrp › UnderlyingInstrument
CollateralInquiryBBOptional—inside UndInstrmtGrp › UnderlyingInstrument
CollateralInquiryAckBGOptional—inside UndInstrmtGrp › UnderlyingInstrument
CollateralReportBAOptional—inside UndInstrmtGrp › UnderlyingInstrument
CollateralRequestAXOptional—inside UndInstrmtCollGrp › UnderlyingInstrument
CollateralResponseAZOptional—inside UndInstrmtCollGrp › UnderlyingInstrument
ConfirmationAKOptional—inside UndInstrmtGrp › UnderlyingInstrument
CrossOrderCancelReplaceRequesttOptional—inside UndInstrmtGrp › UnderlyingInstrument
CrossOrderCancelRequestuOptional—inside UndInstrmtGrp › UnderlyingInstrument
DerivativeSecurityListAAOptional—inside the UnderlyingInstrument component
DerivativeSecurityListRequestzOptional—inside the UnderlyingInstrument component
DontKnowTradeQOptional—inside UndInstrmtGrp › UnderlyingInstrument
EmailCOptional—inside UndInstrmtGrp › UnderlyingInstrument
ExecutionReport8Optional—inside UndInstrmtGrp › UnderlyingInstrument
IOI6Optional—inside UndInstrmtGrp › UnderlyingInstrument
ListStrikePricemOptional—inside UndInstrmtStrkPxGrp › UnderlyingInstrument
MarketDataIncrementalRefreshXOptional—inside MDIncGrp › UndInstrmtGrp › UnderlyingInstrument
MarketDataRequestVOptional—inside InstrmtMDReqGrp › UndInstrmtGrp › UnderlyingInstrument
MarketDataSnapshotFullRefreshWOptional—inside UndInstrmtGrp › UnderlyingInstrument
MassQuoteiOptionalOptionalinside QuotSetGrp › UnderlyingInstrument
MassQuoteAcknowledgementbOptionalOptionalinside QuotSetAckGrp › UnderlyingInstrument
MultilegOrderCancelReplaceACOptional—inside UndInstrmtGrp › UnderlyingInstrument
NewOrderCrosssOptional—inside UndInstrmtGrp › UnderlyingInstrument
NewOrderListEOptional—inside ListOrdGrp › UndInstrmtGrp › UnderlyingInstrument
NewOrderMultilegABOptional—inside UndInstrmtGrp › UnderlyingInstrument
NewOrderSingleDOptional—inside UndInstrmtGrp › UnderlyingInstrument
NewsBOptional—inside UndInstrmtGrp › UnderlyingInstrument
OrderCancelReplaceRequestGOptional—inside UndInstrmtGrp › UnderlyingInstrument
OrderCancelRequestFOptional—inside UndInstrmtGrp › UnderlyingInstrument
OrderMassCancelReportrOptional—inside the UnderlyingInstrument component
OrderMassCancelRequestqOptional—inside the UnderlyingInstrument component
OrderMassStatusRequestAFOptional—inside the UnderlyingInstrument component
OrderStatusRequestHOptional—inside UndInstrmtGrp › UnderlyingInstrument
PositionMaintenanceReportAMOptional—inside UndInstrmtGrp › UnderlyingInstrument
PositionMaintenanceRequestALOptional—inside UndInstrmtGrp › UnderlyingInstrument
PositionReportAPOptional—inside PosUndInstrmtGrp › UnderlyingInstrument
QuoteSOptional—inside UndInstrmtGrp › UnderlyingInstrument
QuoteCancelZOptional—inside QuotCxlEntriesGrp › UndInstrmtGrp › UnderlyingInstrument
QuoteRequestROptional—inside QuotReqGrp › UndInstrmtGrp › UnderlyingInstrument
QuoteRequestRejectAGOptional—inside QuotReqRjctGrp › UndInstrmtGrp › UnderlyingInstrument
QuoteResponseAJOptional—inside UndInstrmtGrp › UnderlyingInstrument
QuoteStatusReportAIOptional—inside UndInstrmtGrp › UnderlyingInstrument
QuoteStatusRequestaOptional—inside UndInstrmtGrp › UnderlyingInstrument
RFQRequestAHOptional—inside RFQReqGrp › UndInstrmtGrp › UnderlyingInstrument
RequestForPositionsANOptional—inside UndInstrmtGrp › UnderlyingInstrument
RequestForPositionsAckAOOptional—inside UndInstrmtGrp › UnderlyingInstrument
SecurityDefinitiondOptionalOptionalinside UndInstrmtGrp › UnderlyingInstrument
SecurityDefinitionRequestcOptionalOptionalinside UndInstrmtGrp › UnderlyingInstrument
SecurityListyOptional—inside SecListGrp › UndInstrmtGrp › UnderlyingInstrument
SecurityListRequestxOptional—inside UndInstrmtGrp › UnderlyingInstrument
SecurityStatusfOptional—inside UndInstrmtGrp › UnderlyingInstrument
SecurityStatusRequesteOptional—inside UndInstrmtGrp › UnderlyingInstrument
TradeCaptureReportAEOptional—inside UndInstrmtGrp › UnderlyingInstrument
TradeCaptureReportRequestADOptional—inside UndInstrmtGrp › UnderlyingInstrument
TradeCaptureReportRequestAckAQOptional—inside UndInstrmtGrp › UnderlyingInstrument

Wire format

A single character. Most char fields are enumerated, so the value is one of a fixed set rather than arbitrary text. @boarteam/fix keeps the value as a string and, for enumerated fields, reports validate/value-not-in-enum when it is not a defined value.

Read tag 317 in TypeScript

decode.tsts
import { createFixEngine } from "@boarteam/fix";import { dictionary } from "@boarteam/fix-dict-fix44";​const fix = createFixEngine(dictionary);const { message, issues } = fix.parse(raw);​const field = message.fields[317];field?.name;   // "UnderlyingOptAttribute"field?.raw;    // the verbatim wire stringfield?.value;  // coerced to a string

Other char fields

Decode this in your own code

The same engine that produced the decoded example above is an Apache-2.0 npm package with zero runtime dependencies. It runs in Node and in the browser, and parse() returns problems as data instead of throwing.

npm i @boarteam/fix @boarteam/fix-dict-fix44
Try the decoderSource on GitHub