URL Parameters Accepted by emxTree.jsp

This table lists the parameters you can specify for emxTree.jsp. When you call emxTree.jsp from a JSP, you can add these parameters. Note that the name of the menu object for the tree is not required because the system automatically looks for the tree menu object that has the same name as the symbolic name of the object's type.

Parameter Description Accepted Input Values

AppendParameters

Passes common parameters to the tree categories in the tree. To use the parameter, set it to true and then include the parameters to pass. Parameters added to emxTree.jsp that are not with AppendParameters are passed only to the root tree node and not to categories.

You can also use the Tree Scope ID setting for the tree menu object to pass the current tree's object ID to all categories and subtrees.

To make Param1 and Param2 available to the children categories:

<a href="../common/emxTree.jsp?objectId=<%=sPartId%>&mode=insert&jsTreeID=<%= jsTreeID %>&AppendParameters=true&Param1=Value1&Param2=Value2" class="object" target="content"><%=sPartName%></a>

To make ProjectId and Workspace available to the tree categories:

<a href="../common/emxTree.jsp?objectId=<%=sPartId%>&mode=insert&jsTreeID=<%= jsTreeID%>&AppendParameters=true&ProjectId=<%=sProjId%>&Workspace=<%=sWorkspace%>" class="object" target="content"><%=sPartName%></a>

To make ProjectId and Workspace available only to the root tree node and not to the tree categories:

<a href="../common/emxTree.jsp?objectId=<%=sPartId%>&mode=insert&jsTreeID=<%= jsTreeID %>&&ProjectId=<%=sProjId%>&Workspace=<%=sWorkspace%>" class="object" target="content"><%=sPartName%></a>

DefaultCategory

Specifies the category to be selected when the tree first opens. The root node is selected, by default, so the object's Properties page displays. If the tree contains a category that users frequently want to see, use this parameter to select it instead.

Alternatively, you can use the Default Category setting for the tree's menu object. 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 displays. You must assign the command object to the tree menu object. If it is not, the root node is selected.

DefaultCategory=PMCWBS

jsTreeID

The ID of the existing tree object required to update the tree with "insert" mode.

When the system constructs the tree for the first time, the "jsTreeID" parameter does not have any valid value.

Whenever the user clicks a category within the tree, the system passes the current "jsTreeID" to that page. If that page needs to update the tree, it must call emxTree.jsp with the same "jsTreeID" value.

node567590204694.5947

legacyTree When the emxFramework.LegacyTree property in emxSystem.properties is set to false (replacing the categories pane with a Categories menu), this URL parameter overrides that setting for the specific tree. true

mode

Controls whether the tree for the object is inserted into the current tree or replaces the current tree.

Insert-Insert the tree for the selected object into the current tree, if there is one.

Replace (default)--Replace the current tree, if there is one, with the tree for the selected object.

objectId

This is the business object ID that the system will construct the tree for. For example, if the object is of type ECR, the system will construct the tree object of menu type "type_ECR". If the menu "type_ECR" does not exist, the system will base the tree on the "Default Tree" configuration.

2233.5567.2323.4678

targetLocation When a URL is defined to open in the slide-in frame (the Target Location setting for the component is set to slidein), BPS appends this URL parameter with this value. This parameter supports a custom page where the html for a popup window needs to be different than the html for a slide-in window. slidein

treeLabel

Use to override the default label for a tree (defined in the "Label" parameter of the tree menu administrative object). When this parameter is available to the emxTree.jsp page, the page uses this value as the Label for tree menu base node.

This parameter also overrides any JPO specified for the label in the settings Label Program and Label Function.

emxTree.jsp?treeLabel=custom Part Label&objectId=3434.345.4564.7755

treeMenu

Use to override the standard tree menu for the object's type (or any alternate tree defined by an application). The standard tree menu for an object is the symbolic name of the type. For example, the standard tree menu object for quality part plans is type_QualityPartPlan. For more information on calling specific trees, see Specific Trees for an Object Type.

Using a custom tree menu by overriding the system-defined tree for any object type is NOT RECOMMENDED.

Name of a menu object for a tree:

customPartTree