ClientSearchScreen

Description

This business rule allows a user-initiated client search by any data column in AsClient. The search results are also configurable and will display in a table format. 

Note: External clients are displayed in one of two ways:

Both the search criteria (Fields & FixedFields) and results (Columns) will accept mask attributes in the DataType elements. Refer to the Fields and Tables sections to see mask attribute configuration.

ClientSearchScreen Element/Attribute Table

Element/Tag

Definition

Attribute

Element/Attribute Value and Description

<ClientSearchScreen>

The required opening and closing tags.

 

 

<Client>

Required, Repeatable Element:.  Indicates the opening of the Client field descriptions and related values. Used to search for different types of clients specified in the TypeCode attribute.

In addition, it also allows for the ability to search external clients from within the Client Search screen and perform actions on that external client like any other client type.

TYPECODE

Required Attribute:
Code: As defined in AsCodeClientType in AsCode table.

 

TYPE

"External" Indicates if the type of client is external, the client search will be performed on an outside data source. Retrieves external client info from another system through a real-time web service from within the existing client search screen.

EXTERNAL

Optional:

Defines the client type as an external client. The only value supported is "Yes".

Yes

If the attribute is omitted, the default is No.

<ExternalClientSearchRetriever>

 

Optional:

Specifies the class used in the client search for role assignments to populate the result grid. Required if EXTERNAL=“Yes” and existing Client Search Screen is used.

The name of a class that has been created to implement the external client search.

<Search>

Required and Repeatable Element:
Indicates and defines search criteria and the fields to be included as part of the Client Search screen activity.

 

 

<Fields>

 

 

 

<Results>

Required:

Defines the results. This element provides the return of the search and the data in the Results override the fixed fields.

 

 

<Table>

Controls formatting of results display. See Table Element section.

 

 

Additional Common Fields Available for Configuration

Because client screens are often required to hold a wide range of information not displayed on any other screens in OIPA, they have a number of configurable fields not available to other screens. The following chart summarizes these fields, their configurability and their behavior.

  Hidden if not Configured Able to be Disabled Able to be Renamed OnChange Generator Can Generate Errors OnChange/OnLoad/OnSubmit Receiver
TypeCode     x1      
CompanyName x x x x x x
LastName x x x x x x
FirstName x x x x x x
MiddleInitial x x x x x x
AlternateName1 x x x x x x
AlternateName2 x x x x x x
AlternateName3 x x x x x x
AlternateName4 x x x x x x
AlternateName5 x x x x x x
Prefix2 x x x x x x
Suffix2 x x x x x x
AdditionalPrefix x x x x x x
AdditionalSuffix x x x x x x
Title2 x x x x x x
Sex x x x x x x
MaritalStatus3 x x x x x x
DateOfBirth x x x x x x
DateOfDeath x x x x x x
TaxIDType2 x x x x x x
TaxID x x x x x x
Email x x x x x x
BirthCountryCode2 x x x x x x
CitizenshipCountryCode2 x x x x x x
BirthRegionCode2 x x x x x x
PrimaryPhone x x x x x x
TextField1 x x x x x x
TextField2 x x x x x x
CheckBox1 x x x x x x
CheckBox2 x x x x x x
Radio1 x x x x x x
Radio2 x x x x x x
Combo12 x x x x x x
Combo22 x x x x x x

Date1

x x x x x x
Date2 x x x x x x
LegalResidenceCountryCode     x1      

1 TypeCode and LegalResidenceCountryCode can only be renamed by using system translation keys.

2 These fixed fields are drop-down fields that will derive their values from their corresponding code names.

3 Marital Status will be a radio field.

XML Example

<ClientSearchScreen>
<Client TYPECODE="90" EXTERNAL="Yes">
<ExternalClientSearchRetriever>com.adminserver.web.ASWebappClassLoader</ExternalClientSearchRetriever>
<Search>
<Fields>
<Field>
<Name>Name</Name>
<Display>Name</Display>
<DataType>Text</DataType>
<Group>Client</Group>
<InitialFocus>Yes</InitialFocus>
</Field>
</Fields>
</Search>
<Results DEFAULTRESULTS="Yes">
<Table>
<Column WIDTH="150" ALIGN="LEFT">
<Display>Name</Display>
<Name>Name</Name>
<Group>Client</Group>
<DataType>Text</DataType>
</Column>
<Column WIDTH="250" ALIGN="LEFT">
<Display>Address</Display>
<Name>Address</Name>
<Group>Address</Group>
<DataType>Text</DataType>
</Column>
</Table>
</Results>
</Client>
<Client TYPECODE="*">  
<Search>   
<Fields> 
<Field> 
<Name>FirstName</Name>  
<Display>First Name</Display>
<DataType>Text</DataType>
<Group>Client</Group>
</Field> 
<Field>
<Name>LastName</Name>
<Display>Last Name</Display>
<DataType>Text</DataType>
<Group>Client</Group>
</Field>
<Field>
<Name>CompanyName</Name>
<Display>Company Name</Display>
<DataType>Text</DataType>
<Group>Client</Group>
</Field>
</Fields>
</Search>
<Results>
<Table NAME="CLIENT">
<Column ALIGN="CENTER">
<Display>TIN</Display>
<Name>TaxId</Name>
<DataType>Text</DataType>
<Group>Client</Group>
</Column>
<Column ALIGN="CENTER">
<Display>Company Name</Display>
<Name>CompanyName</Name>
<DataType>Text</DataType>
<Group>Client</Group>
</Column>
<Column ALIGN="CENTER">
<Display>First Name</Display>
<Name>FirstName</Name>
<DataType>Text</DataType>
<Group>Client</Group>
</Column>
<Column ALIGN="CENTER">
<Display>City</Display>
<Name>City</Name>
<DataType>Text</DataType>
<Group ROLECODE="06">Address</Group>
</Column>
</Table>
</Results>
</Client> 
</ClientSearchScreen>

XML Schema

<ClientSearchScreen>  
<Client TYPECODE="" TYPE="" EXTERNAL="[Yes|No]">
<ExternalClientSearchRetriever>[client search class loader]</ExternalClientSearchRetriever>
<Search>   
<Fields>    
<Field>  
<Name></Name>   
<Display></Display>   
<Group></Group>   
<DataType></DataType>   
</Field>  
<Field>  
<Name></Name>   
<Display></Display>   
<DataType></DataType>   
<Group ROLECODE=""></Group>  
</Field>
</Fields>  
</Search> 
<Results>
<Table NAME="CLIENT">
<Column ALIGN="" FORMAT="">
<Display></Display>
<Name></Name>
<DataType></DataType>
<Group></Group>
</Column>
<Column ALIGN="">
<Display></Display>
<Name></Name>
<DataType></DataType>
<Group ROLECODE=""></Group>
</Column>
</Table>
</Results>
</Client>   
</ClientSearchScreen>