CopyToRequirementFields (For Transactions)

The CopyToRequirementFields business rule is attached to Policy and Client level transactions/activities. This rule updates one or more Requirement fields for one or more Policy, Client or Policy-Client level Requirements. The Requirements to update are identified by the GUID values in an array. Each of the Requirements can be updated with the same set of field values or updated with a unique set of values. The PreviousStatusCode field value on these Requirements can be updated by this rule.

The CopyToRequirementFields business rule should be configured in the TransactionBusinessRulePacket business rule.

 

CopyToRequirementFields for Transaction: Elements and Attributes
Element Attributes Parent Element Description Element / Attribute Values
<CopyToRequirementFields>     This is the root element for the rule.  
  REQUIREMENTGUIDS <CopyToRequirementFields>

Required:

This attribute provides an array of RequirementGUIDs that will be updated by the rule.

  • math variable

    • must be an array
<Fields>   <CopyToRequirementFields>

Required:

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

  
<Field>   <Fields>

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.

All Requirements listed in the REQUIREMENTGUIDS array are updated with the same value.

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.

The Requirements identified by this element's map must be contained in the REQUIREMENTGUIDS array.

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 = RequirementGUID to update

    • value = update 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.

The Requirements identified by this element's map must be contained in the REQUIREMENTGUIDS array.

  • collection

    • key = RequirementGUID to update

    • value = update value

XML Example

<!-- update one or more requirements each with the same values -->
<CopyToRequirementFields REQUIREMENTGUIDS="[variable]">
    <Fields>
        <Field>
            <From>[variable | requirement field]</From>
            <To>[field name]</To>
            <OptionText>[variable | requirement field]</OptionText>
        </Field>
        <Field>...</Field>
    </Fields>
</CopyToRequirementFields>
 
<!-- update one or more requirements each with different values -->
<CopyToRequirementFields REQUIREMENTGUIDS="[variable]">
    <Fields>
        <Field>
            <FromCollection>[variable | requirement field]</FromCollection>
            <To>[field name]</To>
            <OptionTextCollection>[variable | requirement field]</OptionTextCollection>
        </Field>
        <Field>...</Field>
    </Fields>
</CopyToRequirementFields>

XML Example

<CopyToRequirementFields REQUIREMENTGUIDS="RequirementsArray">
    <Fields>
        <Field>
            <FromCollection>CloseDateCollection</FromCollection>
            <To>CloseDate</To>
        </Field>
    </Fields>
</CopyToRequirementFields>