About EagleML Filters

Owned by Natalie Gesin (Deactivated)
Last updated: May 22, 2024 by Aleksei Barich
3 min read

The Control Message file contains filter parameters. All these parameters are located in Task parameters section. Apart from the parameters you can set in the Control Message for a particular extract, there is an option to define global parameters influencing all processes in an environment, including extracts.

Filter parameters define a range of data which is going to be extracted from the Database tables for each object. The list of objects and corresponding filter parameters are described below.

Eagle also maintains a list of available EagleML filters.

On this page

For example, the value of parameter “updatedate” follows.

<taskParameter>
      <name>updatedate</name>
      <dataType>S</dataType>
      <value>2013-06-25 15-00-00</value>
</taskParameter>


Note

All parameter names are case-sensitive.

Cross-Reference of Objects and Filters

All filters can be divided into groups: Common, Date, Entity, Held, Smf, Sources, Delta Based, Issuer and Own filters. “Own” filters are implemented within the rules of an object and are usually specific for the object. All other filters are implemented in the include files located in the folder /eagle_ml-2-0_cm and are shared between several EagleML objects, as follows.

FilterInclude Filename
Commonextract_filter_common.inc
Dateextract_filter_date
extract_date_sql.inc
Entityextract_filter_entity.inc
Heldextract_filter_held.inc
Smfextract_filter_smf.inc
Sourcesextract_filter_sources.inc
Delta Basedextract_delta_based.inc
Issuerextract_filter_iif.inc

See the following table to learn which filters are supported for the EagleML object you are going to extract.

Object NameFeed TypeCommonDateEntityHeldSMFHistory OnlySourcesDelta BasedIssuerOwnCM Parameters

Entity













Composite Entity ListENTITYCOMPOSITELISTEXTRACT+++

+



IncludeEntityInfo, RemoveEntityDuplicates
Entity Manager RelationshipENTITYMANAGERRELEXTRACT+++





entitytype, maxeffectivedate (only in history mode)RemoveEntityDuplicates
Entity Share ClassENTITYSHARECLASSEXTRACT+++
+++


IncludeAssetProperties, IncludeEntityInfo, RemoveEntityDuplicates
Entity Accounting BasisENTITYACCBASISEXTRACT+++






IncludeEntityInfo, RemoveEntityDuplicates, UseAllAcctBasis
Entity AnalyticENTITYANALYTICEXTRACT+++


+


IncludeEntityInfo, RemoveEntityDuplicates
Entity Bank RelationshipENTITYBANKRELEXTRACT+++






IncludeEntityInfo, RemoveEntityDuplicates
Entity LiquidityENTITYLIQUIDITYEXTRACT+++

+



IncludeEntityInfo, RemoveEntityDuplicates
Entity ManagerENTITYMANAGEREXTRACT+++






RemoveEntityDuplicates
Entity XREFENTITYXREFEXTRACT+++





entitytypeRemoveEntityDuplicates
Entity ListENTITYLISTEXTRACT+++






IncludeEntityInfo, RemoveEntityDuplicates
Entities In ListSTATICENTITYLISTEXTRACT+++






IncludeEntityInfo, RemoveEntityDuplicates
Entities In ListDYNAMICENTITYLISTEXTRACT+++
(EntityList filter is required)






IncludeEntityInfo, RemoveEntityDuplicates
Generic EntityENTITYEXTRACT+++

++

entitytype, activeStatusIncludeEntityInfo, RemoveEntityDuplicates
Entity Accounting PeriodsENTITYACCPERIODSEXTRACT+++



+
accountingBasisIncludeEntityInfo, RemoveEntityDuplicates
Entity Peer Group RankingENTITYPEERGROUPRANKINGEXTRACT+++


+


IncludeEntityInfo, RemoveEntityDuplicates
Entity RegulatoryENTITYREGULATORYEXTRACT+++

+



IncludeEntityInfo, RemoveEntityDuplicates
Entity Security LendingENTITYSECLENDINGEXTRACT+++


++

IncludeEntityInfo, RemoveEntityDuplicates
Entity StatisticENTITYSTATISTICEXTRACT+++


+


IncludeEntityInfo, RemoveEntityDuplicates

Rule













Primary Mixed Cost Basis RuleRULEPRIMCOSTBASISEXTRACT+++






RemoveEntityDuplicates
Contract Cash RuleRULECONTRACTCASHEXTRACT+++






RemoveEntityDuplicates
Contractual Cash Settlement RuleRULECCSETTLEMENTEXTRACT+++






RemoveEntityDuplicates
Earn Thru RuleRULEEARNTHRUEXTRACT+++






RemoveEntityDuplicates
Basis Processing RuleRULEBASISPROCEXTRACT+++






RemoveEntityDuplicates
Backup Withholding RuleRULEBUWITHHOLDINGEXTRACT+++






RemoveEntityDuplicates
Month End Date RuleRULEMONTHENDDATEEXTRACT+++






RemoveEntityDuplicates
Amortization Schedule RuleRULEAMORTSCHDLEXTRACT+++






RemoveEntityDuplicates
Accounting RuleRULEACCOUNTINGEXTRACT+++






RemoveEntityDuplicates

SMF













Generic SMFSMFEXTRACT++
+++++
securitysubtype, maxeffectivedate (only in history mode)IncludeAssetProperties

Reference













CalendarREFCALENDAREXTRACT++








Calendar Business DatesCALBUSINESSDATESEXTRACT








OnlyBusinessCalendar, CalendarType, CalendarBusinessName, DateTypeMacro, ProcessCenterName
Calendar HolidayREFCALENDARHOLIDAYEXTRACT++






calendarname, fromcalendardate, calendardate, tocalendardate
Classification MatrixCLASSIFICATIONMATRIXEXTRACT++






ExcludeClassMatrixId, pendingOnly, ClassificationMatrixName
Code TranslationCODETRANEXTRACT++




+

fromsourcecode,fromcodecategory, fromcodecategoryname, fromcodevalue, fromcodevaluename, tosourcecode, tocodecategory, tocodecategoryname, tocodevalue, tocodevaluename


Code ValueCODEVALEXTRACT++


+
+
sourcename, codecategory, codecategoryname, codevalue, codevaluename
Code CategoryCODEEXTRACT++




+
codecategoryname, codecategory
Сompliance 2A-7 Pricing ReportCOMPLIANCE2A7PRICINGEXTRACT++
+




accountingBasis, selectView, reportType, reportPeriod, 2A7PricingSource, reportFilters, advancedReportOptions, selectSector, sectorId, sector, filterSecurityBy, issuename, summaryMain, holdingsByTierLevel, holdingsByInvestmentType, holdingsByIssuer, securityRatings. Read more..
Demand ListDEMANDLIST










Entity Entitlement ListENTITYENTITLEMENTLISTEXTRACT+
+





usergroups (required)RemoveEntityDuplicates
Error DefinitionEXCEPTIONDEFEXTRACT++



v.13+

ErrorCode
Ledger NotesLEDGERNOTESEXTRACT++








Line of CreditLINEOFCREDITEXTRACT+++




+facilityidRemoveEntityDuplicates
NAIC DesignationNAICDESIGNATIONEXTRACT++






naicresolutiontype, naicassetid, naicclientid
PACE CalendarPACECALENDAREXTRACT+





+


PACE SystemPACESYSEXTRACT++




+
sysitem
Pricing System SettingPRICINGSYSSETTINGEXTRACT++


+
+
code
Process CenterPROCESSCENTEREXTRACT+







ProcessCenterName, CalendarBusinessName
RatingRATINGSEXTRACT++
+++++
maxeffectivedateIncludeAssetProperties
Report DictionaryDICTIONARYEXTRACT++

+
++
excludesecuritylinksflag, dictionarynameIncludeAssetProperties, linkedassetonlydelta
Run Time StampsRPTTIMESTAMPS










SourceSOURCEEXTRACT++






sourceinstance, sourcename

Security related













SMF IdentifiersXREFEXTRACT++
+++
+
xrefidtype, securitysubtype, securityalias
SMF Identifier ConfigXREFCONFIGEXTRACT






+


Exchange PriceISSUEEXCHANGEPRICEEXTRACT+++++
++

IncludeAssetProperties, RemoveEntityDuplicates
Issue Variable RateISSUEVARRATEEXTRACT++
+++++

IncludeAssetProperties
Issue Fx RateISSUEFXRATEEXTRACT++
++
++


Issue Fx Rate DemandISSUEFXRATEDEMANDEXTRACT++

+
++


Issue PriceISSUEPRICEEXTRACT++++++++

IncludeAssetProperties, RemoveEntityDuplicates
Issue Fx Pc RateISSUEFXPCRATEEXTRACT++
++
++


Generic Issue AnalyticGENISSUEANALYTICEXTRACT++
+++++

IncludeAssetProperties
ScheduleSCHEDULEEXTRACT++
+++++
securitysubtypeIncludeAssetProperties
GIPS CompositeREFGIPSCOMPOSITEEXTRACT+++






RemoveEntityDuplicates
GIPS DisclosureREFGIPSDISCLOSUREEXTRACT++






DisclosureName, DisclosureType
Time SeriesREFTIMESERIESEXTRACT++
++

+


Trade QuoteREFTRADEQUOTESEXTRACT+++++
++

RemoveEntityDuplicates
Yield CurveYIELDCURVEEXTRACT++








Forward PointsFORWARDPOINTSEXTRACT++
+++++

IncludeAssetProperties
FactorFACTOREXTRACT++
+++++

IncludeAssetProperties
Security DefaultSECURITYDEFAULTEXTRACT++
++





Security NotesSECURITYNOTESEXTRACT++

+

+


Security OverridesSECURITYOVERRIDESEXTRACT++

+
++

IncludeAssetProperties
Earnings Time PeriodEARNINGSTIMEPERIODEXTRACT++

+

+


Issuer













IssuerGENISSUEREXTRACT++
+++
++maxeffectivedate (only in history mode)
Issuer ESGISSUERESGEXTRACT++


+
++maxeffectivedate (only in history mode)
Issuer Entity RelationshipISSUERENTRELEXTRACT






+


Issuer RatingISSUERRATINGEXTRACT++




++maxeffectivedate
Issuer OrganizationISSUERORGEXTRACT++
+++
++maxeffectivedate (only in history mode)
Issuer RegulatoryISSUERREGULATORYEXTRACT++




++

Issuer RelationshipISSUERRELEXTRACT++




++

Issuer RoleISSUERROLEEXTRACT++
+++
++minenddate

Warehouse













Warehouse Pending TradeWRHSPENDINGTRADESEXTRACT+++
+
++

IncludeAssetProperties, IncludeEntityInfo, RemoveEntityDuplicates, excludezero
Warehouse Custody ActivityWRHSCSTDACTIVITYEXTRACT+++
+

+

IncludeAssetProperties, IncludeEntityInfo, RemoveEntityDuplicates, excludezero
Warehouse Custody BalanceWRHSCSTDBALANCEEXTRACT+++
+

+

IncludeAssetProperties, IncludeEntityInfo, RemoveEntityDuplicates, excludezero
Warehouse Cash ActivityWRHSCASHACTIVITYEXTRACT+++
+
++
BatchModeIncludeAssetProperties, IncludeEntityInfo, RemoveEntityDuplicates,excludezero
Warehouse PerformanceWRHSPERFORMANCEEXTRACT+++
+
+

BatchModeIncludeAssetProperties, IncludeEntityInfo, RemoveEntityDuplicates, IncludeCurveAnalytics, excludezero
Warehouse Close LotWRHSCLOSELOTEXTRACT+++
+
++
BatchModeIncludeAssetProperties, IncludeExtendedDetails, IncludeEntityInfo, RemoveEntityDuplicates, excludezero
Warehouse PositionWRHSPOSITIONEXTRACT+++
+
++
BatchMode, extractLevel

IncludeAssetProperties, IncludeExtendedDetails, IncludeEntityInfo, RemoveEntityDuplicates, TakeBaseCurrencyFromWRHSPosDet, includeZeroPositions, IncludeCurveAnalytics, IncludePortfolioValuation, excludezero

Warehouse Open LotWRHSOPENLOTEXTRACT+++
+
++
BatchMode, extractLevel

IncludeAssetProperties, IncludeExtendedDetails, IncludeEntityInfo, RemoveEntityDuplicates, includeZeroPositions, IncludePortfolioValuation, IncludeWashSales, excludezero

Warehouse Open LotWRHSOPENLOTBROKERROLLUPEXTRACT+++
+
++
BatchMode, extractLevel

IncludeAssetProperties, IncludeExtendedDetails, IncludeEntityInfo, RemoveEntityDuplicates, includeZeroPositions, IncludePortfolioValuation, IncludeWashSales, GroupBy, excludezero

Warehouse TradeWRHSTRADEEXTRACT+++
+
++
BatchMode, transactioncodeIncludeAssetProperties, IncludeExtendedDetails, IncludeEntityInfo, RemoveEntityDuplicates, EnableSignageLogic, excludezero, EnhanceCalcTransactionId
Warehouse Trade ChargesWRHSTRADECHARGESEXTRACT+++
+
+

BatchMode
Warehouse Trade Xref IdentifierWRHSTRADEXREFEXTRACT+
+
+





Warehouse NAV MultiWRHSNAVMULTIEXTRACT+++
+

+
BatchMode

IncludeAssetProperties, IncludeExtendedDetails, includeEntityShareClass, includeReportDetails, includeCustomReportDetails, IncludeAverageNetAssets, IncludeEntityInfo, RemoveEntityDuplicates, excludezero

Warehouse NAVWRHSNAVEXTRACT+++


++
BatchModeIncludeEntityInfo, RemoveEntityDuplicates, excludezero
Warehouse NAV Month EndWRHSNAVMONTHENDEXTRACT+++


++

IncludeAssetProperties, IncludeExtendedDetails, includeEntityShareClass, UseFundsOfFunds, IncludeEntityInfo, excludezero
Warehouse General Ledger BalancesWRHSGLDETAILPOSTINGEXTRACT+++
+
++
BatchMode, GLBasic,  IncludeMEMOAccounts, IncludeOnlyAcctBaseCurrencyIncludeAssetProperties, IncludeExtendedDetails, IncludeEntityInfo, RemoveEntityDuplicates, excludezero
Warehouse Broker Trade QuoteWRHSBROKTRDQUOTEEXTRACT+++++
++
masterTicketNumberRemoveEntityDuplicates, excludezero
Warehouse Cash Flow ProjectionWRHSCASHFLOWPROJEXTRACT+++
+
++

IncludeEntityInfo, RemoveEntityDuplicates, excludezero
Insurance Valuation LotWRHSCASHFLOWPROJEXTRACT+++
+



clientID, Lot_idIncludeAssetProperties, IncludeEntityInfo, RemoveEntityDuplicates, excludezero
Warehouse Disclosure StatusWRHSDISCLOSURESTATUSEXTRACT+++
+
+


IncludeAssetProperties, IncludeEntityInfo, RemoveEntityDuplicates, excludezero
Warehouse Wash Sale TradeWRHSWASHSALETRADEEXTRACT+++++
++
BatchMode, origaccountingdate, fromorigaccountingdate, toorigaccountingdateIncludeAssetProperties, IncludeEntityInfo, RemoveEntityDuplicates, excludezero

Corporate Action













Generic Corporate ActionsGENCORPACTIONSEXTRACT++
+++
+

maxsweepdate, maxsweepdaterule, UseTransTypeGrouping, transType, cpReason, cpStatus, clientSpecificCAId

IncludeAssetProperties
Voluntary CA ElectionVOLCAELECTIONEXTRACT++
+++
+


Client













ClientCLIENTEXTRACT+++



+
ClientID, InstanceRemoveEntityDuplicates
Client CommunicationCLIENTCOMMEXTRACT++




+
ClientID, CommunicationType, Instance

Accounting













Accounting TradeACCOUNTINGTRADEEXTRACT+++
+
+


IncludeEntityInfo, RemoveEntityDuplicates

Financial Event

FINANCIALEVENTEXTRACT
(a specific extract for Accounting Trade, tagvalue-only, no EagleML interpretation)		+++
+
++


Traded Cash ActivityTRADEDCAEXTRACT+++
+



accountingBasis, UsePrimaryBasisOnlyIncludeAssetProperties, IncludeExtendedDetails, EnableSignageLogic, IncludeEntityInfo, RemoveEntityDuplicates, EnhanceCalcTransactionId
Settled Cash ActivitySETTLEDCAEXTRACT+++
+

+
accountingBasis, UsePrimaryBasisOnlyIncludeExtendedDetails, EnableSignageLogic, IncludeEntityInfo, RemoveEntityDuplicates, EnhanceCalcTransactionId
Accounting GL ActivityGLACTIVITYEXTRACT+++
+

+

FromGLAccount, GLBasic, GLClass, GLDateType, GLFromDate, GLToDate, GLSector, ToGLAccount, IncludeALLOCATEEvents,

IncludeMEMOAccounts, NetRollbackReplayEntries

IncludeAssetProperties, IncludeEntityInfo
Accrued IncomeACCRUEDINCOMEEXTRACT+++++




IncludeAssetProperties, IncludeEntityInfo
Subscribe RedeemSUBSCRIBEREEDEMEXTRACT+++
+




IncludeAssetProperties, IncludeExtendedDetails, includeEntityShareClass, IncludeSubscribeReedemCalcFields,

IncludeEntityInfo, RemoveEntityDuplicates

Daily Yield Mill RateDAILYYIELDMILLRATEEXTRACT+++






IncludeEntityInfo, RemoveEntityDuplicates
Cash JournalCASHJOURNALEXTRACT+++
+



reportView, selectView, reportType, reportPeriod, includeCancels, displayZero, nraTaxCountry, localCurrency, longShortIndicator, eventType, baseCurrency, processCodeTranslation, codeMapName
All filters are case-insensitive
Cash ProjectionsCASHPROJECTIONSEXTRACT+++
+

+
CashProjectionReportType, CashProjectionReportName, CashProjectionPositionSwitch, CashProjectionInstanceType, CashProjectionInstance, accountingBasisIncludeAssetProperties, IncludeEntityInfo, RemoveEntityDuplicates, IncludeExtendedDetails
Unsettled TransactionsUNSETTLEDTRANSACTIONSEXTRACT++






reportType, reportDate, baseCurrency, accountingBasis, longShortIndicator, cashCategory, eventReason, cashEventType, shareClass, localCurrency, includeCorpAction, includeFwdTransactions

accountingValidationFlag (required in case you set a range of dates)
Realized Gain LossREALIZEDGAINLOSSEXTRACT+++
+



reportType, reportPeriod, reportTypeSource, includeCancels, displayZero, accountingBasis, reportFilters, filterSecurityBy, assetCurrency or localCurrency, longShortIndicator, eventType, issuename, nraTaxCountry, lotPosSwitch (SP mode only), displayUDF (panel mode for v2017 or higher, SP mode only for other)
All filters are case-insensitive		accountingValidationFlag, IncludeEntityInfo, RemoveEntityDuplicates
Consolidated Earned IncomeCONSEARNEDINCOMEEXTRACT
++
+



reportPeriod, reportType, reportStartDate, reportEndDate, accountingBasis, baseCurrency or localCurrency, taxableIndicator, nraTaxCountry, longShortIndicator, governmentIndicator, issuename,

rollupIndicator (SP mode only), processCenter (SP mode only), conversionStatus (SP mode only), urglRecpayIndicator (SP mode only)
All filters are case-insensitive

accountingValidationFlag, selectView, selectSector, sectorID, detailSelection
Distribution ActivityDISTRIBUTIONACTEXTRACT+++
+




IncludeAssetProperties, IncludeExtendedDetails, IncludeEntityInfo, RemoveEntityDuplicates
Custom Ledger AccountCUSTLEDGERACCTEXTRACT+++





GLSelectionType, GLChartOfAccountName, GLAccount, GLCustomAccount, GLCustomAccountDescription, GLPostType
Open Rec Pay MultiOPENRECPAYMULTIEXTRACT+++





settleCurrency, brokerName, brokerCode, targerEventId, eventType, tradeTicketNumber, category, entityName, issuename
All filters are case-insensitive		IncludeEntityInfo, RemoveEntityDuplicates
Unapproved Variation MarginUNAPPROVEDVARMARGINEXTRACT+++
+



accountingBasis, baseCurrency, longShortIndicator, reportTypeIncludeAssetProperties, IncludeEntityInfo, RemoveEntityDuplicates
Trial BalanceTRIALBALANCEEXTRACT

+





selectView, ledgerProfile, reportType, generalLedgerCurrency, accountingBasis, showMEMOAccounts, showAssetLevelDetails, reportFilters, selectSector, sectorID, sector, selectShareClass, shareClass, detailedClassView, reportDate, filterSecurityBy, issuename
All filters are case-insensitive

IncludeEntityInfo, RemoveEntityDuplicates
Fair Value ComparisonFAIRVALUECOMPARISONEXTRACT+++
+



accountingBasis, reportType, nextDayOpenSourceName, nextBusinessDay, nextDayOpenPriceType, nextOpenPricingExchange, reportFilters, showMEMOAccounts, showAssetLevelDetails, filterSecurityBy, issuename, longShort, assetCurrency, issueCountry

IncludeEntityInfo, RemoveEntityDuplicates
Accounting Intraday NAVINTRADAYNAVEXTRACT+++



+

IncludeEntityInfo, RemoveEntityDuplicates, includeEntityShareClass
Accounting NAV for NASDAQNAVFORNASDAQEXTRACT+++



+

IncludeEntityInfo, RemoveEntityDuplicates
Working Trial BalanceWORKINGTRIALBALANCEEXTRACT+++





accountingBasis, generalLedgerCurrency, selectView, selectSector, sectorID, Sector, selectShareClass, shareClass, detailedClassView, reportType, ledgerProfile, reportFilters, showMEMOAccounts, showAssetLevelDetails, filterSecurityBy, xrefid, xrefidtype, primaryassetid, issuename, includeExcludeCloseoutEntries

IncludeEntityInfo, RemoveEntityDuplicates
Monthly Portfolio ValuationMONTHLYPORTFOLIOVALUATIONEXTRACT+++
+

+

RemoveEntityDuplicates
Portfolio ValuationPORTFOLIOVALUATIONEXTRACT+++
+

+

RemoveEntityDuplicates
Accounting RejectionREJECTIONEXTRACT++++++++
eventType, eventId, updateSourceIncludeExtendedDetails, IncludeAssetProperties
Accounting Position As OfPOSITIONASOFEXTRACT










Preferred SharePREFERREDSHAREEXTRACT










Master Feeder RelationshipMASTERFEEDERRELATIONEXTRACT










Bank Cash SettlementBANKCASHSETTLEMENTEXTRACT










Weighted AverageWEIGHTEDAVERAGEEXTRACT










Expense ActivityEXPENSEACTIVITYEXTRACT










Pricing ReportPRICINGREPORTEXTRACT+++
+



usergroups

User Administration













UserUSEREXTRACT++




+
userid, businessgroupname, usergroupname, applicationgroupname, centerrolename, accountstate, SetProcessingOptionsValueIncludeInstanceIds
GroupUSERGROUPEXTRACT++






userid, businessgroupname, usergroupname, applicationgroupname, centerrolename, accountstate, SetProcessingOptionsValueIncludeInstanceIds
EntitlementUSERENTITLEMENTEXTRACT+







PropertyName
Eagle Administration SettingsEAGLEADMINISTRATIONSETTINGSEXTRACT










Internal













Control Center Event LogCONTROLCENTEREVENTLOGEXTRACT++






eventgroupname, eventtaskid, activeflag, completedflag, coregroup, statisticcategory, statisticname, statistictype, businessprocessinggroup


S2P Reporting













Spd Delta Trigger LogSPDDELTATRIGGERLOGEXTRACT+++
+
++
eventId, messageSubType, updateSource, localCurrency, accountingBasis, minAccountingDateFlag

Other













Calculate DateCALCULATEDATE