Parameters for Web Form Objects

This table describes the available parameters for web form objects. The definition of a web form consists primarily of definitions of the fields that make up the form.

All the parameters listed below apply to fields within a form except those that are indicated as applying to the form itself. For specific instructions on how to create web form objects using Business Modeler or MQL, refer to the Business Modeler Guide or MQL Guide.

Parameter Description Accepted Values/Examples

Access

(user MQL command)

Use to specify the persons, roles, and groups who can access the field. To make the field available to all users, regardless of role/group assignments, choose All.

Note that if no users are assigned access, the system assumes all users have access.

Names of group, role, person administrative objects.

or

All (default)

Alt

Use to define the ToolTip text to display when users move their mouse pointer over fields configured to display images, or as an alternate to the Label parameter when defining an input control in the page toolbar.

Either a string resource ID for the text string or the actual text string. To internationalize the text, you must use a string resource ID. See Internationalizing Dynamic UI Components.

The system first looks for a string resource ID that matches the entered value. If it finds one, it uses the value for the ID. If it doesn't find one, it displays the entered text.

emxFramework.Common.ProjectDetails

Description

Applies To

Use to specify the item to apply the select expression to: the business object or relationship.

Depending on what you specify, the system passes a valid business object ID or relationship ID to emxForm.jsp For example, emxForm.jsp?objectId=xxx or emxForm.jsp?relId=yyy.

Dynamic UI table and tree components pass the objectId and relId automatically to emxForm.jsp, so the href link can be configured without passing IDs.

Business Object

Relationship

Description

Use to give a brief description of how the form, field, or input control on a page toolbar should be used. The web form administrative object and each field within it has a description parameter.

Text string

Expression

Use to enter the select expression that gets the field data. This expression is applied to either the relationship or business object, as specified in the Applies To parameter. If the expression is a business object basic or an attribute that will be editable, make sure you include the Field Type setting with either the basic or attribute value.

The Expression and Applies To parameters are equivalent to the businessobject and relationship MQL commands.

To see an example of a field configured to use an expression, see Field Values as Select Expressions.

For business objects:

type

name

current

$<attribute[attribute_Originator]. value>

For relationships:

$<attribute[attribute_FindNumber].value>

$<attribute[attribute_Qty].value>

Label

Use to enter the text that displays as the field's label. Make sure Custom Label is checked so the system gets the label you specify. If Custom Label is unchecked, the system uses the expression as the label.

Either a string resource ID for the text string or the actual text string. To internationalize the text, you must use a string resource ID. See Internationalizing Dynamic UI Components.

The system first looks for a string resource ID that matches the entered value. If it finds one, it uses the value for the ID. If it does not find one, it displays the entered text.

emxEngineeringCentral.common. Name

emxTeam.Common.ProjectName

Description

href

Use to specify the URL that gets executed when the field data is clicked. This parameter is used for View mode. In Edit mode, it is ignored because fields in Edit mode are not shown with a hyperlink.

When a user clicks the hyperlinked field data, the system passes the objectId parameter as part of the URL. By default, the value for the objectId parameter is the ID of the business object the form page applies to. Using the Alternate OID expression setting, you can configure the field to pass the ID returned from a different business object.

Also used for an input control in the page toolbar to specify the URL to execute when a user clicks the submit button. The Input Type = combobox also executes the href on the onChange event and the Input Type = checkbox executes the href on the onClick event. You also need to provide an Action Label setting on the input control to actually draw the submit button (Action Label defines the name that shows on the submit button).

The value for the href parameter should be a JSP and any associated parameters. You can specify the path of the JSP using any of the standard directory macros or you can leave off the path designation to use the registered directory. For more information, see Macros and Expressions in UI Components.

${COMMON_DIR}/emxTree.jsp

${SUITE_DIR}/emxpartEditPartDialog.jsp

To see an example of a field that uses an href, see Field Values as Hyperlinked Image, Field Values with Hyperlinked Data Using an Alternate OID and Alternate Type Icon, and Field Values as Hyperlinked Image.

Name

Use to enter the name of the field used as identifier for the field within the web form object.

This parameter is also used to define the name of an Input Control for the toolbar.

Name

Revision

Material Category

Name (of web form)

Use to enter the name of the web form administrative object. You must enter the actual name of the web form; symbolic names are not supported. For naming conventions, see Naming Conventions.

ENCPart

RangeHref

(range MQL command)

When configuring a form field in Business Modeler, the RangeHREF parameter is set on the Link tab.

Use to configure a textbox that has a Browse (...) button that calls a chooser or custom window from which users can select a value to populate the textbox. This Owner textbox is an example with a range helper.

In the RangeHref parameter, specify the href URL to display the window. For example, the href might call a custom selection page.

Range helpers are available only in Edit mode. Only textbox controls can be configured with a range helper. To specify the control type, set Input Type=textbox.

To see an example of a field configured with a RangeHref, see Field with Popup Range Helper. Also see Implementing Range Helpers for Choosers or Custom Pages.

You can specify the path of the JSP using any of the standard directory macros or you can leave off the path designation to use the registered directory. For more information, see Macros and Expressions in UI Components. For example:

${COMMON_DIR}/emxSelectVault.jsp

${SUITE_DIR}/emxSelectUser.jsp

emxTypeChooser.jsp?typeList=type_Part,type_Document

../common/emxTypeChooser.jsp?&SelectType=multiselect&SelectAbstractTypes=true&InclusionList=eServiceEngineeringCentral.Types&observeHidden=true&ShowIcons=true

renderPDF

Parameter to control whether or not to show the Render PDF icon in the form toolbar when displaying the form in view mode.

If the parameter is not passed in, false is assumed and the icon is not displayed.

false (default)

true

Settings

Additional settings that define the behavior and appearance of the column.

Name/value pairs, as defined in Settings for Fields in Web Form Objects.

Type

(for web form)

Dynamic user interface components do not use the type parameter.

--

Update URL

Dynamic user interface components do not use this parameter. They use the Update Program and Update Function settings instead.

--