This table lists and describes the settings for menus that represent
navigation trees. Note that the names and values are case sensitive.
Setting
Description
Accepted Values/Examples
Currency Converter
Specifies whether the target page should include
the Currency Converter tool. In the href URL called when the user clicks
the tree root node, 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.
True
False
Default Category
Specifies the category to be selected when an object is selected for display, or when the user clicks the top node in the Categories menu. 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, specify
it instead.
Alternatively, you can pass the DefaultCategory parameter
to emxTree.jsp. If both are defined, this URL parameter overrides the
setting.
Note that a tree does not look for default categories
defined for its sub-trees (assigned sub-menus).
The name of a category command object to select
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
Dynamic Command Function
Defines the method in the JPO specified by the
Dynamic Command Program setting that returns a list containing the categories
to include in the navigation tree.
<JPO Method Name>
Dynamic Command Program
Defines the JPO invoked from a navigation tree
component. This setting can only be used on static menus or commands
in a tree; it cannot be used with commands that have been dynamically
added.
<JPO Name>
Help Marker
Specifies the name of the help marker to call
for context-sensitive help.
In the href URL called when the
tree root node 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.
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.
Label Program
Use to define the label for the root node using
a JPO. This parameter 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.
For information on the precedence order, see the Label parameter.
The name of a JPO 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, the system throws an exception.
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 autogenerated name. But if the route creator entered a name
for the task, it's better to show that entered name for the URL link.
To have the URL link show the task's entered name, you would 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 doesn't 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:
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
*Registered Suite
The application the menu belongs to. The system
looks for files related to the tree 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 with no 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 root node, 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.
Structure Menu
Specifies the menu administrative object that
defines a structure tree for the object type.
The name of a menu administrative object.
Tip Page
Specifies whether the target page should include
the Tip Page tool and the URL to call when the user clicks the tool.
In the href URL called when the user clicks the tree root node, the system
passes a parameter called TipPage and includes the URL 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, add this parameter
to the table.jsp:
TipPage=../doc/customcentral/tippage.html
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. 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.
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
Type Icon Program
Defines the program that contains the function
specified using the Type Icon Function setting.