You are here: Business Rules > Screen Rules > ClientSearchScreen

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.

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: Code from AsCodeClientType.
<Client>		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.
<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>
<Actions>	See Action/Events section.
<Events>	See Action/Events section.
<ScreenMath>	See Math Element section.
<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.

ClientSearchScreen Image

Client Search Screen with type highlighted

XML Example

<ClientSearchScreen>

<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 WIDTH="200" ALIGN="CENTER">
                <Display>TIN</Display>
                <Name>TaxId</Name>
                <DataType>Text</DataType>
                <Group>Client</Group>
            </Column>
            <Column WIDTH="200" ALIGN="CENTER">
                <Display>CompanyName</Display>
                <Name>CompanyName</Name>
                <DataType>Text</DataType>
                <Group>Client</Group>
            </Column>
            <Column WIDTH="200" ALIGN="CENTER">
                <Display>First Name</Display>
                <Name>FirstName</Name>
                <DataType>Text</DataType>
                <Group>Client</Group>
            </Column>
            <Column WIDTH="100" ALIGN="CENTER">
                <Display>City</Display>
                <Name>City</Name>
                <DataType>Text</DataType>
                <Group ROLECODE="06">Address</Group>
            </Column>
        </Table>
    </Results>
</Client>

</ClientSearchScreen>

Schema Example

<ClientSearchScreen>

<Client TYPECODE="" TYPE="">

<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 WIDTH="" ALIGN="" FORMAT="">
             <Display></Display>
             <Name></Name>
             <DataType></DataType>
             <Group></Group>
         </Column>
         <Column WIDTH="" ALIGN="">
             <Display></Display>
             <Name></Name>
             <DataType></DataType>
             <Group ROLECODE=""></Group>
         </Column>
     </Table>
</Results>

</Client>

</ClientSearchScreen>