Zone Action

type=

This mnemonic defines the appearance of the action in the zone header.

LINK

Indicates that the action is shown as a textual hyperlink.

ICON

Indicates that the action is shown as a graphical icon.

BUTTON

Indicates that the action is shown as an HTML button.

ASIS

Indicates that the parameter will provide the HTML to be used for the action.

action=

This mnemonic defines the action to take when the link/icon/button is clicked. This is ignored when the type=ASIS.

NAVIGATION

Indicates that the action is navigation to a page.

SCRIPT

Indicates that the action is to run a BPA script.

navopt=

Defines the navigation option to use when the action=NAVIGATION.

'NAV_​OPT_​CD'

Enter a reference to a valid navigation option in single quotes.

bpa=

Defines the script to run when the action=SCRIPT.

'SCRIPT_​CD'

Enter a reference to a valid BPA script in single quotes.

icon=

Indicates the icon to use when type=ICON.

DISP_​ICON_​CD

Enter a reference to a valid display icon.

'path'

Enter an explicit path to the icon, for example 'images/gotoZone.gif'.

asis=

This is required when the type=ASIS. This provides the ability to precisely define the HTML you wish to have included in the header. All valid HTML is permitted including the use of "ora" css classes and JavaScript functions.

['HTML']

label=

By default, the label or tooltip will come from the navigation option or BPA script description. Use this mnemonic to override that label.

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'

Enter the text directly in single quotes.

context=[target1=source1 target2=source2]

This is used to pass context data when navigating to a page or executing a BPA script. The mnemonic supports passing multiple values.

In each case the target context field or BPA script variable is defined first followed by an equal sign, followed by source data defined using one of the valid values defined in the next column.

One or more values may be defined. Each context value is defined separated by spaces. The whole set of context values should be surrounded by square brackets.

FIELD_​NAME

Indicates that the value should be taken from the field with this name from portal context, global context or the page data model. The mnemonic sourceLoc is used for defining the source.

xpath

Indicates that the value should be taken from a schema field, represented by the Xpath, displayed in this zone. This is valid when the zone is displaying a UI Map.

'constant'

Indicates that the value defined in single quotes should be passed.

sourceLoc=

This mnemonic defines the source of the FIELD_​NAME's value in the context mnemonic.

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

- The portal context is checked.

- If no portal context value is found, the global context is checked.

- If neither value is available, the field is ignored.

G

Indicates that the field's value is retrieved from the global context.

P

Indicates that the field's value is retrieved from the portal context.

D

Indicates that the field's value is retrieved from the page data model.

class=

Use this mnemonic to override the look and feel of the link / icon / button using a different CSS style.

'className1' 'className2'

Enter one or more classes in single quotes. Multiple class names may be provided.

style=

Use this mnemonic to override the look and feel of the action element using the indicated css style.

Standard style= format.

All allowed css style definitions may be used.

vss=

This mnemonic, along with vinput= and voutput=, may be used to conditionally hide the action. Use this mnemonic to define the service script responsible for determining wherher the action should be visible or not.

'SCRIPT_​CD'

Enter a reference to a valid service script in single quotes.

vinput=[target1=source1 target2=source2]

This is used to pass input data to the visibility script. The mnemonic supports passing multiple values.

In each case the target field is defined first followed by an equal sign, followed by source data defined using one of the valid values defined in the next column.

One or more input values may be defined. Each value is defined separated by spaces. The whole set of values should be surrounded by square brackets.

FIELD_​NAME

Indicates that the value should be taken from the field with this name from portal context.

'constant'

Indicates that the value defined in single quotes should be passed.

voutput=

Use this mnemonic to define the XPath name of a Boolean element set by the visibility script indicating whether to show the action or not.

xpath

If the visibility script sets the element to true the action is visible. If it is set to false the action is not visible.