Parameters for Tree Category Command Objects

This table describes the available parameters for command objects used for tree categories. These apply to command objects for standard navigation trees (the Categories menu) and for structure trees.

For specific instructions on how to create command objects using Business Modeler or MQL, refer to the Business Modeler Guide or MQL Guide.

Parameter Description Accepted Values/Examples
Icon

Icon for the object within ENOVIA Live Collaboration.

This setting does not display an image in the UI.

The name of an image file, such as Part.gif.

Label

The text that should be used to represent the tree category. The label can be made up of:


  • Plain text, such as "ECRs".
  • Text and/or any valid select expression that gets evaluated before displaying the label, such as "Subfolder ($<attribute[attriubute_Count].value>)".

    For example, you can configure the label to show a count of the number of items in the category to the right of the label and in parentheses. If the category is subfolders of a folder and a particular folder has three subfolders, the label would show "Subfolders (3)".

    To configure the label to include a count, use the macro $<attribute[attriubute_Count].value>. For example:

    Label = Subfolder 
    ($<attribute[attriubute_Count].value>)
    

    The Count attribute is assigned to the Workspace Vault type (called folder in the UI). This attribute keeps the count of the number of subfolders created below the folder. At run time, this value is evaluated and is shown in the label for the tree category.

  • A string resource ID, such as "emxEngineeringCentral.DesignTOP.CreatePart".

    To internationalize the text, you must use a string resource ID. See Internationalizing Dynamic UI Components. The system first looks for a string resource ID that matches the entered value. If it finds one, it uses the value for the ID. If it does not find one, it displays the entered text and/or output from the select expression.

    To internationalize a label that needs a select expression, assign a string resource ID to the label. The string resource ID can contain the macro to be evaluated. For example, using the use case described in option 2 above, you could configure the command object label as follows:

    Label = emxFramework.Common.Subfolder
    

    And in string resource file:

    emxFramework.Common.Subfolder  = Subfolder 
    ($<attribute[attribute_Count].value>)
    

Tree category labels can also be defined using a JPO. See the Label Function and Label Program settings. If these JPO settings are defined for a category, they override any label defined using this parameter.

ECRs

Subfolder ($<attribute[attribute_Count].value>)

emxEngineeringCentral.DesignTOP.CreatePart

href

The URL that gets executed when the user clicks the tree category. This URL displays in the right frame and not in another window or frame.

The value for the href parameter should be a JSP and any associated parameters. You can specify the path of the JSP using any of the standard directory macros or you can leave off the path designation to use the registered directory.

emxECRs.jsp

${COMMON_DIR}/emxECRs.jsp

${SUITE_DIR}/emxECRs.jsp

${ROOT_DIR}/emxECRs.jsp

Alt

Not applicable for tree categories because ToolTips do not display for categories.

--

Access

The persons, roles, and groups who can access the tree category. To make the tree category available to all users, regardless of role/group assignments, choose All.

Note that if no users are assigned access, the system assumes all users have access.

Names of group, role, person administrative objects.

or

All (default)

Settings

Additional settings that define the behavior and appearance of the command. For a list of the accepted settings, see the table below.

Name/value pairs, as defined in Settings for Tree Category Command Objects.