Page Comparison

Anchor
Processing_Details Processing_Details

Processing Details

The general approach here is simple:
1. Main filter makes up a list of Entity Ids (any entity type)
2. TraverseHierarchy logic is enabled to parse the hierarchy and to add sub-entities of composite entities to the list for extraction
3. Extraction is performed
TraverseHierarchy flag toggles execution of step 2.
 
For example, we have a number of EntityIds of different Entity types:
Image Modified

With the following hierarchy:
Image Modified
Image Modified

There are two large Entity structures, BT8207C1 and BT8207L1, which contain entities of various types: composites, lists and portfolios.

Anchor
EntityID EntityID

Passing EntityID

<taskParameter>
    <name>entityselectiontype</name>
    <dataType>S</dataType>
    <value>EntityID</value>
</taskParameter>
<taskParameter>
    <name>entityselectionvalue</name>
    <dataType>S</dataType>
    <value>BT8207C3</value>
</taskParameter>

On the first step we get only one EntityId:
Image Modified
Image Modified

TraverseHierarchy goes thru the tree of dependencies and makes up a list of EntityIds for it:
Image Modified

This list contains only entities under composite entities. BT8207_6 and BT8207_8 are not included because they belong to an entity with type 'LIST', not a composite entity. (EntityList and Entity Composite filters work in a little bit different way)

Anchor
EntityIDs_list EntityIDs_list

Passing a List of EntityIDs

<taskParameter>
    <name>entityselectiontype</name>
    <dataType>S</dataType>
    <value>EntityID</value>
</taskParameter>
<taskParameter>
    <name>entityselectionvalue</name>
    <dataType>S</dataType>
    <value>BT8207C3,BT8207_4,BT8207L4</value>
</taskParameter>

Initial list of Entities:
Image Modified

These entities can be of any entity type. On this step only data for these 3 entities is extracted. But if you switch TraverseHierarchy to 'Y', these entities are taken as a starting point, their hierarchy is analyzed:
Image Modified
Image Modified
Image Modified

Among these three only BT8207C3 is composite, so only its tree is examined and its sub-entities are added to the list for extraction. Same goes for its composite sub-entity BT8207C4 - its tree is parsed and sub-entities are added to the final list.
Image Modified

Anchor
EntityComposites_list EntityComposites_list

Passing a List of EntityComposites

<taskParameter>
    <name>entityselectiontype</name>
    <dataType>S</dataType>
    <value>EntityComposite</value>
</taskParameter>
<taskParameter>
    <name>entityselectionvalue</name>
    <dataType>S</dataType>
    <value>BT8207C3</value>
</taskParameter>

Image Modified

When you set EntityComposite Filter, you get entities that belong to this Composite(s).

Initial list of Entities:
Image Modified
As you can see this list contains only EntityIds which belong to EntityComposite BT8207C3, but it does not contain BT8207C3 itself.

Hierarchy is then examined and the final list of entities transforms into:
Image Modified

Since only BT8207C4 has type = COMP, only its tree is built and its two sub-entities are added. The result is very similar to EntityId filter case. But BT8207C3 is not on the list.

Anchor
EntityLists_list EntityLists_list

Passing a List of EntityLists

The same principle as for EntityComposite, we use EntityIds which belong this List.

<taskParameter>
    <name>entityselectiontype</name>
    <dataType>S</dataType>
    <value>EntityList</value>
</taskParameter>
<taskParameter>
    <name>entityselectionvalue</name>
    <dataType>S</dataType>
    <value>BT8207L2</value>
</taskParameter>

Image Modified
 
Initial list:
Image Modified

Final list (after Traverse):
Image Modified

Anchor
Summary Summary

Compare Examples and Results

Input Parameters	Initial List of EntityIds (Or result w\o Traverse flag)	List of EntityIds with Traverse
EntityId EntityID = BT8207C3	Image Modified