AddImpairments
This business rule is attached to a transaction in order to add impairments based on the configured criteria. AddImpairments will automatically set the OptionText of combo box or radio button fields.
Element/Tag | Definition | Attribute | Element/Attribute Value and Description |
---|---|---|---|
<AddImpairments> |
Required element: The opening and closing tags of the business rule. |
||
<Requirement> |
Required, repeatable element: The container element for the requirement configuration. |
IF |
Required attribute: This attribute's value should be an expression that, if it resolves to true, will cause the impairment to be added. |
<Tests> |
Optional element: The container element for the test expression configuration. |
||
<Test> |
Required, repeatable element: This element defines an expression that, if it resolves to true, will invoke the remainder of the rule's configuration. This element is only required if the <Tests> element is present. |
This element's value should be an expression that, if it resolves to true, will invoke the remainder of the rule's configuration. |
|
<PolicyGUID> |
Optional element:
|
||
<ClientGUID> |
Required element: This element defines the client to which the impairment should be added. |
This element's value should be the ClientGUID for the client to which the impairment should be added. | |
<PriorityCode> | Optional element:
This element defines the impairment's priority. |
This element's value should be a code value from AsCodeImpairmentPriority. | |
<CategoryCode> | Optional element:
This element defines the impairment's category. |
This element's value should be a code value from AsCodeImpairmentCategory. | |
<Debit> | Optional element:
This element specifies the number of points to debit. |
This element's value should be an integer that represents the numbers of points to debit. |
|
<FlatExtra> | Optional element:
This element specifies the flat extra amount that should be applied. |
This element's value should be an integer that represents the flat extra amount to be applied. | |
<Duration> | Optional element:
This element defines the duration for which the flat extra is valid. |
This element's value should be an integer that represents the time in years for which the flat extra should be valid. | |
<Comments> | Optional element:
This element assigns a text description to the impairment. |
This element's value should be a string that describes the purpose of the impairment. |
XML Example
<AddImpairments>
<Impairment>
<Tests>
<Test>1=1</Test>
</Tests>
<CategoryCode>01</CategoryCode>
<PriorityCode>01</PriorityCode>
<Debit>1</Debit>
<FlatExtra>1</FlatExtra>
<Duration>1</Duration>
<Comments>APE Comment for Policy</Comments>
</Impairment>
<Impairment>
<Tests>
<Test>2=2</Test>
</Tests>
<PolicyGuid>PolicyGUIDMV</PolicyGuid>
<ClientGuid>ClientGUIDMV</ClientGuid>
<CategoryCode>04</CategoryCode>
<PriorityCode>04</PriorityCode>
<Debit>DebitMV</Debit>
<FlatExtra>FlatExtraMV</FlatExtra>
<Duration>DurationMV</Duration>
<Comments>CommentsMV</Comments>
</Impairment>
<Impairment>
<Tests>
<Test>3=4</Test>
</Tests>
<Comments>Dummy Impairment</Comments>
</Impairment>
</AddImpairments>
XML Schema
<AddImpairments>
<Impairment>
<Tests>
<Test>[Test expression]</Test>
</Tests>
<PolicyGuid>[Policy GUID]</PolicyGuid>
<ClientGuid>[Client GUID]</ClientGuid>
<CategoryCode>[AsCodeImpairmentCategory code value]</CategoryCode>
<PriorityCode>[AsCodeImpairmentPriority code value]</PriorityCode>
<Debit>[Debit amount]</Debit>
<FlatExtra>[Flat extra amount]</FlatExtra>
<Duration>[Duration value]</Duration>
<Comments>[Comment text]</Comments>
</Impairment>
<Impairment>
. . .
</Impairment>
</AddImpairments>