CopyToImpairmentFields (For Transactions)

The CopyToImpairmentFields business rule is attached to Policy and Client level transactions/activities. This rule updates one or more Impairment fields for one or more Impairment records. The Impairments to update are identified by their GUIDs in an attribute or a key value in a collection.

The CopyToImpairmentFields should be configured in the TransactionBusinessRulePacket business rule.

CopyToImpairmentFields For Transactions: Elements and Attributes
Element Attribute Parent Element Description Element / Attribute Values
<CopyToImpairmentFields>     This is the root element for the rule.  
  IMPAIRMENTGUID <CopyToImpairmentFields>

Optional:

This attribute identifies the Impairment to update.  If this attribute is not configured, one or more <FromCollection> elements must be configured where it identifies one or more records to update.  This attribute cannot be configured when the rule contains one or more <FromCollection> elements.

  • math variable

  • activity field
<Fields>   <CopyToImpairmentFields>

Required:

This element's structure defines one or more fields or data columns to update and the data source of their updated values.

  
<Field>   <Fiields>

Required, Repeatable:

This element defines a single field or data column to update and the data source of its updated value.  The element is repeated to update multiple fields or data columns.

  
<From>   <Field>

Optional:

This element provides a single updated value for the field or data column.

This element cannot co-exist in the same <Field> element with the <FromCollection> element.  Every <Field> element structure must contain either a <From> or <FromCollection> element.

  • math variable

  • activity field
<FromCollection>   <Field>

Optional:

This element identifies one or more records where the field or data column is updated with a record specific value.

This element cannot co-exist in the same <Field> element with the <From> element.  Every <Field> element structure must contain either a <From> or <FromCollection> element.

  • collection

    • key = ImpairmentGUID to update

    • value = updated value
<To>   <Field>

Required:

This element provides the field name to update.

  • field name
<OptionText>   <Field>

Optional:

This element provides a single value for the field's option text.  This applies to combo and radio fields only. 

The value of a combo and radio field is not the same as its visible text.  Option text provides the visible text associated to this field's value.

This element cannot co-exist in the same <Field> element with the <OptionTextCollection> and <FromCollection> elements.

  • math variable

  • activity field
<OptionTextCollection>   <Field>

Optional:

This element identifies one or more records where the option text for the field is updated with a record specific value.  This applies to combo and radio fields only.

The value of combo and radio fields is not the same as its visible text.  Option text provides the visible text associated to this field's value.

This element cannot co-exist in the same <Field> element with the <OptionText> and <From> elements.

  • collection

    • key = ImpairmentGUID to update

    • value = updated OptionText value

XML Schema

<!-- update a single Impairment -->
<CopyToImpairmentFields IMPAIRMENTGUID="[variable | activity field]">
    <Fields>
        <Field>
            <From>[variable | activity field]</From>
            <To>[field name]</To>
            <OptionText>[variable | activity field]</OptionText>
        </Field>
        <Field>...</Field>
    </Fields>
</CopyToImpairmentFields>
 
<!-- update one or more Impairments -->
<CopyToImpairmentFields>
    <Fields>
        <Field>
            <FromCollection>[collection]</FromCollection>
            <To>[field name]</To>
            <OptionTextCollection>[collection]</OptionTextCollection>
        </Field>
        <Field>...</Field>
    </Fields>
</CopyToImpairmentFields>

XML Example

<CopyToImpairmentFields IMPAIRMENTGUID="ImpairmentGUIDMV">
    <Fields>
        <Field>
            <From>PaymentMethodMV</From>
            <To>PaymentMethod</To>
            <OptionText>PaymentMethodOptionTextMV</OptionText>
        </Field>
    </Fields>
</CopyToImpairmentFields>
 
OR
 
<CopyToImpairmentFields>
    <Fields>
        <Field>
            <FromCollection>CloseDateCollectionMV</FromCollection>
            <To>CloseDate</To>
        </Field>
    </Fields>
</CopyToImpairmentFields>