User Filters

name=

This mnemonic is used if the zone's filter should be pre-populated with a value from global context, portal context or broadcast from another zone.

MD Field Name

datasource=

This mnemonic defines the source of the filter's pre-populated value defined in the name mnemonic.

If this mnemonic is left blank, the default behavior is as follows:

- If the field has been broadcast from another zone, the broadcast value is used.

- If no value is broadcast, the portal context is checked to determine if this field exists (if so, its value is taken).

- If still no value, the global context is checked.

- If still no value, no default value is shown.

G

Indicates that the zone should look for the filter value in global context.

P

Indicates that the zone should look for the filter value in portal context.

D

Indicates that the zone should look for the filter value in the page data model.

type=

Defines the visual metaphor used to capture the filter values.

DATE

Filters of this type capture a date.

DATE/TIME

Filters of this type capture a date and time.

STRING

Filters of this type capture a string

MONEY

Filters of this type capture a monetary field. This type of filter must also reference the cur mnemonic.

NUMBER

Filters of this type capture a numeric field. This type of filter may also reference the decimals mnemonic.

LOOKUP

Filters of this type capture a lookup value. This type of filter must also reference the lookup mnemonic.

TABLE

Filters of this type capture an administrative table's value (code and description). This type of filter must also reference the table mnemonic.

CHARTYPE

Filters of this type capture predefined characteristic values for a characteristic type (code and description). This type of filter must also reference the chartype mnemonic.

ASIS

Filters of this type capture a list of values to be referenced within an 'IN' clause within the SQL statement.

label=

Defines the filter's label that appears in the zone's description bar and in the input area.

MD Field Name

Enter a valid field name whose label should be used for the filter label. This should always be the option used if multiple languages are needed.

'text'

Defines the text directly.

cur=

Defines the currency code applied when type=MONEY.

Currency Code

Enter a reference to a valid currency code.

dec=

Defines the number of decimal places when type=NUMBER.

Valid number

It is optional. If provided it should be an integer. If not provided, the number of decimals will default to the number of decimal places defined on the currency code specified on the installation record.

lookup=

Defines the lookup flag whose values appear when type=LOOKUP.

Lookup Field Name

Enter a reference to a valid lookup field name.

table=

Defines the admin table whose values appear when type=TABLE.

Table Name

Enter a reference to a valid control table name.

chartype=

Defines the characteristic type code whose values appear when type=CHARTYPE.

Char Type code

Enter a reference to a valid characteristic type code.

xpath=

This mnemonic is used in conjunction with a Filter Area UI Map. For each filter, you must specify the XPath to the corresponding UI map schema element.

XPath

The type= mnemonic must also be appropriate for the map's input field, otherwise the query's SQL could fail.

likeable=

This mnemonic defines if a likeable search is performed on the entered value when type=STRING.

S

The query will add % to the suffix of the filter value.

P

The query will add % to the prefix of the filter value.

PS

The query will add % to the prefix and suffix of the filter value.

divide=

The mnemonic controls if a divider line appears above and/or below the filter.

Note, you can specify this parameter twice if you want divider lines placed above and below a filter, e.g., divide=above divide=below.

above

This results in a divider line placed above the filter.

below

This results in a divider line placed below the filter.

searchField=

This mnemonic controls the initial population of the filter when the zone is launched as a search from a UI map.

MD Field Name

Enter the field name that exactly matches the searchField name specified in the oraSearchField HTML element in the UI map.

encrypt=

This mnemonic defines if the user filter is encrypted and needs to be searched by hashed value.

[TBL_​NAME,FLD_​NAME,WHERE_​FLD,WHERE_​VALUE]

A valid table name and field name are required.

The WHERE_​FLD and WHERE_​VALUE are optional, but if entered, both are required. Use this to only encrypt the field if another field has a certain value. The following is an example.

encrypt=[CI_​PERSON,PER_​ID_​NBR,ID_​TYPE_​NBR,'SSN']. The WHERE_​VALUE may also reference another filter. The following is an example.

encrypt=[CI_​PERSON,PER_​ID_​NBR,ID_​TYPE_​NBR,F1].