AddAgreementRoles
The AddAgreementRoles rule may be attached to a transaction so that an activity can link a client to an agreement through an agreement role.
| Element/Tag | Attributes | Parent Element | Description | Element/Attribute Values |
|---|---|---|---|---|
|
<AddAgreementRoles> |
|
|
||
|
<AgreementRole> |
|
<AddAgreementRoles> |
Required, repeatable element: Specifies the agreement roles to be added. |
|
|
AGREEMENTGUID |
Required Attribute: MathVariable to populate AgreementGUID. AgreementGUID from Agreement table. |
|||
|
AGREEMENTROLETYPE |
MathVariable to populate AgreementRoleType from Code table. |
|||
| CLIENTGUID |
Required Attribute: MathVariable to populate ClientGUID. A single ClientGUID from the Person table. |
|||
| AGREEMENTROLESTATUS |
Optional Attribute MathVariable to populate AgreementRoleStatus from Code table.
|
When multiple <Test> elements are configured, it is expected that all Test elements resolve to TRUE for the overall <Tests> to be considered TRUE (logical AND operation) and the other parts of the configuration in relation to <Tests> element is executed. |
||
|
<Tests> |
|
<AgreementRole> |
|
|
|
<Test> |
|
<Tests> |
Specifies a test expression |
when multiple <Test> elements are configured, it is expected that all Test elements resolve to TRUE for the overall <Tests> to be considered TRUE (logical AND operation) and the other parts of the configuration in relation to <Tests> element is executed. |
|
<Fields> |
|
<AgreementRole> |
See Fields Elements. |
|
| <From> | <Field> |
This element specifies the field whose value should be copied to the new agreement role.
|
Math Variable, Field Name The name of the field or MathVariable from which value should be copied. |
|
| <To> | <Field> |
This element specifies the field to which the value should be copied.
|
Literal The name of the agreement role field that should be given the value. |
|
| <OptionText> | <Field> |
Identifies the source of the data that will update the OptionText for the field defined in the <To> element. This element and the <OptionTextCollection> element are mutually exclusive. Note: This element and the <OptionTextCollection> element are mutually exclusive.
|
Math Variable The name of the MathVariable from which value should be copied. |
XML Example
<AddAgreementRoles>
<AgreementRole AGREEMENTGUID="MVAgreementGUID" AGREEMENTROLETYPE="MVAgreementRoleTypeCode" CLIENTGUID="MVClientGUID1" AGREEMENTROLESTATUS="MVStatusTo">
<Tests>
<Test>1=1</Test>
</Tests>
</AgreementRole>
<AgreementRole AGREEMENTGUID="AgreementGuid2"AGREEMENTROLETYPE="AgreementRoleType2" CLIENTGUID="ClientGuid2">
<Tests>
<Test>2>1</Test>
</Tests>
<Fields>
<Field>
<From>Activity:TestTextField</From>
<To>AgreementRoleDynamicField1</To>
<OptionText>AgreementRoleDyanmieFieldOptionText</OptionText>
</Field>
</Fields>
</AgreementRole>
</AddAgreementRoles>