CopyToClientFields (For Requirements)

The CopyToClientFields business rule is attached to Client and Policy-Client level Requirements. This rule updates one or more Client fields for one Client. This rule can update the Client that is associated to the Requirement with or without providing the Client's guid. It can also update other Clients with the rule being provided the Client's GUID. Multiple Clients can be updated by repeating the <Client> element with each providing a unique value for the CLIENTGUID attribute. Configuration provided like this will attempt to update the same fixed number of Clients with every attempt to process an instance of this rule.

This rule cannot be used to update external clients.

The CopyToClientFields business rule processes during execution of the <Rule> element configured under the Requirement's Definition rule.

CopyToClientFields (For Requirements): Elements and Attributes
Element/Tag Attributes Parent Attribute Description Element/Attribute Values
<CopyToClientFields>     This is the root element for the rule.  
<Client>

 

   <CopyToClientFields>

Optional, Repeatable:

This element's structure defines the Client fields and values to update. This may be repeated to update multiple clients.

 

CLIENTGUID

<Client>

Optional:

This attribute identifies a single Client that will be updated by the rule.

When this attribute is not configured, the rule will update the Client associated to the Client level Activity or error the Activity if the rule is not attached to a Client level Activity.

  • math variable

<Fields>

 

<CopyToClientFields>, <Client>

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. This element is repeated to update multiple fields or data columns

 

<From>

  

<Fields>

Required:

This element provides a single updated value.

  • math variable

  • requirement field

<To>

  

<Fields>

Required:

This element provides a single updated value.

  • field name
<OptionText>  

<Fields>

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.

  • math variabl

  • requirement field

XML Schema

<!-- update the single client associated to the client or policy-client level requirement -->
<CopyToClientFields>
    <Client>
        <Fields>
            <Field>
                <From>[variable | field name]</From>
                <To>[field name]</To>
                <OptionText>[variable | field name]</OptionText>
            </Field>
            <Field>...</Field>
        </Fields>
    </Client>
</CopyToClientFields>
 
<!-- update the single client associated to the client or policy-client level requirement -->
<CopyToClientFields>
    <Fields>
        <Field>
            <From>[variable | field name]</From>
            <To>[field name]</To>
            <OptionText>[variable | field name]</OptionText>
        </Field>
        <Field>...</Field>
    </Fields>
</CopyToClientFields>
 
<!-- update a fixed number of clients -->
<CopyToClientFields>
    <Client CLIENTGUID="[variable | field name]">
        <Fields>
            <Field>
                <From>[variable | field name]</From>
                <To>[field name]</To>
                <OptionText>[variable | field name]</OptionText>
            </Field>
            <Field>...</Field>
        </Fields>
    </Client>
    <Client CLIENGUID="[variable | field name]">...</Client>
    <Client CLIENGUID="[variable | field name]">...</Client>
</CopyToClientFields>
 
<!-- update the single client associated to the client or policy-client level requirement and a fixed number of other clients -->
<CopyToClientFields>
    <Client>
        <Fields>
            <Field>
                <From>[variable | field name]</From>
                <To>[field name]</To>
                <OptionText>[variable | field name]</OptionText>
            </Field>
            <Field>...</Field>
        </Fields>
    </Client>
    <Client CLIENTGUID="[variable | field name]">
        <Fields>
            <Field>
                <From>[variable | field name]</From>
                <To>[field name]</To>
                <OptionText>[variable | field name]</OptionText>
            </Field>
            <Field>...</Field>
        </Fields>
    </Client>
    <Client CLIENGUID="[variable | field name]">...</Client>
    <Client CLIENGUID="[variable | field name]">...</Client>
</CopyToClientFields>

XML Example 

<!-- update associated client -->
<CopyToClientFields>
    <Fields>
        <Field>
            <From>ClientDOB</From>
            <To>LetterSendDate</To>
        </Field>
    </Fields>
</CopyToClientFields>
 
OR
 
<CopyToClientFields>
    <Client>
        <Fields>
            <Field>
                <From>ClientDOB</From>
                <To>LetterSendDate</To>
            </Field>
        </Fields>
    </Client>
</CopyToClientFields>
 
<!-- update different client -->
<CopyToClientFields>
    <Client CLIENTGUID="ClientGUIDMV">
        <Fields>
            <Field>
                <From>ClientDOB</From>
                <To>LetterSendDate</To>
            </Field>
        </Fields>
    </Client>
</CopyToClientFields>