DisbursementSearchScreen

This business rule is used to configure the dynamic fields in the DisbursementSearchScreen to allow the user to search for disbursement records that match the specified criteria. If the DisbursementSearchScreen business rule is not used the Above the line Fields (FixedFields) will be displayed by default and used for searches. For example Company, Plan, Start Date and End Date will be displayed.

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

Important: DisbursementScreen and DisbursementSearchScreen business rules together constitute the Disbursement screen. Configuration for the Disbursement Search section is done in the DisbursementSearchScreen business rule whereas the configuration for the Disbursement details section is done in the DisbursementScreen business rule.

Note: On the results table the first Column DisbursementNumber and last column DisburementAmount WILL NOT BE Configurable.

DisbursementSearchScreen: Elements and Attributes
Element	Attributes	Parent Element	Description	Element/Attribute Value
<DisbursementSearchScreen>			The required opening and closing elements of this business rule.
<Results>		<DisbursementSearchScreen>	This element defines the tabular display of the searched data that are returned. Optional Element: This section specifies what should be displayed as the result of a search. The container element for the configuration of the results section of the screen. If this element is absent from the configuration, the search results will display in the default format. This section follows the standard <Table> structure and configuration.
<Table>		<Results>	Required Element: The element defines the screen in a table format and controls the display of results, formats results in the table. This section controls the formatting of the Results section of the Disbursement Search screen. It is a required element, if the <Results> element is present in the configuration. See the Table Element page for more information on configuring tables.
	ALIGN	<Column>	Optional attribute: The container element for column configuration. This element defines the width of columns in the results table, the alignment of the column's data and the format of the column's data. Specifies if the column should be displayed in the results table. ALIGN: Defines the data alignment of the column (Case-insensitive).	Left: The information in the column will be left-aligned. Right: The information in the column will be right-aligned. Center: The information in the column will be centered.
	FORMAT	<Column>	Allows formatting of data.	Text: The information in the column will be formatted as simple text. Money: The information in the column will be formatted as currency. Date: The information in the column will be formatted as a date.
	WIDTH	<Column>	Optional Attribute: Defines the column width of the table and the number of characters that can be displayed in the specified column.	Integer
<Display>		<Column>	Defines the header for the search 'Results Table' columns. This is a Translatable element.	Literal
<Name>		<Column>	Specifies the database column name or field name in which the field values are stored.	Literal Column Name or Literal Field Name
<Group>		<Column>	Optional: Indicates the table that stores the field being referenced. The value used should be appropriate for the screen being configured.	The list of relevant table names: GroupCustomer, Company, CompanyField, Policy, PolicyField, Client, ClientField, Disbursement and DisbursementField
<DataType>		<Column>	Defines the datatype of the field.	DATE DECIMAL INTEGER TEXT, and MONEY
	MASK	<DataType>	Optional: Used to specify the mask that will validate and format the field data for display purposes.	Any mask name that has been defined.

XML Schema

<DisbursementSearchScreen>
            <Fields>
                <Field>
                . . .
                </Field>
                <Field>
                    <Name>[literal field name]</Name>
                    <Display>[literal]</Display>
                    <DataType>[literal]</DataType>
                    <Group>[entity]</Group>
                    <Query TYPE="[SQL|FIXED]">
                </Field>
            </Fields>
    <Results>
        <Table>
            <Column WIDTH="[Column width]" ALIGN="[Left|Right|Center]" FORMAT="[Text|Money|Date]">
                <Name>[literal Column name]</Name>
                <Display>[literal]</Display>
                <Group>[entity]</Group>
                <DataType>[Text | Integer | Date | Decimal | Money]</DataType>
            </Column>
            <Column WIDTH="[Column width]" ALIGN="[Left|Right|Center]" FORMAT="[Text|Money|Date]">
                <Name>[Column name]</Name>
                <Display>[Column display name]</Display>
                <Group>[Group name]</Group>
                <OrderBy ORDINAL="[integer]" ORDER="[ASCENDING | DESCENDING]" COLUMN="[name]"></OrderBy> <!-- The usage of <OrderBy> element is being investigated by development team, and a discussion is due with their findings. If there is no agreement, then this element will be removed from config. -->    
            <DataType MASK="[mask name]">[Text | Integer | Date | Decimal | Money]</DataType>
            </Column>
            <Column>
            ...
            </Column>
        </Table>
    </Results>
</DisbursementSearchScreen>

XML Example

<DisbursementSearchScreen>  
        <Fields>
            <Field>
                <Name>TotalFederalWithholding</Name>
                <Display>Total Federal Withholding</Display>
                <Group>DisbursementField</Group>
                <DataType>Decimal</DataType>
            </Field>
            <Field>
                <Name>StatusCode</Name>
                <Display>Approval Code</Display>
                <Group>DisbursementApproval</Group>
                <DataType>Combo</DataType>
                <Query TYPE="SQL">SELECT '', '', 1 FROM DUAL UNION SELECT CodeValue, ShortDescription, 2 FROM AsCode WHERE CodeName = 'AsCodeDisbursementApproval' ORDER BY 3</Query>
            </Field>
            <Field>
                <Name>DisbursementNumber</Name>
                <Display>Disbursement Number</Display>
                <Group>Disbursement</Group>
                <DataType>Text</DataType>
            </Field>
            <Field>
                <Name>DisbursementTypeCode</Name>
                <Display>Type Code</Display>
                <Group>Disbursement</Group>
                <DataType>Combo</DataType>
                <Query TYPE="SQL">SELECT '', '', 1 FROM DUAL UNION SELECT CodeValue, ShortDescription, 2 FROM AsCode WHERE CodeName = 'AsCodeDisbursementType' ORDER BY 3</Query>
            </Field>
            <Field>
                <Name>PolicyNumber</Name>
                <Display>Policy Number</Display>
                <Group>Policy</Group>
                <DataType>Text</DataType>
            </Field>
            <Field>
                <Name>TransactionName</Name>
                <Display>Transaction Name</Display>
                <Group>Transaction</Group>
                <DataType>Combo</DataType>
                <Query TYPE="SQL">SELECT TempTable.OptionValue,TempTable.OptionText FROM ( SELECT null OptionValue, null OptionText, 1 OrderVal FROM DUAL UNION SELECT TransactionName, TransactionName, 2 FROM AsTransaction JOIN AsActivity ON AsTransaction.TransactionGUID=AsActivity.TransactionGUID JOIN AsDisbursement ON AsActivity.ActivityGUID=AsDisbursement.ActivityGUID) TempTable ORDER BY OrderVal, OptionValue</Query>
            </Field>
            <Field>
                <Name>DisbursementAmount</Name>
                <Display>Disbursement Amount</Display>
                <Group>Disbursement</Group>
                <DataType>Money</DataType>
            </Field>
        </Fields>
    <Results>
        <Table>
                <Column ALIGN="LEFT">
                    <Display>PolicyNumber</Display>
                    <Name>Policy Number</Name>
                    <Group>Policy</Group>
                    <DataType>Text</DataType>
                </Column>
                <Column ALIGN="LEFT">
                    <Display>TransactionGUID</Display>
                    <Name>Transaction</Name>
                    <Group>Activity</Group>
                    <DataType>Text</DataType>
                </Column>
                <Column ALIGN="LEFT">
                    <Display>PolicyStatus</Display>
                    <Name>Address</Name>
                    <Group>Policy</Group>
                    <DataType>Text</DataType>
                </Column>
                <Column ALIGN="LEFT">
                    <Display>EffectiveDate</Display>
                    <Name>Date</Name>
                    <Group>Policy</Group>
                    <DataType>Text</DataType>
                </Column>
            </Table>
    </Results>
</DisbursementSearchScreen>