Page Comparison

Table of Contents

The extract process is initiated by sending a Control Message file to the stream eagle_ml-2-0_default_cm_control_message.

There are three required parameters in “Header” and “TaskIdentifier” sections:

<messageId>
<correlationId>
<businessTaskId>

All values of these tags should be unique.

Required Parameters of “Task parameters” Section

These parameters should be defined in each Control Message file which is used for extracts.

...

Parameter

...

Example of value

...

Comments

...

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

...

Table of Contents

The extract process is initiated by sending a Control Message file to the stream eagle_ml-2-0_default_cm_control_message.

There are three required parameters in “Header” and “TaskIdentifier” sections:

<messageId>
<correlationId>
<businessTaskId>

All values of these tags should be unique.

Required Parameters of “Task parameters” Section

These parameters should be defined in each Control Message file which is used for extracts.

Parameter	Example of value	Comments
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

...

Parameter

Example of value

Comments

Common Parameters

Anchor

	ExtractNamePattern
	ExtractNamePattern

ExtractNamePattern

ENTITYDATA

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

Anchor

	ExtractNamePatternEx
	ExtractNamePatternEx

ExtractNamePatternEx

Code Block

language	xml

<taskParameter>
  <name>ExtractNamePatternEx</name>
  <dataType>S</dataType> 
  <value>tst_@FeedType_my.xml</value>
</taskParameter>

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.

Info

title	Important Note

This parameter is different from 'FeedType_ExtractNamePatternEx' for Generic Extract workflow, despite a similar name. Please use ExtractNamePatternEx only with common extracts, FeedType_ExtractNamePatternEx only with Generic Extract.

Anchor

	ExactExtractFileName
	ExactExtractFileName

ExactExtractFileName

CUSTOMEXACTNAME

Customizes the exact name for the output file.

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

Anchor

	T_StreamName
	T_StreamName

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.

Anchor

	StreamingT_StreamName
	StreamingT_StreamName

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

Info

title	Note

This parameter is valid only for objects which already support streaming extracts

Anchor

	QueryProfileName
	QueryProfileName

QueryProfileName

Enables Element Reduction feature. See more details here

Anchor

	Compress
	Compress

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

Info

title	Note

Please note, that for ExtractDeliveryMethod = JMS your extract will be compressed using GZIP+B64 by default (if you specify Compress = Y).

Anchor

	COMPRESS_WITH_CORR_ID
	COMPRESS_WITH_CORR_ID

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.

Anchor

	XSDValidation
	XSDValidation

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.

Anchor

	SaveSQLQuery
	SaveSQLQuery

SaveSQLQuery

Y or N (default)

Code Block

language	xml

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

Setting to Y enables saving query files in the cmw_staging_folder

Anchor

	RemoveTaskFiles
	RemoveTaskFiles

RemoveTaskFiles

Y (default) or N

Code Block

language	xml

<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.

Anchor

	DoNotPublishOnError
	DoNotPublishOnError

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.

Anchor

	sorting
	sorting

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.

Anchor

	CustomWhere
	CustomWhere

CustomWhere

Code Block

language	xml

<taskParameter>
    <name>CustomWhere</name>
    <dataType>S</dataType>
    <value>securitydbo.security_master.security_alias ='15' and rownum < 10</value>
</taskParameter>

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

Warning
You cannot use OR operator in the expression for CustomWhere parameter

Anchor

	SkipGUNZIPOnSaveFile
	SkipGUNZIPOnSaveFile

SkipGUNZIPOnSaveFile

Y or N (default)

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

Anchor

	RemoveEntityDuplicates
	RemoveEntityDuplicates

RemoveEntityDuplicates

Y, N (default)

Code Block

language	xml

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

Anchor

	UseAllAcctBasis
	UseAllAcctBasis

UseAllAcctBasis

Y, N (default)

Code Block

language	xml

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

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.

Anchor

	ForceExtractFileCreation
	ForceExtractFileCreation

ForceExtractFileCreation

Y, N (default)

Code Block

language	xml

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

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

Anchor

	CustomExtractLocation
	CustomExtractLocation

CustomExtractLocation

folder path

Code Block

language	xml

Code Block

language	xml

<taskParameter>
     <name>CustomExtractLocation</name>
     <dataType>S</dataType>
     <value>../../../cmw/custom_extracts/</value>
</taskParameter>
<taskParameter>
     <name>CustomExtractLocation< <name>CustomExtractLocation</name>
     <dataType>S< <dataType>S</dataType>
     <value>../../.. <value>/home0/qa9999app/eagle/estar/tpe/data/msgcenter/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>

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

Code Block

language	xml

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

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

Code Block
<taskParameter> <name>CorrelationIdPrefix</name> <dataType>S</dataType> <value>PROD</value> </taskParameter>

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

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.

Warning
The CorrelationIdPrefix functionality is only supported in v17R2.x version. Do not use symbol “_” at the parameter in case using unpacker shape at custom workflow.

Anchor

	SetNoLoadValidationFlagValue
	SetNoLoadValidationFlagValue

SetNoLoadValidationFlagValue

Code Block

language	xml

	 <taskParameter>
        <name>IncludeBusinessTaskId<	<name>SetNoLoadValidationFlagValue</name>
        	<dataType>S</dataType>
        <value>Y</value>
    </taskParameter>

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

Code Block
<taskParameter> <name>CorrelationIdPrefix</name> <dataType>S</dataType> <value>PROD< <value>Y</value> </taskParameter>

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

Code Block

language	xml

<noLoadValidationFlag>Y</noLoadValidationFlag>

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

Anchor

	ExecutionMonitoringTimeout
	ExecutionMonitoringTimeout

ExecutionMonitoringTimeout

Code Block

language	xml

 <taskParameter>
	<name>ExecutionMonitoringTimeout</name>
	<dataType>S</dataType>
	<value>55</value>
</taskParameter>

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.

Warning
The CorrelationIdPrefix functionality is only supported in v17R2.x version. Do not use symbol “_” at the parameter in case using unpacker shape at custom workflow.

AnchorSetNoLoadValidationFlagValueSetNoLoadValidationFlagValueSetNoLoadValidationFlagValue

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

Anchor

	ExecutionMonitoringPeriod
	ExecutionMonitoringPeriod

ExecutionMonitoringPeriod

Code Block

language	xml

 <taskParameter>
	<name>ExecutionMonitoringPeriod</name>
	<dataType>S</dataType>
	<value>300</value>
</taskParameter>

Sets time interval between status checks. Global variant: W_EXECUTION_MONITORING_PERIOD

Anchor

	MicroBatchKeyRecordCount
	MicroBatchKeyRecordCount

MicroBatchKeyRecordCount

Code Block

language	xml

 <taskParameter>
	<name>SetNoLoadValidationFlagValue<<name>MicroBatchKeyRecordCount</name>
	<dataType>S</dataType>
	<value>Y<<value>5</value>
</taskParameter>

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

Code Block

language	xml

<noLoadValidationFlag>Y</noLoadValidationFlag>

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

AnchorExecutionMonitoringTimeoutExecutionMonitoringTimeoutExecutionMonitoringTimeout

Code Block

language	xml

 <taskParameter>
	<name>ExecutionMonitoringTimeout</name>
	<dataType>S</dataType>
	<value>55</value>
</taskParameter>

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

Code Block

language	xml

 <taskParameter>
	<name>ExecutionMonitoringPeriod</name>
	<dataType>S</dataType>
	<value>300</value>
</taskParameter>

Sets time interval between status checks. Global variant: W_EXECUTION_MONITORING_PERIOD AnchorMicroBatchKeyRecordCountMicroBatchKeyRecordCountMicroBatchKeyRecordCount

/taskParameter>

Sets the amount of records per batch.

Info

IMPORTANT NOTE: There are complex objects with repeating models and complex queries for these objects, sometimes for one logical record DB returns several rows and then these rows are grouped on the transform step.

For example:
Generic Entity Extract can have entityDetail models. If an Entity has 3 EntityDetail models, 3 records will be returned from database. If you specify MicroBatchKeyRecordCount = 2, it doesn’t mean that only two rows will be processed for each file, it means that each file will contain max TWO logical records like GenericEntity, User, GenericSMF etc. which can represent more than 2 rows from database.

Global version: W_MICRO_BATCH_KEY_RECORD_COUNT

Expand

title	Click to read about the older version of this parameter:

Older version is RecordCountPerNugget. It is still supported for backward compatibility, but has a lower priority. Same goes for the global parameter, W_MICRO_BATCH_KEY_RECORD_COUNT has higher priority than W_RECORD_COUNT_PER_NUGGET.

Anchor

	MicroBatchSplitKey
	MicroBatchSplitKey

MicroBatchSplitKey

Code Block

language	xml

 <taskParameter>
	<name>MicroBatchKeyRecordCount<<name>MicroBatchSplitKey</name>
	<dataType>S</dataType>
	<value>5<<value>ENTITY_ID,EFFECTIVE_DATE</value>
</taskParameter>

Sets the amount of records per batch.

Info

IMPORTANT NOTE: There are complex objects with repeating models and complex queries for these objects, sometimes for one logical record DB returns several rows and then these rows are grouped on the transform step.

For example:
Generic Entity Extract can have entityDetail models. If an Entity has 3 EntityDetail models, 3 records will be returned from database. If you specify MicroBatchKeyRecordCount = 2, it doesn’t mean that only two rows will be processed for each file, it means that each file will contain max TWO logical records like GenericEntity, User, GenericSMF etc. which can represent more than 2 rows from database.

Global version: W_MICRO_BATCH_KEY_RECORD_COUNT

Expand

title	Click to read about the older version of this parameter:

Older version is RecordCountPerNugget. It is still supported for backward compatibility, but has a lower priority. Same goes for the global parameter, W_MICRO_BATCH_KEY_RECORD_COUNT has higher priority than W_RECORD_COUNT_PER_NUGGET.

AnchorMicroBatchSplitKeyMicroBatchSplitKeyMicroBatchSplitKey

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

Info
You can specify only values that match column names from the SQL query. Before using this parameter please make sure that you know correct column names, because in some cases this names have specific prefixes. If such value is not found, it will be excluded with a WARNING message for eagle_ml-2-0_default_out_q stream.

Warning
Please take into account, that this logic will slow down the transformation process. More chunks - bigger delay (this is a hyperbolic dependency). You can expect no significant delay when you make up to 300 chunks, but please avoid splitting BIG files into tiny chunks with 1-2 records and creating thousands of files: such process will work very slow.

InternalTSRGeneration

Code Block

language	xml

 <taskParameter>
	<name>MicroBatchSplitKey<<name>InternalTSRGeneration</name>
	<dataType>S</dataType>
	<value>ENTITY_ID,EFFECTIVE_DATE<<value>N</value>
</taskParameter>

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

Info
You can specify only values that match column names from the SQL query. Before using this parameter please make sure that you know correct column names, because in some cases this names have specific prefixes. If such value is not found, it will be excluded with a WARNING message for eagle_ml-2-0_default_out_q stream.

Warning
Please take into account, that this logic will slow down the transformation process. More chunks - bigger delay (this is a hyperbolic dependency). You can expect no significant delay when you make up to 300 chunks, but please avoid splitting BIG files into tiny chunks with 1-2 records and creating thousands of files: such process will work very slow.

InternalTSRGeneration

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

Customizing Extraction of Common Models

Anchor

	ExcludeSecurityAlias
	ExcludeSecurityAlias

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.

Anchor

	IncludeAssetProperties
	IncludeAssetProperties

IncludeAssetProperties

N (default), Y

Code Block

language	xml

<taskParameter>

<name>InternalTSRGeneration<

 <name>IncludeAssetProperties</name>

<dataType>S<

 <dataType>S</dataType>

<value>N<

 <value>Y</value>
</taskParameter>

Setting

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

Customizing Extraction of Common Models

AnchorExcludeSecurityAliasExcludeSecurityAliasExcludeSecurityAlias

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.

AnchorIncludeAssetPropertiesIncludeAssetPropertiesIncludeAssetPropertiesthis 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.

Anchor

	IncludeEntityInfo
	IncludeEntityInfo

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.

Anchor

	IncludeExtendedDetails
	IncludeExtendedDetails

IncludeExtendedDetails

N (default), Y, ALL

Code Block

language	xml

<taskParameter>
    <name>IncludeAssetProperties< <name>IncludeExtendedDetails</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.

AnchorIncludeEntityInfoIncludeEntityInfoIncludeEntityInfo

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.

AnchorIncludeExtendedDetailsIncludeExtendedDetailsIncludeExtendedDetailsN (default), Y, ALL


    <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.

Info

title	Note

Currently available only for the following feedtypes:

WRHSCLOSELOTEXTRACT
WRHSGLDETAILPOSTINGEXTRACT
WRHSNAVMONTHENDEXTRACT
WRHSNAVMULTIEXTRACT
WRHSOPENLOTEXTRACT
WRHSPOSITIONEXTRACT
WRHSTRADEEXTRACT
TRADEDCAEXTRACT
SETTLEDCAEXTRACT
DISTRIBUTIONACTEXTRACT
SUBSCRIBEREEDEMEXTRACT
CASHPROJECTIONSEXTRACT

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.

Anchor

	IncludeCommonTransactionsInfo
	IncludeCommonTransactionsInfo

IncludeCommonTransactionsInfo

N (default), Y

Code Block

language	xml

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

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

Anchor

	UseNumerationForXrefs
	UseNumerationForXrefs

UseNumerationForXrefs

Code Block

language	xml

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

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

Code Block

language	xml

<entityXrefs>
	<entityXref1>
		<xrefAccountId>BT3903IU_TYPE2</xrefAccountId>
		<xrefAccountIdType>TST</xrefAccountIdType>
	</entityXref1>
	<entityXref2>
		<xrefAccountId>BT3903IU_TYPE3</xrefAccountId>
		<xrefAccountIdType>TST</xrefAccountIdType>
	</entityXref2>
</entityXrefs>

Has a global variant W_USE_NUMERATION_FOR_XREFS

EntityXrefsGroupOnly

N (default), Y

Code Block

language	xml

<taskParameter>

<name>IncludeExtendedDetails<

	<name>EntityXrefsGroupOnly</name>

<dataType>S<

	<dataType>S</dataType>

<value>ALL<

	<value>Y</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.

Info

title	Note

Currently available only for the following feedtypes:

WRHSCLOSELOTEXTRACT
WRHSGLDETAILPOSTINGEXTRACT
WRHSNAVMONTHENDEXTRACT
WRHSNAVMULTIEXTRACT
WRHSOPENLOTEXTRACT
WRHSPOSITIONEXTRACT
WRHSTRADEEXTRACT
TRADEDCAEXTRACT
SETTLEDCAEXTRACT
DISTRIBUTIONACTEXTRACT
SUBSCRIBEREEDEMEXTRACT
CASHPROJECTIONSEXTRACT

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.

AnchorIncludeCommonTransactionsInfoIncludeCommonTransactionsInfoIncludeCommonTransactionsInfoN (default), 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.

Anchor

	IncludeAssetToBaseFxRate
	IncludeAssetToBaseFxRate

IncludeAssetToBaseFxRate

Y, empty (default)

Code Block

language	xml

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

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

Settled Cash Activity model

Traded Cash Activity model

Feedtype-Specific Parameters

Anchor

	excludezero
	excludezero

excludezero

Y (default), N

Code Block

language	xml

<taskParameter>

<name>IncludeCommonTransactionsInfo<

  <name>excludezero</name>

<dataType>S<

  <dataType>S</dataType>

<value>Y<

  <value>Y</value>
</taskParameter>

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

AnchorUseNumerationForXrefsUseNumerationForXrefsUseNumerationForXrefsBy 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.

Anchor

	SetSingleLegLoadFlagValue
	SetSingleLegLoadFlagValue

SetSingleLegLoadFlagValue

Code Block

language	xml

<taskParameter>
      <name>UseNumerationForXrefs<<name>SetSingleLegLoadFlagValue</name>
      <dataType>S<<dataType>S</dataType>
      <value>Y<<value>Y</value>
</taskParameter>

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

Code Block

language	xml

<entityXrefs>
	<entityXref1>
		<xrefAccountId>BT3903IU_TYPE2</xrefAccountId>
		<xrefAccountIdType>TST</xrefAccountIdType>
	</entityXref1>
	<entityXref2>
		<xrefAccountId>BT3903IU_TYPE3</xrefAccountId>
		<xrefAccountIdType>TST</xrefAccountIdType>
	</entityXref2>
</entityXrefs>

Has a global variant W_USE_NUMERATION_FOR_XREFS

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

Anchor

	TakeBaseCurrencyFromWRHSPosDet
	TakeBaseCurrencyFromWRHSPosDet

TakeBaseCurrencyFromWRHSPosDet

N (default), Y

Code Block

language	xml

<taskParameter>

<name>EntityXrefsGroupOnly<


    <name>TakeBaseCurrencyFromWRHSPosDet</name>

<dataType>S</dataType>

<value>Y</value>
</taskParameter>

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.

Feedtype-Specific Parameters

AnchorexcludezeroexcludezeroexcludezeroY (default), N

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.

Anchor

	GroupBy
	GroupBy

GroupBy

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

Code Block

language	xml

<taskParameter>

<name>excludezero</name> <dataType>S</dataType> <value>Y<

    <name>GroupBy</name>
    <dataType>S</dataType>     <value>POSITION.ENTITY_ID,POSITION.EFFECTIVE_DATE,LOT_LEVEL_POSITION.SECURITY_ALIAS,
LOT_LEVEL_POSITION.BROKER_CODE,LOT_LEVEL_POSITION.CURRENCY</value>
</taskParameter>

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. AnchorSetSingleLegLoadFlagValue

SetSingleLegLoadFlagValueSetSingleLegLoadFlagValue

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

Anchor

	includeZeroPositions
	includeZeroPositions

includeZeroPositions

N (default), Y

Code Block

language	xml

<taskParameter>

<name>SetSingleLegLoadFlagValue<

 <name>includeZeroPositions</name>

<dataType>S<

 <dataType>S</dataType>

<value>Y<

 <value>Y</value>
</taskParameter>

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

N (default), Y

Code Block

language	xml

<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.

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

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:

Code Block

language	sql

select *  FROM HOLDINGDBO.SPD_DELTA_LOG SPD_DELTA_LOG
WHERE 1=1
and SPD_DELTA_LOG.SHARE_PAR_VALUE=0
and SPD_DELTA_LOG.ENTITY_ID in ('KMIC_5_1','')

Image Added

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

Anchor

	includeEntityShareClass
	includeEntityShareClass

includeEntityShareClass

N (default), Y

Code Block

language	xml

<taskParameter>

<name>GroupBy<

 <name>includeEntityShareClass</name>

   <dataType>S</

dataType>

dataType>

<value>POSITION.ENTITY_ID,POSITION.EFFECTIVE_DATE,LOT_LEVEL_POSITION.SECURITY_ALIAS, LOT_LEVEL_POSITION.BROKER_CODE,LOT_LEVEL_POSITION.CURRENCY<

   <value>Y</value>
</taskParameter>

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

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

ENTITYSHARECLASSEXTRACT
SUBSCRIBEREEDEMEXTRACT
INTRADAYNAVEXTRACT
WRHSNAVMULTIEXTRACT
WRHSNAVMONTHENDEXTRACT

Anchor

	UseFundsOfFunds
	UseFundsOfFunds

UseFundsOfFunds

N (default), Y

Code Block

language	xml

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

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:

Code Block

language	sql

select *  FROM HOLDINGDBO.SPD_DELTA_LOG SPD_DELTA_LOG
WHERE 1=1
and SPD_DELTA_LOG.SHARE_PAR_VALUE=0
and SPD_DELTA_LOG.ENTITY_ID in ('KMIC_5_1','')

Image Removed

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

AnchorincludeEntityShareClassincludeEntityShareClassincludeEntityShareClassSetting to Y enables Security information extraction for WRHSNAVMONTHENDEXTRACT

Anchor

	includeReportDetails
	includeReportDetails

includeReportDetailsN (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

Anchor

	includeCustomReportDetails
	includeCustomReportDetails

includeCustomReportDetailsN (default), YIf 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

Anchor

	EnableSignageLogic
	EnableSignageLogic

EnableSignageLogic

N (default), Y

Code Block

language	xml

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

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

ENTITYSHARECLASSEXTRACT
SUBSCRIBEREEDEMEXTRACT
INTRADAYNAVEXTRACT
WRHSNAVMULTIEXTRACT
WRHSNAVMONTHENDEXTRACT

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

Anchor

	IncludeCurveAnalytics
	IncludeCurveAnalytics

IncludeCurveAnalytics

N (default), Y

Code Block

language	xml

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

Setting to Y enables Security information extraction for WRHSNAVMONTHENDEXTRACT AnchorincludeReportDetailsincludeReportDetailsincludeReportDetailsN (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

AnchorincludeCustomReportDetailsincludeCustomReportDetailsincludeCustomReportDetailsN (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

AnchorEnableSignageLogicEnableSignageLogicEnableSignageLogic

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

Anchor

	IncludeAverageNetAssets
	IncludeAverageNetAssets

IncludeAverageNetAssets

N (default), Y

Code Block

language	xml

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

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

Anchor

	IncludePortfolioValuation
	IncludePortfolioValuation

IncludePortfolioValuation

N (default), ALL, Y

Code Block

language	xml

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

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

Anchor

	IncludeWashSales
	IncludeWashSales

IncludeWashSales

N (default), Y

Code Block

language	xml

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

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.

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

Anchor

	IncludeAccrualRate
	IncludeAccrualRate

IncludeAccrualRate

N (default), Y

Code Block

language	xml

<taskParameter>

<name>IncludeCurveAnalytics<

<name>IncludeAccrualRate</name>

<dataType>S<

<dataType>S</dataType>

<value>Y<

<value>Y</value>
</taskParameter>

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

AnchorIncludeAverageNetAssets

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

Anchor

	IncludeSubscribeReedemCalcFields
	IncludeSubscribeReedemCalcFields

IncludeSubscribeReedemCalcFields

N (default), Y

Code Block

language	xml

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

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

N (default), ALL, Y

Code Block

language	xml

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

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 AnchorIncludeWashSalesIncludeWashSalesIncludeWashSales

N (default), Y

Code Block

language	xml

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

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

/taskParameter>

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

Anchor

	linkedassetonlydelta
	linkedassetonlydelta

linkedassetonlydeltaN (default), YIf 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

Anchor

	ExcludeTradeCash
	ExcludeTradeCash

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

Anchor

	IncludeDailyYieldMillRate
	IncludeDailyYieldMillRate

IncludeDailyYieldMillRateN (default), YWhen set to Y, enables extraction of DailyYieldMillRate model for Distribution Activity extract.

Anchor

	EnableS2PReMappingFlag
	EnableS2PReMappingFlag

EnableS2PReMappingFlagN (default), Y

Code Block

language	xml

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

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

N (default), Y

Code Block

language	xml

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

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

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

Anchor

	IncludeExtractStats
	IncludeExtractStats

IncludeExtractStatsN (default), YIf 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 AnchorExcludeTradeCashExcludeTradeCashExcludeTradeCashY, NWhen set to Y, excludes Trade related cash activity (identified by records with CASH_EVNT_SPAWNED = Y) from the Traded Cash Activity Extract. AnchorIncludeDailyYieldMillRateIncludeDailyYieldMillRateIncludeDailyYieldMillRateN (default), YWhen set to Y, enables extraction of DailyYieldMillRate model for Distribution Activity extract. AnchorEnableS2PReMappingFlagEnableS2PReMappingFlagEnableS2PReMappingFlagN (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

AnchorIncludeExtractStatsIncludeExtractStatsIncludeExtractStatsN (default), YSetting 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 AnchorEnhanceCalcTransactionIdEnhanceCalcTransactionIdEnhanceCalcTransactionIdN (default), Y

Info

Please note:

this parameter works only for
WRHSCLOSELOTEXTRACT
WRHSOPENLOTEXTRACT
WRHSTRADEEXTRACT
TRADEDCAEXTRACT
SETTLEDCAEXTRACT
it is available only on ORA environments;
to extract calcTransactionId and calcCancelTransactionId you must have IncludeExtendedDetails=ALL or Y set in the CM. For more information, see Use Calculated IDs for Transactions.

For Warehouse Trade:

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

Expand

title	Click to expand an example:

...
<starTag26>ESP1227</starTag26>
<tradeCurrency>USD</tradeCurrency>
<priceMethod>M</priceMethod>
<calcTransactionId>USTAX#ESP1227#682409657#L#P8LATA98PPVOI3KB#ESP1227#2#C</calcTransactionId>
<calcMasterTransactionId>P8LATA98PPVOI3KB</calcMasterTransactionId>
<calcCancelTransactionId>USTAX#ESP1227#682409657#L#P8LATA98PPVOI3KB#ESP1227#2</calcCancelTransactionId>
...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

Anchor

	EnhanceCalcTransactionId
	EnhanceCalcTransactionId

EnhanceCalcTransactionIdN (default), Y

Info

Please note:

this parameter works only for
WRHSCLOSELOTEXTRACT
WRHSOPENLOTEXTRACT
WRHSTRADEEXTRACT
TRADEDCAEXTRACT
SETTLEDCAEXTRACT
it is available only on ORA environments;
to extract calcTransactionId and calcCancelTransactionId you must have IncludeExtendedDetails=ALL or Y set in the CM. For more information, see Use Calculated IDs for Transactions.

For Warehouse Trade:

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

Expand

title	Click to expand an example:

...
<starTag26>ESP1227</starTag26>
<tradeCurrency>USD</tradeCurrency>
<priceMethod>M</priceMethod>
<calcTransactionId>USTAX#ESP1227#682409657#L#P8LATA98PPVOI3KB#ESP1227#2#C</calcTransactionId>
<calcMasterTransactionId>P8LATA98PPVOI3KB</calcMasterTransactionId>
<calcCancelTransactionId>USTAX#ESP1227#682409657#L#P8LATA98PPVOI3KB#ESP1227#2</calcCancelTransactionId>
...

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.

Expand

title	Click to expand how it is resolved:

Code Block

language	sql

CASE 
 WHEN RTRIM(ESTAR_SETTLED_CASH_ACTIVITY.CANCEL_FLAG) = 'Y' 
   AND RTRIM(ESTAR_SETTLED_CASH_ACTIVITY.CANCEL_TYPE) IS NOT NULL
 THEN RTRIM(ESTAR_SETTLED_CASH_ACTIVITY.EVENT_TYPE)||'CANCEL'
 ELSE RTRIM(ESTAR_SETTLED_CASH_ACTIVITY.EVENT_TYPE) 
END EVENT_TYPE,

Code Block

language	sql

CASE
 WHEN RTRIM(ESTAR_TRADED_CASH_ACTIVITY.CANCEL_FLAG) = 'Y'
  AND RTRIM(ESTAR_TRADED_CASH_ACTIVITY.CANCEL_TYPE) IS NOT NULL
 THEN RTRIM(ESTAR_TRADED_CASH_ACTIVITY.EVENT_TYPE)||'CANCEL'
 ELSE RTRIM(ESTAR_TRADED_CASH_ACTIVITY.EVENT_TYPE) 
END EVENT_TYPE2

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.

Warehouse Close Lot:

Expand

title	Click to expand how it is resolvedcalcMasterTransactionId resolution:

Code Block

language	sql

CASE 
 WHENRTRIM(TRADESDBO.TRADE.ACCT_BASIS) ||'#'|| 
RTRIM(ESTAR_SETTLED_CASH_ACTIVITY.CANCEL_FLAG) = 'Y' 
   AND RTRIM(ESTAR_SETTLED_CASH_ACTIVITY.CANCEL_TYPE) IS NOT NULL
 THEN RTRIM(ESTAR_SETTLED_CASH_ACTIVITY.EVENT_TYPE)||'CANCEL'
 ELSE RTRIM(ESTAR_SETTLED_CASH_ACTIVITY.EVENT_TYPE) 
END EVENT_TYPE,TRADESDBO.DISPOSAL_LOTS.ENTITY_ID) ||'#'|| 
to_char(TRADESDBO.DISPOSAL_LOTS.SECURITY_ALIAS) ||'#'|| RTRIM(TRADESDBO.DISPOSAL_LOTS.LONG_SHORT_INDICATOR) ||'#'||
RTRIM(TRADESDBO.DISPOSAL_LOTS.CLS_OPEN_EVENT_ID)   CALC_MASTER_TRANSACTION_ID,

Expand

title	calcMasterCloseTransactionId resolution:

Code Block

language	sql

CASE
 WHEN RTRIM(ESTAR_TRADED_CASH_ACTIVITY.CANCEL_FLAG) = 'Y'
  AND RTRIM(ESTAR_TRADED_CASH_ACTIVITY.CANCEL_TYPE) IS NOT NULL
 THEN RTRIM(ESTAR_TRADED_CASH_ACTIVITY.EVENT_TYPE)||'CANCEL'
 ELSE RTRIM(ESTAR_TRADED_CASH_ACTIVITY.EVENT_TYPE) 
END EVENT_TYPE2

calcMasterTransId resolution switches to concatenating:

EntityId
Account Basis
Security Alias
Long Short Indicator
Event Id

For Warehouse Close

TRADE.ACCT_BASIS)||'#'||
RTRIM(DISPOSAL_LOTS.ENTITY_ID)||'#'||
to_char(DISPOSAL_LOTS.SECURITY_ALIAS)||'#'||
RTRIM(DISPOSAL_LOTS.LONG_SHORT_INDICATOR)||'#'||
RTRIM(TRADE.STAR_TAG25) CALC_MASTER_CLOSE_TRAN_ID,

For Warehouse Open Lot:

Expand

title	calcMasterTransactionId resolution:

Code Block

language	sql

RTRIM(TRADESDBOHOLDINGDBO.TRADEPOSITION.ACCT_BASIS)    ||'#'|| 
RTRIM(TRADESDBOHOLDINGDBO.DISPOSAL_LOTSPOSITION.ENTITY_ID)     ||'#'||

to_char(TRADESDBOHOLDINGDBO.DISPOSALLOT_LEVEL_LOTSPOSITION.SECURITY_ALIAS) ||'#'||
RTRIM(TRADESDBOHOLDINGDBO.DISPOSALLOT_LEVEL_LOTSPOSITION.LONG_SHORT_INDICATORIND) ||'#'||
RTRIM(TRADESDBOHOLDINGDBO.DISPOSALLOT_LEVEL_LOTSPOSITION.CLSORIG_OPENLOT_EVENT_IDNUMBER)   CALC_MASTER_TRANSACTION_ID,

Expand

title	calcMasterCloseTransactionId resolution:

Code Block

language	sql

RTRIM(TRADE.ACCT_BASIS)||'#'||
RTRIM(DISPOSAL_LOTS.ENTITY_ID)||'#'||
to_char(DISPOSAL_LOTS.SECURITY_ALIAS)||'#'||
RTRIM(DISPOSAL_LOTS.LONG_SHORT_INDICATOR)||'#'||
RTRIM(TRADE.STAR_TAG25) CALC_MASTER_CLOSE_TRAN_ID,

For Warehouse Open Lot:

Expand

title	calcMasterTransactionId resolution:

Code Block

language	sql

RTRIM(HOLDINGDBO.POSITION.ACCT_BASIS)    ||'#'||
RTRIM(HOLDINGDBO.POSITION.ENTITY_ID)     ||'#'||
to_char(HOLDINGDBO.LOT_LEVEL_POSITION.SECURITY_ALIAS)||'#'||
RTRIM(HOLDINGDBO.LOT_LEVEL_POSITION.LONG_SHORT_IND)||'#'||
RTRIM(HOLDINGDBO.LOT_LEVEL_POSITION.ORIG_LOT_NUMBER)   CALC_MASTER_TRANSACTION_ID,

AnchorIncludeInstanceIdsIncludeInstanceIdsIncludeInstanceIdsY(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

AnchorpricingactiveflagpricingactiveflagpricingactiveflagY(default), NSetting to Y allows bringing back pricing records only when the price validation rule has an Active status. Global alternative is W_PRICINGREPORTEXTRACT_ACTIVE_FLAG AnchorIncludeRecordErrorDetailsIncludeRecordErrorDetails

IncludeRecordErrorDetails

Y (default), N

Anchor

	IncludeInstanceIds
	IncludeInstanceIds

IncludeInstanceIdsY(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

Anchor

	pricingactiveflag
	pricingactiveflag

pricingactiveflagY(default), NSetting to Y allows bringing back pricing records only when the price validation rule has an Active status. Global alternative is W_PRICINGREPORTEXTRACT_ACTIVE_FLAG

Anchor

	IncludeRecordErrorDetails
	IncludeRecordErrorDetails

IncludeRecordErrorDetails

Y (default), N

Code Block

language	xml

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

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

Global alternative is W_INCLUDE_RECORD_ERROR_DETAILS

Anchor

	DisplayEnvNameInSentBy
	DisplayEnvNameInSentBy

DisplayEnvNameInSentBy

N (default), Y

Code Block

language	xml

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

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:

Code Block

language	xml

<sentBy>http://www.eagleinvsys.com/</sentBy>

Parameter is set to Y:

Code Block

language	xml

<sentBy>http://www.eagleinvsys.com/O171Q001</sentBy>

Anchor

	UseEDS
	UseEDS

UseEDS

N (default), Y

Code Block

language	xml

<taskParameter>
     <name>UseEDS</name>
     <value>Y</value>
</taskParameter>

Global parameter:

W_USE_EDS

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

Anchor

	GetResourceName
	GetResourceName

GetResourceName

N (default), Y

Code Block

language	xml

<taskParameter>
     <name>IncludeRecordErrorDetails< <name>GetResourceName</name>
   <dataType>S</dataType>    <value>N< <value>Y</value>
</taskParameter>

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

Global alternative is W_INCLUDE_RECORD_ERROR_DETAILS

Global parameter:

W_GET_RESOURCE_NAME

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

Versions Compared

Old Version 70

New Version 74

Key

Required Parameters of “Task parameters” Section

Required Parameters of “Task parameters” Section

Common Parameters

Customizing Extraction of Common Models

Customizing Extraction of Common Models

Feedtype-Specific Parameters

Feedtype-Specific Parameters