Control Message Required and Optional Parameters

ActionType

EXTRACT

Constant value for all of Extracts

StreamName

eagle_ml-2-0_default_out_q

Constant value for all of Extracts.
The name of Q-stream to which data is sent from the control-message stream.

FeedType

ENTITYEXTRACT (for Object “Generic Entity”, etc.)

Value should be corresponding to the Object of extracting

OutputFormat

EagleML or TagValue or CSV

Specifies the output data format for extracts.

If OutputFormat=EagleML, the extract file will be in EagleML format and the file extension will be *.xml

If OutputFormat=CSV, the extract file will be in TagValue format and the file extension will be *.csv

If OutputFormat=TagValue, the extract file will be in TagValue format and the file extension will be *.txt

If OutputFormat is set to a value other than EagleML, CSV or TagValue, the extract file will be in TagValue format and the file extension will be *.xml

If OutputFormat is not specified, the extract file will be in EagleML format and the file extension will be *.xml

Common Parameters

ExtractNamePattern

ENTITYDATA

Custom name pattern for the output file. Result file name will be “correlation ID_ExtractNamePattern value_records count_current date”.

ExtractNamePatternEx

Custom name pattern for the output file. Please use the corresponding feedtype as prefix for the parameter name. Result file name will be “tst_SMFEXTRACT_my.xml” for an SMF extract. List of valid expressions:

• @CorrelationID replaced by initial CorrID

• @DateTimeStamp – date-time stamp  in format YYYYMMDDHHMISS

• @DateTimeStampISO – date-time stamp in format YYYYMMDDTHHMISS (with 'T' separator between date and time values)

• @DateStamp – date stamp in format YYYYMMDD

• @RecordCount – count of extracted records

• @EntityList – passed entity list filter

• @EntityID  – passed entity id filter

• @FeedType – passed feed type

• @entityselectiontype – passed value of “entityselectiontype” task parameter

• @entityselectiontype2 – passed value of “entityselectiontype2” task parameter

• @entityselectionvalue – passed value of “entityselectionvalue” task parameter

• @entityselectionvalue2 – passed value of “entityselectionvalue2” task parameter

• @SequencerNumber - sequence number of the file.

• @EnvironmentTag - environment tag which can be set in w_config_custom.inc or w_config.inc file.

ExactExtractFileName

CUSTOMEXACTNAME

Customizes the exact name for the output file.

The name will be exact, it will not contain the ID and other info.

T_StreamName

eagle_default_in_csv

If this parameter is present in the CM, the data received in step (eagle_ml-2-0_default_out_q) will be sent to the specified stream. Default value is eagle_ml-2-0_default_out_t.

StreamingT_StreamName

eagle_ml-2-0_my_custom_streaming_t

Forces using a custom streaming_t stream after the q-step. Default value is eagle_ml-2-0_default_out_streaming_t

QueryProfileName

Enables Element Reduction feature. See more details here

Compress

N, Y, ZIP, GZIP, B64, GZIP+B64

Enables/Disables compression. Has a global equivalent - DEFAULT_EAGLEML_EXTRACT_COMPRESS
N - no compression
Y – Default method – ZIP
ZIP - file extension will be .zip
GZIP  - file extension will be .gz
B64 - B64 compression - file extension will be .b64
GZIP + B64 - GZIP and B64 compression - file extension will be .gz.b64

COMPRESS_WITH_CORR_ID

Y or N

If the value of flag is ‘Y’ then result extract file will be compressed to zip (box with Windows OS) or gz (box with Unix OS) archive AND the

both the  zip file name  and the files within the zip gets created with the correlation ID within the name.  

If value set to ‘N’ then zip file name and the files within the zip will not contain the correlation ID within the name.

XSDValidation

Y or N

If the value is set to ‘Y’ and OutputFormat is not TagValue, XML Schema validation will be performed for outgoing file. Results are shown in T-Stream status messages and Task Status Response messages.

If the value is set to ‘N’, feature will be disabled.

Otherwise, g_bXSDValidation flag value (1 or 0) is used from ‘w_config.inc’ configuration file.

SaveSQLQuery

Y or N (default)

Setting to Y enables saving query files in the cmw_staging_folder

RemoveTaskFiles

Y (default) or N

This parameter toggles deletion of TSR and extract files. When set to Y, there will be no files left in the cmw folders after the extract.

DoNotPublishOnError

Y (default) or N

If XML Schema validation was performed with errors (see XSDValidation parameter) and value is set to ‘N’, forces publish of output file via FTP, SFTP, EMAIL, etc. if specified.

sorting

SECURITY_ALIAS,UPDATE_SOURCE,ASC

If this parameter is present in the CM, the sorting will be performed by the specified fields in the descending order of priority. The last part of the parameter (the part after the last comma) determines the sort direction (if the value will be empty, the sort direction is taken by default – in ascending order).

Allowable separators: commas, pipes, spaces.

Format of input parameters:

FIELD_1,FIELD_2,...,FIELD_N,SORT_DIRECTION

FIELD_1|FIELD_2|...|FIELD_N|SORT_DIRECTION

FIELD_1 FIELD_2 ... FIELD_N SORT_DIRECTION

FIELD_1,FIELD_2,...,FIELD_N

When using the Generic Extracts workflow, you must append _sorting to the FeedType or to ALLEXTRACTS. For example, ACCOUNTINGTRADEEXTRACT_sorting or ALLEXTRACTS_sorting. For more information, see Control Message Filters and Filter Parameters in the IWS section.

CustomWhere

This parameter is usually regarded as a filter. See more details about using CustomWhere on this page

SkipGUNZIPOnSaveFile

Y or N (default)

Set to Y to skip the GUNZIP runpreprocessor when saving file. As a result, the file will remain archived.

RemoveEntityDuplicates

Y, N (default)

Enables/disables extraction of duplicate entities for entityselectiontype = ENTITYID filter. You do not get duplicate entities if set to 'Y'.

UseAllAcctBasis

Y, N (default)

Can be used for EntityAccountingBasis extract only. Defines, whether to extract only Primary Accounting Basis (this is default behavior, for UseAllAcctBasis = N) or all Accounting Basis.

ForceExtractFileCreation

Y, N (default)

Generates an empty extraction file in case you get NO_DATA. Has a global alternative - W_FORCE_EMPTY_EXTRACTFILE

CustomExtractLocation

folder path

Defines a custom folder into which the extract is loaded. Folder path should be either relative or absolute starting with the Message Center root directory.

IncludeBusinessTaskId

By default, its value is Y (which means that <businessTaskId> is present in all extracts by default). This RTR parameter, which was specified in Control Message or passed through Generic Extract Workflow, overrides W_ADD_BUSINESSTASKID_EXTRACTS variable from w_config_custom.inc.

CorrelationIdPrefix

RTR parameter, CorrelarionIdPrefix, is supported for EJM tasks executed via the Generic Load and Generic Extract workflows. The prefix to the CorrelationId is configured via a profile or RTR. The maximum length for the prefix is limited to 10 symbols.

The functionality is available by default and controlled by a new global default parameter. The parameter is named g_nCorrIdPrefixMaxLength with a default value set to 5 symbols.

SetNoLoadValidationFlagValue

Adds the noLoadValidationFlag to the extract and gives it a specific value. For the example given the extracted element would look like this:

Can be especially useful for I2I workflows or some cases of Cash Currency type securities loads.

ExecutionMonitoringTimeout

Sets maximum status check timeout for monitoring. Global variant: W_EXECUTION_MONITORING_TIMEOUT

ExecutionMonitoringPeriod

Sets time interval between status checks. Global variant: W_EXECUTION_MONITORING_PERIOD

MicroBatchKeyRecordCount

Sets the amount of records per batch.

Global version: W_MICRO_BATCH_KEY_RECORD_COUNT

MicroBatchSplitKey

A logical key used to split the message into microbatches. To make it more complex, you can specify several comma-separated fields.

InternalTSRGeneration

Setting to N suppresses intermediate TSR generation. Global parameter analog is W_INTERNAL_TSR_GENERATION.

ExcludeSecurityAlias

Y, empty (default)

Disables extraction of security alias in the Asset Identifiers model. Available as a global parameter EXCLUDE_SECURITY_ALIAS. Can be overriden for Warehouse objects by W_INCLUDE_SECALIAS_FORWHS global parameter.

IncludeAssetProperties

N (default), Y

Setting this parameter to Y enables extracting Asset Properties model. Please refer to the corresponding data map table of the EagleML object to understand if it contains this model.

Available as a global parameter W_INCLUDE_ASSET_PROPERTIES.

IncludeEntityInfo

ALL, Y, N (default)

A setting for extracts with Entity fields (such as Entity Id, Name, Xref etc).
N: The following fileds are extracted: Entity Id, Entity Name, Entity Type, Xref Account Id, Xref Account Id Type, Xref Class Code
Y: These fields are extracted along with ones above: Long Entity Name, Legal Entity Name, Total Count Share Class, Partition Number
ALL: Physical Partition fields are extracted along with all fields above: PPTRADES, PPHOLDING, PPCASH, PPPERFORM, PPLEDGER
See a more detailed description of these fields.

Available as a global parameter W_INCLUDE_ENTITY_INFO.

IncludeExtendedDetails

N (default), Y, ALL

When set to Y, provides a more detailed extraction: 

• Extended Asset Properties model;

• Entity Common Id model, excluding Physical Partition;

• Entity Properties model - elements before the delimiter.

When set to ALL, Entity Properties model is fully extracted

---

For Warehouse Trade, Traded Cash Activity and Settled Cash Activity setting IncludeExtendedDetails to Y or ALL enables extraction of 3 additional elements: 

calcTransactionId, calcMasterTransactionId, calcCancelTransactionId. For details, see Use Calculated IDs for Transactions.

IncludeCommonTransactionsInfo

N (default), Y 

Adds a commonTransactionsInformation model with values of dates you have used in your Date filter (please note, that not all date filters are supported by your specific feedtype, refer to this table). Has a global parameter alternative - W_INCLUDE_COMMON_TRANSACTIONS_INFO

UseNumerationForXrefs

Adds numeration for security and entity xrefs. Entity xrefs example:

Has a global variant W_USE_NUMERATION_FOR_XREFS

EntityXrefsGroupOnly

N (default), Y

When set to Y, extracts all cross references for the entity in the entityXrefs model and removes xrefAccountId and xrefAccountIdType elements for the Generic Entity model.

Currently available for Generic Entity only.

IncludeAssetToBaseFxRate

Y, empty (default)

Setting this parameter to Y enables extracting assetToBaseFxRate element in SettledCashActivity and TradedCashActivity extracts.

Settled Cash Activity model

Traded Cash Activity model

excludezero

Y (default), N

By default, elements with zero numeric values are removed from the extract for Warehouse objects. Setting to N lets you skip this logic.




Note: this parameter was introduced in June 2016 EagleML Release.

SetSingleLegLoadFlagValue

Generated SMF would have singleLegLoadFlag = Y node. Such approach allows flags to remain more transparent and help to resolve client issues

TakeBaseCurrencyFromWRHSPosDet

N (default), Y

A parameter exclusively for Warehouse Position extracts. Forces taking the value for baseCurrency from HOLDINGDBO.POSITION_DETAIL.BASE_CURRENCY instead of HOLDINGDBO.POSITION.BASE_CURRENCY field. You can also set it as global. Available as a global parameter W_TAKE_BASE_CURRENCY_FROM_WRHS_POS_DET.

GroupBy

comma-separated list of DB fields in DB_TABLE.DB_FIELD format

Works with WRHSOPENLOTBROKERROLLUPEXTRACT. Represents the GROUP BY SQL statement. See an example of RTR with this parameter.

includeZeroPositions

N (default), Y

Works with Warehouse Open Lot and Position objects only. When this flag is set to Y, an additional record can be returned for zero position.

For example:

We have back a traded sell for 8\16 then S2P happened and some records were deleted from position table and after all we have the following picture:

Since 8\17 to 10\7 we still have two records for each effective_date where records with Security_alias = 999497938 have 0 shares.

Note: Additional records are returned only if they exist in the following table:

Open

And the record with 0 share has the max effective date for the (EntityId+SourceName+Effectivedate+SecurityAlias)

includeEntityShareClass

N (default), Y

Toggle Entity Share Class details in the extract. Available for:

• ENTITYSHARECLASSEXTRACT

• SUBSCRIBEREEDEMEXTRACT

• INTRADAYNAVEXTRACT

• WRHSNAVMULTIEXTRACT

• WRHSNAVMONTHENDEXTRACT

UseFundsOfFunds

N (default), Y

Setting to Y enables Security information extraction for WRHSNAVMONTHENDEXTRACT

includeReportDetails

N (default), Y

If set to Y, the following fields are added to the extract and <navReportDetails> complex node is added to XSD:

• Prior NAV (NAV for the previous Valuation Date),

• Mkt Value Cash (elements from the Position Detail table in case Base Currency = Local Currency or sum of elements in case Base Currency != Local Currency),

• Share Class Level (elements of ARCH_CTRLCTR.NAV_DETAILS table linked with main table via Valuation Date, Entity Id, Share Class),

• Total Fund Level (elements of  ARCH_CTRLCTR.NAV_DETAILS сtable linked with main table via Valuation Date, Entity Id for Share Class = 'TF')

• Distribution Log Level

Works only with WRHSNAVMONTHENDEXTRACT feedtype

Global version is W_INCLUDE_REPORT_DETAILS parameter in w_config.inc

includeCustomReportDetails

N (default), Y

If set to Y, the following fields are added to the extract inside the <navReportDetails> complex node.

• Share Class Level (elements of ARCH_CTRLCTR.NAV_DETAILS table linked with main table via Valuation Date, Entity Id, Share Class),

• Total Fund Level (elements of  ARCH_CTRLCTR.NAV_DETAILS сtable linked with main table via Valuation Date, Entity Id for Share Class = 'TF')

• Distribution Log Level

Works only with WRHSNAVMULTIEXTRACT feedtype

Global version is  W_INCLUDE_CUSTOM_REPORT_DETAILS parameter in w_config.inc

EnableSignageLogic

N (default), Y

Flips the signage for fields that may be extracted with an incorrect sign. Available for Warehouse Trade, Traded Cash Activity and Settled Cash Activity extracts.

IncludeCurveAnalytics

N (default), Y

For Warehouse Position:
- table POSITION_DETAIL_ANL_USER is always used
Setting to Y:
- table PD_CURVE_ANALYTICS is used only if parameter ‘IncludeCurveAnalytics’= ‘Y’

For Warehouse Performance
Setting to Y forces extract to use PERFORMDBO.PSR_CURVE_ANALYTICS table

IncludeAverageNetAssets

N (default), Y

Toggle extraction of average net assets extensions from the ESTAR.AVERAGE_NET_ASSETS TABLE. Works only with WRHSNAVMULTIEXTRACT.

IncludePortfolioValuation

N (default), ALL, Y

Adds the Extended Portfolio Valuation model to your Warehouse Open Lot or Position extract.
Y - partial extraction (fields before the delimiter on the data map table)
ALL - extracts all fields

IncludeWashSales

N (default), Y

When set to Y, adds Wash Sale Trade Model to Warehouse Open Lot extract. Works only with WRHSOPENLOTEXTRACT

IncludeAccrualRate

N (default), Y

When set to Y, the extract joins gto estar income table to get the latest coupon rate. Works only with WRHSOPENLOTEXTRACT

IncludeSubscribeReedemCalcFields

N (default), Y

When set to Y, additional calculated fields are added to your Subscribe Redeem extract

linkedassetonlydelta

N (default), Y

If this parameter is set to Y, then whenever we do a delta based dictionary extract, we should only look at SECURITY_DICTIONARY_LINK.SECURITY_DATE to determine the linked assets (and their corresponding dict detail) records to extract. There is no need to check dict detail update_date for delta based dictionary extracts in the selection criteria if that flag is set to Y. Available as a global parameter for w_config_custom.inc W_LINKED_ASSET_ONLY_DELTA

ExcludeTradeCash

Y, N

When set to Y, excludes Trade related cash activity (identified by records with CASH_EVNT_SPAWNED = Y) from the Traded Cash Activity Extract.

IncludeDailyYieldMillRate

N (default), Y

When set to Y, enables extraction of DailyYieldMillRate model for Distribution Activity extract.

EnableS2PReMappingFlag

N (default), Y

Works only with WRHSTRADEEXTRACT

Setting to Y enables S2P remaping for the following fields:
'secFee' is mapped into 'otherFee'
'secFeesBase' is mapped into 'otherFeeBase'
'exchangeFee' is mapped into 'secFee'
'exchangeFeeBase' is mapped into 'secFeeBase'
'otherFee' is mapped into 'exchangeFee'
'otherFeeBase' is mapped into 'exchangeFeeBase'.

Global parameter is W_ENABLE_S2P_REMAPPING_FLAG

IncludeExtractStats

N (default), Y

Setting to Y adds extractStats model to the TSR for the extracts. Currently supported for the following interfaces: Schedule, GenericSMF, WarehouseCashActivity, WarehouseCashFlowProjection, WarehouseCloseLot, CustodyRestrictionActivity, CustodyRestrictionBalance, WarehouseDisclosureStatus, WarehouseGLBalances, WarehouseNAVMonthEnd, WarehouseNAVMulti, WarehouseNAV, WarehouseOpenLot, WarehousePendingTrade, WarehousePerformance, WarehousePosition, WarehouseTrade, WarehouseWashSaleTrade

EnhanceCalcTransactionId

N (default), Y

For Warehouse Trade:

Adds starTag26 element and changes the way calcTransactionId and calcCancelTransactionId are resolved, adding tag26 into their structure:

calcMasterTransId resolution switches to concatenating:

• EntityId

• Account Basis

• Security Alias

• Long Short Indicator

• Event Id

For Accounting Traded/Settled CA:

If EnhanceCalcTransactionId = Y, the revised value of the field EVENT_TYPE <starEventType> is used in the extracts. 

calcMasterTransId resolution switches to concatenating:

• EntityId

• Account Basis

• Security Alias

• Long Short Indicator

• Event Id

For Warehouse Close Lot:

For Warehouse Open Lot:

IncludeInstanceIds

Y(default), N

If IncludeInstanceIds is set to N, certain elements are removed from the extract. Works with:

• USEREXTRACT - <groupId> node will not be extracted

• USERGROUPEXTRACT - <groupId> node will not be extracted

• SCIM User will not contain any groups/group/value nodes

• SCIM Group will not contain any id/externalId nodes

pricingactiveflag

Y(default), N

Setting to Y allows bringing back pricing records only when the price validation rule has an Active status. Global alternative is W_PRICINGREPORTEXTRACT_ACTIVE_FLAG

IncludeRecordErrorDetails

Y (default), N

Setting to N excludes errors from TSR. See more details on this page.

Global alternative is W_INCLUDE_RECORD_ERROR_DETAILS

DisplayEnvNameInSentBy

N (default), Y

By default the sentBy value is the URL. Setting to Y allows to set meaningful information about the region. The information will be taken from EnvironmentName variable from eagle_ml-2-0_custom_cm/w_config_version.inc.

Global alternative is W_DISPLAY_ENVNAME_IN_SENTBY.

Default value:

Parameter is set to Y:

UseEDS

N (default), Y

Global parameter:

W_USE_EDS



Works with eagle_wrf_generic_load workflow to route files for processing by Data Rules. 

GetResourceName

N (default), Y

Global parameter:

W_GET_RESOURCE_NAME

Works only in pair with UseEDS. Can resolve Data Rules resources by parsing incoming file (lowercase objectType).