Define EXTRACT Options

There are several conventional task parameter setups used with the EXTRACT action type, depending on the type of interface and outgoing file. You can also specify SQL filters to limit the records obtained from the Eagle data warehouse to specific effective dates, entities, and securities. Or, limit the maximum number of rows to retrieve from the database.

You can do the following:

The EXTRACT action type allows you to output data of key data categories within the Eagle product suite and to leverage Message Center capabilities to transport over various protocols and using various formats. The extract process uses a foundational technology within the Eagle product suite called EJM; this stands for Eagle’s external job management and is used to manage and control the extract workflow.

Setup for EagleML Tag Value/XML Extracts

You can create tag value extract files or XML extract files containing information retrieved from the Eagle data warehouse by using the default EagleML message streams with the following <taskParameter> paired options:

 Example of a taskParameter block (click to expand):
<taskParameter>
   <name>Compress</name>
   <datatype>S</datatype>
   <value>Y</value>
</taskParameter>
  • <name> = ActionType and <value> = EXTRACT
  • <name> = StreamName and <value> = eagle_ml-2-0_default_out_q
  • <name> = OutputFormat and <value> = TagValue (or NULL for XML)
  • <name> = Compress and <value> = Y (use this option if you want to compress data after extraction)
  • <name> = FeedType and <value> = Options listed below

The table below lists the feed type options and descriptions used to create the tag value or XML extract file with filtered results.

Object GroupObject NameFeed TypeQ-rule FilenameT-rule FilenameT-rule streaming Filename
EntityComposite Entity ListENTITYCOMPOSITELISTEXTRACTextract_entity_composite_list.xmlt_entity_composite_list.xml
Entity Manager RelationshipENTITYMANAGERRELEXTRACTextract_entity_manager_relationship.xmlt_entity_manager_relationship.xml
Entity Share ClassENTITYSHARECLASSEXTRACTextract_entity_share_class.xmlt_entity_share_class.xmlt_entity_share_class_streaming.xml
Entity Accounting BasisENTITYACCBASISEXTRACTextract_entity_accounting_basis.xmlt_entity_accounting_basis.xml
Entity Bank RelationshipENTITYBANKRELEXTRACTextract_entity_bank_relationship.xmlt_entity_bank_relationship.xml
Entity ManagerENTITYMANAGEREXTRACTextract_entity_manager.xmlt_entity_manager.xml
Entity XREFENTITYXREFEXTRACTextract_entity_xref.xmlt_entity_xref.xml
Entity List*ENTITYLISTEXTRACTextract_entity_list.xmlt_entity_list.xml
Entities In List*ENTITYLISTLISTEXTRACTextract_entity_list_list.xmlt_entity_list_list.xml
Generic EntityENTITYEXTRACTextract_entity.xmlt_entity.xmlt_entity_streaming.xml
Entity Accounting PeriodsENTITYACCPERIODSEXTRACTextract_entity_accounting_periods.xmlt_entity_accounting_periods.xml
RulePrimary Mixed Cost Basis RuleRULEPRIMCOSTBASISEXTRACTextract_rule_primary_mixed_cost_basis.xmlt_rule_primary_mixed_cost_basis.xml
Contract Cash RuleRULECONTRACTCASHEXTRACTextract_rule_contract_cash.xmlt_rule_contract_cash.xml
Contractual Cash Settlement RuleRULECCSETTLEMENTEXTRACTextract_rule_contractual_cash_settlement.xmlt_rule_contractual_cash_settlement.xml
Earn Thru RuleRULEEARNTHRUEXTRACTextract_rule_earn_thru.xmlt_rule_earn_thru.xml
Basis Processing RuleRULEBASISPROCEXTRACTextract_rule_basis_processing.xmlt_rule_basis_processing.xml
Backup Withholding RuleRULEBUWITHHOLDINGEXTRACTextract_rule_backup_withholding.xmlt_rule_backup_withholding.xml
Month End Date RuleRULEMONTHENDDATEEXTRACTextract_rule_month_end_date.xmlt_rule_month_end_date.xml
Amortization Schedule RuleRULEAMORTSCHDLEXTRACTextract_rule_amort_schedule.xmlt_rule_accounting.xml
Accounting RuleRULEACCOUNTINGEXTRACTextract_rule_accounting.xmlt_rule_amort_schedule.xml
SMFGeneric SMFSMFEXTRACTextract_smf.xmlt_smf.xmlt_smf_streaming.xml
ReferenceCode TranslationCODETRANEXTRACTextract_codetran.xmlt_codes.xml
Code ValueCODEVALEXTRACTextract_codeval.xmlt_codeval.xml
Code CategoryCODEEXTRACTextract_codes.xmlt_codetran.xml
Cash ProjectionsCASHPROJECTIONSEXTRACTextract_cash_projections.xmlt_cash_projections.xml
Error DefinitionEXCEPTIONDEFEXTRACTextract_exception_definition.xmlt_exception_definition.xml
Demand ListDEMANDLISTextract_demandlist.xmlt_demandlist.xml
Calendar Business DatesCALBUSINESSDATESEXTRACTextract_calendar_business_dates.xmlt_calendar_business_dates.xml
CalendarREFCALENDAREXTRACTextract_ref_calendar.xmlt_ref_calendar.xml
Calendar HolidayREFCALENDARHOLIDAYEXTRACTextract_ref_calendar_holiday.xmlt_ref_calendar_holiday.xml
Run Time StampsRPTTIMESTAMPSextract_time_stamps.xml t_time_stamps.xml
RatingRATINGSEXTRACTextract_rating.xmlt_rating.xml
Entity Entitlement ListENTITYENTITLEMENTLISTEXTRACTextract_ref_entity_entitlement_list.xml
t_ref_entity_entitlement_list_streaming.xml
Ledger NotesLEDGERNOTESEXTRACTextract_ref_ledger_notes.xmlt_ref_ledger_notes.xmlt_ref_ledger_notes_streaming.xml
Security relatedSMF IdentifiersXREFEXTRACTextract_xref.xmlt_xref.xml
Exchange PriceISSUEEXCHANGEPRICEEXTRACTextract_issueprice_exchange.xmlt_issueprice_exchange.xml
Issue Variable RateISSUEVARRATEEXTRACTextract_issue_variable_rate.xmlt_issue_variable_rate.xmlt_issue_variable_rate_streaming.xml
Issue Fx RateISSUEFXRATEEXTRACTextract_issue_fx_rate.xmlt_issue_fx_rate.xmlt_issue_fx_rate_streaming.xml 
Issue PriceISSUEPRICEEXTRACTextract_issueprice.xmlt_issueprice.xmlt_issueprice_streaming.xml
Issue Fx Pc RateISSUEFXPCRATEEXTRACTextract_issue_fx_pc_rate.xmlt_issue_fx_pc_rate.xmlt_issue_fx_pc_rate_streaming.xml 
Generic Issue AnalyticGENISSUEANALYTICEXTRACTextract_generic_issue_analytic.xmlt_generic_issue_analytic.xml
ScheduleSCHEDULEEXTRACTextract_schedule.xmlt_schedule.xmlt_schedule_streaming.xml
GIPS CompositeREFGIPSCOMPOSITEEXTRACTextract_ref_gips_composite.xmlt_ref_gips_composite.xml
GIPS DisclosureREFGIPSDISCLOSUREEXTRACTextract_ref_gips_disclosure.xmlt_ref_gips_disclosure.xml
Time SeriesREFTIMESERIESEXTRACTextract_ref_time_series.xmlt_ref_time_series.xml
Trade QuoteREFTRADEQUOTESEXTRACTextract_ref_trade_quotes.xmlt_ref_trade_quotes.xml
Yield CurveYIELDCURVEEXTRACTextract_ref_yield_curve.xmlt_ref_yield_curve.xml
Forward PointsFORWARDPOINTSEXTRACTextract_forwardpoints.xmlt_forward_points.xmlt_forward_points_streaming.xml 
FactorFACTOREXTRACTextract_ref_factor.xmlt_ref_factor.xmlt_ref_factor_streaming.xml
IssuerIssuerGENISSUEREXTRACTextract_generic_issuer.xmlt_generic_issuer.xml
Issuer RatingISSUERRATINGEXTRACTextract_issuer_rating.xmlt_issuer_rating.xml
Issuer OrganizationISSUERORGEXTRACTextract_issuer_org.xmlt_issuer_org.xml
Issuer RelationshipISSUERRELEXTRACTextract_issuer_relationship.xmlt_issuer_rel.xml
Issuer RoleISSUERROLEEXTRACTextract_issuer_role.xmlt_issuer_role.xml
WarehouseWarehouse Pending TradeWRHSPENDINGTRADESEXTRACTextract_warehouse_pending_trades.xmlt_warehouse_pending_trades.xmlt_warehouse_pending_trades_streaming.xml
Warehouse Custody ActivityWRHSCSTDACTIVITYEXTRACTextract_warehouse_custody_activity.xmlt_warehouse_custody_activity.xmlt_warehouse_custody_activity_streaming.xml
Warehouse Custody BalanceWRHSCSTDBALANCEEXTRACTextract_warehouse_custody_balance.xmlt_warehouse_custody_balance.xmlt_warehouse_custody_balance_streaming.xml
Warehouse Cash ActivityWRHSCASHACTIVITYEXTRACTextract_warehouse_cash_activity.xmlt_warehouse_cash_activity.xmlt_warehouse_cash_activity_streaming.xml
Warehouse PerformanceWRHSPERFORMANCEEXTRACTextract_warehouse_performance.xmlt_warehouse_performance.xmlt_warehouse_performance_streaming.xml
Warehouse Close LotWRHSCLOSELOTEXTRACTextract_warehouse_closelot.xmlt_warehouse_close_lot.xmlt_warehouse_close_lot_streaming.xml
Warehouse PositionWRHSPOSITIONEXTRACTextract_warehouse_position.xmlt_warehouse_position.xmlt_warehouse_position_streaming.xml
Warehouse Open LotWRHSOPENLOTEXTRACTextract_warehouse_openlot.xmlt_warehouse_openlot.xmlt_warehouse_openlot_streaming.xml
Warehouse TradeWRHSTRADEEXTRACTextract_warehouse_trade.xmlt_warehouse_trade.xmlt_warehouse_trade_streaming.xml
Warehouse NAV MultiWRHSNAVMULTIEXTRACTextract_warehouse_nav_multi.xmlt_warehouse_nav_multi.xmlt_warehouse_nav_multi_streaming.xml
Warehouse NAVWRHSNAVEXTRACTextract_warehouse_nav.xmlt_warehouse_nav.xmlt_warehouse_nav_streaming.xml
Warehouse General Ledger BalancesWRHSGLDETAILPOSTINGEXTRACT     extract_warehouse_gl_detail_posting.xmlt_warehouse_gl_detail_posting.xmlt_warehouse_gl_detail_posting_streaming.xml
Warehouse Broker Trade QuoteWRHSBROKTRDQUOTEEXTRACTextract_warehouse_brokertradequote.xmlt_warehouse_brokertradequote.xml t_warehouse_brokertradequote_streaming.xml
Warehouse Cash Flow ProjectionWRHSCASHFLOWPROJEXTRACTextract_warehouse_cash_flow_proj.xmlt_warehouse_cash_flow_proj.xmlt_warehouse_cash_flow_proj_streaming.xml
Warehouse SPD Delta LogWRHSSPDDELTALOGEXTRACTextract_warehouse_spd_delta_log.xmlt_warehouse_spd_delta_log.xmlt_warehouse_spd_delta_log_streaming.xm
Warehouse Disclosure StatusWRHSDISCLOSURESTATUSEXTRACT


Warehouse Wash Sale TradeWRHSWASHSALETRADEEXTRACT


Warehouse NAV Month EndWRHSNAVMONTHENDEXTRACT


Insurance Valuation LotINSURANCEVALUATIONLOTEXTRACT


Corporate ActionGeneric Corporate ActionsGENCORPACTIONSEXTRACTextract_generic_corporate_actions.xmlt_generic_corporate_actions.xmlt_generic_corporate_actions_streaming
Voluntary CA ElectionVOLCAELECTIONEXTRACTextract_voluntary_ca_election.xmlt_voluntary_ca_election.xmlt_voluntary_ca_election_streaming.xml
ClientClientCLIENTEXTRACTextract_client.xmlt_client.xml
Client CommunicationCLIENTCOMMEXTRACTextract_clientcommunication.xmlt_clientcommunication.xml
AccountingAccounting TradeACCOUNTINGTRADEEXTRACTextract_financial_event.xmlt_accounting_trade.xml
Financial EventFINANCIALEVENTEXTRACTextract_financial_event.xmlt_financial_event.xml
Traded Cash ActivityTRADEDCAEXTRACTextract_acct_traded_cash_activity.xmlt_acct_traded_cash_activity.xmlt_acct_traded_cash_activity_streaming.xml
Settled Cash ActivitySETTLEDCAEXTRACTextract_acct_settled_cash_activity.xmlt_acct_settled_cash_activity.xmlt_acct_settled_cash_activity_streaming.xml
Accounting GL ActivityGLACTIVITYEXTRACTextract_acct_gl_activity.xmlt_acct_gl_activity.xmlt_acct_gl_activity_streaming.xml
Accrued IncomeACCRUEDINCOMEEXTRACTextract_accrued_income.xmlt_accrued_income.xmlt_accrued_income_streaming.xml
Subscribe RedeemSUBSCRIBEREEDEMEXTRACTextract_acct_subscribe_reedem.xmlt_acct_subscribe_reedem.xmlt_acct_subscribe_reedem_streaming.xml
Daily Yield Mill RateDAILYYIELDMILLRATEEXTRACTextract_acct_daily_yield_mill_rate.xmlt_acct_daily_yield_mill_rate.xmlt_acct_daily_yield_mill_rate_streaming.xml
Cash JournalCASHJOURNALEXTRACTextract_acct_cash_journal.xmlt_acct_cash_journal.xmlt_acct_cash_journal_streaming.xml
Unsettled TransactionsUNSETTLEDTRANSACTIONSEXTRACTextract_acct_unsettled_transactions.xmlt_acct_unsettled_transactions.xmlt_acct_unsettled_transactions_streaming.xml
Realized Gain LossREALIZEDGAINLOSSEXTRACTextract_acct_realized_gain_loss.xmlt_acct_realized_gain_loss.xmlt_acct_realized_gain_loss_streaming.xml
Consearned IncomeCONSEARNEDINCOMEEXTRACTextract_acct_cons_earned_inc.xmlt_acct_cons_earned_inc.xmlt_acct_cons_earned_inc_streaming.xml
Distribution ActivityDISTRIBUTIONACTEXTRACTextract_acct_distribution_activity.xmlt_acct_distribution_activity.xmlt_acct_distribution_activity_streaming.xml
Custom Ledger AccountCUSTLEDGERACCTEXTRACTextract_acct_custom_ledger_account.xmlt_acct_custom_ledger_account.xmlt_acct_custom_ledger_account_streaming.xml
Unapproved Variation MarginUNAPPROVEDVARMARGINEXTRACTextract_acct_unapproved_var_margin.xmlt_acct_unapproved_var_margin.xmlt_acct_unapproved_var_margin_streaming.xml
Trial BalanceTRIALBALANCEEXTRACTextract_acct_trial_balance.xmlt_acct_trial_balance.xmlt_acct_trial_balance_streaming.xml
Open Rec Pay MultiOPENRECPAYMULTIEXTRACTextract_acct_open_rec_pay_multi.xmlt_acct_open_rec_pay_multi.xmlt_acct_open_rec_pay_multi_streaming.xml
Accounting Intraday NAVINTRADAYNAVEXTRACTextract_acct_intraday_nav.xmlt_acct_intraday_nav.xmlt_acct_intraday_nav_streaming.xml
Accounting NAV for NASDAQNAVFORNASDAQEXTRACTextract_acct_nav_for_nasdaq.xmlt_acct_nav_for_nasdaq.xmlt_acct_nav_for_nasdaq_streaming.xml
Accounting RejectionREJECTIONEXTRACTextract_acct_rejection.xmlt_acct_event_rejection.xmlt_acct_event_rejection_streaming.inc


Note

*Please note the difference between ENTITYLISTLISTEXTRACT and ENTITYLISTEXTRACT.

For example, you have an entity called TESTLIST of 'LIST' type and there are 4 portfolios on it:

TESTLIST
- VOL01
- VOL02
- VOL03
- VOL04

If you perform an ENTITYLISTLISTEXTRACT, all 5 records will be extracted, including the entity of LIST type (TESTLIST, VOL01, VOL02, VOL03, VOL04)

If you perform an ENTITYLISTEXTRACT, 4 records will be extracted, the entity of LIST type will be ignored (VOL01, VOL02, VOL03, VOL04). 

Setup for STAR Tag Value Extracts

You can create STAR tag value extract files with information retrieved from the EAGLE data warehouse using the Eagle default STAR extract message stream with the following <taskParameter> paired options:

  • <name> = ActionType and <value> = EXTRACT
  • <name> = StreamName and <value> = eagle_ml-2-0_default_out_star_extracts
  • <name> = FeedType and <value> = Options listed below

The table below lists the feed type options, descriptions, and Eagle report panels used by the STAR extract message stream to create the STAR tag value extract file with filtered results.

Feed Type Option

Description

Message Stream Panel

DIST_ACTIVITY

Distribution Activity

Panel: reports/pan-ec_distribution_activity.htm

EXPENSE

Expense Activity

Panel: reports/pan-ec_expenseactivity.htm

INCOME

Income Activity

Panel: reports/pan-ec_income_detail_extract.htm

MGR_ALLOCATION

Manager Allocation

Panel: account/pan-listmanagerallocation.htm

RPT_MAN_LEDGER_ADJ

Ledger Adjustments

Panel: reports/pan-ec_ledger_adj_rpt.htm

SETTLED_CASH

Settled Cash

Panel: reports/pan-ec_settledcash.htm

SHAREHOLDER_ACTIVITY

Shareholder Activity

Panel: reports/pan-ec_shareholderactivity.htm

TRADED_CASH

Traded Cash

Panel: reports/pan-ec_tradedcash.htm

TRD_ACTIVITY

Trade Activity

Panel: reports/pan-ec_tradeactivity.htm