Settings for Tree Category Command Objects

This table lists and describes the settings for command objects used for navigation tree categories. Note that the names and values are case sensitive.

Setting Description Accepted Values/Examples

*Registered Suite

The application the command belongs to. The system looks for files related to the tree category 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", 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".

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

Label

The label that shows the list of structures in the Structure Selector combo box.

If there is only one command attached to the structure menu the system ignores this setting.

A string resource ID or text string:

emxTeam.common.Folders

Discussions

EBOM

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 system runs the Structure Program and Function defined for the Structure command to retrieve the list of objects. It runs the same program for each object to determine whether it must display a [+] icon. If the list of objects is greater than 1, it adds a plus [+] to the structure node.

false (default)--The system runs the JPO Program and Function one time to get the list of objects. It displays plus icon [+] for each structure node.

Revision Filter

Enables or disables the display of the revision filter button.

Enable

Disable (default)

Structure Function

JPO method name that gets the object list.

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

getWorkspaceFolders

getEBOMs

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

Structure Program

JPO program that contains the method that retrieves the object list to display in the structure. The method is specified in the Structure Function setting.

For instructions on writing the JPO program, see Guidelines for Writing Structure Tree JPO.

The name of a JPO program added to the database.

SCSWorkspaceStructure

ENCBOMStructure

Target Location

Controls where the page specified in the href parameter appears.

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

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

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

content--The page replaces the content frame.

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

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

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

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

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

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

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

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

*Required Setting