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.

Note: AddImpairments can be configured partially or entirely through CopyBooks.

AddImpairments: Elements and Attributes

Element/Tag Attributes Parent Element Description Element/Attribute Values
<AddImpairments>

 

   Required element:

The opening and closing tags of the business rule.

  
<Impairment>

IF

 <AddImpairments> Required, repeatable element:

The container element for the required configuration.

Required attribute:

This attribute's value should be an expression that, if it resolves to true, will cause the impairment to be added.
<Tests>

 

 <Impairment> Optional element:

The container element for the test expression configuration.

  
<Test>

 

 <Tests>

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>

 

 <Impairment> Optional element:  
<ClientGUID>

 

 <Impairment>

Optional 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.
<SegmentGUID>

 

 <Impairment> Optional element:

This element defines the segment to which the impairment should be added.

 

.

 This element's value should be the SegmentGUID for the client to which the impairment should be added
<PriorityCode>   <Impairment> Optional element:

This element defines the impairment's priority.

 

This element's value should be a code value from AsCodeImpairmentPriority.
<CategoryCode>   <Impairment> Optional element:

This element defines the impairment's category.

 

 

 This element's value should be a code value from AsCodeImpairmentCategory.
<Debit>   <Impairment> 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>   <Impairment> 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>   <Impairment> 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>   <Impairment> 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.
<Fields>

 

 <Impairment> Optional element:

This element contains configuration specifying the fields to be copied to the newly created Impairment.

 
<Field>   <Fields> This element specifies the field to be copied to the newly created impairment and the field to which it should be copied.  
<From>   <Field>

This element specifies the field whose value should be copied to the new impairment.

 

The name of the field from which value should be copied, or a MathVariable that resolves to the name of this field.
<To>   <Field>

This element specifies the field to which the value should be copied.

 

The name of the Impairment field that should be given the value.
<OptionText>   <Field>

Optional element:

Identifies the source of the data that will update the OptionText for the field defined in the <To> element.

 

Note: This element and the <OptionTextCollection> element are mutually exclusive

 

Math Variable

XML Schema

<AddImpairments>
<Impairment>
<Tests>
<Test>[Test expression]</Test>
</Tests>
<PolicyGuid>[Policy GUID]</PolicyGuid>
<ClientGuid>[Client GUID]</ClientGuid>
<SegmentGuid>[Segment GUID]</SegmentGuid>
<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>
<Fields>
<Field>
<From>MV</From>
<To>FieldName</To>
<OptionText>[MathVariable]</OptionText>
</Field>
</Fields>
</Impairment>
<Impairment>
. . .
</Impairment>
</AddImpairments>

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>
<SegmentGuid>SegmentGUIDMV</SegmentGuid>
<CategoryCode>04</CategoryCode>
<PriorityCode>04</PriorityCode>
<Debit>DebitMV</Debit>
<FlatExtra>FlatExtraMV</FlatExtra>
<Duration>DurationMV</Duration>
<Comments>CommentsMV</Comments>
<Fields>
<Field>
<From>MV</From>
<To>FieldName</To>
<OptionText>FieldNameOptionText</OptionText>
</Field>
</Fields>
</Impairment>
<Impairment>
<Tests>
<Test>3=4</Test>
</Tests>
<Comments>Dummy Impairment</Comments>
</Impairment>
</AddImpairments>