SuspenseSearchScreen
This rule is used to configure the suspense search criteria and suspense results sections of the Suspense Search screen. Fields from AsSuspense and AsSuspenseField tables can be used as the suspense search criteria, based on specific suspense records in the database. This can be searched in the database.
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.
Element/Tag | Definition | Attribute | Element/Attribute Value and Description |
---|---|---|---|
<SuspenseSearchScreen> |
The opening and closing tag for the business rule. |
|
|
<Filter> | |||
<Conditions> |
Exclusion condition definition:
|
SecurityGroup |
Comma separated security group names:
|
<Condition> | Repeatable |
ENTITY RELATIONSHIPKEY |
Specifies the table to be used for the filter. Only requied when ENITITY is CLIENTRELATIONSHIP OR CLIENTRELATIONSHIPFIELD. Should be set to either Primary or Secondary |
Repeatable |
Specifies the field name to be used. For the main tables, this would be the column name. For Field tables this would be the field name. |
||
Specifies the value to search on the attribute should correspond to the datatype of the field: TextValue/ IntValue/ FloatValue/ DateValue |
|||
<FixedFields> |
This tag is used to specify the configuration of the static fields (from AsSuspense table) in the SuspenseSeach criteria section. See Fields Element. |
|
|
<Fields> |
The <Fields> tag is used to specify the configuration of the dynamic fields (from AsSuspenseField table) in the SuspenseSearch Criteria section. See Fields Element. |
|
|
<Field> |
The opening and closing tag for each field being configured. |
|
|
<Results> |
Optional Element: This section specifies what should be displayed as the result of a search. This section follows the standard <Table> structure and configuration. If this element is absent from the configuration, the search results will display in the default format. |
|
|
<Table> |
Required Element: This section controls the formatting of the Results section of the Suspense Search screen. It is required if the <Results> element is present in the configuration. See the Table Element page for more information on configuring tables. |
|
|
<Column> |
Repeatable Element: This section defines the formatting of a column within the Results table, and contains child elements that define the content of the column. This element can be repeated as many times as is necessary—the Results section of the screen will automatically generate a horizontal scroll bar to accommodate more columns than would otherwise fit in the screen. |
|
|
ALIGN |
Left: The column will align to the left. Right: The column will align to the right. Center: The column will be centered. |
||
<Name> |
This element specifies the name of the database column from which the data should be pulled.
|
|
The name of the database column from which the data should be pulled. Name of a column from AsSuspense or AsSuspenseField. This new value returns a system calculated result of the Suspense Amount column less the AttachedAmount column from AsSuspense. The currency displayed is the currency code of the suspense record. Value "Available Amount" Examples: SuspenseNumber EffectiveDate FirstName LastName Available Amount Note:Name of a column from AsSuspense or AsSuspenseField. This new value returns a system calculated result of the Suspense Amount column less the AttachedAmount column from AsSuspense. |
<Display> |
This element specifies the display name of the column. |
|
The name of the column as it should be displayed in the Results table. |
<Group> | This element specifies the name of the database table from which the data should be pulled. |
Suspense: Data will be pulled from AsSuspense fixed fields. SuspenseField: Data will be pulled from AsSuspenseField dynamic fields. |
|
<DataType> | This element specifies the datatype of the column. | The datatype of the column. |
XML Example
<SuspenseSearchScreen>
<Filter>
<Conditions SecurityGroup = "AlamereGroupSuper,AlamereTest" type ="Exclusion" Operator = "AND" >
<Condition Entity = "ASSUSPENSEFIELD">Fieldname = 'Employee' and TextValue = 'GuideStone'</Condition>
</Conditions>
</Filter>
<FixedFields />
<Fields />
<Results>
<Table>
<Column ALIGN="[RIGHT/LEFT]">
<Name>AvailableAmount</Name>
</Column>
</Table>
</Results>
</SuspenseSearchScreen>
XML Schema
<SuspenseSearchScreen>
<FixedFields>
<Field>
<Name></Name>
<Display></Display>
<DataType></DataType>
<Hidden></Hidden>
</Field>
</FixedFields>
<Fields>
<Field>
<Name></Name>
<Display></Display>
<DataType></DataType>
<Hidden></Hidden>
</Field>
</Fields>
<Results>
<Table>
<Column>
<Name></Name>
<Display></Display>
<Group>Suspense|SuspenseField</Group>
<DataType></DataType>
</Column>
</Table>
</Results>
</SuspenseSearchScreen>