Specifies the filters to be applied while loading the project.
In case of P,P,R filters, either
(a) A Filter string can be supplied OR
(b) A Calculation Model ID can be supplied
Note: Calculation Model filters MUST only be supplied through their IDs.
In case of extended filters, either
(a) A Filter string can be supplied OR
(b) A Calculation Model ID can be supplied OR
(c) Both string AND Model ID can be supplied (Combined effectivity case)
Note: Calculation Model filters MUST only be supplied through their IDs.
In case of effectivity filter mode, one of the following rules can be supplied
(a) Give the objects whose begin & end dates contains the begin & end date filters values.
The rule value is 1.
(b) Give the object whose begin & end dates are with in the begin & end dates filter values.
The rule value is 2.
(c) Give the object whose begin date value is lesser than the begin date filter value &
the end date value on the object is contained with in the begin & end date filter values.
The rule value is 4.
(d) Give the object whose begin date value is contained with in the begin & end date filter values &
the end date value on the object is greater than the end date filter value.
The rule value is 8.
(e) Give the object whose begin & end dates exactly match with that of the begin & end date filter values
The rule value is 16.
Note: Combination of the above said rules can also be used.
For example: If the user wants the combination of rule a & c, then the value of 5 should be passed
Note: If the user has not specified any value for this filter, then a default value of 31 (combination of all rules) will be used.
- Parameters:
-
- iFilters
- [in]
The filters to be set. This is a list of values separated by XML type tags
The following tags are supported
<ProcessFilter>Filter Value</ProcessFilter>
<ProcessFilterCalcModelID>ID of Calculation Model Filter</ProcessFilterCalcModelID>
<ProductFilter>Filter Value</ProductFilter>
<ProductFilterCalcModelID>ID of Calculation Model Filter</ProductFilterCalcModelID>
<ResourceFilter>Filter Value</ResourceFilter>
<ResourceFilterCalcModelID>ID of Calculation Model Filter</ResourceFilterCalcModelID>
<StartDateEffectivityFilter>Filter Value</StartDateEffectivityFilter>
<EndDateEffectivityFilter>Filter Value</EndDateEffectivityFilter>
<EffectivityFilterMode>Filter Value</EffectivityFilterMode>
<LineNumberFilter>Filter Value</LineNumberFilter>
<LabelFilter>Filter Value</LabelFilter>
<ModStatementFilterID>Filter Value</ModStatementFilterID>
<PlanningStateOwnerFilterID>ID of Planning State</PlanningStateOwnerFilterID>
<PlanningStateOtherFilterID>ID of Planning State</PlanningStateOtherFilterID>
<ApplyImplicitFilter>TRUE or FALSE</ApplyImplicitFilter>
<ProcessExtendedEffectivityFilter>Filter Value</ProcessExtendedEffectivityFilter>
<ProcessExtendedEffectivityFilterCalcModelID>ID of Calculation Model Filter</ProcessExtendedEffectivityFilterCalcModelID>
<ProductExtendedEffectivityFilter>Filter Value</ProductExtendedEffectivityFilter>
<ProductExtendedEffectivityFilterCalcModelID>ID of Calculation Model Filter</ProductExtendedEffectivityFilterCalcModelID>
<ResourceExtendedEffectivityFilter>Filter Value</ResourceExtendedEffectivityFilter>
<ResourceExtendedEffectivityFilterCalcModelID>ID of Calculation Model Filter</ResourceExtendedEffectivityFilterCalcModelID>
Attribute filters can be supplied using the following tags
<AttributeFilters>
<ProcessAttributeFilters>
<AttributeFilter>
<PlanTypeName>Name of the Plantype</PlanTypeName>
<AttributeName>Name of the Attribute</AttributeName>
<Operator>Type of Operator. See list of legal values below</Operator>
<AttributeValue>Value of the Attribute</AttributeValue>
Add more <AttributeValue>...</AttributeValue> if more attribute values need to be specified
</AttributeFilter>
Add more <AttributeFilter>...</AttributeFilter> if more attribute filters need to be specified
</ProcessAttributeFilters>
<ProductAttributeFilters>
Add <AttributeFilter>...</AttributeFilter> as specified above
</ProductAttributeFilters>
<ResourceAttributeFilters>
Add <AttributeFilter>...</AttributeFilter> as specified above
</ResourceAttributeFilters>
</AttributeFilters>
Note: Instead of specifying plantype name, the object typename (e.g., "ergocompprocessdefault,
"ergocomporgprocess", etc) can also be supplied if filter is to be applicable to all plantypes
Note: For the <Operator> tag, the following are the legal values
   =
   !=
   <
   >
   <=
   >=
   LIKE
   NOT LIKE
- Example:
- iFilters = "<ProcessFilter>Process Type A</ProcessFilter><LabelFilter>Label B</LabelFilter><LineNumberFilter>10</LineNumberFilter>"
The order is NOT important. e.g., "<LabelFilter>...</LabelFilter>" can come before "<ProcessFilter>...</ProcessFilter>"
- Example:
- Example with attribute filers. Assuming user wishes to filter on Line Number 10 and load only those Workplans that are labelled "Workplan A" and "Workplan C"
iFilters = "<LineNumberFilter>10</LineNumberFilter><AttributeFilters><ProcessAttributeFilters><AttributeFilter>
<PlanTypeName>Workplan</PlanTypeName>
<AttributeName>name</AttributeName>
<Operator>=</Operator>
<AttributeValue>Workplan A</AttributeValue>
<AttributeValue>Workplan C</AttributeValue>
</AttributeFilter></ProcessAttributeFilters></AttributeFilters>"
- Returns:
-
S_OK
if all OK
E_INVALIDARG
if incorrect input format