In the [Control Message, you can specify various required and optional parameters.
Required Parameters
The following table lists required parameters for the Control Message. You must define these parameters for each Control Message used to start the IWS workflow.
NOTE: Parameter names are case-sensitive.
Parameter |
Example of Value |
Comments |
---|---|---|
ActionType |
EXTRACT |
Constant value for all extracts. |
StreamName |
eagle_ml-2-0_default_cm_execwkfl |
Constant value for all extracts.The name of the message stream to which data is sent from the Control Message stream. This stream runs the workflow. |
WorkflowName |
eagle_wrf_generic_extract |
|
FeedType |
SMF,FINANCIALEVENT |
Defines the list of object to be extracted.
|
Compress |
Y (default), N |
Setting to N disables compression of extracted files. Available only for FILE delivery method.
|
Optional Parameters
Optional parameters include:
- Pass to Extract parameters. These parameters are passed from the [Control Message. If any of these parameters are not supported, they will not be passed along in the Control Messages for the individual extracts.
- Supported by Extract parameters. These parameters are passed from the Control Messages for individual extracts.
NOTE: Parameter names are case-sensitive.
The following table lists Pass to Extract parameters for the ENTITY extract.
Subprocess name |
Common |
Date |
Entity |
Held |
SMF |
History Only |
Source |
Delta Based |
Own |
---|---|---|---|---|---|---|---|---|---|
eagle_generic_extract_entity_and_rule_objects |
+ |
+ |
+ |
|
|
|
|
|
entitytype,historyonlyflag |
--eagle_generic_extract_entity_objects |
+ |
+ |
+ |
|
|
|
|
|
entitytype,historyonlyflag |
----extract_entity_manager |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_entity_manager_relationship |
+ |
+ |
+ |
|
|
|
|
|
entitytype |
----extract_entity_accounting_periods |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_entity_accounting_basis |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_entity_identifiers |
+ |
+ |
+ |
|
|
|
|
|
entitytype |
----extract_generic_entity |
+ |
+ |
+ |
|
|
|
|
|
entitytype,historyonlyflag |
----extract_entity_bank_relationship |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_entity_composite |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_entity_list |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_entities_in_composite |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_entities_in_list |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_gips_disclosures |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_gips_composite |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_entity_entitlement_list |
+ |
+ |
+ |
|
|
|
|
|
usergroups |
----extract_entity_share_class |
+ |
+ |
+ |
|
|
|
|
|
|
--eagle_generic_extract_rule_objects |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_rule_contract_cash |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_rule_contractual_cash_settlement |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_rule_earn_thru |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_rule_basis_processing |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_rule_backup_withholding |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_rule_month_end_date |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_rule_primary_mixed_cost_basis |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_rule_amortization_schedule |
+ |
+ |
+ |
|
|
|
|
|
|
----extract_rule_accounting |
+ |
+ |
+ |
|
|
|
|
|
|
BACK TO TOP |
|
|
|
|
|
|
|
|
|
Subprocess name |
Common |
Date |
Entity |
Held |
SMF |
History Only |
Source |
Delta Based |
Own |
eagle_generic_extract_reference_objects |
+ |
+ |
+ |
+ |
+ |
|
+ |
|
selectiontype,selectionvalue,includeissuerxref,securitysubtype,xreftype, issueralias, issuerid, issuername, codecategory, codecategoryname, codevalue, codevaluename, fromcodecategory, fromcodecategoryname, CalendarBusinessName, CalendarType, DateTypeMacro, OnlyBusinessCalendar, ProcessCenterNamefromcodevalue, fromcodevaluename, fromsourcecode, tocodecategory, tocodecategoryname, tocodevalue, tocodevaluename, tosourcecode |
--eagle_generic_extract_issuer_objects |
+ |
+ |
+ |
|
+ |
|
|
|
includeissuerxref, issueralias, issuerid, issuername |
--extract_issuer_entity_relationship |
+ |
+ |
+ |
|
+ |
|
|
|
includeissuerxref, issueralias, issuerid, issuername |
----extract_issuer_relationship |
+ |
+ |
|
|
|
|
|
|
issueralias, issuerid, issuername |
----extract_issuer_role |
+ |
+ |
|
|
+ |
|
|
|
issueralias, issuerid, issuername |
----extract_issuer_organization |
+ |
+ |
|
|
|
|
|
|
issueralias, issuerid, issuername |
----extract_issuer_rating |
+ |
+ |
|
|
|
|
|
|
issueralias, issuerid, issuername |
----extract_issuer |
+ |
+ |
|
|
|
|
|
|
includeissuerxref, issueralias, issuerid, issuername |
--eagle_generic_extract_security_related_objects |
+ |
+ |
|
+ |
+ |
|
+ |
|
selectiontype,selectionvalue,securitysubtype |
----extract_issue_fx_rate |
+ |
+ |
|
+ |
+ |
|
+ |
|
|
----extract_issue_fx_pc_rate |
+ |
+ |
|
+ |
+ |
|
+ |
|
|
----extract_issue_price |
+ |
+ |
|
+ |
+ |
|
+ |
|
|
----extract_issue_exchange_price |
+ |
+ |
|
+ |
+ |
|
+ |
|
|
----extract_smfidentifiers |
+ |
+ |
|
+ |
+ |
|
+ |
|
securitysubtype,xreftype |
----extract_schedule |
+ |
+ |
|
+ |
+ |
|
+ |
|
securitysubtype |
----extract_time_series |
+ |
+ |
|
+ |
+ |
|
+ |
|
|
----extract_generic_issue_analytic |
+ |
+ |
|
+ |
+ |
|
+ |
|
|
----extract_issue_variable_rate |
+ |
+ |
|
+ |
+ |
|
+ |
|
|
----extract_rating |
+ |
+ |
|
+ |
+ |
|
+ |
|
securitysubtype |
----extract_cancelsmfidentifiers |
+ |
+ |
|
+ |
+ |
|
+ |
|
|
----extract_forward_points |
+ |
+ |
|
+ |
+ |
|
+ |
|
|
----extract_factor |
+ |
+ |
|
+ |
+ |
|
+ |
|
|
----extract_securityoverrides |
+ |
+ |
|
|
+ |
|
+ |
|
|
----extract_naic_designation |
+ |
+ |
|
+ |
+ |
|
+ |
|
|
--eagle_generic_extract_system_objects |
+ |
+ |
|
|
|
|
+ |
|
jobname, codecategory, codecategoryname, codevalue, codevaluename, fromcodecategory, fromcodecategoryname, fromcodevalue, fromcodevaluename, fromsourcecode, tocodecategory, tocodecategoryname, tocodevalue, tocodevaluename, tosourcecode, CalendarBusinessName, CalendarType, DateTypeMacro, OnlyBusinessCalendar, ProcessCenterName |
----extract_code_translation |
+ |
+ |
|
|
|
|
|
|
fromcodecategory, fromcodecategoryname, fromcodevalue, fromcodevaluename, fromsourcecode, tocodecategory, tocodecategoryname, tocodevalue, tocodevaluename, tosourcecode |
----extract_code_category |
+ |
+ |
|
|
|
|
|
|
codecategory, codecategoryname |
----extract_code_value |
+ |
+ |
|
|
|
|
+ |
|
codecategory, codecategoryname, codevalue, codevaluename |
----extract_calendar |
+ |
+ |
|
|
|
|
|
|
|
----extract_calendar_holiday |
+ |
+ |
|
|
|
|
|
|
calendarname, calendardate, fromcalendardate, tocalendardate |
----extract_calendar_business_dates |
+ |
+ |
|
|
|
|
|
|
CalendarBusinessName, CalendarType, DateTypeMacro, OnlyBusinessCalendar, ProcessCenterName |
----extract_error_definition |
+ |
+ |
|
|
|
|
|
|
|
----extract_yield_curve |
+ |
+ |
|
|
|
|
|
|
|
----extract_run_time_stamps |
+ |
+ |
|
|
|
|
|
|
jobname |
----extract_ledger_notes |
+ |
+ |
|
|
|
|
|
|
|
--eagle_generic_extract_client_objects |
+ |
+ |
|
|
|
|
|
|
selectiontype,selectionvalue |
----extract_client |
+ |
+ |
|
|
|
|
|
|
selectiontype,selectionvalue |
----extract_client_communication |
+ |
+ |
|
|
|
|
|
|
selectiontype,selectionvalue |
BACK TO TOP |
|
|
|
|
|
|
|
|
|
Subprocess name |
Common |
Date |
Entity |
Held |
SMF |
History Only |
Source |
Delta Based |
Own |
eagle_generic_extract_warehouse_objects |
+ |
+ |
+ |
|
+ |
|
+ |
|
BatchMode, ExcludeCurrentDay, accountingdate, fromaccountingdate, frommonthendaccountingdate, GLBasic, monthendaccountingdate, toaccountingdate, tomonthendaccountingdate, fromvaluationdate, tovaluationdate, valuationdate |
--extract_warehouse_cash_activity |
+ |
+ |
+ |
|
+ |
|
+ |
|
BatchMode, ExcludeCurrentDay |
--extract_warehouse_closelot |
+ |
+ |
+ |
|
+ |
|
+ |
|
BatchMode, ExcludeCurrentDay |
--extract_warehouse_openlot |
+ |
+ |
+ |
|
+ |
|
+ |
|
BatchMode, ExcludeCurrentDay |
--extract_warehouse_performance |
+ |
+ |
+ |
|
+ |
|
+ |
|
BatchMode, ExcludeCurrentDay |
--extract_warehouse_position |
+ |
+ |
+ |
|
+ |
|
+ |
|
BatchMode, ExcludeCurrentDay |
--extract_warehouse_trade |
+ |
+ |
+ |
|
+ |
|
+ |
|
BatchMode, ExcludeCurrentDay |
--extract_warehouse_nav |
+ |
+ |
+ |
|
+ |
|
+ |
|
BatchMode, ExcludeCurrentDay |
--extract_warehouse_custody_activity |
+ |
+ |
+ |
|
+ |
|
+ |
|
BatchMode, ExcludeCurrentDay |
--extract_warehouse_custody_balance |
+ |
+ |
+ |
|
+ |
|
+ |
|
BatchMode, ExcludeCurrentDay |
--extract_warehouse_pending_trade |
+ |
+ |
+ |
|
+ |
|
+ |
|
BatchMode, ExcludeCurrentDay |
--extract_warehouse_glbalances |
+ |
+ |
+ |
|
+ |
|
+ |
|
BatchMode, ExcludeCurrentDay, accountingdate, fromaccountingdate, frommonthendaccountingdate, GLBasic, monthendaccountingdate, toaccountingdate, tomonthendaccountingdate |
--extract_warehouse_nav_multi |
+ |
+ |
+ |
|
+ |
|
+ |
|
BatchMode, ExcludeCurrentDay, fromvaluationdate, tovaluationdate, valuationdate |
--extract_warehouse_broker_trade_quote |
+ |
+ |
+ |
|
+ |
|
+ |
|
BatchMode, ExcludeCurrentDay |
--extract_trade_quotes |
+ |
+ |
+ |
|
+ |
|
|
|
|
--extract_warehouse_cash_flow_projection |
+ |
+ |
+ |
|
+ |
|
+ |
|
|
--extract_warehouse_istarlot |
+ |
+ |
+ |
|
+ |
|
+ |
|
|
--extract_warehouse_disclosure_status |
+ |
+ |
+ |
|
+ |
|
+ |
|
|
BACK TO TOP |
|
|
|
|
|
|
|
|
|
Subprocess name |
Common |
Date |
Entity |
Held |
SMF |
History Only |
Source |
Delta Based |
Own |
eagle_generic_extract_smf_objects |
+ |
+ |
|
+ |
+ |
|
+ |
|
asofeffectivedate,securitysubtype |
--extract_generic_smf |
+ |
+ |
|
+ |
+ |
|
+ |
|
asofeffectivedate,securitysubtype |
eagle_generic_extract_financial_event |
+ |
+ |
+ |
|
+ |
|
|
|
|
--extract_financial_event |
+ |
+ |
+ |
|
+ |
|
|
|
|
eagle_generic_extract_corp_actions_objects |
+ |
+ |
|
+ |
+ |
|
+ |
|
|
--extract_generic_ca |
+ |
+ |
|
+ |
+ |
|
+ |
|
|
--extract_voluntary_ca_election |
+ |
+ |
|
+ |
+ |
|
+ |
|
|
eagle_generic_extract_accounting_objects |
+ |
+ |
+ |
+ |
+ |
|
+ |
|
|
--extract_accounting_trade |
+ |
+ |
+ |
|
+ |
|
|
|
|
--extract_accounting_gl_activity |
+ |
+ |
+ |
|
+ |
|
|
|
FromGLAccount, GLBasic, GLClass, GLDateType, GLFromDate, GLSector, GLToDate, ToGLAccount |
--extract_accounting_traded_cash_activity |
+ |
+ |
+ |
|
+ |
|
|
|
|
--extract_accounting_cash_projections |
+ |
+ |
+ |
+ |
+ |
|
+ |
|
|
--extract_accounting_accrued_income |
+ |
+ |
+ |
+ |
+ |
|
+ |
|
|
--extract_accounting_subscribe_reedem |
+ |
+ |
+ |
+ |
+ |
|
+ |
|
|
--extract_accounting_daily_mill_rate |
+ |
+ |
+ |
+ |
+ |
|
+ |
|
|
--extract_accounting_unsettled_trans |
+ |
+ |
+ |
+ |
+ |
|
+ |
|
reportType, reportDate, baseCurrency, accountingBasis, longShortIndicator, cashCategory, eventReason, cashEventType, shareClass, localCurrency, includeCorpAction, includeFwdTransactions |
--extract_accounting_cash_journal |
+ |
+ |
+ |
+ |
+ |
|
+ |
|
reportView,selectView,reportType |
--extract_accounting_realized_gl |
+ |
+ |
+ |
+ |
+ |
|
+ |
|
reportType,reportTypeSource,includeCancels,displayZero,displayUDF |
--extract_accounting_settled_ca |
+ |
+ |
+ |
+ |
+ |
|
+ |
|
|
--extract_accounting_cons_earned_income |
+ |
+ |
+ |
+ |
+ |
|
+ |
|
reportType, reportPeriod, startDate, endDate, longShortIndicator, rollupIndicator, accountingBasis, baseCurrency, localCurrency, taxableIndicator, nraTaxCountry, governmentIndicator, processCenter, conversionStatus, urglRecpayIndicator |
--extract_accounting_distribution_activity |
+ |
+ |
+ |
+ |
+ |
|
+ |
|
|
--extract_accounting_custom_ledger_acct |
+ |
+ |
+ |
+ |
+ |
|
+ |
|
Switch, ChartOfAccountName, GLAccount, CustomAccount, CustomAccountDescription, GLPostType |
--extract_accounting_open_rec_pay_multi |
+ |
+ |
+ |
+ |
+ |
|
+ |
|
issuename, settlecurrency, brokerName, brokerCode, targerEventId, eventType, tradeTicketNumber, category |
--extract_accounting_unapproved_var_margin |
+ |
+ |
+ |
|
+ |
|
|
|
accountingBasis, baseCurrency, longShortIndicator, reportType |
--extract_accounting_trial_balance |
+ |
+ |
+ |
|
|
|
|
|
selectView, ledgerProfile, reportType, generalLedgerCurrency, accountingBasis, showMEMOAccounts, showAssetLevelDetails, reportFilters, selectSector, sectorID, sector, selectShareClass, shareClass, detailedClassView, reportDate, monthEndDate, filterSecurityBy, issuename |
--extract_accounting_intraday_nav |
+ |
+ |
+ |
|
|
|
|
|
|
--extract_accounting_nav_for_nasdaq |
+ |
+ |
+ |
|
|
|
|
|
|
--extract_accounting_fair_value_comparison |
+ |
+ |
+ |
|
|
|
|
|
|
eagle_ml20_default_cm_packer |
|
|
|
|
|
|
|
|
CustomExtractLocation, ExtractDeliveryMethod, FromFolder, ToFolder, OutputZipFileName, OutputZipFileNamePattern, SendDataToFTP |
Add Comment