Mnemonic | Description | Valid Values | Comments |
---|---|---|---|
name= | This mnemonic defines the name of the field that needs to be broadcast from other zones or populated in the portal context | FIELD_NAME | |
datasource= | This mnemonic defines the source of the hidden filter's value. 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, the zone appears as per the poprule mnemonic. | 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. | ||
poprule= | This mnemonic controls what happens if the hidden filter is not present. | R | Indicates that a value for the filter is required. The zone will be set to the "empty state" and the "please broadcast" message will appear in the zone. This is the default value. |
O | Indicates that the value is optional. If no value is required, the zone is still built without that value. | ||
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. | FIELD_NAME | Enter a valid field name whose label should be used. 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_CD | Enter a reference to a valid currency code. |
dec= | Defines the number of decimal places when type=NUMBER. | N | 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 admin table name. |
chartype= | Defines the characteristic type code whose values appear when type=CHARTYPE. | CHAR_TYPE_CD | Enter a reference to a valid characteristic type code. |
searchField= | This mnemonic controls the initial population of the filter when the zone is launched as a search from a UI map. | FIELD_NAME | Enter the field name that exactly matches the searchField name specified in the oraSearchField html element in the UI map. |