CopyToRoleFields
This business rule allows one or more MathVariables or Activity fields to be copied to one or more specified RoleFields upon processing the activity to which the CopyToRoleFields business rule is attached. Configuration has the option to update multiple roles from a single attribute, multiple roles by a singular role code, and one or more roles using collections. This rule may be used to update policy role fields, segment role fields, or both.
In addition to field values, CopyToRoleFields will automatically update the OptionText of combo box and radio button fields.
This rule must be listed in TransactionBusinessRulePacket.
Element/Tag | Definition | Attribute | Element/Attribute Value and Description |
---|---|---|---|
<CopyToRoleFields> |
The opening and closing tag of the CopyToRoleFields business rule. |
|
|
<PolicyRoles> |
A section identifying the policy roles and the fields that are to be updated by the rule. PolicyRoles configuration is not required. | The rule can be configured for Segment role update only, Policy role update only, or update of both types of roles. | |
<PolicyRole> |
Required and Repeatable: A section to identify roles that are to be updated. |
Either ROLECODE or ALLROLES must be provided. | |
Optional: RoleCode that is used to target a role for update. Cannot coexist with ALLROLES attribute or FromCollection element. |
ROLECODE | A singular Role Code; expected population via MathVariable. | |
Optional: Cannot exist with ROLECODE attribute. Cannot coexist with <FromCollection> element. |
ALLROLES | Yes|No If Yes, all Policy roles (excluding CSR) meeting the status criteria will be updated. |
|
<Tests>
|
Optional: Allows for additional filtering of the roles that may be updated, or creates additional MathVariable or activity field triggers that allow role updates by creating conditions outside of role status. All conditions in this section must evaluate to true before the policy's role may be updated. |
||
<Test>
|
Repeatable element: | A conditional statement that tests a MathVariable or Field against another MathVariable or Field or other literal value. | |
<RoleStatus>
|
Optional: Opening tag to list role status information. Status codes in the list further filter the roles that may be updated. Without this information, the filter is not applied and the status is disregarded. |
||
<Status>
|
Required, Repeatable: A role status that can accept the role field update. |
A valid Role status code. | |
<Fields>
|
Required/Repeatable: Defines a section to contain the fields that will be updated. |
||
<Field>
|
Repeatable: Identifies the field that is updated and the updated value. <From> and <FromCollection> elements are mutually exclusive. |
||
<From>
|
Required: Identifies the math variable or activity field as the source of the update. An activity field must be prefixed with Activity:[field name]. |
A MathVariable or activity field from the transaction to which the rule is attached. | |
<FromCollection>
|
Required: Identifies a MathVariable of type COLLECTION as the source of the update. |
A MathVariable of type COLLECTION where the keys are role GUIDs and the values are the source data. | |
<To>
|
Required: Identifies the field that is updated. |
A literal name for a field. | |
<MultiFields> | Optional, repeatable element: Defines the multifields to be updated/inserted. | ||
Note: The system will validate named "To" fields against the field name in the MultiField rule in the RoleScreen rule for the type code of the specified RoleGUID. |
|||
Required: Specifies the named section of the related entity's Multifield rule. | NAME | Literal name | |
Required: Specifies the total number of instances of multifields for the named section of the related entity's Multifield rule. If NAME is omitted or does not exist in the MultiField rule, all the fields in the MultiField rule will be repeated for "END" number of times. | END | Literal Integer or Integer Math Variable | |
<Field> | Optional, repeatable element: Contains the instructions for the specified "To" field. This element (and sub elements) may be omitted if the default field values are desired. | ||
<FromIndexCollection> | Required: A collection of index/value pairs for the target fields. Indices must be unique integers. | Math variable collection of index/values. | |
<To> | Required: The target named field in the entity multifield rule | Literal field name | |
<SegmentRoles> |
Optional: A section identifying the segment roles and the fields that are to be updated by the rule. |
Segment roles configuration is not required. This rule can be configured for Policy role update only, Segment role update only, or update of both role types. | |
<SegmentRole>
|
Optional and Repeatable: A section to identify roles that are to be updated. |
Either ALLROLES or ROLECODE attribute must be provided. | |
Optional: If Yes, all Segment roles meeting the status criteria will be updated. The CSR role is excluded from ALLROLES update. |
ALLROLES |
Yes | No |
|
Optional: This is used to target a singular RoleCode for update. Cannot coexist with ALLROLES attribute or <FromCollection>. |
ROLECODE |
One Role Code |
|
Required:
Used with ROLECODE or ALLROLES. Cannot coexist with <FromCollection>. |
SEGMENTGUID | One SegmentGUID | |
<Tests> |
Optional: Allows for additional filtering of the roles that may be updated, or creates additional MathVariable or activity field triggers that allow role updates by creating conditions outside of role status. All conditions in this section must evaluate to true before the segment's role may be updated. |
||
<Test> |
Repeatable: |
A conditional statement that tests a MathVariable or Field against another MathVariable, Field, or literal value. | |
<RoleStatus> |
Optional:
Opening tag to list role status information. Status codes in the list further filter the roles that may be updated. Without this information, the filter is not applied and the status is disregarded. |
||
<Status> |
Required and Repeatable: A role status that can accept the role field update. |
A valid Role status code | |
<Fields> |
Required/Repeatable:
|
|
|
<Field> |
Repeatable:
<From> and <FromCollection> elements are mutually exclusive. |
|
|
<From> |
Required:
|
|
A MathVariable or Activity field from the transaction to which the rule is attached. |
<FromCollection> |
Required: Identifies a MathVariable of type COLLECTION as the source of the update. |
|
A MathVariable of type COLLECTION where the keys are role GUIDs and the values are the source data. |
<To> |
Required: Identifies the field that is updated. |
|
A literal name for a field. |
XML Sample
<CopyToRoleFields>
<PolicyRoles>
<PolicyRole ALLROLES="Yes">
<Tests>
<Test>IsPolicyTerm=true</Test>
</Tests>
<RoleStatus>
<Status>01</Status>
</RoleStatus>
<Fields>
<Field>
<From>Activity:RoleRelationship</From>
<To>RoleRelationship</To>
</Field>
<Field>
<From>SystemDateMV</From>
<To>RoleTestDate</To>
</Field>
</Fields>
</PolicyRole>
</PolicyRoles>
<SegmentRoles>
<SegmentRole ALLROLES="Yes" SEGMENTGUID="Activity:WhichSegment">
<Tests>
<Test>IsSegmentTypeNot72=true</Test>
</Tests>
<RoleStatus>
<Status>01</Status>
</RoleStatus>
<Fields>
<Field>
<From>Activity:RoleRelationship</From>
<To>RoleRelationship</To>
</Field>
<Field>
<From>SystemDateMV</From>
<To>RoleTestDate</To>
</Field>
</Fields>
</SegmentRole>
</SegmentRoles>
</CopyToRoleFields>
XML Schema
CopyToRoleFields – PolicyRole Schema
<CopyToRoleFields>
<PolicyRoles>
<PolicyRole ALLROLES="Yes|No" ROLECODE="MathVariable">
<Tests>
<Test>conditional statement</Test>
</Tests>
<RoleStatus>
<Status>[role status]</Status>
</RoleStatus>
<Fields>
<Field>
<FromCollection>[activity field|math variable]</FromCollection>
<To>[column name|field name]</To>
</Field>
<Field>
<From>[activity field|math variable]</From>
<To>[column name|field name]</To>
</Field>
</Fields>
<Multifields>
<Field>
<From></From>
<To></To>
</Field>
</MultiFields>
</PolicyRole>
</PolicyRoles>
</CopyToRoleFields>
XML Schema – CopyToRoleFields – Segment Role Schema
<CopyToRoleFields>
<SegmentRoles>
<SegmentRole ALLROLES="Yes|No" ROLECODE="MathVariable" SEGMENTGUID=”MathVariable”>
<Tests>
<Test>conditional statement</Test>
</Tests>
<RoleStatus>
<Status>[role status]</Status>
</RoleStatus>
<Fields>
<Field>
<FromCollection>[activity field|math variable]</FromCollection>
<To>[column name|field name]</To>
</Field>
<Field>
<From>[activity field|math variable]</From>
<To>[column name|field name]</To>
</Field>
</Fields>
</SegmentRole>
</SegmentRoles>
</CopyToRoleFields>
XML Schema Policy roles – ALLROLES =Yes
<CopyToRoleFields>
<PolicyRoles>
<PolicyRole ALLROLES="Yes">
<Tests>
<Test>conditional statement</Test>
</Tests>
<RoleStatus>
<Status>[role status]</Status>
</RoleStatus>
<Fields>
<Field>
<From>[activity field|math variable]</From>
<To>[column name|field name]</To>
</Field>
</Fields>
<Multifields>
<Field>
<From></From>
<To></To>
</Field>
</MultiFields>
</PolicyRole>
</PolicyRoles>
</CopyToRoleFields>
XML Schema Segment Roles – ALLROLES =Yes
<CopyToRoleFields>
<SegmentRoles>
<SegmentRole ALLROLES="Yes" SEGMENTGUID=”MathVariable”>
<Tests>
<Test>conditional statement</Test>
</Tests>
<RoleStatus>
<Status>[role status]</Status>
</RoleStatus>
<Fields>
<Field>
<From>[activity field|math variable]</From>
<To>[column name|field name]</To>
</Field>
</Fields>
</SegmentRole>
</SegmentRoles>
</CopyToRoleFields>
XML Schema Policy roles – ROLECODE attribute used
<CopyToRoleFields>
<PolicyRoles>
<PolicyRole ROLECODE="MathVariable">
<Tests>
<Test>conditional statement</Test>
</Tests>
<RoleStatus>
<Status>[role status]</Status>
</RoleStatus>
<Fields>
<Field>
<From>[activity field|math variable]</From>
<To>[column name|field name]</To>
</Field>
</Fields>
</PolicyRole>
</PolicyRoles>
</CopyToRoleFields>
XML Schema Segment Roles – ROLECODE attribute used
<CopyToRoleFields>
<SegmentRoles>
<SegmentRole ROLECODE="MathVariable" SEGMENTGUID=”MathVariable”>
<Tests>
<Test>conditional statement</Test>
</Tests>
<RoleStatus>
<Status>[role status]</Status>
</RoleStatus>
<Fields>
<Field>
<From>[activity field|math variable]</From>
<To>[column name|field name]</To>
</Field>
</Fields>
</SegmentRole>
</SegmentRoles>
</CopyToRoleFields>
XML Schema – Policy roles ALLROLES, ROLECODE, and SEGMENTGUID attributes are absent; <FromCollection> used
<CopyToRoleFields>
<PolicyRoles>
<PolicyRole>
<Tests>
<Test>conditional statement</Test>
</Tests>
<RoleStatus>
<Status>[role status]</Status>
</RoleStatus>
<Fields>
<Field>
<FromCollection>[math variable]</FromCollection>
<To>[column name|field name]</To>
</Field>
</Fields>
<Multifields>
<Field>
<From></From>
<To></To>
</Field>
</MultiFields>
</PolicyRole>
</PolicyRoles>
</CopyToRoleFields>
XML Schema Segment Roles – ALLROLES, ROLECODE, and SEGMENTGUID attributes are absent; <FromCollection> used
<CopyToRoleFields>
<SegmentRoles>
<SegmentRole>
<Tests>
<Test>conditional statement</Test>
</Tests>
<RoleStatus>
<Status>[role status]</Status>
</RoleStatus>
<Fields>
<Field>
<FromCollection>[math variable]</FromCollection>
<To>[column name|field name]</To>
</Field>
</Fields>
</SegmentRole>
</SegmentRoles>
</CopyToRoleFields>