Control Message Required and Optional Parameters

ExtractNamePattern

ENTITYDATA

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

ExtractNamePatternEx

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

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)

<taskParameter>
   <name>SaveSQLQuery</name>
   <dataType>S</dataType>
   <value>Y</value>
</taskParameter>

Setting to Y enables saving query files in the cmw_staging_folder

RemoveTaskFiles

Y (default) or N

<taskParameter>
   <name>RemoveTaskFiles</name>
   <dataType>S</dataType>
   <value>N</value>
</taskParameter>

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

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)

<taskParameter>
    <name>RemoveEntityDuplicates</name>
    <dataType>S</dataType>
    <value>Y</value>
</taskParameter>

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

UseAllAcctBasis

Y, N (default)

<taskParameter>
    <name>UseAllAcctBasis</name>
    <dataType>S</dataType>
    <value>Y</value>
</taskParameter>

Y, N (default)

<taskParameter>
    <name>ForceExtractFileCreation</name>
    <dataType>S</dataType>
    <value>Y</value>
</taskParameter>

folder path

<taskParameter>
     <name>CustomExtractLocation</name>
     <dataType>S</dataType>
     <value>../../../cmw/custom_extracts/</value>
</taskParameter>
<taskParameter>
      <name>CustomExtractLocation</name>
      <dataType>S</dataType>
      <value>/home0/qa9999app/eagle/estar/tpe/data/msgcenter/cmw/custom_extracts/</value>
</taskParameter>

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

Y, N (default)

<taskParameter>
    <name>IncludeAssetProperties</name>
    <dataType>S</dataType>
    <value>Y</value>
</taskParameter>

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

<taskParameter>
    <name>IncludeExtendedDetails</name>
    <dataType>S</dataType>
    <value>ALL</value>
</taskParameter>

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.

---

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

Y, N (default). 

<taskParameter>
   <name>IncludeCommonTransactionsInfo</name>
   <dataType>S</dataType>
   <value>Y</value>
</taskParameter>

Y, N (default)

<taskParameter>
    <name>TakeBaseCurrencyFromWRHSPosDet</name>
    <dataType>S</dataType>
    <value>Y</value>
</taskParameter>

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

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

includeZeroPositions

Y, N (default)

<taskParameter>
   <name>includeZeroPositions</name>
   <dataType>S</dataType>
   <value>Y</value>
</taskParameter>

includeShareholderActivity

Y, N (default)

<taskParameter>
   <name>includeShareholderActivity</name>
   <dataType>S</dataType>
   <value>Y</value>
</taskParameter>

Adds the Shareholder Activity model to the extract. Available for SUBSCRIBEREEDEMEXTRACT and WRHSNAVMONTHENDEXTRACT feedtypes.

Y, N (default) 

<taskParameter>
   <name>includeEntityShareClass</name>
   <dataType>S</dataType>
   <value>Y</value>
</taskParameter>

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

• SUBSCRIBEREEDEMEXTRACT
• WRHSNAVMULTIEXTRACT
• WRHSNAVMONTHENDEXTRACT

Y, N (default) 

<taskParameter>
   <name>UseFundsOfFunds</name>
   <dataType>S</dataType>
   <value>Y</value>
</taskParameter>

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')

• WRHSNAVMULTIEXTRACT
• WRHSNAVMONTHENDEXTRACT

This parameter overrides W_INCLUDE_REPORT_DETAILS parameter from w_config.inc

• WRHSNAVMULTIEXTRACT

Y, N (default) 

<taskParameter>
   <name>EnableSignageLogic</name>
   <dataType>S</dataType>
   <value>Y</value>
</taskParameter>

Y, N (default) 

<taskParameter>
   <name>IncludeCurveAnalytics</name>
   <dataType>S</dataType>
   <value>Y</value>
</taskParameter>

Y, N (default)

<taskParameter>
   <name>IncludeAverageNetAssets</name>
   <dataType>S</dataType>
   <value>Y</value>
</taskParameter>

ALL, Y, N (default) 

<taskParameter>
   <name>IncludePortfolioValuation</name>
   <dataType>S</dataType>
   <value>ALL</value>
</taskParameter>

Y, N (default) 

<taskParameter>
   <name>IncludeWashSales</name>
   <dataType>S</dataType>
   <value>Y</value>
</taskParameter>

Y, N (default)

<taskParameter>
   <name>IncludeSubscribeReedemCalcFields</name>
   <dataType>S</dataType>
   <value>Y</value>
</taskParameter>