...
...
...
| Code Block | ||
|---|---|---|
| ||
<taskParameter>
<name>ALLEXTRACTS_IncludeAssetProperties</name>
<dataType>S</dataType>
<value>Y</value>
</taskParameter> |
| Tip |
|---|
When you use the Generic Extracts workflow, be aware that the system also requires the same prefix logic to sort extracts in a custom order. You must prefix the sorting parameter with ALLEXTRACTS_ or FeedType_. For example, ALLEXTRACTS_sorting. For more information about sorting, see Control Message Required and Optional Parameters in the EagleML section. |
Using FeedType_ Prefix
| Info |
|---|
customWhere parameter is supported for eagle_wrf_generic_extract only with the FeedType_ prefix. |
| Expand |
|---|
...
| ||
StreamName |
The FeedType_ prefix allows you to address a feedtype individually.
As an example, you are extracting records of three feedtypes: SMFEXTRACT, ENTITYEXTRACT, WRHSTRADEEXTRACT.
You want to limit the number of records of each type to 20, 10 and 5. The obvious choice here is the maxrows filter, but you should add corresponding feedtype prefixes like this:
| Code Block | ||
|---|---|---|
| ||
<taskParameter>
<name>SMFEXTRACT_maxrows</name>
<dataType>S</dataType>
<value>20</value>
</taskParameter>
<taskParameter>
<name>ENTITYEXTRACT_maxrows</name>
<dataType>S</dataType>
<value>10</value>
</taskParameter>
<taskParameter>
<name>WRHSTRADEEXTRACT_maxrows</name>
<dataType>S</dataType>
<value>5</value>
</taskParameter> |
If you use this prefix, there are two parameters that are required to be set: FeedType_CustomWhere and FeedType_ExtractNamePatternEx.
Parameter | Example of Value | Comments |
|---|---|---|
FeedType |
...
_ |
...
CustomWhere |
| CustomWhere CM parameter allows to insert additional code into the WHERE part of the SQL query of an extract. NOTE: You cannot use OR operator in the expression for CustomWhere parameter. | |||||
FeedType |
...
_ |
...
ExtractNamePatternEx |
| Customizes output file name according to the pattern specified.
|
...
|
Any filter listed below can be used in a similar manner – but it is not required in their case.
...
| Tip |
|---|
When you use the Generic Extracts workflow, be aware that the system also requires the same prefix logic to sort extracts in a custom order. You must prefix the sorting parameter with ALLEXTRACTS_ or FeedType_. For example, ACCOUNTINGTRADEEXTRACT_sorting. For more information about sorting, see Control Message Required and Optional Parameters in the EagleML section. |
Object Group Filters
The following table describes which filters are used for each object group.
Object Group Name | Filter Name | Comments |
|---|---|---|
ENTITY | entityselectiontype |
http://eagle.helpdocsonline.com/available-filters [Entity Filter]
...
For more information, see the Available Filters page in the EagleML wiki. |
...
...
entityselectionvalue |
...
...
entityselectiontype2 |
...
...
entityselectionvalue2 |
...
...
UsePrimaryBasisOnly |
...
SMF | processingsecuritytype |
http://eagle.helpdocsonline.com/available-filters [Security Master File (SMF) Filter]
...
For more information, see the Available Filters page in the EagleML wiki. |
...
...
...
securitytype |
...
securityalias |
...
...
releasestatus |
...
...
primaryassetid |
...
investmenttype |
...
...
xrefid |
...
...
xrefidtype |
...
ticker |
...
...
...
historyonlyflag
http://eagle.helpdocsonline.com/available-filters [History Only Filter]
...
historyonlyflag | For more information, see the Available Filters page in the EagleML wiki. |
...
Security Related (SMF, Warehouse, Accounting and Reference) | smfrelatedflag | This parameter works with Generic Extract workflow only.
|
Default | SendNotification |
...
...
...
ACKDeliveryMethod |
...
ReplyDeliveryMethod |
...
...
CustomAckLocation |
...
...
CustomReplyLocation |
...
Common | maxrows |
http://eagle.helpdocsonline.com/available-filters [Common Filter]
...
For more information, see the Available Filter page in the EagleML wiki. |
...
DeltaBased |
http://eagle.helpdocsonline.com/available-filters [Delta Based Filter]
...
For more information, see the Available Filter page in the EagleML wiki. |
...
...
...
DoNotPublishOnError
http://eagle.helpdocsonline.com/format-control-message
...
DoNotPublishOnError | For more information, see the Format the Control Message page in the EagleML wiki. |
...
...
...
XSDValidation
http://eagle.helpdocsonline.com/format-control-message
...
XSDValidation | For more information, see the Format the Control Message page in the EagleML wiki. |
...
QueryProfileName |
...
Held | onlyheld |
http://eagle.helpdocsonline.com/available-filters [Held Securities Filter]
...
For more information, see the Available Filter page in the EagleML wiki. |
...
...
...
heldpositionsources |
...
heldcashactivitysources |
...
...
includecurrencyassets |
...
Source | sourcename |
http://eagle.helpdocsonline.com/available-filters [Sources Filter]
...
For more information, see the Available Filter page in the EagleML wiki. |
...
...
datasources |
...
Date | effectivedate |
http://eagle.helpdocsonline.com/available-filters [Date Filter]
...
For more information, see the Available Filter page in the EagleML wiki. |
...
fromdate |
...
...
fromeffectivedate |
...
updatedate |
...
...
todate |
...
...
toeffectivedate |
...
Default | ACKDeliveryMethod |
http://eagle.helpdocsonline.com/ejm-jobs-notifications
...
For more information, see the EJM Job Notifications Overview page in the EagleML wiki. |
...
...
CustomAckLocation |
...
...
CustomReplyLocation |
...
...
ReplyDeliveryMethod |
...
SendNotification |
...
Release Date Filters | fromreleasedate |
...
...
releasedate |
...
...
toreleasedate |
...
Issuer Filters | issueralias |
...
...
issuerid |
...
...
issuername |
...
Warehouse Filters | BatchMode |
...
...
ExcludeCurrentDay |
...
GL Activity Filters | FromGLAccount |
...
...
GLBasic |
...
...
...
GLClass |
...
GLDateType |
...
...
GLFromDate |
...
...
GLSector |
...
GLToDate |
...
...
ToGLAccount |
...
GL Balances Filters | accountingdate |
...
...
...
fromaccountingdate |
...
frommonthendaccountingdate |
...
...
GLBasic |
...
...
monthendaccountingdate |
...
toaccountingdate |
...
...
tomonthendaccountingdate |
...
Nav Filters | fromvaluationdate |
...
...
...
tovaluationdate |
...
valuationdate |
...
Code Category Filters | codecategory |
...
...
codecategoryname |
...
Code Value Filters | codevalue |
...
codevaluename |
...
Code Translation Filters | fromcodecategory |
...
...
fromcodecategoryname |
...
...
...
fromcodevalue |
...
fromcodevaluename |
...
...
fromsourcecode |
...
...
tocodecategory |
...
tocodecategoryname |
...
...
tocodevalue |
...
...
tocodevaluename |
...
tosourcecode |
...
Calendar Business Filters | CalendarBusinessName |
...
...
CalendarType |
...
...
DateTypeMacro |
...
OnlyBusinessCalendar |
...
...
ProcessCenterName |
...
Packer Parameters | CustomExtractLocation | For more information, see the Archive Parameters |
...
. | |
ExtractDeliveryMethod |
...
...
FromFolder |
...
...
...
OutputZipFileName |
...
OutputZipFileNamePattern |
...
...
...
SendDataToFTP |
...
ToFolder |
...
| Anchor | ||||
|---|---|---|---|---|
|
In the Control Message, filter parameters are specified in the <taskParameter> element. You can set a date filter for all object groups at once by using Common Date Filters or you can specify a filter for each object group. Specific filters have a higher priority than the Common Date filters. If both filters are used, priority is given to the filter for the specific object group.
The following table lists the supported filter parameters.
Parameter | Example of Value | Default Value | Comments |
|---|---|---|---|
Common Date Filters |
...
...
...
fromdate | (yyyy-mm-dd) |
...
The date filter sets a range of update and effective date for all objects. | ||
todate |
...
...
...
updatedate |
...
...
...
fromeffectivedate |
...
...
...
toeffectivedate |
...
...
...
effectivedate |
...
...
...
Please note, that the filters below are designed to be specific for a group of feedtypes. These parameters work with Generic Extract workflow only. |
...
...
...
Reference Date Filters |
...
...
...
reffromdate | (yyyy-mm-dd) |
...
The date filter sets a range of update and effective date for all Objects. | |
reftodate |
...
...
...
refupdatedate |
...
...
...
reffromeffectivedate |
...
...
...
reftoeffectivedate |
...
...
...
refeffectivedate |
...
...
...
Entity Date Filters |
...
...
...
entityfromdate | (yyyy-mm-dd) |
...
Date filter for the ENTITY object group. | |
entitytodate |
...
...
...
entityupdatedate |
...
...
...
entityfromeffectivedate |
...
...
...
entitytoeffectivedate |
...
...
...
entityeffectivedate |
...
...
...
SMF Date Filters |
...
...
...
smffromdate | (yyyy-mm-dd) |
...
Date filter for the SMF extract. | ||
smftodate |
...
...
...
smfupdatedate |
...
...
...
smffromeffectivedate |
...
...
...
smftoeffectivedate |
...
...
...
smfeffectivedate |
...
...
...
Financial Event Date Filters |
...
...
...
fineventfromdate | (yyyy-mm-dd) |
...
Date filter for the Financial Event extract. | ||
fineventtodate |
...
...
...
Warehouse Date Filters |
...
...
...
wrhsfromdate | (yyyy-mm-dd) |
...
Date filter for the Warehouse extract. | ||
wrhstodate |
...
...
...
wrhsupdatedate |
...
...
...
wrhsfromeffectivedate |
...
...
...
wrhstoeffectivedate |
...
...
...
wrhseffectivedate |
...
...
...
Corporate Actions Date Filters |
...
...
...
cafromdate | (yyyy-mm-dd) |
...
Date filter for the Corporate Actions extract. | ||
catodate |
...
...
...
caupdatedate |
...
...
...
cafromeffectivedate |
...
...
...
catoeffectivedate |
...
...
...
caeffectivedate |
...
...
...
Accounting Date Filters |
...
...
...
accfromdate | (yyyy-mm-dd) |
...
Date filter for the Accounting extract. | ||
acctodate |
...
...
...
accupdatedate |
...
...
...
accfromeffectivedate |
...
...
...
...
acctoeffectivedate |
...
...
...
...
acceffectivedate
...
...
...
acceffectivedate |
Using Custom Expressions to Filter the Extract
Generic Extract workflow supports custom expressions, for example,
IF StringLength(:param_filter1:)>0 then "rulesdbo.entity.user_field1 like '":param_filter1:"%'" Else "rulesdbo.entity.ENTITY_ID like '%'" is formatted as:
| Code Block | ||
|---|---|---|
| ||
EXPR#iif(StringLength(:param_filter1:)!=0, 'rulesdbo.entity.user_field1 like "':param_filter1: '%" ', 'rulesdbo.entity.ENTITY_ID like "%"') |