You are here: Business Rules > Screen Rules > ClientScreen

ClientScreen

Description

This business rule allows the configuration of fixed and dynamic fields on the Client screen. This rule holds an indicator that displays fields appropriate for a corporate or individual entity. A repeatable section defines each Client Type, which is identified by its TYPECODE. This rule is also used to control the address table display.

ClientScreen Element and Attribute Table

Element/Tag	Definition	Attribute	Element/Attribute Value and Description
<ClientScreen>	The opening and closing elements of the screen rule.
<Client>	Required and repeatable element; This element defines the Client Type, Group and ActivityPlan for each Client Type.	TYPECODE	Required attribute; Code: As defined in AsCodeClientType table.
		GROUP	Yes: Displays Group button on the Client screen for the client type.
		ACTIVITYPLAN	String:Any plan name.
<MultiFields>	Optional element; See MultiFields Element.
<FixedFields>	See Fields.
<Fields>	See Fields.
<Events>	See Action/Events section.
<ScreenMath>	See Math Element section.
<Actions>	See Action/Events section.
<DisplayFormat>	Required:		The opening and closing tag for Parts section, which designates Client Fields’ order, alignment, and any symbols or codes for the “finished”, viewable Client Name.
<Part>	Required; Repeatable:		<Part> sub-elements define individual “parts” of the “finished” product, which will be visible in Client Summary table, Client Search Results table, and any other screen or peripheral where Client’s Name may be viewed or passed to. <Part> can only be used for Text Data whether they are in fixed Columns of AsClient Table or AsClientfield table.
	Optional: Delimiter preceding the Fixed Field.	PRE	Comma, Hyphen,/ etc.
	Optional: Delimiter following the Fixed Field.	POST	Comma, Hyphen,/ etc.

XML Example

<ClientScreen>

<Client TYPECODE="02">

<MultiFields RULE="IndividualFields">Yes</MultiFields>

<FixedFields>

<Field>

<Name>FirstName</Name>

<Display>Given Name</Display>

</Field>

<Field>

<Name>MiddleInitial</Name>

<Display>Middle Name</Display>

</Field>

<Field>

<Name>LastName</Name>

<Display>Last Name</Display>

</Field>

<Field>

<Name>TaxID</Name>

<Display>National Identification Number</Display>

</Field>

<Field>

<Name>AlternateName1</Name>

<Display>Name in Kanji</Display>

<Expanded>Yes</Expended>

</Field>

<Field>

<Name>DateOfBirthalternate</Name>

<Display>Imperial Date of Birth</Display>

<DataType FORMAT=”JP_IMP”>Date<DataType>

</Field>

<Field>

<Name>DateOfDeath</Name>

<Display>Date of Death</Display>

<Datatype FORMAT=”JP_IMP”>Date</Datatype>

</Field>

<Field>

<Name>LegalResidenceCountry</Name>

<Display>Legal Residence</Display>

</Field>

</FixedFields>

<Fields>

<Field>

<Name>Line</Name>

<Display></Display>

<DataType>Line</DataType>

</Field>

<Field>

<Name>CountryOfCitizenship</Name>

<Display>Country Of Citizenship</Display>

<DataType>Radio</DataType>

<Query TYPE="FIXED">

<Options>

<Option>

<OptionValue>01</OptionValue>

<OptionText>Japan</OptionText>

</Option>

<Option>

<OptionValue>02</OptionValue>

<OptionText>Other</OptionText>

</Option>

</Options>

</Query>

</Field>

<Field>

<Name>DriverLicenseNumber</Name>

<Display>Driver License Number</Display>

<DataType>Text</DataType>

</Field>

<Field>

<Name>DriverLicenseIssueState</Name>

<Display>Driver License Issue State</Display>

<DataType>Text</DataType>

</Field>

</Fields>

<Events/>

<ScreenMath/>

<Actions/>

<DisplayFormat>

<Part >FirstName</Part>

<Part   PRE=”, “  POST=”,”>MiddleInitial</Part>

<Part  >LastName</Part>

</DisplayFormat>

</Client>

</ClientScreen>