Settings

Access Expression

Controls access to the component based on a valid MQL expression. The expression gets evaluated at runtime. If the expression evaluates to True and no other access control prevents access, the component is shown, otherwise it is hidden.

Depending on the type of expression defined, the program may or may not need a valid objectID.

Administrators need to make sure that an objectId is available before configuring this setting for configurable toolbar menus and commands.

When the setting is used for commands connected to the AEFGlobalToolbar (My Desk, Actions, Tools), the expression is evaluated on the person business object. It does not depend 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 the My Desk menu, the Access Mask setting is ignored. Similarly, the IconMail tree, which does not have an objectId, does not use this setting if defined.

Generic Create Form: Do not use object-specific expressions.

Access Expression is not supported for non-object based structure browsers.

attribute[$<attribute_Weight>].value > 100

The toolbar item displays only if the Weight attribute on the business object is greater than 100.

attribute[$<attribute_Originator>].value == owner

For menu command objects:

context.user.name=="Test Everything"

context.user.isassigned[Employee] == TRUE

command objects for menus and toolbar items, PowerView tabs, table columns, form fields, generic create forms, configurable search form, tree categories, structure browser pages

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, which contain all the request parameters that were passed into the Form page. The JPO method must return an object of class Boolean. If the returned value is true and no other access control prevents access, the component is displayed. If false, it is hidden.

This is particularly useful if there is a criteria for access has nothing to do with users' roles. For example, suppose a link should only be shown to users who are employees of the host company. The JPO and method might check the user's company and display the link only if the user is from the host company.

Generic Create Form: Do not use object-specific expressions.

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

emxAccessCheck()

command objects for menus and toolbar items, PowerView tabs, table columns, form fields, generic create form, configurable search form, tree categories, structure browser pages

Access Mask

Specifies the accesses the user must have for the current business object in order for the component to be displayed.

When the setting is used for commands connected to the AEFGlobalToolbar (My Desk, Actions, Tools), the expression is evaluated on the Person business object. It does not depend on any objectId to be passed in as a URL parameter.

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

Administrators need to make sure that an objectId is available before configuring this setting for configurable toolbar menus and commands.

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

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

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

Access Mask is not supported for non-object based structure browsers and toolbar custom filters.

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

Modify

Delete

ToConnect

ToDisconnect

FromConnect

FromDisconnect

Modify,Delete

FromConnect,FromDisconnect

command objects for menus and toolbar items, PowerView tabs, table columns, form fields, tree categories, structure browser pages, subscription commands

Access Program

Controls access to the UI component based on the output from a method in the specified JPO program. The program must be defined in ENOVIA Live Collaboration. This setting requires that the Access Function setting also be specified. If Access Function is not set, the Access Program setting is ignored.

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.

Generic Create Form: Do not use object-specific expressions.

Name of a JPO defined as a program object in ENOVIA Live Collaboration, such as:

emxAEFCollectionAccess

command objects for menus and toolbar items, PowerView tabs, table columns, form fields, generic create form, configurable search form, tree categories, structure browser pages

Action Label

Only used with toolbar commands if Input Type is combobox or textbox. If used, a submit button shows after the combobox or textbox and uses the string specified by this setting as its label. The button refers to the JSON code/href specified on the textbox or combobox, so that a second command is not required to configure the button.

emxFramework.SampleFeature.Find

Find

emxFramework.Common.Filter

Apply Filter

Toolbar textbox

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.

command objects for toolbar items

• textbox (default)
• combobox
• radiobutton
• listbox
• listboxmanual

Admin Type

Use to translate columns or fields whose values are administrative types or ranges of attributes.

Based on the administrative type, the value is translated and presented. For attributes, it is necessary to provide the symbolic name of the attribute, which starts with "attribute_" and is followed by the attribute name with no spaces.

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 the Internationalizing Dynamic UI Components.

Type

State

Role

Relationship

attribute_UnitOfMeasure

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 an attribute value and range values, specify the symbolic name of the attribute. For example:

attribute_UnitOfMeasure

attribute_PartClassification

table object column

form object field

generic create form fields

configurable search form

structure browser pages

Allow Manual Edit

When true, users can manually edit the form row or table column. 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.

For a toolbar link, only used when the format=chooser setting is defined, which is only used when the Input Control = textbox setting is defined.

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

true--Manual entry is allowed.

form object field

generic create object form field

table object column

configurable search form

structure browser pages

toolbar link commands

Alternate OID expression

By default, when a column's data is configured to show as a hyperlink using the href parameter, the system passes the ID of the object for that row in the objectId parameter (tables) or the business object the form page applies to. Using this setting, you can configure the hyperlink so a different objectId is passed. The system passes the ID for the object returned from the expression defined in this setting.

$<to[relationship_NewPartPartRevision].from.id>

$<to[relationship_EBOM].from.id>

table object column

structure browser pages, form object field

Alternate Policy expression

This setting is required to display the state of any connected objects and show the value translated.

This setting is applicable only when the Admin Type setting is set to State.

Any select expression that evaluates to a policy of a connected object.

table object column, structure browser pages

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>

table object column, form object field, structure browser pages

Auto Filter

Determines whether users can filter the table rows based on data in the column. If at least one column in the table has is capable of autofiltering, the Filter tool displays in the page toolbar.

This setting cannot be applied to any column that has multiple values for a single data column cell.

Configuring many columns for auto filtering or applying auto filter to inappropriate columns can potentially have high performance impact when viewing the filtered list. For optimum performance, define a limited number of columns with Auto Filter. Also, choose columns that have a limited set of possible values on which the user may want to filter the table data. For example, state and owner columns. Columns such as description and name are inappropriate because of the unlimited number of values that will result.

If passed, the autoFilter URL Parameter overrides this setting.

Filtering applies to root level objects only.

true--The Filter tool displays in the page toolbar. When clicked, the column is available on the Auto Filter Selection page.

false (default)--The column is not available in the Auto Filter Selection page.

table object column

structure browser column

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

Toolbars

Calculate Average

A setting of true shows the Average of the column values. This is calculated using the total of the values in the column divided by number of rows. Default Label is Average.

true

false

table column objects

Calculate Sum

A setting of true shows the total of the column values. Default Label is Total.

true

false

table column objects

Calculate Maximum

A setting of true shows the largest number of the column values. Default Label is Maximum.

true

false

table column objects

Calculate Minimum

A setting of true shows the smallest number of the column values. Default Label is Minimum.

true

false

table column objects

Calculate Median

A setting of true shows the middle number of the column values. If there is an even number of values, the average of the two middle values is shown.

The median value for the odd number of rows is not rounded since no calculation is done. Default Label is Median.

true

false

table column objects

Calculate Standard Deviation

A setting of true shows the standard deviation of the column values. The formula used for standard deviation is:

sd = square root [sum( x - xbar)^2/ (N-1)]

Where

N is the total number of elements.

xbar is the mean of the column values

Default Label is Standard Deviation.

true

false

table column objects

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

table column objects, structure browser column objects, form field objects

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

table column objects, structure browser column objects, form field objects

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

form object field

configurable search form

Column Count

The number of name/value columns to draw horizontally. For Create forms, this setting applies only to a field defined with Field Type = Dynamic Attributes.

1 (default)

2

3

n

create form fields

Column Icon

Use to display an icon for the column's data instead of other data. Required when the setting "Column Type" is assigned to "icon".

Name of an image file such as:

images/NewWindow.gif

images/EditItem.gif

table object column, structure browser pages

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.

Column Type

The setting "Column Type" is used when no expression is defined for the column data.

program--The values for this column are obtained from a program (JPO). With this setting, the program and function name are required as settings.

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

icon--Used when the column values are shown as an icon. The setting "Column Icon" must be defined with the icon to be displayed.

image--Used when the column values are images. When used, the column shows the primary image associated with the business object (cannot be used with Structure Browser).

checkbox--Used when the column values are check boxes shown grayed or not-grayed based on the access to the object in that row. This access can be based on business logic and defined in a JPO or it can be role-based and defined by assigning roles to the column. If the checkboxes have no access restrictions, this setting is not required and you can create checkboxes by passing in the parameter selection=multiple to emxTable.jsp.

separator--Used to define a column of white space between standard data columns. A separator is especially useful to separate two groups of columns.

file--Shows which hyperlinks to a Quick File Access page listing files checked into or connected to the object. The optional Relationship Filter setting defines how to locate related files.

table object column

structure browser pages

Comparable

Used only for a table showing a structure compare report. Defines whether the column can be used as a comparison criteria in a structure compare report. By default, all columns are comparable except for Column Types of:

Image

Icon

Separator

true (default)

false

column in table

Compare Report

Used only for a table showing a structure compare report. Defines whether to show the column in the structure compare report. By default, all columns are shown except for Column Types of:

Image

Icon

Separator

hide

show (default)

column in table

Confirm Message

Provides a JavaScript confirmation message when users click on the toolbar item. 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.

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

command object for toolbar items

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

form object fields

Currency Converter

Specifies whether the target page should include the Currency Converter tool. In the href URL called when the UI component is clicked, the system passes a parameter called CurrencyConverter and includes the value specified for this setting. If the value is True, the target page includes the Currency Converter tool. If this setting is not included, the value is assumed to be false and the target page does not display the Currency Converter tool.

This setting should only be used with Sourcing Central.

True

False (default)

menu objects for navigation trees

command objects for menu links and tools, tree categories, and toolbar items

table object columns, form object fields

Currency Expression

The name of the currency to convert from. Required for columns whose values are monetary and that can be converted from one currency to another using the Conversion tool and defined exchange rates.

The value should be a select clause that returns the value for the Currency attribute for a specific object or relationship, or the actual value. The currency to be converted from should be the currency in which the user entered the data in (the As Entered currency).

This setting should only be used with Sourcing Central.

For example, to convert currency data for an RFQ Quotation, the following select clause returns the supplier's currency format.

to[Supplier Line Item].attribute[Currency]

table object columns

2

Default

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

Specifies the default value for a toolbar custom filter, and can be a string resource or static text. If the control is configured as a combobox, the Default value must be one of the Range Display Values or Range Values (depending on which setting you used).

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

*

emxFramework.CustomControl.Default

form object field

generic create object fields

configurable search form

toolbar custom filter

Default Category

Specifies the category that should be selected when the tree first opens or is first inserted into another tree. By default the root node is selected, which means the object's Properties page displays. If the tree contains a category that users frequently want to see, you can use this setting to have it selected instead.

Alternatively, you can pass the DefaultCategory parameter to emxTree.jsp. If both are defined, this URL parameter overrides the setting.

A tree does not look for default categories defined for its sub-trees (assigned sub-menus).

The name of a category command object that should be selected when the tree first opens. The command object must be assigned to the tree menu object and if it is not, the root node is selected.

Default Category=PMCWBS

menu objects for navigation trees

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)

form object fields

Diff Code

When multiple columns in a structure compare Complete Summary Report have different values, this setting defines what to show in the Diff Code column. The code value for the column with the lowest precedence shows in the Diff Code column. Multiple columns can have the same precedence, and if both columns have different values, both code values show in the Diff Code column.

<precedence:code value>

1:Attribute

structure browser columns

Display Format

Specifies the number of the date format for any non-editable column or field where the value of the format setting is "date."

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.

table object columns

form object fields

configurable search form

structure browser pages

Display Time

Controls whether the time is displayed along with the date for columns and 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.

true

false

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

table object columns

form object fields

configurable search form

structure browser pages

displayMode

Defines in which mode, Edit or View or Both, that this column is visible. When used, the visibility of the column is defined by the current mode and the value of this setting instead of any Access Expression.

For example, if the table is in view mode and this setting is Edit, then the column is not visible.

This setting applies to columns used in the emxIndentedtable.jsp only; it does not work for columns in flat tables (emxTable.jsp).

Edit

View

Both (default)

columns used by emxIndentedTable.jsp

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 or the categories to add to a tree. 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>

toolbar menu objects

tree menu objects

Dynamic Command Program

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

<JPO Name>

toolbar menu objects

Dynamic URL

When enabled, users can enter URLs or mxLink values and the values will display and function as hyperlinks.

enable (default)

disable

form and create form object fields

table column objects

structure browser columns

Edit Access Mask

Use to control cell-level access in an editable table.

This access check is done on all objects in one database call along with getting the column values. If any cell does not have the specified access, then the cell is shown as read only.

Any access mask, for example:

modify, connect

table column objects

structure browser

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

form object fields

Editable

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

For forms, default is true. For tables and structure browser, default is false.

true--Users can edit the column or field when shown on the Edit mode form.

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

table column objects, form object fields, generic create form fields, configurable search form, structure browser

Effective Date Expression

Used for columns whose values are monetary and that can be converted from one currency to another using defined exchange rates.

The value should be a select clause that provides the value for the Effectivity Date attribute on a specific object or relationship. The system uses this date to get the currency conversion whose rate period falls within this date. If this setting is not added, the current date is used.

For example, for currency data for an RFQ Quotation, the following select clause returns the effectivity date.

to[Supplier Line Item].attribute[Effectivity Date]

table object columns

Expand Function

Specifies the function in the JPO specified in the Expand Program setting that gets the list of child nodes for the tree category.

Name of a method in the Expand Program JPO.

command object for tree category

Expand Inquiry

Use to configure the tree category so a list of business objects is inserted under it automatically, without users having to first view details for objects. For example, Folder categories are often configured to display all folders without users having to view the folders first. Use this setting to define the list of business objects using an inquiry administrative object. You can also define the list using a JPO with the Expand Program and Expand Function settings. If both an inquiry and JPO are specified, the JPO takes precedence.

Name of an inquiry administrative object that retrieves the business objects to list for the category:

TMCFolder

TMCSubFolders

ENCEBOMList

command objects for tree categories

Expand Program

Use to configure the tree category so a list of business objects is inserted under it automatically, without users having to first view details for objects. For example, Folder categories are often configured to display all folders without users having to view the folders first. Use this setting to define the list of business objects using a JPO. You can also define the list using an inquiry with the Expand Inquiry setting. If both an inquiry and JPO are specified, the JPO takes precedence.

This parameter specifies a JPO that contains a method to get the list of objects to insert under the category. The method is specified using the Expand Function setting.

Important Note: This feature is recommended primarily for hierarchically organized categories such as Folders and Subfolders. For best performance and consistency of behavior across applications, the preferred method of navigation is to use the standard tree behavior that does not use a dynamic expand. If conditions require the use of this setting, try to restrict its use to categories that will contain relatively few objects.

Name of a JPO program added to the database.

command object for tree category

Export

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

By default, all column types except programHTMLOutput are exported. To include programHTMLOutput, or exclude other column types from the export, change this setting.

true

false

table object columns

structure browser

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.

Comma-separated list of column heading labels:

Min,Max,Avg

form object field

create form object field

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.

Comma-separated list of row heading labels:

Weight,Volume

form object field

create form object field

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.

form object field

configurable search form

create form object field

Field Table Columns

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

2, 3, ...

form object field

create form object field

Field Table Rows

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

1, 2, ...

form object field

create form object field

Field Type

Setting used only in edit mode while updating the table data.

basic--The column 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 column is editable. The only editable basic information is: type, name, revision, current, policy, description, owner, vault.

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

table object columns

Field Type

This setting is used for several purposes:

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.

These Field Type values that are supported by emxForm.jsp are NOT supported for emxCreate.jsp: emxTable, Table Holder, Group Holder, ClassificationPath, ClassificationAttributes.

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

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

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, then displays a subheading with the name of the attribute group, 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 that 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.

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

image--The primary image associated with the business object.

basic--Displays basic information for the business object: name, type, originated, policy, etc. Use only 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.

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

Group Holder--Groups the fields under the field in one row. Uses the Group Count setting to determine the number of fields to group. When a field has a Field Type of Group Holder, it serves as a dummy field to define the group and does not appear on the form.

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.

emxTable--Embeds a configurable table in the form. Used in conjunction with the table setting and either the inquiry or program setting.

form object field

generic crete form object field

configurable search form

create form object field

format

Specifies 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.

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. 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 "emxUtil:lzDate" to format the displayed field value.

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.

user--Used for create forms (when Editable=false) to add read-only field to support using fullname

chooser--Used only on a toolbar with Input Control = textbox when the entered text should be a date or a chooser. The browse button shows after the text box.

form object field

create form object field

configurable search form

toolbar

format

For custom filter commands, date is the only supported format. When used, the calendar tool shows after the text box.

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

toolbar commands

format

Specifies the format to display the column data.

If at least one column has the format set to currency or UOM, the Conversion tool displays in the page toolbar. When a user clicks the tool, the system opens a new window and displays all column data defined with format=currency and UOM to the currency and unit of measure selected in preferences.

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

currency--Displays the column values as currency.

UOM--Displays the column values as Unit of Measure and enables the Unit of Measure conversion interface.

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.

numeric--Displays the column values as numbers. To perform calculations or graphically analyze the data on a column of string attributes that have numerical values, numeric must be the column type

table object column

structure browser

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", or for tables, "checkbox".

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

getAssignedBuyerDesk

getPackageAccess

getParentPart

getCurrentState

form object field, generic create object field, configurable search form, table object column, structure browser

Group By

Groups rows in the table based on the value in this column. See Group By Column.

true

table column

Group Count

Used in conjunction with the Field Type=Group Holder setting. Specifies the number of fields below the Group Holder field to place in the grouped row.

2, 3, 4, ...

form object field

Group Header

Defines header text to display over several consecutive columns. For example, if you want a group header over three consecutive columns, add this setting to each column and assign the same value for each.

To separate grouped columns using a column of white space, add a separator using Column Type=Separator.

Static text or string resource id.

table object column

structure browser

Group Name

Used for grouping fields in web forms and structure browser. The consecutive fields with same group name are considered a group.

The name of the group.

form objects

configurable search form

create form object field

structure browser

Help Marker

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

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

The naming convention for help markers "emxhelp" followed by the object or feature and then the action, for example, emxhelproutecreate and emxhelpprojectedit. The marker is all lowercase with no spaces.

menu objects for navigation trees, command objects for menu links and tools, tree categories, and toolbar items, table object columns, form object field, configurable search form

Hide Label

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

True

False

form object fields

generic create form fields

configurable search form

Image

Name of the image file to display on toolbar tool commands or next to the label for the tree root node or tree category.

The value can be one of the following:

Any simple image (gif) file name without any prefix. The system assumes the image is referred from the current directory and prefixes it with "images/".

An image file name prefixed with ${COMMON_DIR}. The system looks for the file in the images subdirectory of the directory designated as the common directory. The common directory is defined using the eServiceSuiteFramework.CommonDirectory property in emxSystem.properties.

An image file name prefixed with ${SUITE_DIR}. The system looks for the image file in the images subdirectory of the application-specific directory which is defined using the eServiceSuiteSUITENAME.Directory property in emxSystem.properties. For example, the property for Engineering Central is eServiceSuiteEngineeringCentral.Directory = engineeringcentral.

iconPerson.gif

buttonReports.gif

${COMMON_DIR}/buttonEdit.gif

${SUITE_DIR}/iconCreateECR.gif

If no image is specified for a tree root node or category, the system displays the standard no image icon to indicate there is an error in the definition of the tree.

command objects for toolbar tools

command objects for tree categories

configurable Preferences page

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.

images/newPart.gif

images/EditItem.gif

form object field

generic create form fields

Image

Name of the image used for the menu. This is optional if a label has been defined but required if there is no label.

${COMMON_DIR}/iconSmallOrganization.gif

toolbar menu object

Image Size

When image is the Column Type of a table or the Field Type of a web form, 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.

format_mxSmallImage (default)

format_mxMediumImage

format_mxLargeImage

format_mxThumbnailImage

table object column

Form object field

Input Type

Only used for tables or forms 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. This is important for short numeric entry fields.

Although multiple choices can be displayed in a webform, only one selection can be saved during edit. 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.

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.

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

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

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 with a form field, the Delimiter setting also needs to be defined if you want to use a delimiter other than the default (comma).

The setting accepts the values listed below:

textbox-This is the default. The field has a single-line box for typing text.

textarea-The field has a multi-line box for typing text

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

listbox-The field has a list of range values. Although users can select more than one item in the list by holding the Ctrl key, it's best to use check boxes for multiple selection fields.

radiobutton-For forms only. Shows a radio button next to each range value.

checkbox-For forms only. Shows a check box next to each range value. For fields that allow multiple selections, use check boxes instead of a list box.

listbox-For forms and columns only. 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.

listboxmanual--For structure browser columns. Provides a list of range values and users can select a single value as with the listbox input type. In addition the user can manually type in a value.

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

dynamictextarea-Allows multiple values to be entered in Edit mode

form object field

configurable search form

table column object

structure browser

toolbar textbox

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.

Names of inquiry administrative object separated by a comma.

inquiry=SCSBuyerDesk,SCSBuyerDeskAssigned

inquiry=ENCAllParts, ENCReleasedParts

form object field

Label

Use to enter the text that should appear as the label for the field.

--

configurable search form

Label Function

Specifies the function in the JPO specified in the Label Program setting that gets the value for the root node label.

The name of a method in the Label Program JPO.

menu objects for navigation trees

command objects for tree categories

Label Program

Use to define the label for the root node/tree category using a JPO. This setting specifies a JPO that contains a method to get the value for the label. The method is specified using the Label Function setting.

The input for this JPO must include:

A list of all of the Request Parameters in a HashMap

Method Name as a string

JPO Program Name as a string

The output should be the string that is returned to the tree and used for the label.

There are two other ways to define the label for a tree node: using the TreeLabel URL parameter passed to emxTree.jsp and using the Label parameter for the menu object. The URL parameter takes precedence over the other two methods, then the JPO, then the Label parameter.

Tree category labels can also be defined using a Label parameter for the command object. The JPO takes precedence over the parameter.

The name of a JPO that has been added to the database.

If a JPO is configured for a tree category or root node label and the JPO returns an empty string or null, an exception is thrown.

menu objects for navigation trees

command objects for tree categories

Level

Define the values to show in the Expand filter combo box.

The values for this setting can be:

comma-separated list of positive integers

All

Specify

Text to be processed by the expandProgram JPO.

You cannot use custom levels if the structure browser is filtered using relationship/type/direction.

The All and Specify reserved keywords control specific levels of expansion.

Use the Label setting to define the string resource or static text for the label that shows in front of the expand combo box; use the Registered Suite setting to define the application that defines the menu for the expand filter or the expand Program JPO.

1,2,3,4,5

All

Specify...

Custom expand level (for example, End Item)

toolbar menu object for structure browser

• textbox (default)
• combobox
• radiobutton
• listbox
• listboxmanual

Mass Update

Used only for Edit mode. If set to false for the column, the column is not available to the Mass Update feature, but can be edited using the inline editing (one cell at a time). If set to true, the column is used by the Mass Update feature.

true

false

columns in tables and structure browsers

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

form object field

generic create form field

configurable search form

Maximum Length

Limit the number of characters that are displayed on 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

If this setting is not set, the toolbar displays the entire label.

toolbar menu object

Message URL Label

Specifies the label to use for URL links that call the tree.

For example, notifications that users have new tasks include URL links that open the Inbox Task tree for the user's task. By default, the URL link label shows the name of the Inbox Task object, which is an auto generated name. But if the route creator entered a name for the task, it is better to show that entered name for the URL link.

To have the URL link show the task's entered name, add the Message URL Label setting to the tree menu object for the Inbox Task. The value would be a select macro for the attribute that contains the entered name, in this case the Title attribute.

When building the URL link, the system first looks for the Message URL Label setting on the application specific tree menu, for example, ENCtype_InboxTask. If not found there, the system looks for the setting in the common tree for that object type. If the common tree does not contain the setting, the system defaults to the object's Type,Name,Revision (for example, Inbox Task IT-0000101).

The value can be any select statement, plain text or a string resource ID. For example:

$<attribute[attribute_Title].value>

Task Title

emxEngineeringCentral.TaskTitle

The string resource Id can contain macros also, as in the following example:

emxEngineeringCentral.TaskTitle= $<type> $<name> $<revision>: Urgent Task

menu objects for navigation trees

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

toolbar menu object

Mouse Over Popup

Enables or disables the mouse over popup DIV that displays the entire contents of the cell.

When enabled, the popup shows in both View and Edit mode.

enable

disable (default)

columns used in structure browser

Name Field

Defines how the name field for the object will display in the form:

autoName-only the autoName option is available

keyin-a textbox is provided for text entry

both-both a textbox and the autoName checkbox shown for the name field

autoName

keyin (default)

both

generic create form field

Nowrap

If the setting is true for any column, then the text displayed in that column will not wrap at any time. The default is false.

true

false

table object columns

Popup Modal

If the setting Target Location is set to popup, the window can be configured as modal or non-modal.

true--the popup window is modal

false--the popup window is non-modal

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

command objects for menu links and tools, toolbar items, table object columns, structure browser,

Popup Modal

Use to configure whether the popup range helper window is model or non-modal. Only 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.

form object field

configurable search form

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

• Small
• Medium
• Large
• SmallTall
• MediumTall

command objects for menu links and tools

command objects for toolbar items, form object field, structure browser, configurable search form field

PreExpand

Determines whether to let the JPO program decide whether to add the [+] icon or to simply add the [+] without running the JPO.

true--The Structure Program and Function defined for the Structure command is run to get the list of objects. Then for each object, it runs the same program to determine whether a [+] icon is needed. If the list of objects is greater than 1, a plus [+] is added to the structure node.

false (default)--The JPO Program and Function is run to get the list of objects, but the same program and function is not run again for each object. Instead, a plus icon [+] is automatically added for each structure node.

command objects for structure trees

PreExpand Category

Used in conjunction with the Expand Program and Expand Function settings or the Expand Inquiry setting, which inserts a list of objects under the tree category without requiring users to first view details of those objects. Use this setting to determine whether the tree pre-processes the JPO or inquiry to determine if there are any objects to be listed.

Pre-processing offers the benefit of determining in advance that there are no business objects in the list so the + sign for expansion is not shown. But pre-processing lowers performance.

Administrators who configure this setting as true need to be aware of the performance implications to doing so. While it is nice to only display the + sign when data is present, the tree must actually go and get the data at the time the tree displays to do this. Therefore, if there are many tree categories configured with PreExpand Category set to true, each of those categories will be evaluated when the tree is displayed regardless of whether the user actually intends on viewing data in those categories or not. This potentially unnecessary processing lowers performance.

true--Pre-processing is allowed so if there are no objects, the + sign for expanding the list is not shown.

false (default)--Pre-processing is not allowed so the + sign is displayed even if there are no business objects in the list. The inquiry or JPO is not processes until the user clicks the + sign.

command objects for tree categories

PreExpand Function

Specifies a method in the JPO defined in the Expand Program setting that configures the category for dynamic expand. This method determines whether there are any business objects in the business object list retrieved from the JPO, thereby determining whether the + sign should be displayed.

Use of this setting requires a change in ENOVIA Live Collaboration that has not yet been implemented.

Name of a method in the Expand Program JPO.

command objects for tree categories

Printer Friendly

Passes the PrinterFriendly parameter and the entered value to the JSP specified in the href URL. JSPs that use the PrinterFriendly parameter, such as emxTable.jsp and emxForm.jsp, show the Printer Friendly tool when the setting is True and hide it when False. If the setting is not included, emxTable.jsp and emxForm.jsp show the tool by default. Users can click the tool to get a version of the current page that can be printed with the browser's Print button.

Note that you can also specify the PrinterFriendly parameter in the href URL for JSPs that use it.

True (default)

False

menu objects for navigation trees

command objects for menu links and tools, tree categories, and toolbar items

table object columns

form object field

program

Use to specify the name of the JPO program to use to get the field's data when the Field Type setting is set to "program" or "programHTMLOutput".

Also 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.

The name of a JPO, such as:

SCSBuyerDeskForm

TMCPackagesForm

ENCPartForm

AEFUtilForm

form object field

generic create form field

configurable search form

program

The name of the JPO program to use to get the column's data. This program is used to get the column values when the setting "Column Type" is set to "program" or "programHTMLOutput" or "checkbox".

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

emxSCSBuyerDesk

emxTMCPackages

emxENCParentPart

emxCommonTableUtil

table object column

Pull Right

Determines whether the drop-down links are displayed in 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.

True (default)

False

toolbar menu object

Range Display Values

Only used with toolbar commands if Input Type=combobox. Holds a comma-separated list of string resources or static text values used to populate the combobox.

If this setting is not specified, the Range Values setting is used.

emxCustom.Combo.Value1, emxCustom.Combo.Value2, emxCustom.Combo.Value3

Value1,Value2,Value3

toolbar custom filters

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.

Only used with toolbar commands if Input Type=combobox.

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

getAssignedRange

getClassificationRange

getPartUOM

toolbar custom filters

Range Program

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

The name of a JPO, such as:

ENCParts

AEFUtils

toolbar custom filters

Range Values

Only used with toolbar commands if Input Type=combobox. Holds a comma-separated list of values used to populate the combobox.

Value1,Value2,Value3

toolbar custom filters

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

form object field

configurable search form

table object columns

structure browser

Range Program

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

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

The corresponding method which runs to get the values of the column should not have any HTML code.

The name of a JPO, such as:

SCSBuyerDeskForm

TMCPackagesForm

ENCPartForm

AEFUtilForm

form object field, generic create form field, configurable search form field, table object columns, structure browser

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)

form objects

Registered Suite

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

SuiteDirectory

StringResourceFileId

This setting is required for all dynamic UI components.

The value must be set without 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 item is clicked, the system passes a parameter called suiteKey and includes the property name that maps to the value specified for the setting.

If the Column Type is file, this value must be Components.

For subscription commands, use Components.

menu objects for top-level menus and for My Desk and Actions submenus

command objects for menu links and tools

menu objects for navigation trees

table object columns

form objects

menu objects for toolbars

command objects for toolbar items and PowerView tabsstructure browser

Relationship Filter

Optional setting that defines a comma-separated list of relationship select expressions to get the file lists checked into or connected to the Type object.

from [<relationship_ReferenceDocument>].to.id,

to [<relationship_ReferenceDocument>].from.id,..,..

table object columns

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)

form object fields

configurable search form fields

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.

form object field

genericcreate form object field

Revision Filter

Enables or disables the display of the revision filter button.

Enable

Disable (default)

tree command objects

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>

table objects

toolbar meu objects

Root Label

Determines the label for the root node(s). You can use static text, such as Search Results, or a string resource id. When using a string resource id, you can use any valid MQL expression, such as:

emxFramework.Common.RootL
abel= $<type>$<name>:Root 

If the expression does not apply to the root object (such as an attribute not associated with that object), the expression is ignored and the default label is used.

If this setting is configured for a column not in the freeze pane, it is ignored.

Search Results

emxFramework.Common.RootLabel

structure browser freeze-pane column

true (default)--column can be used for grouping rows

false--column can not be used for grouping roles

Row Number

If the column is defined with a Group Name setting, this setting defines whether this column displays in the first or second row of the group. Only 2 rows are permitted for a group.

Used for merging cells as defined in Merged Cells.

1 (default)

2

structure browser

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" in order to get the details of the selected item(s) from the table.

If the setting is 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.

For subscriptions, this setting must be set to multi and the Submit setting must be set to true.

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.

command objects for toolbar items

Row Span

If this column is defined with a Group Name setting, defines how many rows each cell in this column will span. If set to 1, no spanning is done. If set to 2, the column value spans 2 rows. You cannot span more than 2 rows.

Used for merging cells as defined in Merged Cells.

1

2 (default)

structure browser

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

form object field

configurable search form

Section Level

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

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.

form object field

generic create form field

configurable search form

Selectable in Preferences

Only for commands in 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

command objects for menu links and tools

Show Alternate Icon

If the column value to be displayed with the icon is different from the current row's object icon, set this setting to true. ITo get the right alternate icon, the Alternate Type expression setting must be defined with the expression to obtain the object type.

true

false

table object column

structure browser

Show Alternate Icon

If the field value needs to be displayed with an icon that is different from the current object type icon, set this setting to true. To get the right alternate icon, the Alternate Type expression setting must be defined with the expression to obtain the object type.

true

false (default)

form object field

Show Clear Button

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

True

False

form object field

generic create form field

configurable search form

structure browser columns

Show Type Icon

If set to true, the field or column value is displayed along with the object type icon as defined in the emxFramework.smallIcon property in emxSystem.properties. The icon is displayed to the left of the field or column data.

If no property is defined for the type's icon, the system looks for a property defined for the parent type, then grandparent type and so on. 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)

table object column

structure browser

generic create form field

Sort Direction

Used only for fields of type combobox and listbox.

The direction to sort 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.

table column objects, structure browser, form object fields

Sort Program

Specifies the JPO program name that contains a custom sorting algorithm. This setting is used only when the column parameter sorttype is assigned to "other".

Name of a JPO added as a program in the database, such as:

FindNumberSort

CustomSort

table object column

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 object column, form field, structure broswer, configurable search form field

Sort Type

Determines how the column is sorted.

The MQL sorttype subclause must also be included.

Use on its own to sort numeric columns (sorttype = numeric)

OR

Use in conjunction with the Sort Type setting. Two examples:

(sorttype = other AND Sort Type = integer)

(sorttype = other AND Sort Type = real)

date

integer

real

AlphaNumericLarger--consider all numeric values as larger than the alphanumeric values

AlphaNumericSmaller--consider all numeric values as smaller than the alphanumeric values

table object column

structure browser

Sortable

Controls whether users can sort the table based on data in the table column. If a column is sortable, users can click the column heading to sort the table based on that column.

true (default)

false

table object column

structure browser

sortColumnName

Used only for fields defined with Field Type=emxTable. Specifies the column by which the table should be sorted 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.

form object field

sortDirection

Used only for fields defined with Field Type=emxTable. The direction to sort the rows by.

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

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

form object field

Structure Function

JPO method name to be used for getting the object list.

The name of a method in the JPO specified in the Structure Program setting, such as:

getWorkspaceFolders

getEBOMs

command objects for structure trees

Structure Inquiry

Inquiry administrative object name that gets the object list to display within the structure. This is an alternative to the JPO approach and the JPO approach takes precedence.

This setting is not implemented.

The name of an inquiry administrative object:

SCSWspFolderStructure

ENCEBOMList

command objects for structure trees

Structure Menu

Specifies the menu administrative object that defines a structure tree for the object type.

The name of a menu administrative object.

menu object for navigation tree

Structure Program

JPO program that contains the method to be used for getting the object list to display within the structure. The method is specified in the Structure Function setting.

The name of a JPO program added to the database.

SCSWorkspaceStructure

ENCBOMStructure

command objects for structure trees

Style Column

Customizes the sytle for a column. The value must be a class defined in the dsecUITypeCustom.css. For the example style, the definition in the css file could be:

ColumnBackGroundColor {

background-color : 
rgb(252,186, 186);

} 

To define alignment, use one of these values:

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

For numeric fields, the default is left-align.

ColumnBackGroundColor

column in a structure browser

Style Function

The method in the Style Program JPO that defines the style per cell in the column.

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

getStyleInfo

column in a structure browser

Style Program

The JPO that contains methods to defines the style per cell in the column.

The name of a JPO, such as:

AEFUtilStyleJPO

column in a structure browser

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 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 the setting is not specified, it is assumed to be false.

true--Submits the IDs to the URL specified in the href parameter. Should be used for actions that depend on selected table rows.

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

For toolbar commands in a structure browser, should be true so that the selected items in the structure are posted to the processing page.

command objects for toolbar items, including subscription commands

table

Specifies the name of a table administrative object to embed in the form. Used only for fields defined with Field Type=emxTable.

Name of table administrative object. For example:

table=SCSBuyerDesk

table=ENCParts

form object field

Target Location

Controls where the page specified in the href parameter appears.

For table columns, this value can be set to any valid frame name, which is available to the table body frame.

For toolbar commands, must be listHidden or popup.

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.

content--The page replaces the tree frame.

mainframe--The page appears in the main content frame, to the right of the tree frame and tab frames, replacing the page that is already there. (not used for table columns or structure browser)

popup--Page appears in new window. The window modality is set using the Popup Modal setting.

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

topFrame--The page replaces the banner frame. (not used for table columns or structure browser)

hiddenFrame--The frame called hiddenFrame is part of the top level Navigation window frameset and can be used to submit the Table frame and carry out background processing. This frame is not available for popup windows though so listHidden is a better frame to use.

listHidden--A hidden frame within the table frameset. Use this frame for Target Location for any processing in the context of a table.

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

command objects for menu and toolbar links and tools

table object columns

command objects for toolbar items

subscription commands

structure browser

Target Location

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

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

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.

form object field

configurable search form

Target Location

This must be assigned to "searchContent."

searchContent

Search JSP page

Tip Page

Specifies whether the target page should include the Tip Page tool and the URL that should be called when the tool is clicked. In the href URL called when the UI component is clicked, the system passes a parameter called TipPage and includes the URL specified for this setting.

If this setting is not included, the target page does not display the Tip Page tool.

Name of a custom html or JSP page, including any path. The starting point for the directory reference is the content directory. For example, if you want to call an html file in ematrix/doc/customcentral and the content directory is ematrix/customcentral, you would add this parameter to the table.jsp:

TipPage=../doc/customcentral/tippage.html

menu objects for navigation trees

command objects for menu links and tools, tree categories, and toolbar items

table object columns

form object field

Tree Scope ID

Passes the current tree's objectId to all its categories, to subtrees inserted into the tree, and to categories in the subtrees, to the nth level, in the parameter name specified as the value for this setting. This setting is valid only for tree menu objects and not for tree category command objects.

For example, suppose you want to pass the object ID for the current workspace to all categories and subtrees in the workspace tree. You want to pass the object ID using a parameter called workspaceId. To do this, you would add the Tree Scope ID setting to the menu administrative object for workspace trees (which is called type_Project due to administrative object renaming) and enter "workspaceId" as the value. The parameter and value "workspace Id=OBJECTID OF THE WORKSPACE will be available to all the categories and subtrees of the current workspace to the nth level until another workspace object gets inserted or until any explicit URL parameter with the same name "workspaceId" is passed to the tree.

The name of the parameter you want to use to pass the object ID. For example:

workspaceId

projectId

partId

You can also pass specific parameters from the tree menu object to its categories using the AppendParameter parameter for the emxTree.jsp.

menu objects for tree nodes, menu objects for navigation trees

LASTNAME,FIRSTNAME,USERNAME

true

false (default)

Type Icon Function

Specifies the function in the JPO specified in the Type Icon Program setting that retrieves an icon to show in addition to the icon defined by the emxFramework.smallIcon.type system property.

Function Name

tree menu objects

web forms

tables

structure browsers

Type Icon Program

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

JPO Name

tree menu objects

web forms

tables

structure browsers

TypeAhead

Enables type ahead. For mass update in a structure browser, default is true.

true

false

configurable search form field, structure browser mass update

TypeAhead Program

Name of the JPO called to retrieve a list of possible values.

--

configurable search form field, structure browser mass update

TypeAhead Function

The name of the JPO method.

--

configurable search form field, structure browser mass update

TypeAhead Character Count

Overrides the emxFramework.TypeAhead.RunProgram.CharacterCount system property.

2 (default)

5

configurable search form field

TypeAhead Saved Values Limit

Overrides the emxFramework.TypeAhead.SavedValuesLimit system property.

10 (default)

configurable search form field

UOM Expression

The name of the Unit of Measure to convert from. Required for columns whose values are measurements that can be converted from English units to Metric units or vice versa.

The value can be a select clause that returns the value for the Unit of Measure attribute for a specific object or relationship or the actual value. The unit of measure to convert form should be the unit of measure in which the user entered the data (the As Entered unit of measure).

This setting should only be used with Sourcing Central.

For example, for measurement data for RFQ Quotations, the following select clause returns the supplier's unit of measure format.

to[Supplier Line Item].attribute[Unit of Measure]

table object columns

Update Function

Specifies a method name in the JPO given in the Update Program setting.

Generic Create Form: This setting can not be used with the required fields: Type, Name, Policy, Vault, Owner.

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

setAssignedBuyerDesk

setPackage Access

setPartClassification

form fields,generic create form fields, table object columns, structure browser

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.

Generic Create Form: This setting can not be used with the required fields: Type, Name, Policy, Vault, Owner.

The name of a JPO, such as:

SCSBuyerDeskForm

TMCPackagesForm

ENCPartForm

AEFUtilForm

form fields

generic create formfields

table object columns

structure browser

Update Program Arguments

Comma-separated list of arguments to be passed to the JPO specified by the Update Program setting.

Relationship=relationship_EBOM,ConnectFrom=true

structure browser mass update

Validate

Specifies the method to be invoked for validating any cell.

The name of a method, such as:

checkUniqueName

table column object, form object field, generic create form field, structure browser

Validate Type

This setting is used to validate any column or field value with any specific characters defined in emxSystem.properties.

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

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

table, column object, form field, generic create form field, structure browser

Vertical Group Name

Used for grouping fields vertically in create web forms. The fields with the same Vertical Group Name value will be are considered a group.

The name of the vertical group.

create form object field

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

form field object

Width

Number of pixels to define the column width.

When this setting is not defined, by default the width is calculated based on the header text length, so that the header text is not truncated.

Column width in pixels:

150

structure browser

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

toolbar custom filter