Auction
For CCMX transactions (Carta Cross, Tender, RSU Settlement), the Auction table is used to hold and manage details for each transaction. Each Auction record must correspond to one (and only one) InstrumentMarket record - the Auction is effectively an extension of an InstrumentMarket with CCMX-specific fields.
- Section: CartaX
Metadata
- Base Table Class: Static
- Default Size: 100
Fields
| Name | Type | Size (bytes) | Description |
|---|---|---|---|
| Id | Integer (signed) | 8 | The unique identifier of this Auction. |
| Status | Set of Status | 4 | |
| ShortName | String | 24 | Unique ShortName for the Auction. |
| Name | String | 48 | Unique Name for the Auction. |
| Firm | Foreign key to Firm | 8 | FK to the Firm (or Issuer) to which the Auction belongs. |
| IssuerAccount | Foreign key to Account | 8 | The Issuer's Account for transfer of external trade costs and other funds. |
| IssuerTradingAccount | Foreign key to Account | 8 | The Issuer's Trading Account for buyback orders. The IssuerTradingAccount is optional as it is possible (and common) for the IssuerAccount to be used for buyback orders as well as for transfer of funds. |
| Instrument | Foreign key to Instrument | 8 | FK to the Instrument listed on the Auction. |
| Market | Foreign key to Market | 8 | FK to the Market on which the Auction is listed. |
| AuctionType | One of MarketType | 1 | Stores the Market Type with the Auction for access in UI actions |
| InstrumentMarket | Foreign key to InstrumentMarket | 8 | FK to the InstrumentMarket for the Auction. |
| NoHoldings | Integer (unsigned) | 1 | Set to true to force TrackHoldings off for the Auction. |
| ExternalFK | Integer (unsigned) | 8 | FK for this record in external system that generated it |
| PriceDecimals | Integer (unsigned) | 1 | The number of decimals for Price fields on the Auction. |
| QuantityDecimals | Integer (unsigned) | 1 | The number of decimals for Quantity fields on the Auction. |
| ValueDecimals | Integer (unsigned) | 1 | The number of decimals for Value fields on the Auction. |
| PriceLowerBound | Integer (signed) | 8 | The lower price bound for Orders on the Auction. |
| PriceUpperBound | Integer (signed) | 8 | The upper price bound for Orders on the Auction. |
| BuyerAllowsReprice | Integer (unsigned) | 1 | Buyers' Orders will not be withdrawn if the price is repriced outside of min/max price. |
| SellerAllowsReprice | Integer (unsigned) | 1 | Sellers' Orders will not be withdrawn if the price is repriced outside of min/max price. |
| Integer (signed) | 8 | For a Tender Offer, the quantity of shares to be tendered. | |
| AllowMinFill | Integer (unsigned) | 1 | Set to true if minimum fills may be specified for Accounts on the Auction. |
| AllowUnfundedBids | Integer (unsigned) | 1 | Set to true if unfunded bids may be placed on the Auction. |
| TenderOfferAllocationMethod | One of CcmxTenderOfferAllocationMethod | 1 | The method to be used to allocate quantity to sellers for a Tender Offer. |
| TenderOfferSellPriorityTimeEnd | Integer (unsigned) | 8 | For a Tender Offer, if not null, then the date/time at which the seller priority period ends. |
| IsReverseTender | Integer (unsigned) | 1 | True for a Reverse Tender Offer. |
| ZeroIfMinFillNotMet | Integer (unsigned) | 1 | True if Min Fill violating accounts should have allocation set to zero. |
| AllowMinFillOverride | Integer (unsigned) | 1 | True if Min Fill constraint can be over-ridden by a Tender Offer issuer. |
| IsMultiClass | Integer (unsigned) | 1 | True if this auction is a multi-class settlement auction. |
| CertLevelOrders | Integer (unsigned) | 1 | True if this auction uses cert-level orders per brokerage account. If true, BrokerageAccountOrders will be set true automatically. |
| BrokerageAccountOrders | Integer (unsigned) | 1 | True if this auction uses brokerage account-level sell orders. |
| IsTwoStepExercise | Integer (unsigned) | 1 | True if settlement of ISOs should be via the two-step process. |
| NetFundingType | One of CcmxAuctionNetFundingType | 1 | The type of Issuer Net Funding to be used for the Auction (default: None) |
| NetFundingUseTaxWithholding | Integer (unsigned) | 1 | Use Tax Withholding proceeds for Issuer Net Funding |
| NetFundingUseExerciseCosts | Integer (unsigned) | 1 | Use Exercise Cost proceeds for Issuer Net Funding |
| NetFundingUsePayrollProceeds | Integer (unsigned) | 1 | Use Payroll proceeds for Issuer Net Funding |
| IndicativePriceCalcTime | Integer (unsigned) | 4 | Number of seconds between calculation of indicative prices and quantity for the Auction, if 0, no indicatives are calculated. |
| PublishIndicativeFills | Integer (unsigned) | 1 | Set to 1 if indicative fills will be published for Orders and Accounts at the end of each (non-final) phase of the Auction. |
| AuctionSession | Foreign key to AuctionSession | 8 | FK to the AuctionSession table for the current Session for the Auction. |
| Session | Foreign key to Session | 8 | FK to the Session table for the current Session for the Auction. |
| Phase | One of CcmxAuctionPhase | 1 | Integer phase count for the Auction, -1 means that the Auction has not started and -2 means that the Auction is closed. |
| PhaseActive | One of CcmxAuctionPhaseActive | 1 | Current Phase Status for an Auction. |
| NextPhase | One of CcmxAuctionPhase | 1 | FK to the next AuctionSession record, used to provide information to the UI for trigger next session action. |
| SettlementPhase | String | 40 | Settlement Phase for the Auction received from SETL service. |
| AuctionExtended | Integer (unsigned) | 1 | Set to true if/when the Auction is extended. |
| AuctionPrice | Integer (signed) | 8 | The current provisional price for the Auction while the Auction is still running, or the final price after matching. |
| AuctionQuantity | Integer (signed) | 8 | The current provisional quantity for the Auction while the Auction is still running or the final quantity after matching. |
| ThresholdPrice | Integer (signed) | 8 | The current threshold price for the Auction. |
| IndicativePrice | Integer (signed) | 8 | The last indicative price for the Auction. |
| IndicativeQuantity | Integer (signed) | 8 | The last indicative quantity for the Auction. |
| ScheduleSettlement | Integer (unsigned) | 4 | Number of seconds after Auction closes when Settlement should be triggered. Settlement is triggered by an update of the Phase field for the Auction to the value Settlement. |
| SettlementTime | Integer (unsigned) | 8 | The time at which settlement for the Auction will be triggered. |
| SettlementTimeSet | Integer (signed) | 1 | Used in the trigger settlement function to control the current settlement state. |
| SettlementCount | Integer (unsigned) | 2 | The number of times that settlement has been triggered for the Auction. |
| MetaData | String | 1024 | MetaData blob for pass-through to external systems. |
| SettlementDate | String | 10 | The settlement date of the auction, only for information and pass-through, not used for any processing. |
| SkipTaxWithholding | Integer (unsigned) | 1 | Indicates that tax withholding calculations should be skipped, only for pass-through to the SETL service, not used for any processing. |
| FeeTransferedOut | Integer (signed) | 8 | Total fee already transfered to CCMX for this Auction with the TransferAuctionTradeFees transaction. |
| ExtendOnPriceThreshold | Integer (unsigned) | 1 | If this field is true (checked), then at the end of the InitialEntry and Ascending Phases, the Auction may be extended if the crossing price is equal to or greater than the price calculated from MaxPriceand ExtendPriceThreshold. |
| ExtendPriceThreshold | Integer (signed) | 8 | If ExtendOnPriceThreshold is true at the end of a Phase (other than the PreMarket Phase), if the crossing price for the Auction is equal to or greater than MaxPrice - ExtendPriceThreshold then the Auction may be extended (depending on other fields discussed below). |
| ExtendAdjustPriceUpperBound | Integer (signed) | 8 | If the Auction is extended for Price Threshold, the current value of MaxPrice will be adjusted up by the value of ExtendAdjustPriceUpperBound. |
| ExtendDelaySeconds | Integer (unsigned) | 2 | If this is non-zero, the commencement of the new InitialEntry Phase for the Auction extension for Price Threshold will be delayed by this number of seconds.If ExtendDelaySeconds is zero, the new InitialEntry Phase will commence one second after the end of the current Phase. |
| ExtendInitialEntryHours | Integer (unsigned) | 2 | For an Auction extension for Price Threshold, this is the number of hours that the InitialEntry Phase will run for. |
| ExtendAscendingHours | Integer (unsigned) | 2 | For an Auction extension for Price Threshold, this is the number of hours that each of the Ascending Phases will run for. |
| ExtendNumTimes | Integer (unsigned) | 2 | This is the maximum number of times the Auction may be extended for Price Threshold. After that many extensions, the Auction will just proceed normally, regardless of the crossing price at the end of each Phase. |
| ExtensionCount | Integer (unsigned) | 2 | This is a count of the number of times that the Auction has been extended for Price Threshold. This field is not editable. |
| ExtendAllowPreMarketParticipants | Integer (unsigned) | 1 | If this field is true (checked) and the Auction is extended for Price Threshold, pre-market participants will be able to participate in the extension Phases. If not, pre-market participants will remain unable to participate. |
| ExtendOnNoCross | Integer (unsigned) | 1 | If this field is true (checked), then at the end of the InitialEntry Phase (or an extension InitialEntry Phase), the Auction may be extended if there is no crossing possible. |
| ExtendNoCrossInitialEntryHours | Integer (unsigned) | 2 | For an Auction extension for No Cross, this is the number of hours that the InitialEntry Phase will run for. |
| ExtendNoCrossAscendingHours | Integer (unsigned) | 2 | For an Auction extension for No Cross, this is the number of hours that subsequent Ascending Phases will run for. |
| ExtendNoCrossNumTimes | Integer (unsigned) | 2 | This is the maximum number of times the Auction may be extended for No Cross. After that many extensions, the Auction will proceed normally through the phases unless HaltOnNoCross is set. |
| ExtensionNoCrossCount | Integer (unsigned) | 2 | This is a count of the number of times that the Auction has been extended for No Cross. This field is not editable. |
| HaltOnNoCross | Integer (unsigned) | 1 | If this field is true (checked), then at the end of the InitialEntry Phase (or an extension InitialEntry Phase), if no crossing is possible and either ExtendOnNoCross is false or the Auction has been extended for the maximum number of times for No Cross (controlled by ExtensionNoCrossNumTimes), then the Auction will halt a PAUSED session with all AuctionSession records suspended. It could be continued manually if required. |
| OrdinalPhase | Integer (signed) | 1 | Count of the current Phase including extensions to be used for tie-breaks. |
| ExtensionReason | One of CcmxAuctionExtensionReason | 1 | For an extended Carta Cross, the reason for the extension. |
| TradeBatch | Integer (unsigned) | 2 | For a Tender Offer, this is the number current trade batch (the last one generated). |
| SettlementInstructionsBatch | Integer (unsigned) | 2 | Current settlement instructions batch (the last one generated). |
| TaxCalculationCount | Integer (unsigned) | 2 | Integer incremented every time tax calculations are triggered to signal the SETL service. |
| HasUnfundedProposedTrades | Integer (unsigned) | 1 | Will be true for a Tender Offer for which the last batch of proposed trades includes trades in respect of unfunded bids. The final trades cannot be generated until this is false. |
| TerminateRequested | Integer (unsigned) | 1 | Set to true when a request has been made to terminate the Auction. |
| TerminateRequestedUser | Foreign key to User | 8 | This is the User that last requested to terminate the Auction, used to force a different User to confirm. |
| Integer (signed) | 8 | The number of fully diluted shares outstanding for the Issuer. Used in notional order processing. | |
| AllowNotional | One of AllowNotional | 1 | Set to true if notional orders are allowed for the Auction. |
| ReceivingPreliminaryNettingFunds | Integer (unsigned) | 1 | True when SETL is sending preliminary netting funds for trades on the Auction, will be set False when the PreliminaryExternalCostsDone message is received for the Auction. For net funding purposes, tax and exercise costs are not known until after settlement. In order to facilitate working out the Issuer's true funding obligations, SETL sends preliminary values prior to settlement. |
| HasAdjustedSellerAllocations | Integer (unsigned) | 1 | This will be true when an Auction has adjusted seller allocations but has not had a new set of proposed trades generated. An Auction can't be closed in this state. |
| PreliminaryExternalTaxCosts | Integer (signed) | 8 | Preliminary total external tax costs for the Auction, sent from SETL before settlement. |
| PreliminaryExternalExerciseCosts | Integer (signed) | 8 | Preliminary total external exercise costs for the Auction, sent from SETL before settlement. |
| PreliminaryPayrollProceeds | Integer (signed) | 8 | Preliminary total payroll proceeds for the Auction, sent from SETL before settlement. |
| FinalExternalTaxCosts | Integer (signed) | 8 | Final total external tax costs for the Auction, sent from SETL after settlement. |
| FinalExternalExerciseCosts | Integer (signed) | 8 | Final total external exercise costs for the Auction, sent from SETL after settlement. |
| FinalPrice | Integer (signed) | 8 | Final price for the transaction for a Carta Cross transaction. For a Tender, the price(s) is determined by the price(s) in the AuctionSettlementClass table. |
| FinalQuantity | Integer (signed) | 8 | Final quantity traded for the Auction. |
| FinalValueTraded | Integer (signed) | 8 | Final value traded for the Auction. |
| FinalPayrollProceeds | Integer (signed) | 8 | Finals value of proceeds transferred to the Issuer for payment via payroll. |
| PayrollProceedsAll | Integer (unsigned) | 1 | Boolean indicator for the SETL service, true if all proceeds from the Auction should be used transferred to the Issuer and paid via payroll. If this is set true, the other PayrollProceedsXXX values will be automatically set false (since they are included in All). |
| PayrollProceedsCompensatory | Integer (unsigned) | 1 | Boolean indicator for the SETL service, true if compensatory proceeds from the Auction should be used transferred to the Issuer and paid via payroll. |
| PayrollProceedsEmiExercise | Integer (unsigned) | 1 | Boolean indicator for the SETL service, true if EMI exercise proceeds from the Auction should be used transferred to the Issuer and paid via payroll. |
| PayrollProceedsIntlExercise | Integer (unsigned) | 1 | Boolean indicator for the SETL service, true if Intl exercise proceeds from the Auction should be used transferred to the Issuer and paid via payroll. |
| PayrollProceedsIsoExercise | Integer (unsigned) | 1 | Boolean indicator for the SETL service, true if ISO exercise proceeds from the Auction should be used transferred to the Issuer and paid via payroll. |
| PayrollProceedsNsoExercise | Integer (unsigned) | 1 | Boolean indicator for the SETL service, true if NSO exercise proceeds from the Auction should be used transferred to the Issuer and paid via payroll. |
| SettlementResetCount | Integer (unsigned) | 2 | It is possible to reset the settlement for a transaction to enable the SETL service to re-run the settlement process. This field counts the number of times that this has happened. |
| Integer (unsigned) | 1 | This is a pass-through field for RSU Settlement transactions. | |
| NetSettlementOnly | Integer (unsigned) | 1 | For an RSU Settlement transaction, this flag indicates that the transaction does not use any cash settlement. |
| FeeBasis | One of FeeBasis | 1 | Fee basis for the Auction. See Fees for more details. |
| FeeBuy | Integer (signed) | 8 | Buy fee value or percentage for the Auction. |
| FeeSell | Integer (signed) | 8 | Sell fee value or percentage for the Auction. |
| UpdateNumber | Integer (unsigned) | 8 | A number that records every change that happens to a record. It is primarily used to avoid write after read problems when an intermediate write has changed the originally read record. |
| OwnerUser | Foreign key to User | 8 | The Id of the User that owns this Auction. |
| OwnerGroup | Foreign key to Group | 8 | The Id of the Group that owns this Auction. |
| OwnerFirm | Foreign key to Firm | 8 | The Id of the Firm that owns this Auction. |
| CreateUser | Foreign key to User | 8 | The Id of the User that created this Auction. |
| CreateTimestamp | Integer (unsigned) | 8 | The time at which this Auction was created. |
| UpdateUser | Foreign key to User | 8 | The Id of the User that last updated this Auction. |
| UpdateTimestamp | Integer (unsigned) | 8 | The time at which this Auction was last updated. |
Foreign Keys
The following diagram shows the tables that have a foreign key link to the Auction table. All Table nodes can be clicked to take you to that table's definition page.
graph LR; AuctionSettlementClass-->|Auction|Auction click AuctionSettlementClass "/marketgrid/developer/model/tables/AuctionSettlementClass" AuctionAccount-->|Auction|Auction click AuctionAccount "/marketgrid/developer/model/tables/AuctionAccount" AuctionAccountAllocation-->|Auction|Auction click AuctionAccountAllocation "/marketgrid/developer/model/tables/AuctionAccountAllocation" AuctionAccountRelationship-->|Auction|Auction click AuctionAccountRelationship "/marketgrid/developer/model/tables/AuctionAccountRelationship" AuctionSession-->|Auction|Auction click AuctionSession "/marketgrid/developer/model/tables/AuctionSession" MarketEligibleEquityClass-->|Auction|Auction click MarketEligibleEquityClass "/marketgrid/developer/model/tables/MarketEligibleEquityClass"