You are here: Business Rules > Attached Rules > AddRoles

AddRoles

Description

The purpose of the AddRoles business rule is to add existing clients in the database to new roles on an existing Policy or Segment. This rule can only be attached to a policy-level transaction and can only be used to add roles to the policy on which the activity is being processed. For each Role in AddRole, at least ROLECODE and CLIENTGUID are required. All other fields if not specified will be set to null.

Note: Reversing off an activity that uses AddRoles changes the role code of the added role to a Deleted role code. The role record should not be deleted completely.

AddRoles Element/Attribute Table
Element	Attribute	Definition
<AddRoles>		The opening and closing tag of the AddRoles Business Rule.
<Role>		Required/Repeatable Element; This element is used to define the criteria with which the specified Roles should be added to the Policy. Criteria are defined through various attributes.
	CLIENTGUID, CLIENTGUIDCOLLECTION	Required attribute: These attributes are mutually exclusive. If a single Client should be added to a particular type of role, use CLIENTGUID, if multiple Clients should be added to the same role, use CLIENTGUIDCOLLECTION.
	ROLECODE	Required attribute: The type of role, the client(s) are added to depends on the value of the ROLECODE attribute. The MathVariable must contain a valid RoleCode from AsCode=>AsCodeRole table.
	COMPANYGUID	Optional attribute: This attribute is used to specify the CompanyGUID with which the newly added role should be saved in the AsRole table.
	EXTERNALCLIENTGUID	Attribute EXTERNALCLIENTGUID replaces HIERARCHYGUID. The specified EXTERNALCLIENTGUID will be copied to the ExternalClientGUID column of AsRole.
	STATECODE	Optional attribute: This attribute is used to specify the StateCode from AsCode=>AsCodeState table, with which the newly added role should be saved in the AsRole table.
	PERCENTDOLLARCODE	Attribute PERCENTDOLLARCODE will no longer be supported. While it exists in AsRole, we will copy a NULL value for that column to AsRole.
	ROLEPERCENT	Optional attribute; Used to specify the percentage of allocation for the newly added Role through this Business rule. Saves the specified Role Percent in the AsRole Table.
	ROLEAMOUNT	Optional attribute: Used to specify the amount of allocation for the newly added Role through this Business rule. Saves the specified Role Amount in the AsRole Table.
<Tests>		Optional Element; Allows configuration of Test(s) to see if section of rule should be invoked.
<Test>		Required/Repeatable Element (Expression). Condition to add Role to the Policy.
	TYPE	Optional attribute (="Expression") To indicate the type of the condition. Example: <Test TYPE="Expression">SomeMathVariable=27</Test>
<Fields>		Optional Element; Used to create a record in AsRoleField table by passing the required information from the Transaction.
<Field>		Required/Repeatable Element; This tag is used to specify the values with which the newly added roles should be updated in AsRoleField table.
<From>		Required Element value: (ActivityFieldName/MathVariable) When CLIENTGUID is used, use <From> tag.
<FromCollection>		Required Element value: (ActivityFieldName or MathVariable of TYPE=”COLLECTION”) When CLIENTGUIDCOLLECTION is used, use <FromCollection> tag.
<To>		Required Element value: (RoleScreenFieldName) Name of the RoleScreen field. Depending whether <From> or <FromCollection> tag is used, same or different values are updated in the RoleScreen

XML Sample

<AddRoles>

<Role CLIENTGUIDCOLLECTION="AddClientGUIDCollection" ROLECODE="AddRoleCodeCollection" PERCENTDOLLARCODE="" ROLEPERCENT="RolePercentMV" ROLEAMOUNT="RoleAmountMV">

<Tests>

<Test TYPE="Expression">ClientCount=4</Test>

</Tests>

<Fields>

<Field>

<FromCollection>TaxIDCollection</FromCollection>

<To>TaxIDField</To>

</Field>

</Fields>

</Role>

<Role CLIENTGUID="AddClientGUID" ROLECODE="AddRoleCode" PERCENTDOLLARCODE="" ROLEPERCENT="RolePercentMV2" COMPANYGUID="CompanyGUIDMV" EXTERNALCLIENTGUID="ExternalClientGUIDMV" STATECODE="StateCodeMV">

<Fields>

<Field>

<From>TaxIDMV</From>

<To>TaxIDField</To>

</Field>

</Fields>

</Role>

</AddRoles>