Eliminate Source By Ratio

(Available with Order Execution Mgt.)

Description

Eliminate Source By Ratio eliminates or applies a weight to items that do not fit ratio 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 ratio 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 Ratio 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 particular ratio can be assigned to items.

Use Eliminate Source by Ratio 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 modules will 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 element of this array contains the name of an attribute to be paired with an attribute value for comparison. The function block attempts to match the array element's Attribute Value the current item's value for the same attribute. Results can be either of the following.
	If:		Then:
	The attribute values match.		The function block compares the respective Block Size and Attribute History elements.
	Selecting the current item (incrementing the Spacing Count) would exceed the ratio defined by Block Size:Block Limit.		The comparison fails for that attribute and the: 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 name of an attribute). You can then enter a named query or query expression as the respective element in the Attribute Value array.
Block Size Array	Integer (analog) array point. Each element in the array contains the size of the block for its respective attribute name/value, i.e. the denominator of the ratio. The number of items released that have the attribute are recorded to the elements of this array.
Block Limit Array	Real or integer (analog) array point. Each element of the array contains the maximum number of matching attribute values for the respective attribute name/value in a bock; i.e. the numerator of the ratio.
Attribute History Array	Integer (analog) array point. Each element of the array contains the actual history of released items for the respective attribute name/value.

More information

	Record Attribute Ratios.
	Eliminate and Weight Sources.
	RSA function blocks list.