GroupCustomerSearchScreen

The GroupCustomerSearchScreen provides the ability to search for a Group Customer. The search can be configured with multiple search criteria. The user can enter values in any of the defined search criteria.

GroupCustomerSearchScreen: Elements and Attributes
Element/Tag Attributes Parent Element Description Element/Attribute Value

<GroupCustomerSearchScreen>


 

Required:

This is the root element for the GroupCustomerSearchScreen rule.

  

<Filter>

   <GroupCustomerSearchScreen>

Optional:

The filter structure expresses conditions upon which the entity's data will not be displayed to a user. The restrictions are based on the user's SecurityGroup membership and the entity's data values.

  

<Conditions>

   <Filter>

Required, Repeatable:

This structure defines one or more conditions by one or more user SecurityGroups.

  

 

SecurityGroup

 <Conditions>

Required:

The attribute provides a comma-delimited list of Security Group names to associate with the conditional statements contained within this structure. When the user is a member of one of these Security Groups, the conditions are applied to the screen's entity record data to determine their removal from the screen's presentation.

comma-delimited list of security group names.
  Type <Conditions>

Required:

This attribute indicates when the conditions express an exclusion of data from a presentation or an inclusion of data in the presentation.

  • Exclusion

    • The filter will remove the entity record from the screen's presentation when the conditions evaluate to true.

    • The system currently only supports this value.
  Operator <Conditions>

Optional:

The <Conditions> element may contain multiple <Condition> elements. This attribute indicates the relationship between the multiple <Condition> elements. All <Condition> elements apply the same Operator attribute value.

  • AND

    • default

    • All conditionals connected by AND must evaluate to be true for the filter to impact the resulting presentation.

  • OR

    • Any one of the conditionals connected by OR must evaluate to be true for the filter to impact the resulting presentation.

<Condition>

 

 <Conditions>

Required, Repeatable:

The element provides a single condition.

SQL predicate
 

Entity

 <Condition>

Required:

The attribute provides a table name upon which the condition will apply. Tables related to the GroupCustomer are applicable

  • ASGROUPCUSTOMER

  • ASCLIENT

  • ASCLIENTFIELD

  • ASCLIENTRELATIONSHIP

  • ASCLIENTRELATIONSHIPFIELD

 

RelationshipKey

 <Condition>

Optional:

The attribute provides a further definition for the type of Client Relationship being filtered. This attribute is required when the Entity attribute value is ASCLIENTRELATIONSHIP or ASCLIENTRELATIONSHIPFIELD. These tables store ClientGUIDs in PrimaryClientGUID and SecondaryClientGUID columns and this attribute indicates which this filter is based upon.

The attribute will be ignored when the Entity attribute is not ASCLIENTRELATIONSHIP and ASCLIENTRELATIONSHIPFIELD.

  • Primary

  • Secondary

<GroupCustomer>

 

 <GroupCustomerSearchScreen>

Required, Repeatable:

This element provides the definition of the search criteria and result presentation for each group customer client type. GroupCustomers can be defined by more than one Client type. In order to search for all possible types there must be a search definition for each Client type.

  
 

TYPECODE

 <GroupCustomer>

Required:

The attribute provides the client type code that this <GroupCustomer> search structure defines.

  • literal

    • This value must be a code value from AsCodeClientType.

<Search>

 

 

 <GroupCustomer>

Required:

This element structure provides the entry criteria that can filter the group customer data.

  
<Subsections>

 

 <Search>

Required:

This element defines one or more collapsible sections of search criteria.

  
<Subsection>    

Required, Repeatable:

This element defines a single collapsible section. More than one of these sections may be defined.

  
 

TITLE

  

Required:

This attribute gives the section a title on the subsection's header.

literal text

 

 SECTIONNODES  

Optional:

A Section can initially display collapsed or expanded.

  • Collapsed

    • default

    • The subsection is initially collapsed.

  • Expanded

    • The subsections are initially expanded.

<Fields>


<Search>

Required:

This element structure describes the entry criteria.

  

<Field>


<Fields>

Required, Repeatable:

This element structure provides the definition for one search criteria.

  

<Name>


<Field>

Required:

This element provides the name of the column or field that can be searched.

  • literal

    • The literal value must be a field name or a column name.
<Display>   <Field>

Required:

This element provides the label to present with the field entry.

literal
<DataType>   <Field>

Required:

This element provides the data type of the field.

  • Text

  • Integer

  • Decimal

  • Date

  • Combo
<Group>   <Field>

Required:

This element provides the data table where the field or column resides without the AS prefix. The table must be related to the GroupCustomer.

  • GroupCustomer

  • Client

  • ClientField

  • Address

  • AddressField
<Query>   <Field>

Optional:

This element provides definition to populate the options for combo boxes.

  • complete SQL statement

    • The SQL statement must return a key/value pair where a selected key represents the field's value and the value is the text displayed to the user.

    • This is required when the TYPE attribute is SQL.

  • no value

    • When the TYPE attribute is FIXED, this element becomes a containing structure holding the definition of multiple options.
  TYPE <Query>

Required:

This attribute indicates a method to obtain key/value data pairs for the options population.

  • SQL

    • A SQL query is executed to return data.

  • FIXED

    • This element contains a structure that defines the key/value pairs for the options population.

    • With this value, the <Options> element is required.
<Options>   <Query>

Optional:

This element is a structure that provides the key/value pairs for the options population. This structure is required when the TYPE attribute is FIXED.

  
<Option>   <Options>

Required, Repeatable:

This element contains the key/value pair.

  
<OptionValue>   <Option>

Required:

This element is a single key and becomes the field's value after user selection.

literal
<OptionText>    

Required:

This element is a single value associated to a single key. This value is displayed to the user.

literal
<Results>   <GroupCustomer>

Required:

This element defines the presentation of results from processing the search criteria.

  
<Table>   <Results>

Required:

The results of this rule are presented in a table format.

  
<Column>   <Table>

Required, Repeatable:

This element describes a column in the result table. It is repeated for each column.

  
  ALIGN <Column>

Optional:

This attribute defines how the data is positioned in the column.

  • LEFT

    • default

  • RIGHT

  • CENTER
<Name>   <Column>

Required:

This element provides a reference to the column or field name in the data source whose value will be displayed in the result column. The value of the element is dependent on the database table referenced by the <Group> element.

  • literal

    • a database column name or a field name in an entity's related FIELD database table.

  • Name

    • Client data provides a composite Name field defined by the Client's <DisplayFormat> definition.

    • This is only applicable when <Group> is Client.

  • Address

    • Address data provides a composite Address field defined by the Address' <DisplayFormat> definition

    • This is only applicable when <Group> is Address.
<Display>   <Column>

Required:

This element provides the column's header text. The header text can be translated to other languages.

literal
<DataType>   <Column>

Required:

This element provides the datatype of the value that is to be presented.

  • Text

  • Date

  • Integer

  • Decimal
<Group>   <Column>

Required:

This element provides the table name where the column or field name can be found.

  • GroupCustomer

  • Client

  • ClientField

  • Address

  • AddressField
<OrderBy>   <Column>

Optional, Repeatable:

This element's structure defines the attributes for ordering the result data. The structure is repeated when the data source is a composite of multiple columns from a single entity. Only the columns needed to sort the data in the desired order should have an <OrderBy> element.

  
  ORDINAL <OrderBy>

Required:

This attribute provides the priority of the column's data within a composite order structure involving multiple columns. The lower the number the higher the priority. Within the same <Results> table, no two columns should have the same ORDINAL value.

literal integer value
  ORDER <OrderBy>

Optional:

This attribute provides the direction of the order with respect to the value of each column's ORDINAL attribute.

  • ASCENDING

    • default

    • Sorts data from a lower value to a higher value.

  • DESCENDING

    • Sorts data from a higher value to a lower value.
  COLUMN <OrderBy>

Optional:

This attribute provides the elemental data of a composite data source. This is only applicable when <Name> is Address from the Address table or <Name> is Name from the Client table.

column name

XML Schema

<GroupCustomerSearchScreen>
    <Filter>
        <Conditions SecurityGroup="[list]" Type="[Exclusion]" Operator="[AND | OR]">
            <Condition Entity="[ASGROUPCUSTOMER | ASCLIENT | ASCLIENTFIELD]">[sql predicate]</Condition>
            <Condition Entity="[ASCLIENTRELATIONSHIP | ASCLIENTRELATIONSHIPFIELD]" RelationshipKey="[Primary | Secondary]">[sql predicate]</Condition>
            <Condition>...</Condition>
        </Conditions>
        <Conditions>...</Conditions>
    </Filter>
    <GroupCustomer TYPECODE="[literal]">
        <Search>
            <Subsections>
                <Subsection TITLE="[literal]" SECTIONNODES="[Collapsed | Expanded]">
                    <Fields>
                        <Field>
                            <Name>[name]</Name>
                            <Display>[literal]</Display>
                            <DataType>[Text | Integer | Decimal | Date]</DataType>
                            <Group>[GroupCustomer | Client | ClientField | Address | AddressField]</Group>
                        </Field>
                        <Field>
                            <Name>[name]</Name>
                            <Display>[literal]</Display>
                            <DataType>Combo</DataType>
                            <Group>[GroupCustomer | Client | ClientField | Address | AddressField]</Group>
                            <Query TYPE="FIXED">
                                <Options>
                                    <Option>
                                        <OptionValue>[literal]</OptionValue>
                                        <OptionText>[literal]</OptionText>
                                    </Option>
                                    <Option>...</Option>
                                </Options>
                            </Query>
                        </Field>
                        <Field>
                            <Name>[name]</Name>
                            <Display>[literal]</Display>
                            <DataType>Combo</DataType>
                            <Group>[GroupCustomer | Client | ClientField | Address | AddressField]</Group>
                            <Query TYPE="SQL">[SQL statement]</Query>
                        </Field>
                        <Field>...</Field>
                    </Fields>
                </Subsection>
                <Subsection>...</Subsection>
            </Subsections>
        </Search>
        <Results>
            <Table>
                <Column ALIGN="[LEFT | RIGHT | CENTER]">
                    <Name>[literal]</Name>
                    <Display>[literal]</Display>
                    <DataType>[Text | Date | Integer | Decimal]</DataType>
                    <Group>[GroupCustomer | Client | ClientField | Address | AddressField]</Group>
                    <OrderBy ORDINAL="[integer]" ORDER="[ASCENDING | DESCENDING]"/>
                </Column>
                <Column ALIGN="[LEFT | RIGHT | CENTER]">
                    <Name>[Name | Address]</Name>
                    <Display>[literal]</Display>
                    <DataType>Text</DataType>
                    <Group>[Client | Address]</Group>
                    <OrderBy ORDINAL="[integer]" ORDER="[ASCENDING | DESCENDING]" COLUMN="[name]"/>
                </Column>
                <Column>...</Column>
            </Table>
        </Results>
    </GroupCustomer>
    <GroupCustomer>...</GroupCustomer>
</GroupCustomerSearchScreen>

XML Example

<GroupCustomerSearchScreen>
    <Filter>
        <Conditions SecurityGroup="AlamereGroupSuper,AlamereTest" Type="Exclusion" Operator="AND">
            <Condition Entity="ASCLIENT">Fieldname = 'Employee' and TextValue = 'GuideStone'</Condition>
        </Conditions>
    </Filter>
    <GroupCustomer TYPECODE="20">
        <Search>
            <Subsections>
                <Subsection TITLE="Search Criteria" SECTIONNODES="Expanded">
                    <Fields>
                        <Field>
                            <Name>CompanyName</Name>
                            <Display>Group Customer Name</Display>
                            <Group>GroupCustomer</Group>
                            <DataType>Text</DataType>
                        </Field>
                        <Field>
                            <Name>TaxID</Name>
                            <Display>TIN</Display>
                            <Group>Client</Group>
                            <DataType>Text</DataType>
                        </Field>
                    </Fields>
                </Subsection>
            </Subsections>
        </Search>
        <Results>
            <Table>
                <Column ALIGN="LEFT">
                    <Display>First Name</Display>
                    <Name>FirstName</Name>
                    <Group>Client</Group>
                    <DataType>Text</DataType>
                    <OrderBy ORDINAL="1" ORDER="DESCENDING"/>
                </Column>
                <Column ALIGN="LEFT">
                    <Display>Last Name</Display>
                    <Name>LastName</Name>
                    <Group>Client</Group>
                    <DataType>Text</DataType>
                    <OrderBy ORDINAL="2" ORDER="DESCENDING"/>
                </Column>
                <Column ALIGN="LEFT">
                    <Display>Address</Display>
                    <Name>Address</Name>
                    <Group>Address</Group>
                    <DataType>Text</DataType>
                    <OrderBy ORDINAL="3" ORDER="DESCENDING" COLUMN="AddressLine1"/>
                    <OrderBy ORDINAL="4" ORDER="DESCENDING" COLUMN="AddressLine2"/>
                </Column>
            </Table>
        </Results>
    </GroupCustomer>
</GroupCustomerSearchScreen>