Settings for Fields in Web Form Objects

This table lists and describes the settings for web form objects. The name and value for each setting are case sensitive.

Setting Description Accepted Values/Examples

*Registered Suite

The application the field belongs to. The system looks for files related to the field 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

Set the value without any spaces, for example, EngineeringCentral or Framework.

Set the value to the suite name as defined in the key eServiceSuites.DisplayedSuites within emxSystem.properties. If the suite name starts with eServiceSuite then you can skip this prefix 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".

Access Expression

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

 

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 field to display.

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

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

Additional Query When Type Ahead is configured on the field (by setting the RangeHref to emxFullSearch.jsp or using a predefined Type Ahead Chooser), this setting defines additional field/selection critiera used to restrict the selection list. See About Automatic Type Ahead. <FieldName1>=<select expression1>:<FieldName2>=<select expression2>:

Admin Type

Use to translate fields whose values are names of administrative objects or ranges of attributes. For example, suppose you are configuring a field that shows an object's current state and you want the state name to be translated. You would add this setting and set the value to State. The translations for administrative object names are stored in the emxFrameworkStringResource.properties files, as described in Internationalizing Dynamic UI Components.

These keywords get the field values translated for the appropriate type name:

  • Type
  • State
  • Role
  • Relationship
  • Policy
  • Group
  • Vault
  • Attribute (for translating the attribute name, not the range values)

To translate attribute and range values, specify the symbolic name of the attribute, which starts with "attribute_" and is followed by the attribute name with no spaces. For example:

  • attribute_UnitOfMeasure
  • attribute_PartClassification

Allow Manual Edit

When true, users can manually edit the form row for this field. Applicable only when the range parameter is set to a URL or when the setting format is assigned to date or for fields of type combobox. It is ignored in all other cases.

When this setting is true, the Admin Type setting is ignored.

false (default)--Manual entry is not allowed.

true--Manual entry is allowed.

Alternate OID expression

By default, when a field's data is configured to show as a hyperlink using the href parameter, the system passes the ID for the business object the form page applies to. Using this setting, you can have the system pass the ID(s) for a different object, namely, the ID(s) for the object(s) returned from the expression specified in this setting.

$<to[relationship_NewPartPartRevision].from.id>

$<to[relationship_EBOM].from.id>

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

Alternate Type expression

When the Show Alternate Icon setting is true, this expression is used to obtain the object type. Based on the obtained type, the corresponding icon is displayed.

$<to[relationship_NewPartPartRevision].from.type>

$<to[relationship_EBOM].from.type>

Calendar Function

Use to specify the name of the method in the JPO specified in the Calendar Program setting that retrieves the non-working days based on the calendar defined for the location.

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

getNonWorkingDays

Calendar Program

Use to specify the name of a JPO that contains a method to get the non-working days for a calendar.

The name of a JPO, such as:

emxWorkCalendar

Category

Used to select attributes with the same uiform_Category property setting.

For example:

D2MBusiness

EC Technical

Cols

Used when the input type is set to textarea. This setting limits the length of the textarea on the form and specifies the visible width in average character widths. If not specified, it uses the HTML default, which is 25.

25

40

50

Column Count

The number of name/value columns to draw horizontally.

1 (default)

2

3

n

Column Style This setting is only valid for Edit mode; it does not work with View mode.

Defines styles from the CSS for the specific field.

To define alignment, use one of these values:


  • left-align
  • center-align
  • right-align

For numeric fields, the default is left-align.

left-align

Create Exclude

Comma-separated list of attributes that will not be included in the webform when opened in Create mode when a field on the webform has been defined as Field Type = Dynamic Attributes.

For example:

attribute_Cost

Decimal Format Defines the decimal precision (number of digits after the decimal point) for displaying values in numeric fields. 5

2

Decimal Precision

Defines the decimal precision for all calculations for this form. The system properties setting emxFramework.FormCalculations.DecimalPrecision defines the system-wide value; this setting overrides that value. You only need to use this setting if you want to use a value other than the system-wide value (defined in emxSystem.properties).

Any positive integer.

Default

If a field's value is empty or null and this setting is defined, the default value is displayed for the field.

The default value you want to display. This can be a string resource key or the actual characters you want to fill in as the default. The wildcard (*) can be used for search criteria fields.

emxFramework.Common.default

All

*

Delimiter

When using Input Type = dynamictextarea setting, this setting defines the character that separates values when the field is in View mode. In Edit mode, each value shows on a separate line. A comma is the default delimiter.

If you specify any of these characters as the delimeter, a comma is used instead:

$ \ ' " * | ? ( ) >

<any string value>

, (default)

Display Format

Specifies the number of the date format for any field where the value of the format setting is "date." See Date/Time Fields in Forms and Tables.

These are Java standard values of Date Format to display a date in a specific format.

3 - SHORT (12/12/52)

2 - MEDIUM (Dec 12, 1952)

1 - LONG (December 12, 1952)

0 - FULL (Tuesday, December 12 1952 AD)

Default is set in emxSystem.properties: emxFramework.DateTime.DisplayFormat=MEDIUM.

emxSystem.properties uses words, but the Display Format setting uses numbers.

Display Time

Controls whether the time displays with the date for fields whose format is set to date.

If no time zone preference is set, then the DateTime is shown in the browser's time zone. The time is shown in terms of GMT+/- hh:mm, (e.g., Saturday, August 21, 2004 12:45:00 PM GMT-04:00). To get the time in a format like EST or PDT, set the time zone preference to a specific zone. See Date/Time Fields in Forms and Tables.

true

false

Default is set in emxSystem.properties for the property emxFramework.DateTime.DisplayTime = false

findMxLink

When true, show the mxLink icon/command button on the toolbar, which opens a search dialog box.

true (default)

false

Editable

Use to indicate whether the field is displayed as editable or read only. Only applies for Edit mode. View mode ignores the setting.

true (default)--Users can edit the field when shown on the Edit mode form.

false--Users cannot edit the field when shown on the Edit mode form. The field looks just like it does in View mode except it is never hyperlinked.

Edit Exclude

Comma-separated list of attributes that will not be included in the webform when opened in Edit mode when a field on the webform has been defined as Field Type = Dynamic Attributes.

For example:

attribute_Cost

Export

Specifies whether field data is exported to csv or not. Use this to change the export value on a field-by-field basis.

true

false

Field Column Headers

Used in conjunction with the Field Type=Table Holder setting. Specifies the labels for the column headings. The number of labels should be the same as the value for the Field Table Columns setting and should be separated by a comma.

You can specify either a string resource ID for the text string or the actual text string that should appear. To internationalize the text, you must use a string resource ID.

See Fields that are Grouped.

Comma-separated list of column heading labels:

Min,Max,Avg

Field Row Headers

Used in conjunction with the Field Type=Table Holder setting. Specifies the labels for the row headings. The number of labels should be the same as the value for the Field Table Rows setting and should be separated by a comma.

You can specify either a string resource ID for the text string or the actual text string that should appear. To internationalize the text, you must use a string resource ID.

See Fields that are Grouped.

Comma-separated list of row heading labels:

Weight,Volume

Field Size

Determines the width of a textbox input type field. The width is given in pixels except when Input Type is textbox or not set. In that case, its value refers to the (integer) number of characters.

Number of pixels, for example:

30

20 is the default.

Field Table Columns

Used in conjunction with the Field Type=Table Holder setting. Defines the number of columns for the table.

See Fields that are Grouped.

2, 3, ...

Field Table Rows

Used in conjunction with the Field Type=Table Holder setting. Defines the number of rows in the table.

See Fields that are Grouped.

1, 2, ...

Field Type

This setting is used:

  • To indicate that the field's data should be obtained from a program or image instead of an expression.
  • When the field data is obtained from an expression, if the data is basic information or an attribute. The system needs to know whether a field's data is basic information or an attribute in order to update the information correctly. Specifying whether the field is basic or an attribute is only required for fields that will be editable.
  • To indicate the field is a dummy field that defines fields to display in a table or group.

For more information on specifying field data, see Form Fields.

The Group Holder setting has been deprecated.

program--The values for this field are obtained from a program (JPO). The program and function name are required as settings.

programHTMLOutput--Same as the program setting, except the field value output is in HTML format. Field values are placed in the table cell between <td> and </td> tags. This setting ignores other field settings such as Show Type Icon, href, format, and Alternate OID expression.

Dynamic Attributes--Displays all attribute/value pairs associated with the context object in the properties page.

ClassificationPaths--Used only with Library Central. Displays the paths where the object is classified, with a separator between hierarchies. This separator is configurable with the Library Central property string emxLibraryCentral.ClassPathSeparatorString. The default separator is '-----'.

ClassificationAttributes--Used only with Library Central and the Multiple Classification Module. Displays the attributes acquired via classification. If the object is classified, it displays the classification name as the heading, and then displays a subheading with the name of the attribute group, and then attributes and their values acquired from the attribute group.

If the same attribute is repeated in another attribute group or in another classification, this field displays a message underneath the field: "This value also appears in another Attribute Group." If a user modifies one attribute and has other occurrences in different attribute groups, this automatically updates all other occurrences of the attribute. If the object is classified but no attributes are acquired via classification, this field does not display anything.

image--The field's value is the primary image associated with the business object.

basic--The field displays basic information for the business object. Basic information includes name, type, originated, policy, etc. Specifying basic as the field type is only needed when the field is editable. The only editable basic information is: type, name, revision, current, policy, description, owner, vault.

attribute--The field displays values for an attribute on the business object, such as Originator or Weight.

Section Header--Adds a new section heading between the form fields. The setting Section Level determines the heading level. See Field as Section Header and Separator.

Section Separator--Adds white space to separate fields and sections.

Table Holder--Arranges the fields under the field in columns and rows. Table Holder fields serve as dummy fields to define the fields to display in a table. Also see these settings: Field Column Headers, Field Row Headers, Field Table Columns, Field Table Rows.

emxTable--Embeds a configurable table in the form. Used in conjunction with the table setting and either the inquiry or program setting. See Field that Embeds a Configurable Table.

format

Use to specify the type of data in the field. If the Editable setting is true and the field is on an Edit mode form, the system uses these format values to validate the field value. Validation takes place on the client side, before updating the object displayed in the form. For more information on validation, see Validating Form Field Data.

To support the date compare logic, whenever the field format is "date", an additional hidden parameter is added to the form with the name assigned to the web form field name suffixed by "_msvalue". If there is a valid display value for the date, the hidden parameter is assigned with the value that is the equivalent of displayed date in milliseconds (calculated from midnight, January 1, 1970).

This hidden parameter value can be used by the validation methods to compare two dates.

Note: The hidden parameter gets updated only when the out-of-the-box calendar component is used to change the date. So if the field type is changed to manual edit, the hidden parameter may not have the updated milliseconds value when the field is manually changed. In this case the validation method can simply ignore the date compare and must depend on the server side validation. The client side validation can be ignored by checking if the field is readonly.

date--Uses the tag lib to format the displayed field value based on the browser locale setting. To see an example of a field configured as a date field and that has date validation, see Field Value with Dates.

currency

numeric--Use if the value must be validated as a number before updating the values. Applicable only in Edit mode.

email--Displays the column values as an email address. When a user clicks the email address, the email editor configured in the client is presented.

function

The name of the method to call within the JPO program specified in the program setting. This method within the JPO is used to get the field values if the setting "Field Type" is set to "program" or "programHTMLOutput".

For more information, see Field Values Obtained from a Program.

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

getAssignedBuyerDesk

getPackageAccess

getParentPart

Group Name

Used for grouping fields in web forms. The consecutive fields with same group name are considered a group. See Fields that are Grouped.

The name of the group.

Help Marker

Specifies the name of the help marker to call for context-sensitive help.

In the href URL called when the field data is clicked, the system passes a parameter called HelpMarker and includes the marker text specified for this setting.

The naming convention for help markers is the page title, as displayed at the top of the visual page, prefixed with "emxhelp". The marker is all lowercase with no spaces.

Hide Label

Displays or hides the label for a particular row on a form.

True

False

Image

Use to specify an image file when the field value should be an image only. This setting is required when the Field Type setting is set to image. This file must exist in the application server (not in the database). You can make the image a hyperlink by including a URL in the href parameter.

To see an example of a field with an image, see Field Values as Hyperlinked Image.

images/newPart.gif

images/EditItem.gif

Image Size

When the web form includes a Field Type of image, this setting defines which size of the primary image associated with the business object should display in the column. The pixel dimensions for these sizes are defined using the emxComponents.Image.SizeImageSize property (see emxComponents.properties).

format_mxSmallImage (default)

format_mxLargeImage

format_mxMediumImage

format_mxThumbnailImage

Input Type

Only used for forms and table columns in edit mode. Specifies the type of HTML control to display for user input.

Although multiple choices can be displayed in a webform, only one selection can be saved during edit. If you want to disable the ability to make multiple selections during view of webform, you need to use programHTMLoutput and the html tag that does that.

Use the radiobutton or combobox input types for fields that require a single selection.

If you want to save multiple selections, a custom JPO needs to be written using the checkbox or listbox input types which might delimit the choices in the attribute using the Studio Customization Toolkit.

If you specify checkbox or radiobutton for an attribute with the String datatype, the attribute must be defined with a range or an error occurs when the form is in Edit mode.

If using dynamictextarea, the Delimiter setting also needs to be defined if you want to use a delimiter other than the default (comma).

textbox-Default. Provides a single-line box for typing text. This graphic shows a field configured as a Text Box with the Required setting equal to true. If the attribute is configured with a dimension, a drop-down list of units displays after the test box

textarea-Provides a multi-line box for typing text.

checkbox-Provides a check box next to each range value.

See Sample JPO for Web Form with Custom Combobox.

listbox-Provides a list of range values. Although users can select more than one item in the list by holding the Ctrl key, only one value will be saved unless a custom JPO is implemented.

radiobutton-Shows a radio button next to each range value. To see an example of a field configured with radio buttons, see Field for Attribute with Choices in Radio Buttons.

combobox-Provides 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. To see an example of a field with a combo box, see Field for Attribute with Choices in Combo Box.

dynamictextarea-Allows multiple values to be entered in Edit mode

inquiry

Used only for fields defined with Field Type=emxTable. Either this setting or the program setting must be used to define the objects to retrieve. Specifies the inquiry administrative object that should be used to retrieve the business objects to be included in the table.

Name of inquiry administrative object.

inquiry=SCSBuyerDesk

inquiry=ENCAllParts

Label

Use to enter the text that should appear as the label for the field. 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 that should appear. 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.

When used with a field type of Dynamic Attributes, the Label becomes the section heading name, or if not provided or set to blank, indicates that no section heading will be displayed.

emxEngineeringCentral.common.Name

emxTeam.Common.ProjectName

Description

Maximum Length

Limits the number of characters that can be entered in a field with Input Type of textbox. If not specified, it uses the HTML default (unlimited).

Number of characters, for example:

30

OnChange Handler

The name of the JavaScript function called when the value in the field is changed. You can provide a semicolon separated list of JavaScript functions.

<JavaScript function name>

OnFocus Handler

The name of the JavaScript function called when a field is selected for edit. You can provide a semicolon separated list of JavaScript functions.

<JavaScript function name>

Popup Modal

Specifies whether windows opened from a link are modal or non-modal.

Used when the setting Target Location is set to popup.

If a form Component is opened in a dialog in edit mode then the dialog must open as a modal dialog. For example, if a table column is designed to pop up the Form Component in edit mode, then that column must have a setting Popup Modal=true to open the dialog as modal dialog.

true--the popup window is modal

false--the popup window is non-modal

If the setting is not specified, the window is modal.

Popup Size Defines the size of the popup window. The value can be one of the listed example sizes.

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


  • Small
  • Medium
  • Large
  • SmallTall
  • MediumTall

Printer Friendly

Specifies whether the target page should include the Printer Friendly tool. In the href URL called when the field data is clicked, the system passes a parameter called PrinterFriendly and includes the value specified for this setting. If this setting is not included, the value is assumed to be false.

True

False (default)

program

Use to specify the name of the JPO program to get the field's data. This program gets the field values when the Field Type setting is program or programHTMLOutput.

Can be used for fields defined with Field Type=emxTable to define the objects in the table. Alternatively, inquiry can be used.

Using a JPO to populate field data is recommended only when a select expression cannot be used to obtain the field value.

To see an example of a field that uses a program, see Field Values Obtained from a Program.

The name of a JPO, such as:

SCSBuyerDeskForm

TMCPackagesForm

ENCPartForm

AEFUtilForm

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.

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

getAssignedRange

getClassificationRange

getPartUOM

Range Program

Use to specify the name of a JPO that contains a method to get the field value ranges (choices). A range program is used only when the Input Type setting is combobox, radiobutton, or checkbox.

If the choices need to be presented on a page in a popup window, for example in a chooser, use the RangeHref parameter instead.

To see an example of a field configured with a range program, see Field for Attribute with Choices in Combo Box. Also see JPO for Getting Field Range Values (Choices).

The name of a JPO, such as:

SCSBuyerDeskForm

TMCPackagesForm

ENCPartForm

AEFUtilForm

Read Only Checkbox

For a field defined with the Boolean data type, or as a string with Boolean range values, this setting shows a checkbox instead of the TRUE or FALSE text.

In edit mode, the user can check/clear the checkbox unless the Editable=false setting is specified for the field.

true

false (default)

Reload Function

The name of the method in the JPO specified by the Reload Program setting that executes a field reload.

You also need to specify a value for the Reload Program setting.

<JPO method name>

Reload Program

The name of a JPO to invoke when this code in the form is called:

emxFormReloadField("FieldName")

You also need to specify a value for the Reload Function setting.

<JPO Name>

Remove Range Blank

Used when the input type is set to combobox to ensure that the field contains a value and is not left blank. If set to True, this setting removes the blank from the combo box list. If a default is not specified, the first value in the list is shown by default.

true

false (default)

Required

Use to indicate the value for this field is required. This setting is applicable for editable fields displayed on the Editable mode form.

true--When completing the form, the user must enter a value for the field. The field label appears in red italic text. If the user does not enter a value and clicks Done, a JavaScript message appears that prompts the user to enter a value.

false (default)--When completing the Edit form, the user can leave this field blank.

Rows

Used when the input type is set to textarea. This setting limits the height of the textarea on the form and specifies the number of visible text lines. If not specified, it uses the HTML default, which is 5.

5

10

20

Section Level

Used in conjunction with the Field Type: Section Header setting to define the level of heading.

To see an example, see Field as Section Header and Separator.

Two heading levels are available:

1 (default)--Font for heading label is large and a horizontal line is included above the label.

2--Font for heading label is smaller and the heading is in the same gray rectangle as standard fields.

Show Alternate Icon

Set to true if the field value must display with an icon other than the current object type icon.To get the right alternate icon, you must define the Alternate Type expression with the expression to obtain the object type.

true

false (default)

Show Clear Button

Adds a Clear hyperlink next to the field. This setting only applies to textarea/textbox input type fields. When the user clicks the Clear link, it clears the content of the textbox/textarea input type field.

true

false

Show Type Icon

If set to true, the field value displays along with the type icon for the business object being displayed by the current form page. The icon is defined in the emxFramework.smallIcon property in emxSystem.properties. The icon displays to the left of the field data.

If no icon is defined for this type, the system looks for a property defined for the parent type and so on up the hierarchy. If no property is defined for any type in the hierarchy, the system uses the default icon specified in the emxFramework.smallIcon.defaultType property.

true

false (default)

To see an example of a field with a type icon, see Field Values as a Hyperlink and Type Icon.

sortColumnName

Used only for fields defined with Field Type=emxTable. Specifies the column the table should sort on when the page is first loaded. If no column is specified, the rows are listed in the order they are retrieved from the database.

Name of column in the table specified in the table=TABLE_NAME setting.

Sort Direction

Used only for fields of type combobox and listbox (attributes with defined ranges).

The sort order for the option list.

ascending (default)--Sort a to z or 0 to n.

descending--Sort z to a or n to 0.

none--The option list is not sorted.

Sort Range Values

Enables or disables the sorting of range values in combobox or listbox controls. When enabled, the list is sorted based on the datatype and using the direction defined by the Sort Direction setting. When disabled, no sorting is done on the list.

In a drop-down, range values populated based on an attribute expression will be sorted based on the attribute's datatype. Range values populated using the Range Program and Range Function settings will be sorted alphanumerically.

If the Range Program or Range Function returns numeric or date values, the alphanumeric sort will not be appropriate. The program or function should sort the values in the required order, and this setting should be disabled.

This setting does not apply to fields or columns configured for attributes associated with a dimension. Dimension ranges are always sorted as alphanumeric in ascending order.

This setting cannot be used in custom JSPs that use the editOptionList taglib. For this specific situation, you can use the sortType attribute for that tag.

enable (default

disable

table

Specifies the name of a table administrative object to embed in the form. Used only for fields defined with Field Type=emxTable. You must use the actual table name: symbolic names are not supported. See Field that Embeds a Configurable Table.

Name of table administrative object. For example:

table=SCSBuyerDesk

table=ENCParts

Target Location

Controls where the page specified in the href parameter appears when a user clicks the hyperlinked data.

To specify a tab in a PowerView window, use the administrative command name that configures the tab in the PowerView page. If the specified command name is not defined within the current PowerView, the popup value is used.

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.

popup--Page appears in a new window. The window modality can be set with the Popup Modal setting. Popup is the default value and is used if the setting is not included or if the named frame cannot be found.

content--The page replaces the content frame.

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

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

<command name>--The name of a command configured as the target tab in a PowerView page.

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.

Tip Page

Specifies whether the target page should include the Tip Page tool (light bulb icon). In the href URL called when the field data is clicked, the system passes a parameter called TipPage and includes the URL specified for this setting. If this setting is not included, the value is assumed to be false and the target page does not display the Tip Page tool.

Name of a custom URL page.

Type Ahead Mapping When Type Ahead is configured on the field (by setting the RangeHref to emxFullSearch.jsp or using a predefined Type Ahead Chooser), this setting maps that field to the corresponding indexed field in config.xml. See About Automatic Type Ahead. NAME

LASTNAME,FIRSTNAME,USERNAME

Type Ahead Validate When Type Ahead is configured on the field, this setting determines if the application should restrict the user to selecting one of the suggested values (if true), or if the user can enter any data in the field without BPS validating that data (if false).

true

false (default)

Type Icon Function

Specifies the method in the JPO specified in the Type Icon Program setting that retrieves an icon to show in addition to the Alternate Icon or Type Icon (enabled by Show Alternate Icon or Show Type Icon settings).

If both the Show Alternate Icon and the Show Type Icon settings are set to false, any value for this setting is ignored.

Method Name

Type Icon Program

Defines the program that contains the function specified using the Type Icon Function setting.

JPO Name

TypeAhead

Enables type ahead. If not provided, automatically set to true. Typically used to disable type ahead for a field.

true

false

TypeAhead Program

Name of the JPO called to retrieve a list of possible values. This JPO is called after the user types the specified number of characters. A JPO is typically used by fields that are normally populated using choosers.

 

TypeAhead Function

The name of the JPO method used in conjunction with the TypeAhead.Program setting.

 

TypeAhead Character Count

Overrides the emxFramework.TypeAhead.RunProgram.CharacterCount system property. This setting may be useful for fields whose values may all contain the same prefix.

2 (default)

5

TypeAhead Saved Values Limit

Overrides the emxFramework.TypeAhead.SavedValuesLimit system property.

10 (default)

Update Function

Specifies a method name in the JPO given in the Update Program setting. See Update Program for more information.

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

setAssignedBuyerDesk

setPackage Access

setPartClassification

Update Program

Specifies a JPO that contains a method to set the field value when the field is displayed on an Edit mode form and when the user clicks Done. This program is used only when the Field Type setting is program or programHTMLOutput.

Using an update program is recommended only when the Field Type is not attribute or basic.

See JPO for Getting Field Values.

The name of a JPO, such as:

SCSBuyerDeskForm

TMCPackagesForm

ENCPartForm

AEFUtilForm

Validate

Specifies the method to execute for validating any cell. The file containing this method must be specified in the emxAPPNAME.properties file.

The name of a method, such as:

checkUniqueName

Validate Type

Specifies how field values should be validated.

Basic or Restricted--The field values are validated against the value of emxFramework.Javascript.BadChars.

Name--The field values are validated against the value of emxFramework.Javascript.NameBadChars.

Vertical Group Name

All fields with the same Vertical Group Name will display in a column in the specified form location.

<text name of group>

View Exclude

Comma-separated list of attributes that will not be included in the webform when opened in View mode when a field on the webform has been defined as Field Type = Dynamic Attributes.

For example:

attribute_Cost

*Required Setting