Expand Tools

You can add expand tools to the structure browser's toolbar.

This example shows the default expand tools.




  • opens the box shown where a user can choose how many levels to expand the structure browser. The expand levels can be customized.
  • expands the entire structure browser to all levels. This functionality has also been added to the default right-click menu for the structure browser

The AEFFreezePaneExpandLevelFilter menu contains these commands and can be included in a structure browser toolbar:


  • AEFFreezePaneExpandNLevel. Adds the icon to the toolbar, which provides the drop down box shown above that allows users to select range values 1 through 5
  • AEFFreezePaneExpandAllLevel. Add the icon to the toolbar that allows a user to expand the entire structure.

You can use these administrative parameters on the menu command:

Parameter Description Accepted Input Value

Access

The user, group, or role to which this option applies.

All

Test Everything

Label

The display values for choices in the Expand combo box. A string resource property can be provided. If a label has not been defined, then the Level information shows.

Next,2,3,4,5

emxFramework.FreezePane.Next

The expand filter is controlled by these URL parameters:


  • expandLevelFilter--enables or disables the expand filter
  • expandLevelFilterMenu--defines the administrative menu that adds the expand filter to the toolbar

The Level setting defines the values that populate the Expand combo box. The expandProgram JPO (see Expand Objects using JPO for ENOVIA Objects) uses the value selected in this box when expanding a node. The values for the Level setting can include the keyword All.

The All levels choice is supported by the relationship expand and an expandProgram JPO. The Label is displayed based on the Label parameter for the command object, and can be internationalized.

You can include a custom text value as a level if you write a custom expandProgram JPO that processes that value. You cannot use a custom text value with a relationship expand.

When a structure browser page is loaded and the user selects , the Expand filter shows the first value entered for the first command in the expand menu. If that command is a comma-separated list, the first value in the list is used. If the structure browser shows multiple root nodes, the page is not expanded to any level when initially loaded. Also for multiple root nodes in edit mode, if a user edits any data and clicks Expand All in the shortcut menu, a message instructs them to save their changes before the structure can be expanded.

If the type or relationship/direction filters are used, the Refresh button causes the structure to expand one level at a time to the level selected in the Expand levels combo box using the selected filter options. The user cannot select both the To and From directions if the Level is set to All--this combination would create an infinite loop. If the user tries this combination, an error message displays.

If you anticipate that the expand could return large object sets, you should set a value for the BOS_EXPAND_LIMIT setting in the enovia.ini file for the ENOVIA Live Collaboration Server to limit the number of objects returned from the ENOVIA Live Collaboration core. You can also use the Studio Customization Toolkit to set a limit to the expand (the ENOVIA Studio Customization Toolkit expand limit can be used within the expandProgram JPO).