AgreementDefinition Business Rule
Agreements provide the ability to do the following:
- Link a Group Customer's purchased Product(s) in order to create and support the customer's plan(s)
- Provide links to Class Groups, which are required in order to associate Classes and their members to available plans and applicable financial reporting
- Support direct association of Clients to Roles, as with Policies and Segments.
An Agreement Definition business rule gives users the ability to configure the Roles, Products, Plans and Class Groups that are associated with the given Agreement.
Element/Tag | Attribute | Definition | Element/Attribute Value and Description |
---|---|---|---|
<Agreement> |
|
The opening/closing tag of the Agreement configuration. |
|
PRODUCT |
Optional attribute: Specifies if a particular Agreement will associate Products with the Agreement. |
Yes: The agreement can be used to link Products to a Group Customer. The "Products" tab will be available on the Group Customer Agreement screen. No: The agreement cannot be used to link Products to a Group Customer, and the "Products" tab will not display on the Group Customer Agreement screen. This is the default value if this attribute is omitted from configuration. |
|
PLAN |
Optional attribute: Specifies if a particular Agreement will support creating and maintaining Group Customer plans. |
Yes: The Agreement will support creating and maintaining Group Customer plans. No: The Agreement will not support creating and maintaining Group Customer plans. |
|
CLASSGROUP |
Optional attribute: Specifies if a particular Agreement will associate Class Groups with the Agreement. |
Yes: The agreement can be used to link Class Groups to a Group Customer. The "Class Groups" tab will be available on the Group Customer Agreement screen. No: The agreement cannot be used to link Class Groups to a Group Customer, and the "Class Groups" tab will not display on the Group Customer Agreement screen. This is the default value if this attribute is omitted from configuration. |
|
<Subsections> |
SECTIONNODES |
Optional element: The fields configured inside subsections will be grouped together and the display can be collapsed or expanded. |
Optional attribute:Expanded/Collapsed Collapsed is the default value. |
<Subsection>
|
Repeatable element: Required if the <Subsections> element is configured. |
||
TITLE |
Optional attribute: The title to be displayed on the subsection header. |
String |
|
SECTIONNODES |
Optional attribute: |
Expanded/Collapsed Collapsed is the default value. |
|
<Fields> |
|
The Fields section can be used within the Subsection element or outside of it. Currently if a subsection tag is used, all fields should stay within a subsection. Else, all fields should be used without any subsection elements. |
|
<Events> |
|
See Action/Events. |
|
<ScreenMath> |
|
See ScreenMath Element. |
|
<Actions> |
|
See Action Events |
|
<MultiFields> | Required: The opening and closing tag of the MultiFields element. This element is used to turn on/off the multifields section. The statement can occur in any part of the Transaction/Screen XML. | Required element value: Yes | |
RULE | A literal value referencing the exact rule name of a MultiFields business rule (AsBusinessRules.RuleName). |
XML Schema
<Agreement PRODUCT="[Yes|No]" CLASSGROUP="[Yes|No]" PLAN="[Yes|No]">
<Subsections SECTIONNODES="Value">
<Subsection TITLE="Value">
<Fields>
<Field>
</Field>
</Fields>
</Subsection>
</Subsections>
<EligibleRoleTypes>
<RoleType></RoleType>
</EligibleRoleTypes>
<MultiFields RULE="Value">Value</MultiFields>
<MultiFields RULE="[business rule name]">Yes</MultiFields>
</Agreement>
XML Example
<Agreement PRODUCT="Yes">
<Subsections SECTIONNODES="Value">
<Subsection TITLE="Value">
<Fields>
<Field>
</Field>
</Fields>
</Subsection>
</Subsections>
<EligibleRoleTypes>
<RoleType></RoleType>
</EligibleRoleTypes>
<MultiFields RULE="Value">Value</MultiFields>
</Agreement>