Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In the Control Message, you can specify various required and optional parameters.

Anchor
Required_Parameters
Required_Parameters
Required Parameters

...

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

 

Compress = Y: the relative path for CustomExtractLocation is resolved relative


FeedType

SMF,FINANCIALEVENT

Defines the list of object to be extracted.
Should contain a comma-separated combination of values:

  • ENTITY – all ENTITY + RULE will be extracted
  • RULE – all RULE will be extracted
  • REFERENCE – all REFERENCE [ISSUER + SYSTEM + SECURITY] will be extracted
  • ISSUER – all ISSUER group only will be extracted
  • SYSTEM – all SYSTEM group only will be extracted
  • SECURITY – all SECURITY group only will be extracted
  • WAREHOUSE – all WAREHOUSE will be extracted
  • CORPORATEACTIONS – all CORPORATEACTIONS group will be extracted
  • SMF – all SMF will be extracted
  • ACCOUNTING – all ACCOUNTING group will be extracted
  • CORPORATEACTIONS – all CORPORATEACTIONS group will be extracted
  • FINANCIALEVENT – all FINANCIALEVENT will be extracted
  • CLIENT – all CLIENT will be extracted

You can also select only specific extract types from a group, such as: ENTITYLISTLISTEXTRACT, WRHSCLOSELOTEXTRACT, WRHSNAVEXTRACT
For a list of all object groups, see Extract Object Groups.

Anchor
Compress
Compress
Compress

Y (default)

, N

Setting to N disables compression of extracted files. Available only for FILE delivery method.
Please note, that this parameter would affect the way you set CustomExtractLocation parameter:


N
ZIP
GZIP
GZ
TAR (only UNIX)
TARGZ (only UNIX)
B64
TAR+B64 (only UNIX)
TARGZ+B64 (only UNIX)
GZIP+B64
GZ+B64
ZIP+B64

Y – Default method ZIP (.zip extension)
N – this setting disables compression for extracted files. Available only for FILE delivery method.
ZIP – files will be compressed as ZIP archive (.zip extension)
GZIP – files will be compressed altogether in one TAR archive, only after this it will be compressed as GZIP archive, because GZIP can work only with one file. (.tar.gz extension)
GZ – files will be compressed altogether in one TAR archive, only after this it will be compressed as GZIP archive, because GZIP can work only with one file. (.tar.gz extension)
TAR – files will be compressed as TAR archive (.tar extension)
TARGZ – files will be compressed as TAR archive (.tar.gz extension)
B64– files will be compressed as ZIP archive and then encoded to base64 text
TAR+B64– files will be compressed as TAR archive and then encoded to base64 text
TARGZ+B64– files will be compressed as TARGZ archive and then encoded to base64 text
GZIP+B64 – files will be compressed as TARGZ archive and then encoded to base64 text
GZ+B64 – files will be compressed as TARGZ archive and then encoded to base64 text
ZIP+B64– files will be compressed as ZIP archive and then it will be compress to base64 text


Info

Important notes:

  • If delivery method is JMS, all archive will be automatically compressed as base64 text
  • Generic Extract workflow and simple extract have some differences
    1. Generic Extract cannot produce GZIP archives, because GZIP does not allow multiple files, so at first a TAR archive will be created and after this it will be compress as GZIP. Simple extract works fine with GZIP
    2. Default value for compress in Generic Extract is ZIP
    3. Default value for compress in simple extract is G ZIP
  • Compress parameter would affect the way you set CustomExtractLocation parameter:
    1. Compress = Y or specific archivation format: the relative path for CustomExtractLocation is resolved relative to the extracts folder [...]/cmw/extracts/
    2. Compress = N: the relative path for CustomExtractLocation is resolved relative to the Packer stream folder [MessageCenter root directory]/estar/tpe/data/msgcenter/out/TAGVALUE/eagle_ml-2-0_default_cm_packer/


Anchor
Optional_Parameters
Optional_Parameters
Optional Parameters

...

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

+

+

+

 

 

 

 

 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

+

+

+

 

 

 

 

 

 _date

+

+

+







----extract_rule_primary_mixed_cost_basis

+

+

+

 

 

 

 

 

 







----extract_rule_amortization_schedule

+

+

+

 

 

 

 

 

 







----extract_rule_accounting

+

+

+

 

 

 

 

 

 







 
 
The following table lists Pass to Extract parameters for the REFERENCE extract.

 

 

 

 

 

 

 

 

 the REFERENCE extract.










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

+

+

 

 

 

 

 

 

 _error_definition

+

+








----extract_yield_curve

+

+

 

 

 

 

 

 

 








----extract_run_time_stamps

+

+

 

 

 

 

 

 







jobname

----extract_ledger_notes

+

+

 

 

 

 

 

 

 








--eagle_generic_extract_client_objects

+

+

 

 

 

 

 

 _objects

+

+







selectiontype, selectionvalue

----extract_client

+

+

 

 

 

 

 

 







selectiontype, selectionvalue

----extract_client_communication

+

+

 

 

 

 

 

 

selectiontype, selectionvalue

 
 
The following table lists Pass to Extract parameters for the WAREHOUSE extract.

 

 

 

 

 







 selectiontype, selectionvalue

 
 
  The following table lists Pass to Extract parameters for the WAREHOUSE extract.










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

+

+

+ 


+ 


+

 

 



 
 
The following table lists Pass to Extract parameters for the SMF, FINANCIALEVENT, CORPORATEACTIONS, and ACCOUNTING extracts and the extract archiving eagle_ml20_default_cm_packer message stream.

 

 

 

 

 

 

 

 

 










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

...