CopyToWithholdingFields
CopyToWithholdingFields loads the withholding fields from the database and updates them based on the values specified in the business rule. The <From> element identifies the math variable or field where a value is being obtained. The <To> element identifies the field that is being updated.
The optional <Test> elements allow conditional logic to be configured, to determine whether the Withholding fields of a pending activity should be updated. If multiple test conditions are configured, they are viewed as AND statements; if all conditions are not met, the update will not be made.
Only one set of withholdings can be updated by a rule.
In addition to field values, CopyToWithholdingFields will automatically update the OptionText of combo box and radio button fields.
| Element/Tag | Attributes | Parent Element | Description | Element/Attribute Values |
|---|---|---|---|---|
| <CopyToWithholdingFields> |
|
Required opening and closing tag. | ||
|
POLICYGUID |
Required attribute for policy level update:
PolicyGUID Identifies the policy for which withholding will be updated |
|||
|
CLIENTGUID |
Required attribute for client level update:
ClientGUID Identifies the client for whom withholding will be updated |
|||
|
<Tests> |
|
<CopyToWithholdingFields> |
Optional element: Allows for further definition of the activities that may be updated. |
|
|
<Test> |
|
<Tests> |
Required element if <Test> is present. A conditional statement that tests a MathVariable or Field against another MathVariable, Field, or literal value. |
|
|
<Fields> |
<CopyToWithholdingFields> |
Required element:
|
||
|
<Field> |
<Fields> |
Repeatable element:
|
||
|
<From> |
<Field> |
This element is used to specify the math variable or withholding field where the data should be copied from. Required
element value:
|
Name of MathVariable or field from the transaction. |
|
|
<To> |
<Field> |
Required element:
Required
element value:
|
Name of the field in Withholding screen . |
|
|
<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. |
XML Example
<CopyToWithholdingFields POLICYGUID="Activity:PolicyGUID">
<Tests>
<Test TYPE="Expression">1 = 1</Test>
</Tests>
<Fields>
<Field>
<From>Activity:FederalAmount</From>
<To>FederalAmount</To>
<OptionText>FederalAmountOptionText</OptionText>
</Field>
<Field>
<From>Activity:FederalPercent</From>
<To>FederalPercent</To>
<OptionText>FederalPercentOptionText</OptionText>
</Field>
<Field>
<From>Activity:StateAmount</From>
<To>StateAmount</To>
<OptionText>StateAmountOptionText</OptionText>
</Field>
<Field>
<From>Activity:StatePercent</From>
<To>StatePercent</To>
<OptionText>StatePercentOptionText</OptionText>
</Field>
</Fields>
</CopyToWithholdingFields>