Settings for Toolbar Link Command Objects

Access Expression

Controls access to the link 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 link 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.

Access Mask is not supported for toolbar custom filters.

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 link 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

Action Label

A text string shown as the button label after the textbox of an input control. Used only for Input Type = textbox or submit. This setting does not define a label to display in front of the input control. If this setting is not defined, then the button after the input control does not display. An href must also be provided when using this setting.

For internationalization, a string resource key can be used. If a key is used, the Registered Suite setting must also be defined.

The href parameter is required for the button to be displayed next to the text box.

emxFramework.SampleFeature.Find

Find

emxFramework.Common.Filter

Apply Filter

Action Type

Tells the configurable toolbar that the command is a separator instead of a link. If the setting is not included, the toolbar treats the command as a standard link.

Separator--A line that separates one or more links. If the command is assigned to the top-level menu and is therefore on the toolbar itself, it is considered a vertical separator. Otherwise, it is considered a horizontal separator.

Allow Manual Edit

Only used when the format=chooser setting is defined, which is only used when the Input Control = textbox setting is defined.

When set to false (the default), the user must click the ellipsis button to open the chooser dialog to select values for the textbox.

When set to true, the user can enter text directly into the textbox, or use the chooser dialog.

false (default)

true

Confirm Message

Provides a JavaScript confirmation message when users click on the link. For example, a custom delete message can be configured for the onClick event to display a JavaScript confirm message to the user. The Confirmation dialog has the "OK" and "Cancel" button. Clicking OK proceeds with the processing and Cancel cancels the operation.

You can include the number of selected table rows in the message using a macro. See Macros and Expressions in UI Components.

The actual text to display in the confirmation message or a string resource property key. To internationalize the message, a string resource key must be used:

Are you sure you want to delete this object?

emxFramework.common.alertMsg

Default

Provides the default value for the input control if the user does not enter a value but executes the control.

The value can be static text or string resource keys.

emxFramework.CustomControl.Default

Field Size

Width of the toolbar control in pixels. This setting helps design the toolbar if many controls need to be used in a small area.

100

format

Used only with Input Control = textbox when the entered text should be a date or a chooser. When date is specified used, the calendar tool shows after the text box. When chooser is specified, the browse button shows after the text box.

date--Displays the column values as a date. Uses the tag lib "emxUtil:lzDate" to format the display.

chooser--displays the a chooser button after the text box

Maximum Length

Limits the number of characters that are displayed on toolbar link. 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.

Image

The image used for the link. This is optional if you define a label, but required if there is no label.

${COMMON_DIR}/iconSmallOrganization.gif

Input Type

Adds an item to the toolbar. Usually, this setting is used in combination with the Action Label, where the text in the textbox is used as input to the action taken when the button is clicked.

If checkbox is specified, only a single checkbox displays with values of Yes or True when checked, and No or False when clear.

When used in a structure browser toolbar, only used for tables in Edit mode. Specifies the type of HTML control to display for user input. You can also designate the size of the input boxes to allow for appropriate spacing.

For toolbar commands, textbox, combobox, and submit are supported.

For controls other than toolbar commands, submit is not supported.

textbox--This is the default. Provides a single-line box for typing text. This graphic shows a textbox and the associated Action Label.

combobox--The input control has a drop-down list of options and users can only select one value. Use combo boxes for attributes that have defined ranges and for attributes whose ranges are determined with a Range Helper URL.

submit--Submit button configured to send contents of input control to a processing page.

checkbox

Javascript Include

For a menu or command on the toolbar used to specify Javascript files to perform client-side validations. Use this setting in conjunction with the Validate setting on table columns or form fields in place of the application- or component-specific ValidationFile property.

Javascript file name

Popup Modal

If the setting Target Location is set to popup, you can configure the to be modal or non-modal.

true--the popup window is modal

false--the popup window is non-modal

If not specified, the window is modal.

The pixel width and height values for these sizes are defined in emxSystem.properties. See emxSystem.properties.

• Small
• Medium
• Large
• SmallTall
• MediumTall

Range Display Values

A comma-separated list used only for the Input Type = combobox setting. If values for this setting are not provided, the Range Value setting is used to populate the combo box list.

The list can be static text or string resource keys.

A,B,C

emxFramework.Choice.A,emxFramework.Choice.B,emxFramework.ChoiceC

Range Function

Use to specify the name of the method in the JPO specified in the Range Program setting. See the Range Program setting below for more information.

If you specify the Range Program/Range Function and provide a Range Value list, the Range Value list will be used.

The name of a function in the Range Program JPO, such as:

getAssignedRange

getClassificationRange

Range Program

Use to specify the name of a JPO that contains a method to get the ranges (choices) for a combobox input control. A range program is used only when the Input Type setting is combobox.

The name of a JPO, such as:

ENCPartFilter

AEFUtilToolbarFilter

Range Values

A comma-separated list used only for the Input Type = combobox setting. The values for this setting override any Range Function/Range Program value.

The list can be static text or string resource keys.

A,B,C

emxFramework.Choice.A,emxFramework.Choice.B,emxFramework.ChoiceC

*Registered Suite

The application the command belongs to. The system looks for files related to the link in the registered directory for that application, which is specified in emxSystem.properties.

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

suiteKey

emxSuiteDirectory

StringResourceFileId

The value cannot contain 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 tree category 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.

Row Select

Used only for links on table pages. Specifies whether the JSP specified for the href expects one, at least one, or no rows in the table (Middle Frame) to be selected.

If the Row Select setting is set to "single" or "multi", the setting Submit must be set to "true" to get the details of the selected item(s) from the table.

If not specified, it is assumed to be none.

A JavaScript alert message is displayed on error conditions when the onClick event occurs. The error conditions are explained in the column to the right.

single-Appropriate only for links that appear on table pages that have radio buttons or check boxes for each row. The JSP specified for the href expects exactly one row in the table (middle frame) to be selected. If more than one item is selected, a JavaScript alert message is displayed. The default message is set to the value of the following key in emxFrameworkStringResource.properties: emxFramework.Common.PleaseSelectOneItemOnly. Currently, the message is set to "Please Select One Item Only". If no item is selected, then the user will see the following message: "Please select an Item". This message corresponds to this key value in the emxFrameworkStringResource.properties file: emxFramework.Common.PleaseSelectitem

multi-Appropriate only for links that appear on table pages that have check boxes or radio buttons for each row. The JSP specified for the href expects at least one row in the table (middle frame) to be checked. If no item is selected, then the user will see the following message: "Please select an Item". This message corresponds to the following key value in the emxFrameworkStringResource.properties file: emxFramework.Common.PleaseSelectitem

none (default)-The JSP specified for the href expects no row in the table to be selected. If a row is selected, the JSP does not use it.

Selectable in Preferences

Only for commands in the 3DS (My Desk) submenus. Controls whether the link is available as a preferred Home page. If not set, the system assumes true and the command is listed as a Home page preference. Commands that call pages to display in a popup window, such as an object search command, should not be available as a Home page preference.

True

False

Submit

Specifies whether the system should send the object ID(s) (and relationship ID, if applicable) for the current page to the JSP specified in the href parameter. For form pages, the submitted data is just the object ID for the business object the page is about. For table pages, the submitted data is the ID for each selected item in the table, which can include object and relationships. In either case, the IDs are sent using the relBusIdList parameter.

If not specified, the system assumes it is false.

true--Submits the IDs to the URL specified in the href parameter.

false--The URL specified in the href parameter is directly called from the link and no IDs from the current page are used. Use this value for links that do not require the business object IDs, such as links for creating a new object.

Submit Function

Method within the Submit Program JPO that is executed when a user clicks the submit button for an input control.

getUpdatedList

Submit Program

JPO program that contains the method executed when a user clicks the submit button for an input control.

ENCPartList

Target Location

Controls where the page specified in the href parameter appears.

Popup is the default value for a textbox and is used if the setting is not included or if the named frame cannot be found.

This value can be set to any valid frame name that is available to the form body frame.

When using slidein as the Target Location and the Popup Modal setting is true, then the content window and the global toolbar are grayed out and disabled until the slidein window is closed.

content--The page replaces the content frame.

popup--Page appears in new window. Set the modality of the window using the Popup Modal setting.

_top--Page replaces the entire body of the browser window.

listHidden--Carries out any background processing when no UI is required.

hiddenFrame--Targets the Navigator hidden frame to perform any background processing. Do not use this frame within the context of the configurable table. Use listHidden instead.

mainFrame--Page appears in the frame that includes the content and menu frames.

fromViewHidden--Used within the context of the configurable form.

slidein--Page appears in a slidein frame (slides in along the right side of the window).

This value can be set to any valid frame name that is available to the form body frame.

width

Specifies the width of the filter toolbar control in pixels. Use this setting if you need to display many controls in a small area.

100

*Required Setting