Entity Filter
Entity filters are used to define an entity (portfolio, fund). You need two task parameters to configure such a filter:
The following two parameters take a limited set of values:
entityselectiontype - defines the mode for the filter
Only one mode can be selected at a time, so you cannot define several values for entityselectiontype.
entityselectionvalue - defines the value for the filter
All parameters are formatted as “string” (<dataType>S</dataType>).
Filter Mode | Parameter Name | Example of Value | Comments |
---|---|---|---|
ProcessCenter | entityselectiontype | ProcessCenter | Constant value |
entityselectionvalue | ABC | “PROCESS_CENTER” field value from “RULESDBO.ENTITY_STAR_PROCESSING” DB table | |
EntityList | entityselectiontype | EntityList | Constant value Default Entity List mode. Stored procedure will be used to resolve Entity list (both for dynamic and static). Dynamic entity lists are defined with tables with names different from ‘‘ENTITY*’. |
entityselectionvalue | IQ71048 | “ENTITY_ID” field value from “RULESDBO.ENTITY_LIST” DB table | |
DynamicPortfolioList | entityselectiontype | DynamicPortfolioList | Constant value Enhanced Entity List mode. Dynamic query will be used to resolve a dynamic Entity list. Static Entity list in this mode will be resolved by the Stored procedure (as in default mode). |
entityselectionvalue | IQ71048 | “ENTITY_ID” field value | |
EntityID | entityselectiontype | EntityID | Constant value |
entityselectionvalue | IQ71048,DM89202 | “ENTITY_ID” field value from “RULESDBO.ENTITY” DB table | |
EntityComposite | entityselectiontype | EntityComposite | Constant value |
entityselectionvalue | IQ71048,DM89202 | “ENTITY_ID” field value from “RULESDBO.ENTITY_DETAIL” DB table | |
EntityXrefId | entityselectiontype | EntityXrefId | Constant value |
entityselectionvalue | IQ71048,DM89202 | “XREF_ACCOUNT_ID” field value from “RULESDBO.ENTITY_XREFERENCE” DB table | |
EntityXrefType | EntityXrefType | OTHER,COPER | “XREF_ACCOUNT_ID_TYPE” field value from “RULESDBO.ENTITY_XREFERENCE” DB table |
User Groups | usergroups | EQCSCS,DBFIFI | Defines the user group(s) to be extracted. ACCOUNTINGTRADEEXTRACT |
DynamicExpression | entityselectiontype | DynamicExpression | Constant value |
entityselectionvalue | x.ENTITY_ID like 'SOLME%' | It will be added into ‘WHERE’ section with ‘AND’ connector. | |
CashEntityID | entityselectiontype | CashEntityID | Constant value |
entityselectionvalue | IQ71048,DM89202 | “PORTFOLIO_ACCT” field value from “ESTAR.ESTAR_CASH_PROJECTION” DB table | |
CashEntityName | entityselectiontype | CashEntityName | Constant value |
entityselectionvalue | IQ71048,DM89202 | “ENTITY_NAME” field value from “ESTAR.ESTAR_CASH_PROJECTION_DETAILS” DB table | |
CashEntityType | entityselectiontype | CashEntityType | Constant value |
entityselectionvalue | PORT | “ENTITY_TYPE” field value from “ESTAR.ESTAR_CASH_PROJECTION_DETAILS” DB table |
There is an additional parameter available for EntityID, EntityComposite, EntityList, ProcessCenter, EntityXrefId filters - TraverseHierarchy flag. It enables additional logic to perform a deeper search thru the hierarchy of entities. See the Entity Filter with TraverseHierarchy Parameter page for more details.
Accounting SP Based Extract Filter Logic Specifics for Entity Filter
Read more on Accounting SP Based Extracts Filter Logic Specifics
Example: Entity List Filter
<taskParameter>
<name>entityselectiontype</name>
<dataType>S</dataType>
<value>EntityList</value>
</taskParameter>
<taskParameter>
<name>entityselectionvalue</name>
<dataType>S</dataType>
<value>FUNDS001</value>
</taskParameter>