ClientRelationshipScreen
The Client Relationship screen provides the user with the ability to view, update or create new relationships between a Group Customer and either a non-Group Customer client or another existing Group Customer . The Client Relationship Screen associates clients to policies with context and associated data, similar to the way the Policy Role screen works.
Element/Tag | Attribute | Definition | Element/Attribute Value and Description |
---|---|---|---|
<ClientRelationshipScreen> |
|
|
|
<UseBusinessStatus> |
|
Optional element: Indicates whether or not business status will be tracked for ClassGroup time slices as well as the record state. Default is No |
Text: Yes No |
<PrimaryRelationships> |
|
|
|
<PrimaryRelationship> |
Required and Repeatable element: This relationship is displayed to the user only if a corresponding AsCode record is defined. |
||
TYPECODE |
Text Must be a code from AsCodePrimaryRelationshipType table, e.g. HR Manager, Account Executive. The same primary relationship type cannot be configured more than once. |
||
< AvailableToClientTypes > |
Optional Element If empty all client types except Type 99 can use the Primary Relationship Note :If <AvailableToClientTypes> is configured these elements are required |
Text A ClientTypeIdentifier ID |
|
<ClientTypeIdentifier> |
Required & Repeatable Element |
||
<Spawns> |
Required element: Note: This Spawns section is moved from inside the ONSUBMIT event to inside the main ClassGroup tag |
|
|
<Spawn> |
Required element: Note: The IF attribute which is available as part of the Spawn tag will not be available in this BR and will be ignored if used. |
|
|
<Transaction> |
|
Required element: Identifies the transaction that should be spawned. The transaction must be available from the entity’s context. A transaction’s name. |
|
EXECUTIONDATE | Required attribute:
The date in which the activity should execute. For instance, a future dated entity may have a current execution date so the entity becomes active before it is effective |
Field or screen math variable containing a date value or IMMEDIATE | |
<SecondaryRelationships> |
Required element: |
|
|
<SecondaryRelationship> |
ALLOWGROUPCUSTOMER |
Required and Repeatable element: |
Text: Yes/No |
<Maximum> |
|
Optional element: |
Integer Defines the maximum number of client type identifiers that can be configured. |
<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> |
TITLE |
Repeatable element: Required if <Subsections> element is configured. |
Optional attribute:String The title to be displayed on the subsection header. |
<Fields> |
|
See Fields Elements. |
|
<Events> |
Repeatable element: The opening and closing tag for Events section. See Action/Events. |
This rule may contain multiple configuration sectors based on SecondaryRelationship elements, each containing its own Events section, which will act only on the Fields and MultiFields configured within the same sector. For example: One of the <SecondaryRelationship> elements in the XML Example below with TypeCode VALUE=”40” displays a portion of the screen. |
|
<ScreenMath> |
Repeatable element: The opening and closing tag for ScreenMath section. |
|
|
<Actions> |
Repeatable element: The opening and closing tag for Actions section. See Action/Events. |
|
|
<Spawns> |
|
Required element: Note: This Spawns section is moved from inside the ONSUBMIT event to inside the main ClassGroup tag |
|
<Spawn>
|
|
Required element: Opening element containing a transaction to spawn based an entity action. Note: The IF attribute which is available as part of the Spawn tag will not be available in this BR and will be ignored if used. Asides from that the typical spawn section with one Transaction element can be configured here. Please refer Spawns_ Element Section for more details |
|
<Transaction> |
Required element: Identifies the transaction that should be spawned. The transaction must be available from the entity’s context. A transaction’s name. |
||
EXECUTIONDATE |
Required element: The date in which the activity should execute. For instance, a future dated entity may have a current execution date so the entity becomes active before it is effective |
Field or screen math variable containing a date value or IMMEDIATE | |
PROCESSIMMEDIATE |
Optional element: A literal value or math variable that resolves to “Yes” or “No”. |
If the value is “Yes”, the Activity object is inserted and executed immediately. If the value is “No”, the Activity object is inserted and but not executed. The default value is “No”. |
|
<ClientTypeIdentifiers> |
|
|
|
<ClientTypeIdentifier>
|
|
Optional Repeatable element: |
|
ID |
Required attribute:Text Must match one of the values specified in the ClientTypeIdentifier attribute of TypeCodes. |
||
<ClientType> |
Required and Repeatable element: |
Text Lists the ClientType code to be included in the ClientType dropdown when finding clients and group customers. |
XML Example
<ClientRelationshipScreen>
<PrimaryRelationships>
<PrimaryRelationship TYPECODE=”Contacts” >
<AvailableToClientTypes>
<ClientTypeIdentifier> ClientTypeIdentifier value]</ClientTypeIdentifier>
</AvailableToClientTypes>
<SecondaryRelationships>
<SecondaryRelationship>
<TypeCodes>
<TypeCode VALUE=”10”>
<AvailableToClientTypes>
<ClientTypeIdentifier> ClientTypeIdentifier value]</ClientTypeIdentifier>
</AvailableToClientTypes>
<ClientTypeIdentifiers>
<ClientTypeIdentifier>C</ClientTypeIdentifier>
</ClientTypeIdentifiers>
<Maximum>3<Maximum>
</TypeCode>
</TypeCodes>
<Fields>
<Field>
<Name>AccountNumber</Name>
<Display>Account No.</Display>
<DataType>Text</DataType>
</Field>
</Fields>
</SecondaryRelationship>
<SecondaryRelationship>
<TypeCodes>
<TypeCode VALUE=”30”>
<ClientTypeIdentifiers>
<ClientTypeIdentifier>A</ClientTypeIdentifier>
</ClientTypeIdentifiers>
</TypeCode>
</TypeCodes> <Fields>
<Field>
<Name>RoutingNumber</Name>
<Display>Routing No.</Display>
<DataType>Text</DataType>
</Field>
</Fields>
</SecondaryRelationship>
</SecondaryRelationships>
</PrimaryRelationship>
<PrimaryRelationship TYPECODE=”Employees”>
<SecondaryRelationships>
<SecondaryRelationship>
<TypeCodes>
<TypeCode VALUE=”40”>
<ClientTypeIdentifiers>
<ClientTypeIdentifier>B</ClientTypeIdentifier>
</ClientTypeIdentifiers>
</TypeCode>
</TypeCodes>
<Fields>
<Field>
<Name>AccountNumber</Name>
<Display>Account No.</Display>
<DataType>Text</DataType> </Field>
</Fields>
<Events>
<Event TYPE="ONLOAD">
<ActionSet ID="DisableFields"></ActionSet>
</Event>
</Events>
<ScreenMath>
...
</ScreenMath>
<Actions>
<ActionSet ID="DisableFields">
<Condition IF="PreferenceOne ='Test'">
<Action ACTIONTYPE="DISABLEALL"/>
</Condition>
</ActionSet>
</Actions>
</SecondaryRelationship>
</SecondaryRelationships>
</PrimaryRelationship>
<PrimaryRelationship TYPECODE=”Affiliations”>
<SecondaryRelationships>
<SecondaryRelationship>
<TypeCodes>
<TypeCode VALUE=”50” RELATIONSHIPSTATUS="01,02"></TypeCode>
</TypeCodes>
<Fields>
<Field>
<Name>AccountNumber</Name>
<Display>Account No.</Display>
<DataType>Text</DataType>
</Field>
</Fields>
</SecondaryRelationship>
</SecondaryRelationships>
<Spawns> <Spawn> <Transaction SPAWNCODE="03" FIELD="EffectiveFrom" EXECUTIONDATE="IMMEDIATE">ClientRelationshipUpdate</Transaction> </Spawn> </Spawns>
</PrimaryRelationship>
</PrimaryRelationships>
<Spawns> <Spawn> <Transaction SPAWNCODE="03" FIELD="EffectiveFrom" EXECUTIONDATE="MVDate|DateField|IMMIDIATE"PROCESSIMMEDIATE="Yes|No">ScreenUpdateTransactionName>ClientRelationshipUpdate</Transaction>
</Spawn> </Spawns>
<ClientTypeIdentifiers>
<ClientTypeIdentifier ID=”A”>
<ClientType>01</ClientType>
<ClientType>02</ClientType>
<ClientType>20</ClientType>
</ClientTypeIdentifier>
<ClientTypeIdentifier ID=”B”>
<ClientType>02</ClientType>
<ClientType>30</ClientType>
</ClientTypeIdentifier>
<ClientTypeIdentifier ID=”C”>
<ClientType>08</ClientType>
<ClientType>09</ClientType>
<ClientType>10</ClientType>
</ClientTypeIdentifier>
</ClientTypeIdentifiers>
</ClientRelationshipScreen>