id

string

IDs are optional. However, when used, they must be unique to the IDs that are specified by other navigational components within the global context area.

The ID is included when rendering the NavAction component within the DOM to enable custom CSS files to target the styling of the NavAction without having to modify the JSP file directly.

sortPriority

integer

Identifies the sort order relative to other NavActions provided by the NavActionFactory. The NavActionFactory sorts the NavActions by this value before producing the list of NavActions it provides.

available

Boolean

Determines if the NavAction is available. If false, the NavAction will not be included by the NavActionFactory.

accessRight

string

Defines the access rights required to use this action. If the agent does not have this right, the action will be filtered out by the NavActionFactory and will not be included within the UI.

resourceBundleName

string

Identifies the name of the resource bundle used to look up all resourced values.

enabled

Boolean

Determines whether the action is enabled or disabled in the UI. Disabled actions are grayed out.

Note: This value is useful in cases where an action becomes unavailable at certain times based on the agent’s working environment. As such, it is more common to extend the isEnabled() API to get the desired behavior than it is to statically provide the value through the properties file.

labelResourceKey

string

The resource key used to identify the text that appears for the action in the NavItem’s action menu.

javaScriptFunctionCall

string

Calls the JavaScript to execute.