RATEARRAY
Retrieves a list of rates based on parameter criteria.
Note: The rule can list more criteria than needed for a specific instance. The system will only use those criteria that are valid for the RateDescription given. Using more criteria than needed can be used to create a reusable function that calls RATEARRAY. Be sure to include in the RateCriteria list all or the criteria for all RateTables that will be using the RATEARRAY call.
TYPE=RATEARRAY | ||||
---|---|---|---|---|
Element | Attributes | Attribute Value | Definition | Element Value |
<MathVariable>
|
|
|
|
|
VARIABLENAME |
Literal string |
Required |
|
|
TYPE |
RATEARRAY |
RequiredIdentifies the type of the MathVariable. |
|
|
DATATYPE |
DECIMAL |
Required |
|
|
ROUND | Integer |
Optional when DATATYPE="DECIMAL" |
||
DEFAULT | String |
Optional |
||
LOG | YES |
Optional |
||
STARTINDEX |
Integer |
The starting index of the rate array. |
|
|
ENDINDEX |
Integer |
The ending index of the rate array. |
|
|
<Parameters> |
|
|
|
|
<RateDescription> |
|
|
Required This is the RATEDESCRIPTION from AsRate, for the table to use to retrieve rates. |
String |
<EffectiveDate> |
|
Effective date (like Activity effective date), for which the rate retrieval is to take place. |
Activity:EffectiveDate | |
<ActiveDate> |
|
|
Rate effective date for the table being retrieved. |
Date |
<RateCriteria>
|
|
|
The MathVariable previously defined that holds the value of the Criteria (Like 01 for Gender, or 03 for Risk). |
String |
NAME |
String |
Required, repeatable The specific instance of Criteria given in AsRateGroup (the actual instance such as Gender, Tobacco, Risk, etc. It is not the heading of Criteria1, Criteria2, etc.) |
|
XML Example
<MathVariable VARIABLENAME="RateArrayMV" TYPE="RATEARRAY" STARTINDEX="20" ENDINDEX="30" DATATYPE="DECIMAL">
<Parameters>
<RateDescription>RateDescriptionMV</RateDescription>
<EffectiveDate>ActivityEffectiveDateMV</EffectiveDate>
<ActiveDate>ActivityEffectiveDateMV</ActiveDate>
<RateCriteria NAME="Gender">GenderMV</RateCriteria>
<RateCriteria NAME="Risk">RiskMV</RateCriteria>
<RateCriteria NAME="Tobacco">TobaccoMV</RateCriteria>
<RateCriteria NAME="IssueAge">IssueAgeMV</RateCriteria>
<RateCriteria NAME="Band">BandMV</RateCriteria>
</Parameters>
</MathVariable>
XML Schema
<!-- TYPE="RATEARRAY" -->
<!-- ROUND="[Integer]" is an optional attribute to be used when DATATYPE="DECIMAL" -->
<!-- DEFAULT="[String]" is an optional attribute -->
<!-- LOG="YES" is an optional attribute -->
<!-- -->
<MathVariable VARIABLENAME="[String]" TYPE="RATEARRAY" DATATYPE="DECIMAL" STARTINDEX="[Integer]" ENDINDEX="[Integer]" ROUND="[Integer]" DEFAULT="[String]" LOG="Yes">
<Parameters>
<RateDescription>[String]</RateDescription>
<ActiveDate>[Date]</ActiveDate>
<EffectiveDate>[Date]</EffectiveDate>
<!-- there can be 1-to-n occurrences of the "RateCriteria" tag -->
<RateCriteria>[String]</RateCriteria>
</Parameters>
</MathVariable>