Warehouse Trade Inbound Interface

Owned by Natalie Gesin (Deactivated)
Last updated: Oct 23, 2024 by Kinga Huszno
2 min read

Overview

Warehouse Trade inbound interface is designed to load and update data in the following database tables:

  • TRADESDBO.TRADE

  • TRADESDBO.TRADE_DETAIL

Relationship between DB tables TRADESDBO.TRADE and TRADESDBO.TRADE_DETAIL (1:1):

TRADESDBO.TRADE.TRADE_ID = TRADESDBO.TRADE_DETAIL.TRADE_ID

Format of the incoming message: EagleML (WarehouseTrade complex type).

Warehouse Trade is one of the essential EagleML objects types. This means that some object types cannot be loaded into DB without an already existing TRADE record in it. The list of "dependent" types as follows:

  • Warehouse Broker Trade Quote

  • Warehouse Pending Trade

  • Warehouse Close Lot

Stream Logic

EagleML Processing Sequence

Warehouse Trade is loaded into DB via eagle_ml-2-0_default_in_xml_warehouse_preproc in two steps:

  • XSLT transformation. XSLT rule 'eagle_default/in/xml/xslt/wrh_egl_gen_interface3.xsl' is used.

  • Loading data into the database. The 'eagle_default/in/xml/xml-warehouse_v2.xml' rule is used.

To load or update data in Warehouse Trade database tables send an EagleML message into the eagle_ml-2-0_default_in_xml_warehouse_preproc stream.

<netCash> and <netAmountLocal> are passed into the same DB field TRADESDBO.TRADE.NET_CASH. You should use either of these two nodes in your incoming message, but not both of them at the same time.<toCashType> and <toCashEventType> are passed into the same DB field TRADESDBO.TRADE.TO_CASH_TYPE. You should use either of these two nodes in your incoming message, but not both of them at the same time.

Refer to the data map table for Warehouse Trade object

CSV Processing Sequence

Warehouse Trade is loaded to DB with the following streams:

  • eagle_default_in_csv_warehouse - this is PRF stream which consist of two steps transform and load

  • eagle_default_in_csv_warehouse_t - transformation CSV to EagleML

    • trade.xml ​ rule

  • eagle_ml-2-0_default_in_xml_warehouse_preproc

    • XSLT transformation. XSLT rule 'eagle_default/in/xml/xslt/wrh_egl_gen_interface3.xsl' is used.

    • Loading data into the database. The 'eagle_default/in/xml/xml-warehouse_v2.xml' rule is used

To load or update data in Warehouse Trade tables, send your CSV message to the eagle_default_in_csv_warehouse stream.

Required Elements

The following elements are required in the EagleML message: Effective Date, Entity Id (or Entity Identifiers), Source Name, Lot Number, identifiers to resolve Security Alias.

  • Effective Date: warehouseTransaction/warehouseTrade/effectiveDate – mapped to TRADESDBO.TRADE.EFFECTIVE_DATE

  • Entity Id: warehouseTransaction/warehouseTrade/entityId (or warehouseTransaction/warehouseTrade/xrefAccountId and warehouseTransaction/warehouseTrade/xrefAccountIdType) – mapped to TRADESDBO.TRADE.ENTITY_ID

  • Source Name: warehouseTransaction/warehouseTrade/sourceName

  • Lot Number: warehouseTransaction/warehouseTrade/lotNumber – mapped to TRADESDBO.TRADE.LOT_NUMBER

  • Master Ticket Number: warehouseTransaction/warehouseTrade/masterTicketNumber – mapped to TRADESDBO.TRADE.MASTER_TICKET_NUMBER

  • Security Identifiers for resolve the Security Alias (see the section 'Security Resolution Logic'), Security Alias mapped to TRADESDBO.TRADE.SECURITY_ALIAS

Security Resolution Logic

<securityAlias> should not be specified in the incoming EagleML message.

Read more on Security Resolution - Warehouse Objects

Entity Resolution Logic

You will find more details on Entity Resolution for Warehouse Objects

Modes of Data Loading 

The Warehouse Trade inbound interface has 2 modes for loading data into the DB table: