Settings for Toolbar Menu Objects

This table describes the available settings for menu objects that represent drop-down toolbar menus. There are no settings for the top-level menu. The name and value for each setting are case sensitive.

Setting Description Accepted Values/Examples

Access Behavior

This setting works with the results of the Access Expression, Access Mask, or Access Program/Access Function settings. Those settings return a true or false value.

When true, the menu command shows in the list and can be selected by the user. When false, this setting defines whether a menu command is hidden from the user (hide; does not display in the menu) or shown in gray (disable) so that it cannot be selected.

This setting does not work with Role accesses. Commands not available to a user based on role are always hidden, regardless of the value of this setting.

hide (default)

disable

Access Expression

Controls access to the menu based on a valid expression. The system evaluates the expression at runtime. If the expression evaluates to True and no other access control prevents access, the component is shown. Depending on the type of expression defined, the program may or may not need a valid objectID.

Make sure that an objectID is available before configuring this setting for configurable toolbar menus and commands.

When you use the setting for commands connected to the AEFGlobalToolbar (My Desk, Actions, Tools), the system evaluates the expression on the person business object. It does not rely on any objectId to be passed in as a URL parameter.

In cases where no objectId is passed, such as a table page originating from My Desk, the Access Mask setting is ignored. Similarly, the IconMail tree, which does not have an objectId, does not use this setting if defined.


  • $<attribute[attribute_Weight].value>?> 100
  • $<attribute[attribute_Originator].value >== owner

Access Function

The name of the JPO method to invoke in the JPO specified for the Access Program setting. The Access function gets the input parameter as a HashMap that contains all the request parameters passed into the JSP page. The JPO method must return a Boolean object. If the returned value is true and no other access control prevents access, the component displays. If false, it is hidden.

To see a sample JPO method to control access, see Sample JPO for Controlling Access.

Use this setting to evaluate access independent of users' roles.

The name of an access check method in the JPO specified in the Access Program setting, such as:

emxAccessCheck()

Access Mask

Specifies the accesses the user must have for the current business object for the menu to display.

When you use the setting for commands in page toolbars, menus, trees, table columns, and form fields, the system evaluates the access mask on a specific business object. This business object is available only when the objectId is passed in as a URL parameter to the JSP.

If the user does not have all the specified accesses in the business object's policy for the current state, the system hides the component. If the user has the access and no other access control prevents access, the system displays the component.

You can specify multiple accesses by separating the accesses with a comma.

Any set of accesses, separated by a comma. For example:

Modify

Delete

ToConnect

ToDisconnect

FromConnect

FromDisconnect

Modify,Delete

FromConnect,FromDisconnect

Access Program

Controls access to the menu based on the output from a method in the specified JPO program. You must define the program in Business Modeler. This setting requires that you also specify the Access Function setting. If Access Function is not set, the system ignores the Access Program setting.

The following input values are required for the program:


  • A list of all of the request parameters in a HashMap
  • Method name as a string
  • JPO Program Name as a string
  • Context

The output must be a Boolean.

Name of a JPO defined as a program object, such as:

emxAEFCollectionAccess

Dynamic Command Function

Defines the method in the JPO specified by the Dynamic Command Program setting that returns a list containing the data structure to build the right-click menu. In general, the list contains dynamic options based on the user context.

This setting is only used with the right-click menu component and the toolbar component.

<JPO Method Name>

Dynamic Command Program

Defines the JPO invoked from a right-click menu component, or toolbar menu component.

<JPO Name>

Image

Specifies the image used for the menu. This is optional if you have defined a label. Required if there is no label.

${COMMON_DIR}/iconSmallOrganization.gif

Maximum Length

Define the greatest number of characters that can be displayed on a drop-down menu label. The Title property of the button is used as the Alt text to display the full label.

Any number of characters, such as 25

When not set, the toolbar displays the entire label.

Mode

Used for structure browser only.

If defined for a toolbar command, that command is only enabled on the toolbar in the indicated mode (Edit or View). If not defined, the command is enabled in both Edit and View mode.

If defined for a toolbar top-level menu, the entire toolbar only shows in the indicated mode and is hidden in the other mode.

edit

view

Pull Right

Determines whether the drop-down links display at the same level as the menu or pulled right to display the links in the next level. Applies only to second-level drop-down menus. For examples, see About Toolbars.

True (default)

False

*Registered Suite

Specifies the application the toolbar menu belongs to. The system looks for files related to the menu in the registered directory for that application (specified in emxSystem.properties).

Based on the application name, the system passes the following parameters in the href URL:

suiteKey

SuiteDirectory

StringResourceFileId

The value cannot contain any spaces. For example, EngineeringCentral or Framework. The value must be set to the suite name as defined in the key eServiceSuites.DisplayedSuites within emxSystem.properties. If the suite name starts with "eServiceSuite" then this prefix can be skipped and assign the remaining text to the setting. For example, if the suite name in emxSystem.properties is "eServiceSuiteEngineeringCentral", then the word "EngineeringCentral", can be assigned as "Registered Suite".

In the href URL that is called when the menu is clicked, the system passes a parameter called "suiteKey". The value for the parameter is the property name from emxSystem.properties that maps to the setting's value.

RMB Menu

Specifies the name of the right-click menu to associate with the component.

For a type-specific menu, such as type_Part, defines the type-specific right-click menu for that type.

For a table column, specifies the right-click menu for that specific column.

<admin menu name>

*Required