Record Attribute Rule

(Available with Order Execution Mgt.)

Description

Record Attribute Rule adds the history data saved for the currently selected source item to Rule History array points you create or select.

Notes

Add Record Attribute Rule to the end of any module where you use the Eliminate Sources Based on Rule function block to store information about the item that remains after that elimination.

Example

Eliminate Source by Rule is in a Resequence Block Module,

Place a Record Attribute Rule block between that block and the Resequence Range block at the end of that module.

Record Attribute Rule records only one item's history data to the specified points – the item at the range source head.

Where all item eliminations (by any and all methods) have been completed.

  1. Insert another function block such as

Select Lowest Weight

Select Source By Age

before Record Attribute Rule to insure that the most appropriate item(s) are selected.

If you have criteria to determine which item should be selected in case of a tie, specify that criteria in an RSA function block inserted before the Select block.

  1. Insert Record Attribute Rule.

Parameters

This function block has the following parameters:

Important: Select the same array points previously configured for the corresponding Eliminate Sources Based on Rule block you inserted earlier in this logic or output module.

Parameter

Description

Rule Type Array

Text array point.

Each element of the array contains one of the following rule types.

 

G

Grouping

 

S

Spacing

 

B

Blocking

 

P

Percentage

Attribute Name Array

Text array point.

The names of the selected item's attributes are recorded to elements of this array.

Attribute Value Array

Text array point.

The values of the selected item's respective attributes are recorded to elements of this array.

Count Array

 

(Grouping, Spacing and Blocking rules only)

Integer (analog) array point.

The actual number of items consecutively selected that have the same, or different, attribute name/value (depending on the grouping, spacing or blocking rule) is recorded to the respective element of this array.

Note: Items selected using a percentage rule are also recorded, however this data is not currently used.

Attribute Release Count Array

(Grouping, Spacing and Blocking rules only)

Integer (analog) array point.

The actual number of matching items selected for the respective attribute name/value pair is recorded to the respective element of this array.

Total Release Count

(Percentage rules only)

Integer (analog) point.

Counter point stores and continues to increment the total number of items released.

More information

Eliminate Sources Based on Rule.

Record selections and rule violations.

RSA function blocks list.