AgreementRoleScreen
The AgreementRoleScreen gives users the following capabilities:
- View existing agreement roles of a group customer.
- Add a new client of a specific role type.
- Find and add that client as an agreement role.
- Edit the details of an agreement role.
- Delete an agreement role record (the record is not physically deleted from the database, but is marked with a specific status code).
Element/Tag | Attribute | Definition | Element/Attribute Value and Description |
---|---|---|---|
<AgreementRoleScreen> |
|
|
|
<AgreementRole> |
Repeatable element: | ||
TYPECODE |
Required attribute:
Specifies the agreement type code. |
|
|
DISABLEBYAGREEMENTSTATUS |
Optional attribute: The role records of a specific role type are disabled based on a particular agreement role status |
Text: StatusCode from Agreement table, |
|
ALLOWGROUPCUSTOMER |
Optional attribute: Specifies whether the Agreement Role TypeCode will be available for selection under the "Find Customer" tab. |
YES/NO
Yes:The Agreement Role TypeCode will be available for selection under the "Find Customer" tab. No: The AgreementRole TypeCode will not be selectable under the "Find Customer" tab. If the ALLOWGROUPCUSTOMER attribute is not set to "Yes" for at least one AgreementRole element, the "Find Customer" tab will not be displayed on the screen. The default value is "No". |
|
<ClientTypes> |
Optional element: Required if <ClientTypes> is configured |
||
<ClientType> |
Required & Repeatable attribute: Specifies a client type code or a list of client type codes, separated by commas. |
Code as defined in AsCode CodeName AsCodeClientType Provides a list of applicable client type codes that will be available in the type selection list on "Find Client" and "New Client" screens. If no client types are defined for a particular role type, that particular role type will not be listed in the role type dropdown for New Client and Find Client tabs |
|
</ClientTypes> | |||
<Subsections>
|
|
Optional element: The fields configured inside subsections will be grouped together and the display can be collapsed or expanded. |
|
SECTIONNODES |
Optional attribute:
Specifies whether all of the subsections as a whole should display as expanded or collapsed. |
Expanded/Collapsed Collapsed is the default value. |
|
<Subsection>
|
Repeatable element: Required if <Subsections> element is configured. |
|
|
TITLE |
Optional attribute:
Assigns a title to the subsection. |
String The title to be displayed on the subsection header. |
|
SECTIONNODES |
Optional attribute:
Specifies whether the subsection should display as expanded or collapsed. |
Expanded/Collapsed Collapsed is the default value. |
|
<Fields> |
|
See Fields Elements. |
|
<ScreenMath> |
|
Optional element: See ScreenMath Element. |
|
<Actions> |
|
Optional element: See Action/Events |
|
<Events> |
|
Optional element: See Action/Events. |
|
XML Example
<AgreementRoleScreen>
<AgreementRole TYPECODE="[type code]" ALLOWGROUPCUSTOMER="[Yes/No]" DISABLEBYAGREEMENTSTATUS="[text]">
<ClientTypes>
<ClientType>[type code]</ClientType>
</ClientTypes>
<Subsections>
<Subsection TITLE="[String]" SECTIONNODES="[Expanded/Collapsed]">
<Fields></Fields>
</Subsection>
</Subsections>
<Events></Events>
<ScreenMath></ScreenMath>
<Actions></Actions>
</AgreementRole>
</AgreementRoleScreen><AgreementRoleScreen>
<AgreementRole TYPECODE="[type code]" ALLOWGROUPCUSTOMER="[Yes/No]" DISABLEBYAGREEMENTSTATUS="[text]">
<ClientTypes>
<ClientType>[type code]</ClientType>
</ClientTypes>
<Subsections>
<Subsection TITLE="[String]" SECTIONNODES="[Expanded/Collapsed]">
<Fields></Fields>
</Subsection>
</Subsections>
<Events></Events>…
<ScreenMath></ScreenMath>
<Actions></Actions>
</AgreementRole>
</AgreementRoleScreen>