Versions Compared

Old Version 21

changes.mady.by.user Dmitry Donosiyan (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Pamela Totas

Saved on

Key

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

In the Control Message, you can define various object group filters and filter parameters to specify the range of data to be extracted from the database for each object group. You can also use custom filters. For more information about filters, see the About EagleML Filters page in  in the EagleML wiki.

Background Color
color#E0F0FF

Table of Contents
maxLevel2
printablefalse

Anchor

Using

_

ALLEXTRACTS_ Prefix

Using ALLEXTRACTS_ Prefix

The ALLEXTRACTS_ prefix allows you to address all feedtypes at the same time.

For example, you want to extract all feedtypes with Asset Properties model. The task parameter is set like this:

On this page

Table of Contents
maxLevel2
printablefalse

Using_FeedType__PrefixUsing_FeedType__Prefix
Code Block
languagexml
<taskParameter>
    <name>ALLEXTRACTS_IncludeAssetProperties</name>
    <dataType>S</dataType>
    <value>Y</value>
</taskParameter>
Anchor
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
title
Note

customWhere parameter is supported for eagle_wrf_generic_extract only with the FeedType_ prefix.

Expand
titleClick to expand the list of filters which DO NOT REQUIRE FeedType_ prefix:

StreamName
ActionType
GenerateRTR
DeliveryStreamName
DeliveryMethod
ACKDeliveryMethod
CustomAckLocation
CustomReplyLocation
DeltaBased
DeltaBasedUID
DoNotPublishOnError
FeedType
ChainExtract
Compress
ExtractDeliveryMethod
GenericExtractorAllTaskParams
OutputZipFileName
OutputZipFileNamePattern
OutputZipFileNamePatternEx
SendNotification
UseGenericExtractorAllTaskParams
CustomExtractLocation
FilesAddToZip
FromFolder
I2IProcessUID
IsDeltaRunTimeModeEnabled
isRemoteRun
LinkId
RemoteCMExecution
ReplyDeliveryMethod
SendDataToFTP
SpokeSID
ToFolder
SourceFileName
SourceFolder
ToFTPFolder
WorkflowName
XSDValidation
maxrows

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

Code Block
languagexml
<taskParameter>
    <name>SMFEXTRACT_CustomWhere</name>
    <dataType>S</dataType>
    <value>securitydbo.security_master.security_alias ='15' and rownum < 10</value>
</taskParameter>

CustomWhere CM parameter allows to insert additional code into the WHERE part of the SQL query of an extract. 

Warning

NOTE: You cannot use OR operator in the expression for CustomWhere parameter.

FeedType_ExtractNamePatternEx

Code Block
languagexml
<taskParameter>
    <name>SMFEXTRACT_ExtractNamePatternEx</name>
    <dataType>S</dataType>
    <value>tst_@FeedType_my.xml</value>
</taskParameter>

Customizes output file name according to the pattern specified. 
List of valid expressions:

  • @CorrelationID replaced by initial CorrID (must be always specified, required parameter)

InfotitleNoteObject_Group_FiltersObject_Group_Filters

  • If the process is launched via PACE Event Scheduler, its correlation Id is built as a combination of the tag 1177 value given in the PACE event's stream parameters and 'yyyymmddThhmmss' timestamp of the start of the event.

  • @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

Any filter listed below can be used in a similar manner – but it is not required in their case. 

Anchor
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

For more information, see the Available Filters page in the EagleML wiki.

entityselectionvalue

entityselectiontype2

entityselectionvalue2

UsePrimaryBasisOnly

SMF

processingsecuritytype

For more information, see the Available Filters page in the EagleML wiki.

securitytype

securityalias

releasestatus

primaryassetid

investmenttype

xrefid

xrefidtype

ticker

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.
Valid values: Y or N
When you set smfrelatedflag to Y and specify some SMF-related feedtypes

  1. The filters are applied to SMF records, the SMFs are extracted by default

  2. A set of security aliases is created based on extracted SMFs

  3. SMF-related extracts are performed using the security aliases from the set defined on Step 2.

Default

SendNotification

ACKDeliveryMethod

ReplyDeliveryMethod

CustomAckLocation

CustomReplyLocation

Common

maxrows

For more information, see the Available Filter page in the EagleML wiki.

DeltaBased

For more information, see the Available Filter page in the EagleML wiki.

DoNotPublishOnError

For more information, see the Format the Control Message page in the EagleML wiki.

XSDValidation

For more information, see the Format the Control Message page in the EagleML wiki.

QueryProfileName

Held

onlyheld

For more information, see the Available Filter page in the EagleML wiki.

heldpositionsources

heldcashactivitysources

includecurrencyassets

Source

sourcename

For more information, see the Available Filter page in the EagleML wiki.

datasources

Date

effectivedate

For more information, see the Available Filter page in the EagleML wiki.

fromdate

fromeffectivedate

updatedate

todate

toeffectivedate

Default

ACKDeliveryMethod

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
Filter_Parameters
Filter_Parameters
Filter Parameters

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)
2013-01-012013-01-01 15-00-00

The date filter sets a range of update and effective date for all objects.
Effectivedate parameters are applied only to objects containing the "EFFECTIVE_DATE" field.
Currently enabled 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)
2013-01-012013-01-01 15-00-00

The date filter sets a range of update and effective date for all Objects.
Effectivedate parameters are applied only to objects containing the "EFFECTIVE_DATE" field.
Currently enabled for REFERENCE.

reftodate

refupdatedate

reffromeffectivedate

reftoeffectivedate

refeffectivedate

Entity Date Filters

entityfromdate

(yyyy-mm-dd)
2013-01-012013-01-01 15-00-00

Date filter for the ENTITY object group.

entitytodate

entityupdatedate

entityfromeffectivedate

entitytoeffectivedate

entityeffectivedate

SMF Date Filters

smffromdate

(yyyy-mm-dd)
2013-01-012013-01-01 15-00-00

Date filter for the SMF extract.

smftodate

smfupdatedate

smffromeffectivedate

smftoeffectivedate

smfeffectivedate

Financial Event Date Filters

fineventfromdate

(yyyy-mm-dd)
2013-01-012013-01-01 15-00-00

Date filter for the Financial Event extract.

fineventtodate

Warehouse Date Filters

wrhsfromdate

(yyyy-mm-dd)
2013-01-012013-01-01 15-00-00

Date filter for the Warehouse extract.

wrhstodate

wrhsupdatedate

wrhsfromeffectivedate

wrhstoeffectivedate

wrhseffectivedate

Corporate Actions Date Filters

cafromdate

(yyyy-mm-dd)
2013-01-012013-01-01 15-00-00

Date filter for the Corporate Actions extract.

catodate

caupdatedate

cafromeffectivedate

catoeffectivedate

caeffectivedate

Accounting Date Filters

accfromdate

(yyyy-mm-dd)
2013-01-012013-01-01 15-00-00

Date filter for the Accounting extract.

acctodate

accupdatedate

accfromeffectivedate

acctoeffectivedate

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
languagesql
EXPR#iif(StringLength(:param_filter1:)!=0, 'rulesdbo.entity.user_field1 like "':param_filter1: '%" ', 'rulesdbo.entity.ENTITY_ID like "%"')