(Available with Order Execution Mgt.)
Description
Eliminate Source By Percentages eliminates or applies a weight to items that do not fit within percentage constraints.
The applied weight is a value that:
You entered in the Set Block Weights function block's corresponding parameter.
Set Block Weights assigns to this function block.
Any item whose selection would push any attribute name/value combination's percentage of the total release outside its configured limits fails.
Notes
An accurate historical record of the item selections is required.
When you use this block, insert a corresponding Record Attribute function block into your routing or output logic module.
Insert a Record Attribute function block where all item eliminations (by any and all methods) have been completed.
Example
If the Eliminate Source function block is placed within a Resequence Block Module, then the corresponding Record Attribute function block should be inserted immediately before the Resequence Range block where the selection is processed.
The Eliminate Source By Percentage and corresponding Record Attribute function blocks should be configured with the same points and array point names.
A block that applies a zero weight eliminates failed items from the range source.
Rotation numbers that observe a percentage breakdown according to their attributes can be assigned to items.
Use Eliminate Source by Percentage within a multiple-pass Resequence Block Module.
Parameters
This function block has the following parameters:
Parameter |
Description |
|||
Always Evaluate |
Hard, Soft or Breakable. Controls what happens when the extension eliminates all items in the range source. |
|||
|
Hard |
All items will remain eliminated. Enter a wait state after the logic script has completed. |
||
|
Soft |
Roll back any eliminations made by this extension. |
||
|
Breakable |
Roll back any eliminations made by this extension that have a danger point value of TRUE (non zero). Routing logic modules first use the danger defined for each individual decision However, one of the following may occur instead. |
||
|
|
If: |
Then: |
|
|
|
No danger point has been configured for the decision |
The site-wide danger point is used. |
|
|
|
This function block is used in the decision output logic. |
The site-wide danger point is used. |
|
|
|
No danger point can be found for a decision. |
The decision remains eliminated. |
|
Attribute Name Array |
Text array point. Each rule contains an attribute name/value that the function block compares to an item's corresponding attribute names/values. Note: The value is defined in the Attribute Value array. Results can be any of the following. |
|||
|
If: |
Then: |
||
|
The attribute values match. |
The function block compares the respective Attribute Release percent against the Total Release Count. |
||
|
Selecting the current item would exceed the percent defined by the Upper Release % Target. |
The comparison fails for that attribute and the: Item is either weighted or eliminated. Failure is saved as history data. |
||
|
Selecting the current item would cause a different attribute name/value to fail to meet its minimum Lower Release % Target defined in another rule, |
The comparison fails for the current attribute and the: Current item is either weighted or eliminated. Failure is saved as history data |
||
|
Note: To compare items that satisfy a named query or query expression, enter the reserved name SOLVE for this element in the Attribute Name array. (This is instead of the actual name of an attribute). You can then enter a named query or query expression as the respective element in the Attribute Value array. |
|||
Attribute Value Array |
Text array point. Each rule contains an attribute name/value that the function block compares to an item's corresponding attribute names/values. Note: The name is defined in the Attribute Name Array. An element in the array can contain: The value of the respective attribute in the Attribute Name Array. Each element can contain one or multiple values with a comma separator. Do not include quotes. Attribute values can be wild cards. A named query, or query expression, returning a Boolean result. Guidelines For any element in the Attribute Name Array that contains the reserved name SOLVE you can enter a named query, or query expression, as the respective value element. In this case, the percentage rule is not applied to an attribute name/value, but is instead applied to any items for which the query returns TRUE. Example A Boolean named query $IsStandardHatchback$ returns TRUE for items that have a standard transmission and have a hatchback rear door.
$IsStandardHatchback$ is the query
expression: When $IsStandardHatchback$ is entered as the value element, the applied percentage rule determines the percent of selected vehicles that can be standard hatchbacks. However, interaction with other rules can cause a hatchback item to fail even if it complies with the hatchback percent rule. Example
You can use a query that returns a set of attributes, instead of a Boolean result, by setting the query name or expression to a particular value. Example A attribute named query $TransmissionIs$ is the expression Vehicle.TransmissionType. $TransmissionIs$ can
be entered as the value element of this array in the form of an
expression: |
|||
Upper Release % Limit |
Contains the upper percentage limit for a Percentage rule. If selecting the current item would cause the Attribute Release percent for the respective name/value to exceed the specified percentage of the Total Release Count, the item fails. |
|||
Lower Release % Limit |
If selecting the current item would make it impossible to satisfy the Lower Release % Limit defined for any other attribute name/value for the items that remain in the range source, then the current item fails. Example The current item is a red, two-door car.
Notes: This evaluation checks the Lower Release % Limit for attributes of all items that remain in the range source for which a percentage rule has been defined. Eliminate Sources Percentages function block is generally used within a multiple-pass Resequence Block Module. Therefore, a rejected item may be selected by a subsequent pass in that case. |
|||
Attribute Release Array |
Integer (analog) array point. Each element in the array contains the total number of items already selected that have the same attribute name/value. |
|||
Total Release Count |
Integer (analog) point. Counter point stores and continues to increment the total number of items released. |
Record Attribute Percentages. |
|
Eliminate and Weight Sources. |
|
RSA function blocks list. |