ClientSearchScreen

The required opening and closing tags.

Exclusion condition definition:

• Type
• Operator

Comma separated security group names:

• Exclusion
• And
• Or

Repeatable

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

Optional:

Identifies configurable events for the rule.

Required, Repeatable:
Identifies a specific event. There is no practical need for multiple <Event> elements as there is only one event applicable in this rule.

ONLOAD

Required:

This attribute indicates the screen's state that may trigger a configurable action. The only applicable type is ONLOAD. Other types cause a system exception.

Optional, Repeatable:

This element identifies a <Math> section that to be executed for the <Event> trigger. There is no practical need to have multiple <Math> sections under <ScreenMath>.

literal

Required:

The attribute identifes the <Math> section that to be executed upon the <Event> trigger. The value is the name of a defined<Math> element under the <ScreenMath> section.

Required, Repeatable:

This element identifies an <Action> to be executed by the <Event>. There is no practical need to define multiple <QuerySet> elements.

literal

Required:

This attribute identifies the <Action>, by its ID attribute, to execute for the <Event> trigger.

TypeCode

Required:

This attribute identifies the field that to be populated with the values returned by the <Action>. There is only one field that may be updated by <Events> in this rule.

Optional:

OIPA's common screen math functionality with access to the extended activity/transaction context.

Required, Repeatable:

This provides a section of configured logic that establishes variables for use in the associated <Actions> element. There is no practical use for repeating the element in this rule.

literal

Required:

Provides a name for the Math section. Access to the <Math>'s variables require prefixing the <Math>'s name.

Yes, No

Optional:

Allows the variables in the <Math> section to be visible throughout the rule in all Client Type configuration. Applicable values are Yes and No. The default value is No. If multiple <Math> elements have GLOBAL="Yes", only the first defined element gets executed.

Optional:

A section to contain actions that may be performed by the triggered <Event>s on this screen.

Required, Repeatable:

This element's definition results in the data that will populate the field identified by the <Event>'s attribute.

literal

Required:

Provides a name for the QuerySet.

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.

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

Optional:

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

If the attribute is omitted, the default is No.

"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.

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

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.

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

Required:

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

Controls formatting of results display. See Table Element section.

The container element for column configuration.

Defines the header for the search result table column.

Specifies the database column in which the field values are stored.

Indicates the table/screen that stores the field being referenced. The value used should be appropriate for the screen being configured.

The name of the database table that holds the relevant records.

Examples:

Activity
ActivityField
Address
AddressField
Client
ClientField
ClientGroupField
DisbursementApproval
Disbursement
DisbursementField
Organization
Person
Policy
PolicyField
Program
ProgramField
Requirement
RequirementDefinition
Role
RoleField
Segment
SegmentName
SegmentField
Transaction

String

Defines the datatype of the field.

Optional:

Used to specify the mask that will validate and format the field data for display purposes.

Any mask name that has been defined.

Optional, repeatable element:

Specifies a structure to define an ordering ability to the data in the table.

This element is repeatable only when the <Name> element has a value of "Name" and the <Group> element has a value of "Client," or when the <Name> element has a value of "Address" and the <Group> element has a value of "Address."

Required attribute:

Specifies priority of the column among the columns being sorted.

An integer indicating the sort order of the column.

Optional attribute:

Specifies the direction of the sort with respect to the value of each column's ORDINAL attribute.

ASCENDING: The columns will sort in ascending order. This is the default value.

DESCENDING: The columns will sort in descending order.